API Management 10.4 | Using CentraSite | Policy Management | Managing Design Time Policies through CentraSite Business UI | Creating a Design Time Policy
 
Creating a Design Time Policy
Pre-requisites:
To create a new Design Time policy, you must have one of the following permissions in CentraSite:
*To create policies for a specific organization, you must have the Manage Design Time Policies permission for that organization. By default, users in the CentraSite Administrator, Organization Administrator, or Policy Administrator role have this permission.
*To create system-wide policies (that is, policies that apply to all organization within an instance of CentraSite), you must have the Manage System-Wide Design Time Policies permission. By default, users in the CentraSite Administrator role, Asset Type Administrator role, and Operations Administrator role have this permission.
* To Create a Design Time Policy
1. In the CentraSite Business UI activity bar, click Design Time.
2. Click Add Design Time Policy.
The Add Policy page appears.
3. In the Basic Information profile, specify basic information about the policy.
In this field...
Do the following...
Name
Type a name for the new policy. A policy name can contain any character (including spaces). A policy name does not need to be unique within the registry. However, to reduce ambiguity, you should avoid giving multiple policies the same name. As a best practice, Software AG recommends that you adopt appropriate naming conventions to ensure that policies are distinctly named within your organization.
Description
(Optional). Type a description for the new policy. This description appears when a user displays a list of policies in the user interface.
Version
(Optional). Specify a version identifier for the new policy.
Note: The version identifier does not need to be numeric.
Examples:
0.0a
1.0.0 (beta)
Pre-release 001
V1-2007.04.30
The version identifier you type here is the policy's public, user-assigned version identifier. CentraSite also maintains an internal, system-assigned version number for the policy.
Priority
Type an integer that represents the priority of this policy with respect to other policies that might be triggered by the same event. The priority value determines the order in which the policies are enforced. The lower the Priority value, the higher the priority (that is, 0 is the highest priority and policies with this priority value are executed first).
*Priority values 0 through 10 and values greater than 9999 are reserved for predefined policies. You cannot assign these values to the user-defined policies that you create in CentraSite Business UI.
*The default priority for a user-defined policy is 11.
Organization
Specify the organization to which the policy applies or select All if the policy applies to all organizations.
Note: The Organization list contains the names of all organizations for which you have Manage Design Time Policies permission. The option appears in the list if you also have Manage System-Wide Design Time Policies permission.
4. In the Scope profile, specify Applicable Types and Event Types to which the policy applies.
In this field...
Do the following...
Applicable Types
Specify the types of assets applicable for this policy.
Note: When you select a base type, for example, a Service asset type that has virtual types, for example, Virtual Service, Virtual REST Service, associated to it, and the Inherit Base Type Policies option is enabled for certain of the virtual types, be aware that the policy you create is applied to instances of the base type and instances of the virtual types.
You can optionally restrict a policy to specific instances of the selected Applicable Types by specifying additional selection criteria.
Event Types
Specify the types of events applicable for this policy.
Important: The OnCollect, OnMove and OnExport events are designed to execute handler and collector processes. Do not use these events unless you are creating a handler or collector policy. The improper use of these event types can damage the registry.
Filter Criteria
Specify the selection criteria to narrow the set of Applicable Types applicable for this policy . You can filter the Applicable Types by Name, Description, and Classification attributes.
5. In Policy Actions, select the actions that you want CentraSite to execute for a policy. To add a policy action, perform the following:
a. Based on your selection for the Scope profile, the system shows the policy actions available for this new policy on the left side menu.
b. Click next to a policy action to add it to the Policy Actions page.
c. If you want to delete an action from the Policy Actions page, click next to the up and down arrows in the policy action row.
Remember the following points when you select the actions for the policy:
*In the Scope profile, you have to select atleast one Event Types. If not, when you click on a policy action, the system shows an error message and the policy action page appears empty.
*The actions shown in the Policy Actions list are determined by the Applicable Types and Event Types that you specify on the Scope profile. If you do not see an action that you need, that action is probably not compatible with all of the Applicable Types and Event Types that you selected in the Scope profile.
*If necessary, you can click the Scope profile and change your Applicable types and Event types selections.
*Ensure that the actions in the area labeled Policy Actions appear in the order that you want CentraSite to execute them at enforcement time. If necessary, use the up and down arrows to place the actions in the correct order.
*Be aware that actions from the WS-I category cannot be combined with other types of actions. Also be aware that when you add a WS-I action to the action list, CentraSite automatically adds dependent actions to the list as necessary.
6. Complete the policy by doing the following:
a. Configure the parameters for each action in the Policy Actions area by clicking the policy action. Clicking the policy action more than once toggles the form.
Note: Ensure that you specify values for any mandatory parameters. If not, you cannot save the form.
b. If the policy is to be enforced during a PreStateChange or PostStateChange event, ensure that the options on the States profile specify the lifecycles and state changes to which the policy applies. By default, the States profile is disabled. When you select Pre-State Change or Post-State Change Event Type, the system automatically enables this profile.
Note: Listing of Pre-State or Post-State Event Type depends on the Applicable Types and Organization selections.
c. If you want to allow other users to view, edit, or delete a policy, you need the necessary permissions. You can assign permissions to a policy only after the successful creation of a policy.
7. Click Save to save the new policy.
Note: You can save a policy even without adding any policy actions.
8. When you are ready to put the policy into effect, activate the policy.
Copyright © 2015- 2019 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.
Innovation Release