BMC Helix for CSP Create Activity¶

Introduction¶

A BMC Helix for CSP Create activity, using its BMC Helix for CSP connection, inserts entity data in BMC Helix for CSP and is intended to be used as a target to consume data in an operation.

Create a BMC Helix for CSP Create Activity¶

An instance of a BMC Helix for CSP Create activity is created from a BMC Helix for CSP connection using its Create activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Creating an Activity Instance in Component Reuse.

An existing BMC Helix for CSP Create activity can be edited from these locations:

• The design canvas (see Component Actions Menu in Design Canvas).
• The project pane's Components tab (see Component Actions Menu in Project Pane Components Tab).

Configure a BMC Helix for CSP Create Activity¶

Follow these steps to configure a BMC Helix for CSP Create activity:

• Step 1: Enter a Name and Select an Entity
  Provide a name for the activity and select an entity.

• Step 2: Review the Data Schemas
  Any request or response schemas generated from the endpoint are displayed.

Step 1: Enter a Name and Select an Entity¶

In this step, provide a name for the activity and select an entity. Each user interface element of this step is described below.

• Name: Enter a name to identify the activity. The name must be unique for each BMC Helix for CSP Create activity and must not contain forward slashes / or colons :.

• Select an Object for the Resource: This section displays entity types available in the BMC Helix for CSP endpoint.

  • Selected Object: After an entity is selected, it is listed here.

  • Search: Enter any part of the entity name into the search box to filter the list of entities. The search is not case-sensitive. If entities are already displayed within the table, the table results are filtered in real time with each keystroke. To reload entities from the endpoint when searching, enter search criteria and then refresh, as described below.

  • Refresh: Click the refresh icon or the word Refresh to reload entities from the BMC Helix for CSP endpoint. This may be useful if entities have been added to BMC Helix for CSP. This action refreshes all metadata used to build the table of entities displayed in the configuration.

  • Select an Object for the Resource: Within the table, click anywhere on a row to select an entity. Only one entity can be selected. The information available for each entity is fetched from the BMC Helix for CSP endpoint:

    • Name: The entity class name from BMC Helix for CSP.

    • Description: The description of the entity class type from BMC Helix for CSP.

  Tip

  If the table does not populate with available entities, the BMC Helix for CSP connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

• Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

• Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

• Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Review the Data Schemas¶

Any request or response schemas generated from the endpoint are displayed. Each user interface element of this step is described below.

• Data Schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

The BMC Helix for CSP connector uses the BMC Helix for CSP REST API. Refer to the API documentation for information on the schema nodes and fields

• Refresh: Click the refresh icon or the word Refresh to regenerate schemas from the BMC Helix for CSP endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

• Back: Click to temporarily store the configuration for this step and return to the previous step.

• Finished: Click to save the configuration for all steps and close the activity configuration.

• Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next Steps¶

After configuring a BMC Helix for CSP Create activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity Actions Menu in Connector Basics.

BMC Helix for CSP Create activities can be used as a target with these operation patterns:

• Transformation Pattern
• Two-transformation Pattern (as the first or second target)

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.