Create input variables

Create the variables to pass into the activity in the Inputs form of the activity designer.

Before you begin

You must name your activity in the General form before you can advance to the Inputs stage.

Roles required: workflow_admin or activity_creator

Note: Variable strings in the Inputs form have a 255 character limit.

Procedure

  1. Click the + icon to create a new input variable.

    The designer creates a default variable called Input1.

    Creating an input variable
  2. Type your new variable name in the field.
  3. To change the name of a variable or any of its attributes, double-click the value and then select or enter a new value in the field that appears.
  4. Configure your variable using these fields:
    Table 1. Variable configuration
    Field Description
    Type Data type for this variable. Double-click on the field to display the choice list. In addition to the usual data types, you can create input arrays and encrypt individual variables that contain sensitive data. Encrypted variables are passed to the ECC Queue and then decrypted by the MID Server when they run on the target host. Sensitive data returned from running these variables on the host can then be passed to another activity through encrypted output variables.
    Mandatory Marks an input variable as mandatory. Variables marked as mandatory are required fields in the properties form for the activity in the workflow. The input testing feature allows you to filter on mandatory variables.
    Default Default value for this input variable. Default values are prepopulated for variables in the properties form for the activity in the workflow. You can override this value when you test the variables.
  5. To reorder the variable list, select a row and then drag the row to its new location.

    When you select a row to move it, the pointer icon changes to an up/down arrow icon ().

  6. To delete a variable, click the delete icon () in the row.
  7. Click Continue to advance to the Execution Command stage or click Go to Pre-Processing (Advanced) to create a script that runs before the activity executes.

Map an input variable

After you create the input variables, map them to the fields in the Execution Command form.

Before you begin

Role required: activity_admin, activity_creator

About this task

These fields contain values required by the target host or endpoint to authenticate and query for data. Included in this example are fields for a command to run on the target and the MID Server to use, if one is required.

Procedure

To map a variable, drag it into the appropriate field.

The designer automatically expresses the variable in the syntax the system requires.

Mapping input variables

Configure the PowerShell execution command

Use the input variables you created to configure the command that Orchestration executes on the Windows target machine.

Before you begin

Create the input variables you need in the Inputs form before you can advance to the Execution Command stage.

Role required: activity_creator, admin

Note: You can test the PowerShell connection between the MID Server and the target computer without having to run the acvitity in a workflow context. For details, see test template outputs.

Procedure

  1. Drag variables from the list of inputs and drop them into command fields.
    The system formats the variable in the proper syntax for the command.
    Figure 1. PowerShell execution command
    PowerShell execution command
  2. Complete the fields shown in the table.
    Table 2. Powershell command fields
    Field Description
    Input Input variable builder. Create variables to map to available fields.
    Target host Host name or IP address of the target server for this PowerShell activity.
    Script type Type of script to run on the PowerShell host. Available options are:
    • Custom Powershell command
    • MID Server script file
    MID Server script file MID Server script file to run. This field is available when the Script type selected is MID Server script file.
    Command Command that this activity runs on the target host. This field is available when the Script type selected is Custom Powershell command. You can drag and drop input variables from the variable builder into this field to create your command.
    Powershell variables Name-value pairs to pass to the host with Powershell. You can create these variables manually, or drag input variables into the Value field. Encrypted input variables retain their encryption, regardless of the data type settings in this field. If you type in a value and select the Encrypted data type, your value appears in plain text in this field and is only encrypted when it passes to the ECC Queue.
    Use MID service account Forces this activity to authenticate on the target host using the credentials of the MID Server service account only, without trying any other credentials. When this check box is selected, the Credential tag field is not available.
    Credential tag Specific credential tag this activity must use to run Powershell commands on the host. If this field is left blank, the MID Server tries all the available credentials until it finds a valid one, ending with the MID Server service account. If a credential tag is defined, the MID Server tries the credentials for that tag only and does not try the MID Server service account. This field is not available when the Use MID service account check box is selected.
    Required MID Server capabilities MID Server to use for querying Powershell, by capabilities. By default, the system selects a Powershell MID Server.
  3. Click Save.
  4. Click Continue to advance to the Outputs stage.

Test activity template inputs

You can test the input parameters of a custom activity during its development without having to run the activity in a workflow context.

Before you begin

Create input variables and map them to fields in the Execution Command form or provide actual values for these fields.

Role required: web_service_admin, activity_admin, activity_creator

About this task

An input test executes only the input parameters against an endpoint and not the pre-processing or post-processing scripts. You need to use a workflow to test a pre-processing or post-processing scritp. You do not need to check out the activity to test it, and you can test input variables from any stage in the activity designer, if your activity is properly configured. Typically, the Execution Command stage is the point at which your inputs are ready for testing.
Note: If you intend to use auto-mapping, you must test your input variables.

Procedure

  1. Click Test Inputs.
    The list of input source variables appears. If you added default values for these variables, those values appear in the Substitute Value column. Mandatory variables are marked with a red star. In this example, a SOAP endpoint returns a value for a stock quote variable.
    Test value for input variable
  2. Filter the variable list with these controls:
    • All Inputs: Displays all input variables. This is the default view.
    • Mandatory Inputs: Displays only mandatory input variables.
    • Inputs Without Defaults: Shows input variables that do not have assigned default values.
  3. Reset values as needed.
    • Reset default values: Replaces any test values set in this form with the default values, if they are present.
    • Clear values: Clears all values in the input variable list, even if default values exist.
  4. When your test values are configured correctly, click OK.
    The system runs the values for all the inputs configured against the specified target and returns the resulting payload. The buttons in the Response form display different views of the payload. The entire payload appears in the Raw Output window.
    Figure 2. Response payload from inputs test
  5. To map appropriate parameter values in the payload to variables in the Outputs stage automatically, select an auto-mapping option.
  6. Alternately, you can click Save for parsing rules to copy the entire payload to the parsing rules.
    This allows you to manually select values for the output variables directly from the payload. This action completely overwrites any previous payload that existed in the parsing rules.
  7. Click the X in the upper right corner of the window to close it.