Plug-in Documentation

IBM UrbanCode Deploy Components

Overview

Overview

This plug-in manipulates components on the IBM UrbanCode Deploy server. For example, the steps in this plug-in can create components, add components to teams, and add properties to components.

Compatibility

This plug-in requires version 6.0 or later of IBM UrbanCode Deploy.

This plug-in is supported to run on all operating systems that are supported by the IBM UrbanCode Deploy agent, including z/OS with UNIX System Services.

Installation

No special steps are required for installation. See Installing plug-ins in UrbanCode Deploy.

History

Version 71

Update for API changes in server.

Version 70

${p:sourceConfigType} option has been added to the Create Components Source Config Type property.
Specify this property within the process configuration to resolve a source config type that is not listed.
Resolved MissingPropertyException in the Remove Tag from Component step.

Version 69

  • RFE 100937 Added Create Multiple Components step to create multiple components using json.
  • RFE 100937 Altered Add Component To Team step to allow adding multiple components to a team.

Version 68

Support property file encryption.

Version 67

Fixes APAR PI57417. Plug-in now checks the agent settings for acceptance of self signed certificates.

Version 66

  • Added a step to add a tag to a component.
  • Added a step to remove a tag from a component.

Version 65

This release of the plug-in includes steps to delete components and to get component applications.

Version 64

This release of the plug-in includes a fix for a compatibility defect with IBM Urbancode Deploy version 6.1.0.4 and later.

Usage

Create Multiple Components

The Create Multiple Components step provides the ability to create multiple components using one JSON file or JSON text body. The format of this JSON body follows the IBM UrbanCode Deploy component/create REST endpoint. The documentation for this endpoint can be found in the knowledge center: IBM UrbanCode Deploy component/create REST endpoint

To create multiple components, specify multiple JSON component objects inside of a JSON array as follows:

[{"name": "Component One",
"sourceConfigPlugin": "File System",
"defaultVersionType": "INCREMENTAL",
"importAutomatically": "TRUE",
"useVfs": "TRUE",
"properties": {"FileSystemComponentProperties\/basePath" : "/opt/test", "FileSystemComponentProperties\/extensions" : ".txt"}
},
{"name": "Component Two",
"sourceConfigPlugin": "Maven",
"defaultVersionType": "FULL",
"importAutomatically": "TRUE",
"useVfs": "TRUE",
"properties": {"MavenComponentProperties\/artifactId":"MyArtifact", "MavenComponentProperties\/groupId":"MyGroup", "MavenComponentProperties\/extension":"ext", "MavenComponentProperties\/repoUrl":"http:\/\/myserver.com"}
}]

Steps

Process steps in the IBM UrbanCode Deploy Components plug-in

Add Component To Team

Adds a component to a team for a given type classification.

Input properties for the Add Component To Team step
Name Type Description Required
Component String Yes
Team String Yes
Type String The type classification to add. Leave blank to use the type Standard Component. No

Check If Component Exists

This step will succeed if the component exists and fail if it doesnt.

Input properties for the Check If Component Exists step
Name Type Description Required
Component String Yes

Create Component

Creates a new component.

Input properties for the Create Component step
Name Type Description Required
Component Description String A description of the new component. No
Component Name String The name of the new component. Yes
Copy To Codestation Boolean If checked, artifacts will be copied from the given source to the servers Codestation
repository.
No
Default Version Type Enumeration:

  • Full
  • Incremental
The types of versions to create automatically upon import. Yes
Import Versions Automatically Boolean Check to import versions automatically. No
Source Config Properties String Insert properties to pass in for the source config plugin. One per line, name=value
format.
No
Source Config Type Enumeration:

  • None
  • AnthillPro
  • ClearCaseUCM
  • File System
  • File System (Versioned)
  • Git
  • Maven
  • Rational Asset Manager
  • Subversion
  • TeamCity
  • TFS
  • TFS_SCM
  • uBuild
The source config plugin for this component. Yes
Template Name String If this component uses a template, enter its name here. No
Template Version String If this component uses a template version, enter the version number here. No

Create Component Property

Creates or sets an existing component property.

Input properties for the Create Component Property step
Name Type Description Required
Component Name String The name of the new component. Yes
Property Name String name of the property to set. Yes
Property Value String value of the property to set. No
Secure? Boolean check if the property should be secure. No

Delete Component

Deletes a component

Input properties for the Delete Component step
Name Type Description Required
Component String Name or ID of the component to delete Yes

Get Applications Using Component

Get a list of applications using a component name or ID.

Input properties for the Get Applications Using Component step
Name Type Description Required
Component String Name or ID of the component Yes

Get Component Details

Retrieve basic configuration information about a component.

Input properties for the Get Component Details step
Name Type Description Required
Component String Component name or ID Yes

Get Component Properties

Retrieve the basic properties for a component.

Input properties for the Get Component Properties step
Name Type Description Required
Component String Yes

Create Multiple Components

Creates multiple components.

Input properties for the Create Component step
Name Type Description Required
JSON File/Text String A body of JSON text or a file to define components. Yes