Location, Naming, and Structure of Service Manager Adapter Configuration Files
Each Service Manager adapter configuration file must follow specific conventions for its location, naming, and structure, as described in the following sections.
Location and Naming of the Service Manager Adapter Configuration File
The adapter configuration files are located in the
<PPM_Home>/conf/sdi directory of the PPM Server. This directory contains the following:
Configuration file for the adapter (or one for each adapter if there are multiple adapters).
In this configuration file, you define a name for the adapter. The configuration file must have a
Subdirectory (or one for each adapter configuration file if there are multiple files).
The subdirectory contains the conversion scripts, which are called by the converter to map the fields between and to filter the changes and requests. The name of the subdirectory must be the same as the
<adapter name>(for a description, see Structure of the Service Manager Adapter Configuration File and Configuring the Service Manager Adapter Attributes) followed by
For example, if the adapter name is
<PPM_Home>/conf/sdidirectory must contain a subdirectory named
serviceManager-adapter.extto hold all the conversion script files for the adapter.
Structure of the Service Manager Adapter Configuration File
ALM provides, as a template, a default Service Manager adapter configuration file named
serviceManager-adapter.settings1. The adapter file you configure and use must have a
.settings file extension.
Copy the default adapter file (to preserve the original), and rename the copy with a
.settings file extension and, if desired, a different file name.
As detailed in subsequent sections, the adapter file has the following basic structure, including adapter attributes, and properties for its connector, converter, and sender:
<?xml version="1.0" encoding="UTF-8"?> <settings>
<adapter adapter-name="<adapter name>"> <service-desk-application><SD application> </service-desk-application> <number-of-tickets><number of tickets> </number-of-tickets> <polling-schedules><schedule></polling-schedules> <polling-frequency><frequency></polling-frequency> <initial-load-state><date></initial-load-state>
<request-types> <request-type level="1"> <polling-operation>
<connector> <connector-type>serviceManagerChange</connector-type> <properties> idProperty= lastUpdatedPropertyForQuery= creationDatePropertyForQuery= lastUpdatedPropertyForResult= creationDatePropertyForResult= keyMethodName= timeZone= wsDateFormatPattern= queryDateFormatPattern= userName= password= serviceUrl= </properties> </connector>
<converter> <converter-type>scriptConverter</converter-type> <properties> scripts=<convert1>.js,<convert2>.js,... </properties> </converter>
</polling-operation> </request-type> /request-types> <sender> <sender-type>PPMSender</sender-type> <properties> userName= password= requestType= updateRequest= ticketIdFieldName= sdSystemFieldName= staticFieldNames= </properties> </sender>
Caution: Do not delete or change the values provided for
<connector-type>, <converter-type>, or
The following sections describe how to configure the adapter attributes, the connector properties, the converter property (
scripts), and the sender properties.