AR System workflow for TrueSight Orchestration integration

To integrate a AR System application with TrueSight Orchestration, use Developer Studio to create a AR System form or forms to hold the input and output data for each process, and a filter or escalation to exchange information with TrueSight Orchestration.

In the AR System filter or escalation, you select the TrueSight Orchestration processes and the operation to perform. The workflow can be designed to carry out synchronous or asynchronous TrueSight Orchestration operations. With synchronous execution, AR System waits for the operation to complete before returning a result to the workflow action. With asynchronous execution, the operation returns a job ID. In this case, you use the job ID in subsequent workflow actions to determine the status of the operation or to cancel it.

You must use a separate Set Fields action for each TrueSight Orchestration process.

Before you define the application form and filter (or escalation), import the TrueSight Orchestration certificate into AR Java trust store as described in the following procedure.

To import the TrueSight Orchestration certificate

  1. Locate the conf directory in your Content Distribution Peer folder, for example:

    [root]# cd /opt/bmc/BAO/CDP/tomcat/conf
    [root]# pwd /opt/bmc/BAO/CDP/tomcat/conf

  2. Run the keytool command to view the certificates.
    The default keystore password is changeit, for example:

    [root]# /opt/bmc/BAO/CDP/jvm/bin/keytool -list -keystore .keystore
    Enter keystore password:

  3. Export the certificate that is stored in the tomcat.crt file, for example:

    [root@tsi-bao2 conf]# /opt/bmc/BAO/CDP/jvm/bin/keytool -export -keystore .keystore -alias tomcat -file tomcat.crt
    Enter keystore password:

  4. From Developer Studio installation folder, open the devstudio.ini file to identify the JRE used by the Developer Studio.

    Refer to the example below:

    -vm
    C:/Program Files/Java/<Java_Home_Folder>/bin/javaw.exe
    -startup
    plugins/org.eclipse.equinox.launcher_1.3.100.v20150511-1540.jar
    --launcher.library
    plugins/org.eclipse.equinox.launcher.win32.win32.x86_64_1.1.300.v20150602-1417
    -vmargs
    -Xms512m
    -Xmx2048m
    -XX:MaxMetaspaceSize=128m

  5. Open the command prompt on the computer where Developer Studio is installed and import the tomcat.crt file to the java folder identified in the above step 4.

    C:\> cd C:\Program Files\Java\<Java_Home_Folder>\lib\security
    keytool -import -trustcacerts -alias tomcat -file d:\temp\tomcat.crt -keystore cacerts

    The certificate file is imported. 

  6. Repeat the steps to add the same public certificate to the AR System server.

  7. You must restart the AR System server for the new public certificate. Refer to the example below

    [root@tsi-itsm2 ~]# ps -ef | fgrep -i ars
    root      2432     1  0 Jun30 ?        00:03:46 /usr/java/default/bin/java -Xmx512m -Djava.lib.path=. -classpath .:/opt/bmc/ARSystem/bin/arapi-91_build001.jar:/opt/bmc/ARSystem/bin/arlogger-9.1.11-SNAPSHOT.jar:/opt/bmc/ARSystem/bin/armonitor-9.1.00-SNAPSHOT.jar com.bmc.arsys.armonitor.ARMonitorDaemon
    root      2453  2432  0 Jun30 ?        00:03:32 /usr/java/default/bin/java -jar /opt/bmc/ARSystem/bin/arserver.jar -s tsi-itsm2 -i /opt/bmc/ARSystem -l /etc/arsystem/tsi-itsm2

    From this we can see Java is under /usr/java/default. We again use keytool to import the certificate.[root@tsi-itsm2 ~]# /usr/java/default/bin/keytool -import -trustcacerts -alias tomcat -file /root/tomcat.crt -keystore cacerts
    Enter keystore password:
    Certificate was added to keystore

    If you do not want to modify the default JRE cacert file, configure the server to use the Custom Truststore parameter, for example:

    -Djavax.net.ssl.trustStore=/usr/share/tomcat/conf/certificates.p12 -Djavax.net.ssl.trustStorePassword=0nbmcc3rts -Djavax.net.ssl.trustStoreType=pkcs12" 

    For more information, see Configuring-to-consume-over-SSL-or-with-client-certificates.

