Running the Integration Daemon – Product Documentation

Summary of Steps to Start the Integration Daemon

The following steps are documented for both Microsoft Windows and Linux operating system installations. On Windows, the servers are normally started as Windows Services, although they can be started from the command-line for troubleshooting purposes. On Linux and other operating systems the servers are started on the command-line and run as background processes.

Start the ExtraView server
Start the Integration Daemon

Start ExtraView Server

Start the application server (e.g, Tomcat or WebLogic) that has the ExtraView application deployed. Once the application server is started, connect to the ExtraView application with a web browser or other client from the machine where the integration daemon is installed in order to ensure connectivity from the integration daemon to the ExtraView application.

Start Integration Daemon

On Microsoft Windows, if the integration daemon was installed as a Windows Service, then simply start the service named ExtraViewIntegrationDaemon.

To start the integration daemon on the command-line, you must first open a Command Prompt window and change the current directory to the installation directory, INTEGRATION_HOME.

cd INTEGRATION_HOME

Next, execute the start_daemon.bat script. The following lines are written to the Command Prompt window as the integration daemon starts:

C:\ExtraView\integrationdaemon>start_daemon.bat
JIRA Integration Daemon Started
 Setting event log:C:\ExtraView\integrationdaemon/logs/JIRA
Attempting to Open Log File: C:\ExtraView\integrationdaemon\logs\error.log
Log is:C:\ExtraView\integrationdaemon\\logserror.log
Running without a queue...

On Linux, execute the following commands to start the integration daemon:

cd INTEGRATION_HOME
./start_daemon.sh

Stop Integration Daemon

On Microsoft Windows, if the integration daemon was installed as a Windows Service, then simply stop the service named ExtraViewIntegrationDaemon. To stop the integration daemon on the command-line, type [Ctrl]+C on the Command Prompt window where you started the integration daemon. For example:

...
Running without a queue...
...
[TYPE Ctrl+C HERE]
Terminate batch job (Y/N)? y
C:\ExtraView\integrationdaemon>

On Linux, stop the start_daemon.sh script when it is running in the foreground. If the integration daemon is running in the background (e.g., using nohup or &), then find the process id of the java process running the com.extraview.sccintegration.common.IntegrationDaemon program and stop or kill the process.

State File – state.properties

Certain dynamic runtime state variables are maintained in a persistent properties file, named state.properties. This file is stored in the INTEGRATION_HOME/data/JIRA directory and it must be available for writing by the integration daemon (e.g., privileges are set appropriately and the file must not be “in use by another application”).

This file contains the state of progress of the integration daemon while processing updates from both JIRA and ExtraView systems. The EV_TIMESTAMP setting specifies the date and time of the latest records in ExtraView processed and the JIRA_TIMESTAMP setting identifies the timestamp of most recent record obtained from JIRA. The timestamp settings are updated dynamically every time the integration daemon processes records that have been updated since the last polling period (see the “Polling Times” section on the Integration Configuration page).

Since state information is maintained internally during the operation of the daemon, it will do no good to modify the values in this file while the daemon is running. The values can be modified when the daemon is not running, and the new values will be used when the daemon starts. The following keys and values are examples of state properties; note that all timestamps are maintained in a universal timestamp format, including time zone.

#Cutoff values for EVInterface and PeerInterface
#Tue Apr 03 10:09:01 PDT 2012
JIRA_TIMESTAMP=2012-04-03 10:56:06.252 -0700
EV_TIMESTAMP=2012-03-28 10:26:37.754 -0700

It is possible to edit this file manually to rework some transactions or correct an error. However, if you do this, you must be careful to preserve the syntax and format of the file.

Error Log

The default location for the file error.log is in the INTEGRATION_HOME/logs directory. The log file contains entries recounting integration daemon activity, including exceptions and other entries depending upon the log level setting.

Log information includes the JIRA records that matched and mapped to ExtraView issues, ExtraView issue ids that matched and mapped to JIRA records, the names/ids of newly created records/issues, actions that failed, and notification of the updating of cutoff thresholds.

If the daemon shuts down due to a failure, the log will include as much information about the failure as it is able to ascertain.

Note: Configuration errors such as fields mapped incorrectly, may cause the daemon to shut down, and a log entry to be created. This is because continued operation may result in a loss of synchronization of the ExtraView and JIRA systems.