An introduction to importing and exporting deployment plans in IBM UrbanCode Release.
1. The basics of Deployment Plan structure
2. How to export a deployment plan
3. The structure of an exported deployment plan
4. The required fields for a deployment plan
5. How to import a deployment plan
In addition to the video above, we’ve captured some additional reference material to assist in preparing deployment plan imports below.
In the video we covered four basic required fields:
The import supports a number of additional fields described below:
executorRole and assignedUser
The executorRole column defines roles that have permission to perform actions on a specific task such as starting, completing or skipping a task. Roles will be covered in more detail in another video. The roles column entry must match a role name that exists within IBM UrbanCode Release.
The assignedUser column is similar to executorRole, and tells the importer which user is assigned to the current task. The user should be identified by username (not display name) , must exist in IBM UrbanCode Release’s security settings, and must belong to the executorRole — if any—assigned to the task.
taskPattern and segmentPattern
The taskPattern describes the way in which a task fits into a particular Deployment Plan. Task pattern can be one of two possible values — either ALWAYS (in all caps), meaning the task will need to be executed every time the deployment plan is run. Or, ONCE_PER_ENVIRONMENT (in all caps, with underscores delimiting the words), to indicate that once the task has been run once in a given environment, it does not need to be run again. If omitted, taskPattern will default to ALWAYS.
The field segmentPattern describes the order in which a segments tasks must be run. The segmentPattern must be one of two possible values — either SEQUENTIAL (in all caps), meaning all tasks in the segment must be run in the order in which they appear in that segment from top to bottom, or PARALLEL (in all caps), meaning that any of the tasks can be started in any order.
type and applicationName
The type field describes the kind of task that is represented by the row. If supplied it must be one of two possible values — either ManualTask (upper camel-case), in which case the task actions are to be updated by a user in the IBM UrbanCode Release user interface. An AutomatedTask (upper camel-case), is a task which will be delegated to an automation system rather be than manually started and stopped by a user. If the task is set to execute as an automated task, you MUST provide a second column entry, applicationName. This second column must be the name of an application that already exists in IBM UrbanCode Release.
As of 6.0.1 segment prerequisites and start times are not available as import options in the CSV import and we find these easy to configure these directly in the plan after it is imported.
Import is a one time start-up process
Do remember that the import capability is intended to facilitate a one-time import of a plan created in a spreadsheet or project management tool into IBM UrbanCode Release. Once imported, Release will handle automatic enabling and disabling of tasks based on the applications and environments participating in a particular deployment. If you find that your are importing a plan with each release, then you are likely not using the power of IBM UrbanCode Release to its fullest potential.
Sample import file
We’ve made an example .csv import file available here as starting place. Unzip the file before importing it.
Thanks for watching!