Skip to main content
Kinetic Community

Adapters

Modular components to retrieve data from different data sources, such as BMC Remedy or Microsoft Exchange.

Implementation

All adapters have a core set of properties that they must support in the configuration file.  Please see the adapter configuration page for details about these properties.  In addition to these core properties, adapters may have additional properties they must support.

Any additional properties should be documented on the adapter's documentation page.

 

Adapter Configuration

The following properties are required for all adapters.

 

Property Description
name

Any alpha-numeric value is acceptable, but should indicate the type of adapter.

Example: "ars", "exchange", "sharepoint", etc...

className

The value of the main adapter class file.  This will be a unique value specific to the adapter.

Example: "com.kineticdata.schedule.adapter.ars.ArsAdapter"

 

Example Adapters Configuration File

Below is an example adapter configuration file that tells Kinetic Schedule one adapter is installed in the system.  The name assigned to the adapter is "ars", and the class that should be loaded for this adapter is "com.kineticdata.schedule.adapter.ars.ArsAdapter".

 

{
    "adaptersConfig": {
        "adapters": [
            {
                "name": "ars",
                "className": "com.kineticdata.schedule.adapter.ars.ArsAdapter"
            }
        ]
    }
}

 

Connection Configuration

The following properties are required for all connections, regardless of what type of adapter is used.  If the value for that property is not used by the adapter, the property must still exist in the configuration file.  The value for the property should be set to the blank string ("") if it is not used.

 

Property Description
name

The name of the connection that will be used in data source configuration files that use this connection.  Should be a name that correlates the adapter and server.

Example: "ars-server"

type

The value that was entered as the "name" property for the adapter in the adapters configuration file.

Example: "ars", "exchange", "sharepoint", etc...

description

A description of the connection.  This is not seen by the end users, it is simply a way to describe what server or system this connection interacts with.

Example: "Remedy server"

location

The name or IP address of the server or system to connect with.

Example: "remedyprod.mycompany.com"

username

The name of the proxy user used to login to the end point system.

Example: "username"

password

The password that corresponds to the proxy user.  This value can be entered as plain-text or encrypted with the Password Encryption form.

Example: "password"

useEncryption

Indicates if the password is stored in plain-text or encrypted form.

"true" if encrypted, "false" if plain-text

 

 

IDF guide rendered from cache
 
Topics
  • The BMC Remedy ARS Adapter is used to retrieve data from a BMC Remedy server.