Overview
The HCL Component plugin manipulates component on the HCL Launch server. For example, the steps in this plugin can create components, manipulates components and add component to teams.
This plugin includes one or more steps, click Steps for step details and properties.
Compatibility
This plugin HCL requires Launch 6.0.1 and later.
This plugin runs on all operating systems that are supported by the HCL Launch agent, including z/OS with UNIX System Services.
Installation
See Installing plugins in HCL Launch for installing and removing plugins.
Steps
The following process steps are available in the Component in HCL Launch plugin.
Add Component To Team
Adds a component to a team for a given type classification.
Input properties for the Component 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 Component step
Name |
Type |
Description |
Required |
Component |
String |
|
Yes |
Create Component
Creates a new component.
Input properties for the 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:
|
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 Component 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 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 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 Component 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 Component step
Name |
Type |
Description |
Required |
Component |
String |
|
Yes |
Create Multiple Components
Creates multiple components.
Input properties for the Component step
Name |
Type |
Description |
Required |
JSON File/Text |
String |
A body of JSON text or a file to define components. |
Yes |
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.
See Create a components from a JSON filet
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":"https:\/\/myserver.com"}
}]