Configuring the BPPM adapter

You configure an adapter in Grid Manager. The configuration provides information about how the adapter interacts with BMC ProactiveNet Performance Management. While 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 human errors that might occur as a result of copying the configuration XML from the XML sample into the UI when configuring an adapter. 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 using XML only. However, after you switch to the XML view and save the configuration in the XML from that view, you cannot thereafter use the form view for modifying that configuration.

Note

The default name for the actor adapter is BPPMActorAdapter.

To configure the actor adapter, monitor adapter, or both

Log on to the BMC Atrium Orchestrator Grid Manager.
Access the adapters page by clicking the Manage tab; then click the Adapters tab.
In the Adapters in Repository list:
- Select the bmc-adapter-bmc-proactivenet-performance-management-actor check box to configure the actor adapter.
- Select the bmc-adapter-bmc-proactivenet-performance-management-monitor check box to configure the monitor adapter.
- Select both check boxes to configure both adapters.
Click Add to Grid to include the adapter in the Adapters on Grid list.
Click Configure corresponding to the newly added adapter.
On the Add an Adapter Configuration page, perform the following substeps to configure the adapter using the form view or skip to step 7 to configure the adapter using the XML view:
1. Enter a name for the adapter.
  Note
  
  The Name field does not support single-quote (') and ampersand (&) characters.
2. Enter a description for the adapter.
3. Under Properties, enter or select values for the configuration elements.
  
  Include all required elements, indicated with an asterisk (*).
(optional) Configure the adapter in the XML view using the following substeps:
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. Copy the configuration elements and attributes from the XML sample into the Properties text box, 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.
  
  This action saves the adapter configuration with settings in the XML view permanently. The newly configured adapter is now listed in the Adapters on Grid list.

The following table describes the node elements required for configuring the actor adapter:

Node elements for configuring the actor adapter

UI label	Element	Description	Required
Mcell Dir File Path	`<mcell-dir-file-path>`	Specifies the location of the mcell.dir file local to the BMC Atrium Orchestrator peer on which the adapter is enabled The mcell.dir file contains information about the cell. For details about the mcell.dir file, see BPPM actor adapter.	Yes
Cell Name	`<cell-name>`	Specifies the cell name in BMC ProactiveNet Performance Management where the events are reported	Conditional; required if not specified in the request
User Name	`<user-name>`	Specifies the user name used for authentication	Conditional; required if not specified in the request
Request Field Mapping File Location	`<request-field-mapping-file-location>`	Specifies the location of the request field mapping file local to the BMC Atrium Orchestrator peer The request field mapping file contains information about the cell, such as custom slot name mapping, where you can specify slot names to be used in requests. If you use the same slot names in the requests as those used by the application or if you do not change the slot names that are identified by the application, you do not need to specify the request field mapping file. However, if you use additional slots that are not incorporated earlier or slot names that are different from the slot names identified by the application, you need to specify the request field mapping file. Example: If the application identifies newSlot as an existing slot, you can use newSlot in the request without specifying the request field mapping file. However, if you change newSlot to newSlotForXYZ, you need the request field mapping file to map the external name, newSlotForXYZ, to a corresponding internal name used by BMC ProactiveNet Performance Management, newSlot, as follows: `<elements> <element> <external>newSlotForXYZ</external> <internal>newSlot</internal> </element> </elements>` If the external slot names for ID, Origin Time, Component ID, Component Type, Status, Notes, Owner, or Priority are changed, you need to make corresponding changes in the adapter module configuration to ensure that the wrapper validations work properly.	Conditional; required if not specified in the request
Config File Location	`<config-file-location>`	Specifies the location of the mclient.conf file local to the BMC Atrium Orchestrator peer You can use the mclient.conf file in the BMC Service Impact Manager server installation location as a reference to create or copy the mclient.conf file required by BMC Atrium Orchestrator. The mclient.conf file is then placed on the BMC Atrium Orchestrator peer on which the adapter is enabled. The mclient.conf file contains the information about the cell such as customized values for connection configuration parameters (for example, MessageBuffer parameters, Trace parameters, and so on). For details about the .conf files, see the BMC ProactiveNet Administrator Guide available at https://docs.bmc.com/docs/display/bppmsuite86/PDF+product+guides.	Conditional; required if not specified in the request
Component Name	`<component-name>`	Specifies the component name used for maintenance mode operation	Conditional; required if not specified in the request
Max Active Connections	`<max-active-connections>`	Specifies the number of simultaneous active connections that can be made to a particular cell If you specify a negative value, the number of simultaneous active connections that can be made is unlimited. Default value: 8	No
Min Active Connections	`<min-active-connections>`	Specifies the minimum number of connections that are always present in the connections pool You can use this element to optimize the number of active connections in the pool, which is required to make buffering effective. Default value: 0	No

The following figure shows an XML sample for configuring the actor adapter.

XML sample for configuring the actor adapter

<config>
  <mcell-dir-file-path>/xyz/abc/lmn/mcell.dir</mcell-dir-file-path>
  <cell-name >somecell</cell-name>
  <user-name>someuser</user-name>
  <request-field-mapping-file-location>/xyz/abc/lmn/mymapping.xml
</request-field-mapping-file-location>
  <config-file-location>/xyz/abc/lmn/mcell.conf</config-file-location>
  <component-name>test</component-name>
</config>

The following table describes the node elements required for configuring the monitor adapter:

Node elements for configuring the monitor adapter

UI label	Element	Description	Required
Port	`<port>`	Specifies the port on which the gateway listens	Yes
Gateway Name	`<gateway-name>`	Specifies the name of the gateway	No
Encryption Key	`<encryption-key>`	Specifies the encryption key used to encrypt events	Yes

Note

The configuration information that you specify for the monitor adapter must match that specified in the incomm.conf and mcell.dir files located on the BMC ProactiveNet Performance Management server.

The following figure shows an XML sample for configuring the monitor adapter.

XML sample for configuring the monitor adapter

<config>
<port>1859</port>
<gateway-name>BPPMGW</gateway-name>
<encryption-key>mc</encryption-key>
</config>

Configuring the BPPM adapter

To configure the actor adapter, monitor adapter, or both

Comments