Skip to main content
Kinetic Community

Connections Configuration

A connection defines the adapter that will be used to retrieve resource and event data from the back end data source, and the specific property values to use the adapter.  An adapter is code that is written specifically to connect to one type of data system, such as BMC Action Request System, or Microsoft Exchange.

Implementation

Since each adapter is written for a specific type of system, multiple connections can be configured to use the same adapter yet retrieve data from different servers.  For example, the ArsAdapter can be used to connect to both the ITSM Remedy server, and the HR Remedy server.  Each server (ITSM Remedy server, and HR Remedy server) will contain its own connection definition in the connections directory.

For each connection, a configuration file for that connection must exist in the connections directory located in the system <DataDirectory>.  The name of the connection file is usually a combination of the adapter and end point system, such as ars-production.json, or exchange-server.json.

A list of available adapters for Kinetic Schedule can be found here.

 

Connection Configuration

All connection configurations have a core set of property values that must be configured for the connection to successfully work.

 

Core Configuration Properties

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

 

Additional Configuration Properties

In addition to the core configuration properties, specific adapter properties may be needed depending on the adapter the connection uses.  Each adapter should document what additional configuration properties it accepts, and give examples of the values for each property.

Please find the documentation for the specific adapter your connection uses.

 

Connection Configuration Example

Below is an example of a connection configuration file that uses the BMC Remedy ARS Adapter.

{
    "connection": {
        "name": "ars-server",
        "type": "ars",
        "description": "Remedy Server",
        "location": "remedyprod.mycompany.com",
        "username": "Demo",
        "password": "",
        "useEncryption": "false",
        "additionalParameters": [
            {
                "name": "maxConnections",
                "value": "80"
            },
            {
                "name": "arsPort",
                "value": "0"
            },
            {
                "name": "arsRpc",
                "value": "0"
            },
            {
                "name": "arsAuth",
                "value": ""
            }
        ]
    }
}