User Tools

Site Tools


sm_sharer_agent

Service Manager Sharer Agent

v3.21.0

The Service Manager Sharer Agent is an agent for Windows and Linux that supports sharing records out of HP Service Manager.

The agent has the same requirements as the Replicator Agent as noted here.

As of the Europium release, the HP Service Manager Sharer Agent supports up to Java version 10.

Installation

The agent is packaged as a zip file that you can unzip to where you would like to install it. Once unzipped, you will have the following directories:

Configurations

To configure the agent, run setup.sh (Linux) or setup.bat (Windows) located in <agent_installed_directory>/bin. The agent's configuration file is located in <agent_installed_directory>/conf/agent.properties. The service wrapper configuration is located in <agent_installed_directory>/conf/wrapper.conf. The setup script updates the necessary properties in both of these files.

The following configurations are available for the agent:

MBS Configuration

Configuration information for connecting to Perspectium MBS as provided by Perspectium:

Attribute Description
mbs_url URL of the Perspectium MBS server Required
mbs_user Username for the Perspectium MBS server Required
mbs_password Password for the Perspectium MBS server Required

Service Integration Configuration

Configuration information for Service Manager that the agent will be integrating with:

servicenow_instance name of your servicenow instance ex: dev1234 Required
service_url URL of the Service Manager API endpoint to connect to. (ex: http://servicemanager.yourcompany.net:13080/SM/7/ws) Required
service_user Username for the Service Manager API to connect to. Required
service_password Password for the Service Manager API to connect to. Required
share_object Property to match the ServiceName field in your Service Manager External Access record Required
key_name Argon Key field name defined in the KeysType in the WSDL for the object being shared Required
last_update_field Name of the field in Service Manager that contains the last modified timestamp for the object being shared. Ex: update.time Required
last_update_value Date and time of the earliest records you want to share when the agent starts for the first time and the last_updated.dat does not exist in the cache_location. This value and the value in the last_update.dat file will be incremented by the agent when it runs. If the last_updated.dat file is removed, the agent will revert to this value. Required
last_update_timezone Timezone of Service Manager. Defaults to timezone of agent host Optional
datetime_format Format of the field specified in the last_update_field. Ex: MM/dd/yyyy HH:mm:ss Required
include_attachments To send attachments on the object being shared set the include_attachments property to trueRequired
filter_where Should match the integration user and add any addition filtering required. Syntax is Service Manager Expert Search format (html encoded) Required
cache_location v3.26.0 Declares directory for caching. The last_update_time of used for querying ServiceManager is stored here in the last_updated.dat file. Locating this location on a network shared drive allow for failover to a standby agent in disaster recover scenarios. If the directory is not declared, it will be set to a default location in the data directory under the agent installation directory. Optional

The Service API URL (service_url configuration) will also need to be provided to Perspectium for provisioning on MBS.

Proxy Configuration

The Service Manager Sharer Agent supports optionally using an HTTP/HTTPS proxy for the agent to connect outside the network to MBS.

Description
proxy_url URL of the proxy server to connect to. Optional
proxy_user Username for the proxy server. Optional
proxy_password Password for the proxy server. Optional

Cache Location

In v3.26.0 users can set the directory in which the logging file, agent.dat, will be saved. Set this property in the agent.properties file, which will be in the conf folder. When setting the properties, please append the next folders with the “/” instead of “\” as shown:

cache_location=C:/Users/Windows10/Desktop

If no file path is set, it will default to the data folder.

Sample Configuration File

#Perspectium Service Manager Sharer Configuration File
#   To encrypt property values such as passwords, prefix the value with encrypt:

#MBS Configuration
mbs_url=http://localhost:8080
mbs_user=sm/sm
mbs_password=sm

#Proxy Configuration
proxy_url=
proxy_user=
proxy_password=

servicenow_instance=dev10673

#Service Manager Web Service Configuration
service_url=http://servicemanager.perspectium.net:13080/SM/7/ws
service_user=perspectium
service_password=perspectium
share_object=Incident
last_update_field=update.time
last_update_value=05/04/2017 14:47:25
last_update_timezone=GMT-6
datetime_format=MM/dd/yyyy HH:mm:ss
include_attachments=false
filter_where=updated.by ~= &quot;perspectium&quot;
cache_location=../data

Running the Agent

The Repeater Agent runs by executing scripts in the <agent_installed_directory>/bin directory. It can be run in the console or installed as a Windows service or Linux Daemon.

STARTING THE AGENT IN THE CONSOLE

  • cd to the /bin subdirectory of your install directory
  • run runConsole.sh (linux) or runConsole.bat (windows)

STOPPING THE AGENT

  • cd to the /bin subdirectory of your install directory
  • run stop.sh (linux) or stop.bat (windows)

INSTALLING WINDOWS SERVICE OR LINUX DAEMON

  • As Adminstrator, cd to the /bin subdirectory of your install directory
  • run installDaemon.sh (linux) or installService.bat (windows)

STARTING WINDOWS SERVICE OR LINUX DAEMON

  • As Adminstrator, cd to the /bin subdirectory of your install directory
  • run startDaemon.sh (linux) or startService.bat (windows)

STOPPING WINDOWS SERVICE OR LINUX DAEMON

  • As Adminstrator, cd to the /bin subdirectory of your install directory
  • run stopDaemon.sh (linux) or stopService.bat (windows)

UNINSTALLING WINDOWS SERVICE OR LINUX DAEMON

  • As Adminstrator, cd to the /bin subdirectory of your install directory
  • run uninstallDaemon.sh (linux) or uninstallService.bat (windows)

TROUBLESHOOTING

  • log files are located in the /logs subdirectory of your install directory
sm_sharer_agent.txt · Last modified: 2018/12/14 11:01 by timothy.pike