Using Deployment Automation → Deployment Automation Built-in Properties
A component process step has access to properties set before or during the process execution, including those that are:
Step property values become unavailable once the component process ends.
Properties values are often passed using variables. Typically, you set the actual value where the value is most likely to change. For example, the value for a web server port number would probably be set in the environment or resource properties. Property values are restricted to 4,000 characters.
Variable property values are specified in the following format: ${p:propertyname}, where the ${ indicates the start of a variable value, p stands for property, propertyname is the property name, and } indicates the end of the variable value.
Property names can be user-defined or system-defined, or built-in. Deployment Automation has a number of built-in properties that can be used by your processes. These are described in the following table.
| Property Name | Reference Property Value Using | Description |
|---|---|---|
| agent.id | ${p:agent.id} | Agent ID is the unique number Deployment Automation gives an agent at installation to distinguish it from others. |
| agent.name | ${p:agent.name} | Agent name is a user-defined name given at installation that distinguishes the agent from others. The agent name can be changed by editing the agent's conf/agent/installed.properties file and restarting the agent. |
| agent/<property name> | ${p:agent/<property name>} | Agent properties are user-defined and are set on the agent's Properties tab. |
| application.id | ${p:application.id} | An application ID is a unique number Deployment Automation gives the application at creation to distinguish it from others. |
| application.name | ${p:application.name} | An application name is a user-defined name that distinguishes the application from others. It is entered when editing or creating a new application. |
| application/<property name> | ${p:application/<property name>} | Application properties are user-defined and are set on the application’s Properties tab. |
| component.id | ${p:component.id} | Component ID is the unique number Deployment Automation gives a component at creation to distinguish it from others. |
| component.name | ${p:component.name} | A component name is a user-defined name that distinguishes the component from others. It is entered when creating or editing a component. |
| component/property_name | ${p:component/<property name>} | Component properties are user-defined and are set on the component’s Properties tab. |
| environment.id | ${p:environment.id} | Environment ID is the unique number Deployment Automation gives an environment at creation to distinguish it from others. |
| environment.name | ${p:environment.name} | An environment name is a user-defined name that distinguishes the environment from others. It is entered when creating or editing an environment. |
| environment/property_name | ${p:environment/<property name>} |
Environment properties are user-defined and can be set on the environment, application environment, and component Properties tabs. Values for same-named environment properties are overridden at the most specific level, with component being the most specific. |
| <property_name> | ${p:<property name>} | Users can define properties on the process's Properties tab and enter them in a component or application process. If the property does not have an assigned value, the user running the process can is prompted for the value. |
| resource.id | ${p:resource.id} | Resource ID is the unique number Deployment Automation gives an resource at creation to distinguish it from others. |
| resource.name | ${p:resource.name} | A resource name is a user-defined name that distinguishes the resource from others. It is entered when creating or editing a resource. |
| resource/<property name> | ${p:resource/<property name>} | Resource properties are user-defined and are set on the resource's Roles & Properties tab. |
| resource/role name/<property name> | ${p:resource/<role name>/<property name>} | Resource role properties are user-defined and are defined on the resource's Roles & Properties tab. The values are set when adding a role to a resource. |
| <stepname>/<property name> | ${p:<stepname>/<property name>} | You can reference a property name in a process step that is set in a previous step name in the same process. The property value is set as output from the named step. |
| system/<property name> | ${p:system/<property name>} | System properties are user-defined and are set in Administration > System > Properties. These can be thought of as global properties, and should be used to set values that are system-wide defaults. |
| version.id | ${p:version.id} | Version ID is the number assigned to a version when it is imported into CodeStation. |
| version.name | ${p:version.name} | A version name is a user-defined name that distinguishes the version from others. It is given when the version is imported. |
| prevStep | ${p:prevStep/<property name>} | This enables you
to access previous step values without having to explicitly fill in the
previous step name.
Warning: If a step has multiple possible previous
steps in a conditional process design, the results will be unpredictable.
|
| logPath | ${p:<step name>/logPath} | This is an output
property that resolves to the full path of a given step's log file during
process execution. For example, this can be used with the
prevStep property as follows:
${p:prevStep/logPath} Important: This functionality was introduced in
Deployment Automation
version 5.1.5. Processes that were executed before this functionality was
implemented will not have the
logPath property.
|
All of the following are comma-separated series of name=value, including each property on the given object. This is useful for token replacement.
| Property Name | Property Value | Description |
|---|---|---|
| component/allProperties | ${p:component/allProperties} | Selects all the properties with the same value in a given component. |
| environment/allProperties | ${p:environment/allProperties} | Selects all the properties with the same value in a given environment. |
| resource/allProperties | ${p:resource/allProperties} | Selects all properties with the same value in a given resource. |
| system/allProperties | ${p:system/allProperties} | Selects all properties with the same value in a given system. |
Copyright © 2011–2015 Serena Software, Inc. All rights reserved.