Integrate with CA Process Automation Integration for a Notification Process Manually

This article contains the following topics:
casm171
This article contains the following topics:
CA APM and CA Process Automation integrate to let you set up and configure a notification process that delivers notifications to specific recipients after a defined event occurs. CA APM provides email notification processes with the product. These processes are delivered in files that are included on the product installation media. You import the files into CA Process Automation and specify process parameters in CA Process Automation and CA APM.
How to Set Up the CA Process Automation Notification Process
Use the following steps to set up the email notification processes that are provided with CA APM.
  1. Install CA APM and CA Process Automation.
  2. In CA Process Automation, configure the mail server.
  3. In CA Process Automation, modify the settings for the workflow process parameters.
    1. Change the default email address for the administrator (Admin_Email_To parameter) to specify your required setting.
    2. Change the default CA APM URL (ITAM_URL parameter) to specify your required setting.
    3. Change the default CA Process Automation URL (ITPAM_URL parameter) to specify your required setting.
    4. (Optional) Change any of the other parameters for which you want to specify your required settings.
  4. In CA EEM, create CA Process Automation user accounts for any non-CA APM users.
  5. In CA APM, specify the workflow process parameters when you define an event.
    For information about defining an event in CA APM, see Events and Notifications for CA APM. For information about using CA Process Automation and CA EEM, see the CA Process Automation and CA EEM documentation.
Import the Workflow Provider Notification Process Files
CA APM provides default email notification process files. You import these files into CA Process Automation before you can set up and can configure email notifications in the products.
For more information about importing and working with the files, see the CA Process Automation documentation.
Follow these steps:
  1. Log in to CA Process Automation as the administrator.
  2. Navigate to the CA Process Automation client.
  3. Locate the ITAM.xml file on the CA APM installation media using the following path:
    CD1\SetupFiles\ITPAM\
  4. Import the ITAM.xml file into the
    /
    node.
    In CA Process Automation Release 3.1, you import the XML file from the client. In Release 4.0 SP1, you import the XML file from the Library tab.
    Select the import options to set the imported versions as current and to make the imported custom operators and sensors available.
    The notification process files are imported into the default /ITAM folder.
Configure the CA Process Automation Mail Server
To implement email notifications between CA Process Automation and CA APM, configure the mail server for CA Process Automation.
  1. Log in to CA Process Automation as the administrator.
  2. Navigate to the CA Process Automation client.
  3. Navigate to the library browser.
  4. Locate and lock the default environment.
  5. Locate the alert module and clear the inherit check box.
  6. Specify the SMTP (mail) server.
    Example:
    mail.company.com
  7. Specify the From address.
    Example:
    [email protected]
  8. Save the changes.
  9. Unlock the default environment.
    The changes require a few minutes to take effect.
