Creating components#

A component consists of artifacts of a single source type and one or more processes. Component creation is the same for all source types, however; the content can be different.

Components can be created manually, by using a template, or imported. This topic includes the steps for creating a component manually. See Component templates and Importing components for the other methods.

Several fields in the Create Component window are the same for every source type, while others depend on the source that is selected from the Source Configuration Type list. The graphic below show the Create Component window with the common fields for all configuration types.

1. On the Components page, click Create Component.

2. Type a name and description for the component.

   The name identifies the component throughout the product user interface. The description conveys more information about the component. If the component is used by more than one application, for example, entering Used in applications A and B can help identify how the component is used. The Name field is required and must contain a value.

3. In the Teams fields, specify the one or more teams that can manage the component.

   Click the plus sign () and select from the list of previously defined teams. For information about teams, see Managing security.

4. To use a template for the new component, select a template from the Component Template list.

   When using a template, the component inherits source configuration, properties, and processes from the template. A component can have a single template associated with it. The default value is none.

   If you select a template, the Template Version field is displayed which is used to select a template version. By controlling the version, you can roll out template changes as needed. The default value is Latest Version, which means that the component uses the newest version which is based on creation date.

   Note: If you select a template that includes a source type, the dialog box changes to reflect values that are defined for the template. Several fields, including the Source Configuration Type field are populated and locked.

   For information about templates, see Component templates.

5. Select the component type in the Component Type field.

   Select z/OS if the component is based on IBM z/OS® artifacts, otherwise use the default value of Standard. If you select z/OS, the source configuration controls are not available. Artifacts that are stored in z/OS do not use source configurations. To learn more about configuring and deploying z/OS components, see Deploying components to the z/OS platform.

6. In the Source Configuration Type list, select type of source for which the component is being defined. This field defines the source type for the component's artifacts.

   Sources are defined with source configuration plug-ins. If you do not see a desired source type, verify that the source-type plug-in is installed.

   All artifacts must have the same source type. Selecting a source type shows the fields that are associated with the plug-in. Source-dependent fields are used to identify and configure the component's artifacts.

7. Complete common properties that configure how and when artifact versions are imported.

   • Import Versions Automatically

     If selected, the source location is periodically polled for new versions. Found versions are automatically imported. The default polling period is 300 seconds, which can be changed with the Automatic Version Import Check Period setting on the System Settings pane. If left cleared, you can manually create versions by using the Versions pane. By default, the box is cleared.

   • Components copy to CodeStation

     If selected, imported artifacts are copied to a CodeStation repository which is a tamper-proof embedded artifact repository. If cleared, only metadata about the artifacts is imported. For additional information, see Server settings.

   • Default Version Type

     Defines how component versions are imported into CodeStation. The Full value means that the version is comprehensive and contains all artifacts. The Incremental value means that the version contains only the artifacts that were modified from the previous version. The default value is Full.

8. Select xxx

   • Use the system's default version import agent/tag

     If selected, the agent or tag that you specified on the System Settings page is used to import component artifacts. The agent or tagged agents must have access to the system where the artifacts are located. See Server settings

   • Import new component versions using a single agent

     If selected, use the Agent for Version Imports field to designate the agent that imports artifacts into the component. The agent must have access to the system where the artifacts are located. To import artifacts from the server location, install an agent in the same location and specify that agent.

   • Import new component versions using any agent with the specified tag

     If selected, use the Agent Tag for Version Imports field to designate the tag that is used to identify the agents that can import artifacts into the component. Tagged agents must have access to the system where the artifacts are located.

9. Configure common cleanup properties.

   • Inherit Cleanup Settings

     Specify whether to use the values specified in the system settings for artifact cleanup or specified them for this component. If this check box is cleared, you must specify values for the following settings:

     • Days to Retain Versions

       The number of days to retain component versions after they are created. For example, if you specify 30, component versions are archived when they are older than 30 days and have no other setting that keeps them. To retain component versions indefinitely, enter - 1. To use the system default retention value, enter 0.

     • Number of Versions to Retain

       The number of versions to retain for each component. For example, if you specify 10, the server keeps the 10 most recently created component versions. To retain all component versions, enter -1. To use the system default retention value, enter 0.

   For more information about cleaning up component versions, see Cleaning up component versions.

10. Select the Run process after a Version is Created checkbox to automatically run a process after versions are imported.

    If selected, specify an application process and an environment for the process.

    The process runs only when the version is imported automatically, not when you import versions manually. Similarly, the process does not run when you create versions with the REST API or the udclient command. If the automatic version import finds multiple versions, the process runs only once.

11. Complete properties based on the source configuration type selected.

    Each source configuration has a unique set of required and optional properties that are displayed after the configuration type is selected. For details on these properties, refer to the plug-in used to integrate the source type.

12. Click Save.

    Saved components are listed in the Components pane.

13. Getting started with creating components
    Components are the centerpiece of the HCL Launch deployment engine. Components associate deployable items (artifacts) with processes that deploy them.

14. Creating components from the file system
    You can create components by importing artifacts from the file system on the HCL Launch server. You can import a single version or automatically import versions as they are added to the file system.
15. Creating components from source-code management systems
    You can create components from the artifacts in various source-code management systems.
16. Creating components from build integration tools
    You can create components from the artifacts in various build integration tools.
17. Creating component versions with the command-line client
    If HCL Launch does not have a source configuration type for your external tool, you can use the udclient command-line client to manage components.
18. Importing components
    Importing and exporting can be especially useful if you have multiple HCL Launch servers, for example, and must quickly move or update components.
19. Exporting components
    Importing and exporting can be especially useful if you have multiple HCL Launch servers, for example, and must quickly move or update components.

Parent topic: Components