API Management 10.4 | Using CentraSite | Policy Management | Built-In Design/Change-Time Actions Reference | Promote Asset
 
Promote Asset
This policy action allows you to promote an asset instance to a different CentraSite stage. The action can be executed on a lifecycle pre-state change, post-state change, or on an OnTrigger event. The configurations cover the following options:
*Specify a stage to promote to
This can be either the name of a lifecycle stage or the URL of the target registry.
*Specify optional user credentials for the target stage
The credentials specify a user name and password of a user defined on the target registry. This user should have the required permissions to create the asset on the target registry.
*Include referenced objects in the promotion set
Assets that are referenced by the asset being promoted can be included in the promotion process.
*Keep the asset owner unchanged
You can specify that the owner of the asset in the source registry is the owner in the target registry. If this user does not exist in the target registry, the owner is the user specified in the optional user credentials described above.
This user should be able to create assets in the target organization, which can be any of the following, depending on the input parameters you specify:
*The organization mentioned in the Target Organization parameter.
*The organization to which the user in the target registry belongs.
*The organization to which the triggering user or the user in the Username parameter belongs.
*Replace existing registry objects in the target stage
If an asset already exists on the target stage, it may be replaced by the asset being promoted.
*Specify a target organization name
When the asset is promoted, it will belong to the organization specified.
*Keep the lifecycle state
You can specify a lifecycle state for the promoted asset on the target registry. If you do not specify a state, the promoted asset is placed in the initial state of the lifecycle model on the target registry.
*Ignore the asset's type definition in the promotion set
If the asset's type definition already exists on the target stage, it may be ignored in the promotion process.
*Ignore API keys and OAuth2 tokens in the promotion set
API keys and OAuth2 tokens that are available for the asset being promoted can be ignored in the promotion process.
Event Scope
Pre- State Change
Post-State Change
OnTrigger
Object Scope
Assets
Input Parameters
The following table lists the input parameters for the policy action.
Target Stage
(String). The name of the target stage to which the asset is promoted.
If a value is specified for the parameter Target Stage URL, the value of Target Stage is used instead of the value of the parameter Target Stage URL. At least one of the parameters Target Stage or Target Stage URL must be specified, that is, they cannot both be empty.
Target Stage URL
(String). The URL of the target CentraSite registry.
If a value is specified for the parameter Target Stage URL, the value of Target Stage is used instead of the value of the parameter Target Stage URL. At least one of the parameters Target Stage or Target Stage URL must be specified, that is, they cannot both be empty.
Username
(String). (Optional).The user name and password are used as authentication credentials for the target stage. The assets is created in the target by this user.
If the user name and password are not supplied, the user name and password of the triggering user on the source stage is used. If this user is not defined on the target stage, the promotion fails.
Password
(String). (Optional). The user name and password are used as authentication credentials for the target stage. The assets is created in the target by this user.
If the user name and password are not supplied, the user name and password of the triggering user on the source stage is used. If this user is not defined on the target stage, the promotion fails.
Target Organization
(String). (Optional). Specifies the owning organization of the asset on the target stage. This can only happen if the specified organization exists on the target.
Include Referenced Assets
Specifies whether the referenced assets (referenced through associations) of the applied asset are included for the promotion.
A selection of the Include Referenced Assets check box indicates that the referenced assets are promoted. A cancellation of the Include Referenced Assets check box indicates that only the specified asset is promoted.
The Include Referenced Assets check box remains selected by default.
Keep Owner
Specifies if the current owner is the owner in the target registry. This can only happen if the owner also exists as a user on the target registry and has the permissions required to create assets.
A selection of the Keep Owner check box indicates that the asset owner on the target stage is the same owner as on the source stage. A cancellation of the Keep Owner check box indicates that the owner is the specified user from the User Name parameter.
The Keep Owner check box remains cancelled by default.
Replace Existing Assets
Specifies if an asset that already exists on the target stage may be replaced by the asset being promoted.
A selection of the Replace Existing Assets check box indicates that an asset on the target stage can be replaced. A cancellation of the Replace Existing Assets check box indicates that an existing asset on the target stage cannot be replaced.
The Replace Existing Assets check box remains cancelled by default.
Keep Lifecycle State
Specifies if the promoted asset should keep the lifecycle state that it has on the source stage. This can only happen if the lifecycle model used on the source stage is also defined and active on the target stage.
A selection of the Keep Lifecycle State check box indicates that an asset on the target stage have the same state as on the source stage. A cancellation of the Keep Lifecycle State check box indicates that the promoted asset is set to a lifecycle state according to the combinations as shown in the table below.
The Keep Lifecycle State check box remains cancelled by default.
Remove Unreferenced Associations
Specifies whether the referenced assets (referenced through associations) of the applied asset are excluded from the promotion.
A selection of the Remove Unreferenced Associations check box indicates that the referenced assets are not promoted. A cancellation of the Remove Unreferenced Associations check box indicates hat the referenced assets are also promoted.
The Remove Unreferenced Associations check box remains cancelled by default.
Ignore Asset Types
Specifies whether the type definition of the applied asset is included for the promotion.
A selection of the Ignore Asset Types check box indicates that the type definition will be ignored in the promotion process. A cancellation of the Ignore Asset Types check box indicates that the type definition will also be promoted.
The Ignore Asset Types check box remains cancelled by default.
Ignore API Keys and OAuth2 Tokens
Specifies whether the API keys and OAuth2 tokens of the applied asset are included for the promotion.
A selection of the Ignore API Keys and OAuth2 Tokens check box indicates that the API keys and OAuth2 tokens will be ignored in the promotion process. A cancellation of the Ignore API Keys and OAuth2 Tokens check box indicates that the API keys and OAuth2 tokens will also be promoted.
The Ignore API Keys and OAuth2 Tokens check box remains cancelled by default.
As noted in the table, some of the promotion operations are only possible if the target stage contains users, organizations, and lifecycle models that are compatible with those defined on the source stage. The possible combinations are listed in the following tables.
Note: During the promotion process, CentraSite copies the metadata of an asset from the source instance to the target instance. However, if the action is to be executed during a pre-state change event, the changes due to the other actions in the source instance are not reflected in the target instance. You needs to explicitly update the asset if you want that change reflected in the target instance, too.
Important: Before you activate a policy that includes the Promote Asset action, ensure that the target's specified target stage URL or target stage is active and the user credentials of target registry are valid. To check this, click the Check Connection button. If the connection is not active and valid, activate the target specified in Target Stage or Target Stage URL, and modify the user credentials as required.
Target Organization and Target Owner
When the asset is promoted to the target registry, it belongs to a specific organization and is owned by a specific user. The organization and owner on the target registry are not necessarily the same organization and owner as on the source registry.
The owner on the target registry can be one of the following:
*the same owner as on the source registry (called User A in the following description)
*the user specified in the Username parameter (called User B in the following description)
*the triggering user, that is, the user who activates the asset promotion (called User C in the following description)
The organization on the target registry can be one of the following:
*the organization specified in the Target Organization parameter (called Organization P in the following description)
*the organization of the user supplied in the Username parameter (called Organization Q in the following description)
*the organization of the triggering user (called Organization R in the following description)
Target Owner
This user is the owner …
... under these circumstances
User A
If Keep Owner is specified, and User A has permission to create assets in Organization P or Q or R.
User B
If User A does not meet the requirements described in the previous row, and User B is defined.
User C
If User B not meet the requirements described in the previous row.
Target Organization
This organization is the owning organization …
... under these circumstances
Organization P
If Target Organization is specified and the target owner defined in the above table has permission to create assets in this organization.
Organization Q
If Organization P does not meet the requirements described in the previous row, and User B is defined.
Organization R
If Organization Q does not meet the requirements described in the previous row.
CentraSite attempts to create the asset on the target registry using the resulting combination of target owner and target organization. If the given user does not have permission to create assets in the given organization, the promotion fails.
Keep Lifecycle State
Keep LCM State
Availability of the same LCM in the target stage
Does target have its own LCM
Result state of the promoted asset
yes
yes
na
Same state as in the source.
yes
no
yes
Initial state of the LCM in the target.
yes
no
no
No state assigned.
no
n/a
yes
Initial state of the LCM in the target.
no
n/a
no
No state assigned.
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