Using Policy Editor

To access the Policy Editor (ECL_POLICY_EDITOR), select the Governance tile.

The Policy Editor is used to add policies, as well as manage existing policies. Policies will be displayed by Policy Group. Policy groups are optional and can be used to group policies together for display. Any policies that are not associated with a specific policy group will be shown under Default Policies.

See Creating Policy Groups

When you add a policy, the owner is the user who defined the policy. The owner can be an administrator user or a self service user.

Policies defined by an administrator can be applied on any policy object artifact. For example, if an administrator adds a policy for stopping environments, then all the environments available in the Cloud Manager instance (irrespective of which user created the environment) can be associated with the policies.

Policies created by a self service user can be applied to the environments created by that user.

To add a policy:

  1. Select the Governance tile.

  2. Click the Add Policy button.

Image: Add Policy page

This example illustrates the fields and controls on the Add Policy page. You can find definitions for the fields and controls later on this page.

Add Policy Page

Field or Control

Definition

Name

Enter a name for the policy.

Description

Enter a description for the policy.

Policy Group

Policy groups are used to group policies together. The policy does not need to belong to a group.

Security Role

Select the security role that can edit the policy.

Policy Type

Select the policy type.

  • Schedule

    Policy can be scheduled for a start date and time or recurrence.

  • Event

    Based on an event, for example PRPs are downloaded.

Schedule

This button is available when the policy type is Schedule. Select to set the policy schedule.

See Setting Policy Schedule

Policy Object

A Policy object exposes properties and actions, which are used by the Policy editor to set policy conditions and action for the policy.

Built-in policy objects are:

  • Environment

    Used for creating policies for lifecyle activities on environments, for example start and stop.

  • Repository Artifact

    Used for creating policies based on artifacts in the repository.

When you select the Schedule button from the Add Policy page, you can select to create an adhoc schedule or a recurrence.

Adhoc

Select Adhoc if you want to schedule the policy for a specific data and time.

Image: Adhoc Policy Schedule

This example illustrates the fields and controls on the Adhoc Policy Schedule page. You can find definitions for the fields and controls later on this page.

Field or Control

Definition

Start Date

Select the start date.

Start Time

Enter the start time.

Time Zone

Select the time zone.

Recurrence

Select Recurrence if you want the policy to be executed on a recurrence schedule.

Image: Recurrence Policy Schedule

This example illustrates the fields and controls on the Recurrence Policy Schedule page. You can find definitions for the fields and controls later on this page.

Recurrence Policy Schedule

Field or Control

Definition

Recurrence

Select an existing process scheduler recurrence schedule.

Add a new process scheduler recurrence definition

Select this link if you want to add a new recurrence definition. This link will open the Process Scheduler Recurrence Definition page.

Start Date

Optionally, you can enter a start date for this recurrence.

Start Time

Optionally, you can enter a start time for this recurrence.

Time Zone

Optionally, you can enter a time zone for this recurrence.

Based on the policy object selected, the policy conditions and action will change.

Environment Example

Image: Example Adding Environment Policy

This example illustrates the fields and controls on the Add Policy page where the Object Type is Environment. You can find definitions for the fields and controls later on this page.

Example Adding Environment Policy

Field or Control

Definition

Property Name

Select the property name:

  • Event Type

    Only applies to event based policies.

  • Name

  • Status

Operator

Select either In or Is.

Property Value

Enter the property value.

Enter a single value or a comma separated list of values.

Info icon

Mouse over this icon for an explanation of the property and example values.

Relation

Select the relation.

add_row icon

Select to add another condition.

delete_row icon

Select to delete a condition.

Action

If the policy object is Environment, the available actions are:

  • Backup

  • Refresh

  • ScaleDown

  • ScaleUp

  • Start

  • Stop

Action Parameters

Depending on the policy action selected, the action parameters are displayed. Mandatory actions parameters are prefixed with an asterisk (*) and must be entered. Mouse over the Info icon for the action parameter for information on how to enter the parameter value.

Policy Action

Action Parameters

Backup

Backup Prefix

Refresh

Environment Name

Backup ID

Use Latest Backup

App Refresh

Source TDE KeyStore (Wallet) Password

Pre Refresh Custom script

Post Refresh Custom script

Target MT DMS Path

File Server App DPK Location

See Refreshing DB Systems Environment

ScaleDown

Node Count

Auto Scale

Application Server Domain

Process Scheduler Domain

PIA Domain

ScaleUp

Node Count

Auto Scale

Application Server Domain

Process Scheduler Domain

PIA Domain

Repository Artifact Example

Image: Example Adding Repository Artifact Policy

This example illustrates the fields and controls on the Add Policy page where the Object Type is Repository Artifact. You can find definitions for the fields and controls later on this page.

Example Adding Repository Artifact Policy

Field or Control

Definition

Property Name

Select the property name:

  • Event Type

  • Product

  • Release

Operator

Select either In or Is.

Property Value

Mouse over the Info icon to view available values. For Event Type property, the only supported value is Patch Download.

Use the Info icon to view available values.

Action

Initially the only valid option from the drop down list is Apply PRPs.

All defined policies are available and grouped by policy group.

Image: Policy Editor page

This example illustrates the fields and controls on the Policy Editor page. You can find definitions for the fields and controls later on this page.

Policy Editor page

Field or Control

Definition

Active

Select Yes or No to activate or inactivate a policy.

Once a policy is inactivated, it will be suspended and will not be executed.

Delete

Use the Delete icon to remove a policy.

View/Edit

Click the edit icon to view or edit a policy. The user must belong to the security role assigned to the policy in order to edit the policy. If the user does not belong to the security role, the user can view the policy, but can not edit it.

Editing the Policy

When you select to edit or view the policy, the policy is displayed.

Image: Example Edit Policy

This example illustrates the fields and controls on the Add Policy page when you select to edit or view a policy.

Example Edit Policy

Note: Environments can be added to or removed from a policy directly from the Environment Details page. See Policies Page