To define the application form

  1. Create a regular form, and add the appropriate fields to hold the input and output data for the Set Fields action.
     The input and output fields on the form depend on the operation and process type. You can create one form that will hold the data for all process integrations, or separate forms for each process.
  2. Save the form and assign a form name.

 To define the filter or escalation

  1. Create a new filter or escalation.
  2. On the Associated Forms panel, associate the form to the filter or escalation by selecting the form you created in the previous procedure.
  3. Select the appropriate Execution Options and enter a Run If qualification that is appropriate for the application.
  4. On the If Actions panel, add a Set Fields action with the following settings:
    1. As the Data Source, select BMC ATRIUM ORCHESTRATOR.

    2. From the Configuration Name list, select a configuration.
       Developer Studio obtains the list of available configurations from the entries in the AR System Orchestrator Configuration form. When you select a configuration, Developer Studio retrieves the values for the Service URL and Grid Name, and populates those fields.

      Note

      If you override the values in the Service URL, Grid Name, Username, or Password field, Developer Studio stores the overriding values in the filter or escalation. In this case, whenever the Set Fields action is opened in the future, Developer Studio warns you that the values in the filter do not match the values in the configuration form. At that time, you can select which values to replace with those from the form, if necessary.

    3. In the Operation field, select an operation from the list.
       The available operation types are:

      • Synchronous Execution—AR System waits until the process is complete, and then returns the process result. If the process fails to execute, TrueSight Orchestration returns a SOAP fault and the AR System server reports an error in the filter or escalation.

        Processes that take longer than 40 seconds to complete cannot be executed in Synchronous Execution mode. If this occurs, AR System reports error 8939: The AR System Plug-In server is not responding. For longer processes, use Asynchronous Execution mode instead.

      • Asynchronous Execution—AR System returns without waiting for the process to complete. An asynchronous execution operation always returns the Job ID.
      • Cancel Execution—Cancels the operation identified by the Job ID.
         The time in which you can cancel an operation is limited, based on when the operation started. You can configure this in TrueSight Orchestration.
         Valid input values for this operation are WITH_COMPENSATION and WITHOUT_COMPENSATION. If you use WITHOUT_COMPENSATION, TrueSight Orchestration returns the job status ABORTED. If you use WITH_COMPENSATION, or if you use an invalid or empty input value, TrueSight Orchestration returns the job status COMPENSATED.
      • Get Job Status—Returns the current status of the job identified by the Job ID. See Obtaining job status for asynchronous execution operations.
  5. To add a TrueSight Orchestration process to the Process table, click Add.
  6. In the Add Process dialog box, select a module from the Module list.
     A list of TrueSight Orchestration processes appears in the Process list of the Add Process dialog box.
  7. Scroll through the list of processes and select the appropriate one, and click OK.
     Developer Studio enters the process in the Process table, and populates the Input Mapping and Output Mapping tables with the appropriate TrueSight Orchestration data elements.
  8. In the Input Mapping table, map each TrueSight Orchestration data element to a field or a static value:
  9. To map a field from the associated form, click in the Field/Value column, and then click the ellipsis button. In the Field Selector dialog box, select the field to map to the TrueSight Orchestration data item, and click OK.
    • To enter a static value, type the value in the Field/Value column.

    • To override the user name and password stored in the configuration form, map these elements to fields in the associated form, as shown in the following figure, or enter a different static value.
       When you enter a static password value, the plain text password appears in the Field/Value cell until the cell loses focus. From then on, the password value is displayed as a string of asterisks whether the cell has focus.

      The Username and Password from the configuration form are stored in these elements as the default attribute, and will be used if the mapped fields are NULL at runtime. If you want to prevent this, delete them from the Field/Value column before you map the fields. Also, Developer Studio automatically sets the attributes arUsername: true and arPassword: true in these elements. This causes the filter or escalation to use the current user name and password at runtime, if no other value is available. You cannot change these attributes.
      Mapping Username and Password to fields
      BAO-InputMappingAuth.gif

  10. In the Output Mapping table, map each TrueSight Orchestration data element to a field on the associated form.

    Output parameters returned to AR System consist of the value only. XML tags that TrueSight Orchestration generates are stripped from the returned value.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*