Configure the transport.properties file

The transport.properties file identifies the system information for the target web server and Company into which you want to import the data.

The EPIC client accepts the transport.properties in plain text format or encrypted by the APSecureClient tool. For information about using the APSecureClient tool see Encrypting/Decrypting .properties files.

To configure the target system information, you will require the following information:

  • The web server URL: This is provided to you by your xMatters representative, and will take the form of a hostname; for example, https://clientname.xmatters.com The web server uses the HTTPS protocol to securely transmit data to xMatters.
  • Company name: The xMatters Company into which you want to import the data. This is the same Company name you would enter when logging into the xMatters web user interface.
  • A web service user name and password: Web service users are created within your xMatters Company from the Add Web Service User page of the Users tab. Web service users are separate from regular users and cannot receive notifications or log on to the xMatters user interface.
  • Proxy server name and logon credentials: If your organization uses a proxy server, you must provide the proxy server settings, including logon credentials if your proxy server uses authentication. If your organization does not use a proxy server then you can ignore these settings.

For example, to import the data into "MyCompany", the configuration may resemble the following:

WS_URL=https://mycompany.xmatters.com
COMPANY_NAME=MyCompany
WS_USERNAME=epicws
WS_PASSWORD=password
 
To configure the transport.properties file:

Open the epic-client-5.5.297/conf/transport.properties file in a text editor

  1. Uncomment the following lines, and replace the place holders with the appropriate values as illustrated in the example above:
#WS_URL=<https://xMatters web server URL>
#COMPANY_NAME=<destination Company name>
#WS_USERNAME=<web service user name>
#WS_PASSWORD=<web service password>
 
  1. If you are using a proxy server, uncomment the lines beginning with PROXY_ and replace the placeholders with the actual values, as shown in the following example:
Replace:
#PROXY_SERVER_NAME=<proxy server name or IP address>
#PROXY_PORT=<proxy port number>
#PROXY_USERNAME=<proxy server username>
#PROXY_PASSWORD=<proxy server password>
 
With:
PROXY_SERVER_NAME=192.192.168.204
PROXY_PORT=8080
PROXY_USERNAME=mmcbride
PROXY_PASSWORD=52_a_29ps687
         

PROXY_USERNAME and PROXY_PASSWORD values are optional, and required only if the forward proxy server requires authentication. If they are specified but not required by the proxy server, they will be ignored and no message will be sent to indicate this.

  1. If you are using an NTLM proxy server, you must provide a logon domain in addition to the other proxy settings. Uncomment #PROXY_NTLM_DOMAIN=<proxy domain> and replace <proxy domain> with the logon domain as shown in the following example. If you are unsure of the domain name or other NTLM proxy server settings, contact your domain administrator.

If you log on to your domain using the domainname\username format, you must specify the user name and domain name separately in the PROXY_USERNAME and PROXY_NTLM_DOMAIN settings. For example, if you log on using myproxydomain\myusername and a password, set PROXY_NTLM_DOMAIN to myproxydomain and set PROXY_USERNAME to myusername.

Replace:
#PROXY_NTLM_DOMAIN=<proxy domain>
 
With:
PROXY_NTLM_DOMAIN=myproxydomain
 
  1. Save and close the transport.properties file.