Configuring the HP Service Manager actor adapter

You configure an adapter in TrueSight Orchestration Grid Manager. The configuration provides information about how the adapter interacts with the HP Service Manager application. Although each adapter must have a unique name, you can create multiple adapters with the same adapter type to allow for different configuration properties.

The form view provides an easy-to-use interface for configuring adapters. The form view prevents errors that might occur when you copy the configuration XML from the adapter documentation into the UI during configuration. You can switch to the XML view to configure those elements and attributes that are not available as fields or to configure all the elements and attributes by using XML only. However, after you switch to the XML view and save the configuration in XML from that view, you cannot thereafter use the form view for modifying that configuration.

To configure the actor adapter

  1. Log on to TrueSight Orchestration Grid Manager.
  2. To access the adapters page, click the Manage tab, and then click the Adapters tab.
  3. In the Adapters in Repository list, select the bmc-adapter-hp-servicemanager-actor version check box.
  4. To include the adapter in the Adapters on Grid list:
    • Select the bmc-adapter-hp-servicemanager-actor version check box to configure the actor adapter.
    • Select the bmc-adapter-hp-servicemanager-monitor version check box to configure the monitor adapter.
    • Select both check boxes to configure both adapters.
  5. Click Configure corresponding to the newly added adapter.
  6. On the Add an Adapter Configuration page, perform the following steps to configure the adapter by using the form view, or skip to step 7 to configure the adapter by using the XML view:
    1. Enter a name for the adapter.
    2. Enter a description for the adapter.
    3. Under Properties, enter or select values for the configuration elements.

      Include all the required elements, which are indicated with an asterisk (*).
    4. Click OK.

      The newly configured adapter is now listed in the Adapters on Grid list.
  7. ( Optional ) Configure the adapter in the XML view by performing the following steps.

    Note

    Switching to the XML view means that you cannot thereafter use the form view for modifying that configuration.

    1. Enter a name and a description for the adapter.
    2. Click Switch to XML View.
    3. On the warning message that appears, click Switch View.
    4. In the Properties text box, use XML format to enter the configuration elements and attributes, and then click OK.

      Note

      If the default value for an optional element is acceptable, omit the element. Do not include empty elements.

    5. On the warning message that appears, click Save.

The adapter configuration with settings is saved in the XML view permanently. The newly configured adapter is now listed in the Adapters on Grid list.

The following table describes the configuration elements for the actor adapter. You cannot use the form view to configure elements and attributes that do not have an entry in the UI label column.

Node elements for configuring the actor adapter

UI label

Element

Definition

Required

None

<config>

Contains elements that are required for configuring the actor adapter

Yes

Soap Url

<soap-url>

Specifies the URL of the application web server (for example, https://172.11.11.111:11111/SM/7)

Yes

User Name

<user-name>

Specifies the user name for the HP Service Manager controller authentication

Yes

Password

<password>

Specifies the password that corresponds to the user name

The password element can contain an encryption-type attribute (the Encryption Type field on the form in the form view) that indicates whether the password specified is encrypted.

Valid values for encryption-type: base64, plain (default)

Conditional; not required when the password is blank

Use Ssl Certificate

<use-ssl-certificate>

Specifies whether SSL certificates are used for authentication

Valid values: true, false (default)

Conditional; if the value of the <soap-url> element is set to https, then the value of <use-ssl-certificate> must be set to true

Allow Unsigned Certificate

<allow-unsigned-certificates>

Specifies whether to allow unsigned certificates from trusted zones

If you use self-signed SSL certificates (a common practice), set the value of this element to true. On ecommerce sites or military installations, if you need to use signed certificates such as Verisign or Thawte (a rare practice), set the value of this element to false.

Valid values: true, false (default)

Conditional; used only when the <use-ssl-certificate> element is set to true

Install Certificate

<install-certificate>

Specifies whether to install security certificates automatically

If you prefer to have security certificates installed automatically (a common practice), set the value of the <install-certificate> element to true. If you prefer to manually export the security certificate from the HP Service Manager server and manually import it into the TrueSight Orchestration local peer's cacerts file (a rare practice), set the value of the <install-certificate> element to false.

Valid values: true, false (default)

No

Passphrase

<passphrase>

Specifies the password to the keystore file (cacerts ) local to the TrueSight Orchestration peer

Default value: changeit

Note: The value of the <passphrase> element must match the password in the keystore.

The password can be changed by using keytool. If a change is made, this value must be updated to reflect the new password.

Conditional; used only when the <use-ssl-certificate> element is set to true

Web Services

<web-services>

Contains information about any additional web services that are exposed in the HP Service Manager application

No

None

<web-service>

Specifies the name of the new web service that is exposed in the HP Service Manager application

The <web-service> element can contain an entity attribute, whose value can be used as an alias for the new web service. The entity value is a string that is unique for the exposed web services.

Note: You must explicitly define the name of the web service for the Association Management module in the <web-service> element to be able to use it.
For example: <web-service>AssociationManagement</web-service>

No

 


The following figure shows an XML sample for configuring the adapter with a base64 encryption.

XML sample for a base64 configuration

<config>
  <soap-url>https://172.11.11.111:11111/SM/7</soap-url>
  <user-name>username</user-name>
  <password encryption-type="Base64">cGFzc3dvcmQ=</password>
  <web-services>
    <web-service entity="association">AssociationManagement</web-service>
  </web-services>
  <use-ssl-certificate>true</use-ssl-certificate>
  <allow-unsigned-certificate>true</allow-unsigned-certificate>
  <install-certificate>true</install-certificate>
  <passphrase>changeit</passphrase>
</config>

Enabling custom logging

To enable custom logging for the adapter, you must specify a log file name. You can also provide additional parameters for logging.

Note

You must be using TrueSight Orchestration version 7.8 or later to use the custom logging feature. These parameters will be ignored in earlier versions of TrueSight Orchestration Platform.

These parameters are available with supported adapter versions. See TrueSight Orchestration Content documentation for details.

  • Log File Name: Provide a name for the log file.
    This file will be stored in the AO_HOME/tomcat/logs directory. If Log File Max Backup Index value is greater than 0, the log file name is suffixed with the backup index. For example, if the parameter value is a.log, backup log files will have names, such as a.log.1, a.log.2.
  • Log File Size: Specify a size limit for the log file. 
    If the value specified for Log File Max Backup Index is greater than 0, when the specified size is reached, the current file is renamed with the suffix .1. Otherwise, the log file will be reset and over-written. The default value is 10MB. The available units are KiloBytes (KB), MegaBytes (MB) or GigaBytes (GB).
  • Log File Max Backup Index: Enter the maximum number of backup files allowed. The default value is 10.
  • Log File Append: Select this option to append new log information to the existing information in the file. If unselected, the file will be overwritten with new log information.
  • Log Level: Enter the logging level using one of the following choices:

    Logging level

    Description

    DEBUG

    The most detailed logging level; logs low-level messages, normal execution, recoverable erroneous conditions, and unrecoverable erroneous conditions

    INFO

    (default)

    Logs normal execution, recoverable erroneous conditions, and unrecoverable erroneous conditions

    WARN

    Logs recoverable erroneous conditions and unrecoverable erroneous conditions

    ERROR

    The least detailed logging level; logs only error conditions that are not usually recoverable

Encrypting an element's contents

You can add the attribute secure="true" to an XML adapter element XML view to ensure that the element's contents is encrypted when displayed.

Note

You must be using TrueSight Orchestration Platform version 7.8 or later to use this encryption attribute.

Was this page helpful? Yes No Submitting... Thank you

Comments