You can send an email notification to an external email address if your SMTP (mail) server settings permit email delivery to the external address. Check your mail server settings to verify if you can send email to external addresses.
Modify CA Process Automation Workflow Process Parameters
After you install CA APM and CA Process Automation and import the notification process files into CA Process Automation, the default workflow process parameters are defined in CA Process Automation. You can modify the default process parameters to include your required settings. You provide actual (hard-coded) values for the process parameters. You must verify that the values you enter are valid.
You can modify the notification process parameters in the data set that applies to all notification processes or in the individual process start request forms. The parameters you specify for an individual process override the parameters in the main data set for that process.
You specify some of the notification process parameters for the workflow provider when you define an event in CA APM. For more information about specifying process parameters in CA APM, see Workflow Provider Process Parameters.
To modify CA Process Automation workflow process parameters
CA APM and CA Process Automation do not validate the information that you enter for the parameters. You must verify that your input is valid and that you entered the data in the correct format.
  1. Log in to CA Process Automation and navigate to the CA Process Automation client.
  2. In the ITAM folder, locate the data set that is named Dataset.
  3. Enter the information for the parameters.
    The following fields require explanation:
    • Ack_Interaction_Form_Full_Path
      Full path to the file that contains the acknowledgment interaction form in CA Process Automation. The email notification recipient uses this form to acknowledge receipt of the notification. Each workflow process must have a unique user interaction form and a unique path to the form. You can find the acknowledgment interaction form files that are provided with the product in the folder that contains the processes and main data set (/ITAM or the folder where you imported the processes).
    • Admin_Email_CC
      Email address of the copy recipients for the email that is sent to the administrator when a notification error occurs.
    • Admin_Email_To
      Email address of the administrator for the email that is sent when a notification error occurs. Change the default value to your required setting.
    • Log_Folder_Path
      Full path of the error log file that is created when an error occurs with the notification process. If you do not specify a path, the log file uses the default CA Process Automation log file path.
    • ITAM_Username
      User name to log in to CA APM. CA Process Automation requires access to CA APM for information about notification recipients and escalation.
    • ITAM_Password
      User password to log in to CA APM. CA Process Automation requires access to CA APM for information about notification recipients and escalation.
    • Admin_Email_Subject
      Subject for the email that is sent to the administrator when a notification error occurs. This parameter can be set in the main data set or in the individual process start request form.
    • Admin_Email_Header
      Header or introduction for the email that is sent to the administrator when a notification error occurs (for example, "Hello"). This parameter can be set in the main data set or in the individual process start request form.
    • Admin_Email_Footer
      Signature for the email that is sent to the administrator when a notification error occurs (for example, "Thank You"). This parameter can be set in the main data set or in the individual process start request form.
    • Log_File_Name
      Name of the error log file that is created when an error occurs with the notification process. The email that is sent to the administrator when a notification error occurs contains the log file name. If you do not specify a name, the log file uses the following default CA Process Automation log file name:
      process name_process instance number.log
    • ITAM_URL
      CA APM URL that CA Process Automation uses to access CA APM for information about notification recipients and escalation. Change the default value to your required setting.
      Example:
      http://ITAMAPPSERVER:99/ITAMService/Service.asmx
    • ITPAM_URL
      CA Process Automation URL that is included in the email notification message. Change the default value to your required setting.
      Example:
      http://PAMSERVER:8080/itpam
  4. Save the changes in CA Process Automation.
For information about setting up a notification process, see your workflow provider documentation.
Permit CA APM Users to Use CA Process Automation
The CA APM users who receive notifications need to access CA Process Automation to acknowledge the notifications. These users need to have permission to use CA Process Automation. You permit users to use CA Process Automation by performing steps in CA APM first and then in CA EEM. In CA APM you define and authorize users to log in to and use CA APM. In CA EEM, you permit the authorized CA APM users to use CA Process Automation.
To permit CA APM users to use CA Process Automation
  1. Log in to CA APM.
  2. Verify that both new users and existing users are authorized to log in to and use CA APM.
    For information about defining and authorizing new users and authorizing existing users in CA APM, see Maintaining Security.
    The product defines and authorizes the CA APM users. CA EEM now includes the CA APM users in the list of available users.
  3. Log in to CA EEM, selecting CA Process Automation from the application drop-down list.
    You must select the CA Process Automation application when you log in to CA EEM to permit CA APM users to use CA Process Automation.
  4. Select a CA APM user from the list of all users and click the application user details for the user.
  5. Select a CA Process Automation user group for the user and save the selection.
    For information about using CA EEM to add applications to user details, see this topic in the CA EEM documentation.
    The CA APM user can now access and use CA Process Automation.
Required Indicators and Multiple Line Text Fields for Parameters
The default notification processes that are delivered with the product contain the parameters that appear on the product Event Definition user interface and the parameters that you specify in the workflow provider. The default processes also contain XML formatting that lets you display a required indicator and a multiple line text field on the product user interface. These items are not readily available from the workflow provider, and so they are specified in the process. In the CA Process Automation start request form for each default process, the following XML statement appears before the Description of each user interface parameter:
<FieldDescriptor><IsRequired>true_or_false</IsRequired><Length>number</Length></FieldDescriptor>
  • IsRequired
    Specifies if the parameter is required (true) or not required (false). If the parameter is required, the product displays the standard required indicator on the user interface.
    Example:
    <FieldDescriptor><IsRequired>true</IsRequired></FieldDescriptor>
  • Length
    Specifies the length of the parameter text entry field. To define a multiple line text field, specify a value greater than 255.
    Example:
    <FieldDescriptor><Length>275</Length></FieldDescriptor>
You can change the default notification processes that are delivered with the product, and you can also create your own new notification process. To include information about the required indicator and field length in your changed or new process, you must insert the XML statement before the Description of each user interface parameter in your process.
If you are creating a new notification process, you must have a corresponding start request form for the process. For information about changing or creating notification processes, see your workflow provider documentation.