Configuring SirsiDynix agent processes to halt and run using the auto_haltrun script
You can create a configuration file that enables the SirsiDynix Symphony auto_haltrun script to halt and run other SirsiDynix product agent processes in addition to the SirsiDynix Symphony processes. You can enable this functionality by configuring an agents.cfg file on your SirsiDynix Symphony server.
The following SirsiDynix agent processes can be added to the auto_haltrun process:
• | BLUEcloud Harvester |
• | Discovery ILS Agent |
You can also add configurations for halting, initializing, and running processes for custom clients on UNIX or Linux systems.
To configure the agents.cfg file
1 | Navigate to the /Unicorn/Config directory on the SirsiDynix Symphony server. |
2 | Make a copy of the agents.cfg.deliv file and name it agents.cfg. |
3 | Do one of the following: |
• | If you are configuring this file on a UNIX or Linux system, remove the contents of the comments for the following lines: |
#agent#_name
#agent#_type
#agent#_dir
#agent#_runfrom
#agent#_start
#agent#_status
#agent#_stop
• | If you are configuring this file on a Windows system, remove the contents of the comments for the following lines and remove all other lines in the file: |
#agent#_name
#agent#_type
#agent#_servicename
4 | Replace [#agent#] with a unique name of your choice to denote a specific agent process you are configuring (for example, agent1_name). Use a different identifier for each agent process; the auto_haltrun script uses these identifiers to tell the configurations of each process apart from one another. |
5 | Complete each field with the appropriate values, which are specified using an equal sign (for example, agent1_name=Discovery Agent). The following table describes the function of each field and how its values should be formed: |
Field |
Description |
Example |
---|---|---|
name |
The name of the agent. |
Discovery Agent |
type |
The type of the agent. This value should be script for UNIX or Linux systems and service for Windows systems. |
script |
dir |
The path to the directory containing the agent. For UNIX and Linux systems only. |
/s/sirsi/Unicorn/Discovery4 |
runfrom |
The path to the directory from which the scripts should be run. For UNIX and Linux systems only. |
./bin |
start |
The name of the start script for the agent with the proper argument specified. For UNIX and Linux systems only. |
agent.sh start |
stop |
The name of the stop script for the agent with the proper argument specified. For UNIX and Linux systems only. |
agent.sh stop |
servicename |
The Windows service name of the agent. For Windows systems only. |
EnterpriseAgent |
status |
The name of the status script for the agent with the proper argument specified. For UNIX and Linux systems only. If you are configuring the BLUEcloud Harvester or Discovery ILS agents, there is no need to fill this field, and it may be removed from the file. If you are using this field to configure the auto_haltrun process for a custom client, this field can support a status script. If the agent uses a Java service to return a status instead, there is no need to fill this field, and it may be removed from the file. |
agent.sh status |
6 | Do one of the following: |
• | If you want the auto_haltrun script to always halt and run the associated agent process, skip this step. |
• | If you want to only allow the auto_haltrun script to halt and run the associated agent process when an override flag (-force_agent) is provided on the command line, remove the contents of the comments for the #agent#_allowhalt line as well. Follow these steps to configure the allowhalt attribute: |
a | Replace [#agent#] with the unique name you are using for the agent process's configuration. |
b | Specify either Y or N for the attribute value. Specify Y to have auto_haltrun always halt and run the agent process; specify N to have auto_haltrun require the -force_agents flag to be specified as part of the auto_haltrun command for the auto_haltrun script to halt and run the agent process. If this value is not specified, auto_haltrun uses the behavior for the Y value. |
7 | Repeat Steps 3-6 for each agent process you want to configure for use with the auto_haltrun script. |
8 | Once you have finished the configuration, save and close the agents.cfg file. For examples of how this file should look after configuration, see agents.cfg file examples. |
9 | Run the auto_haltrun script using any arguments of your choice (for example, auto_haltrun status). The agent processes you configured should also respond to the argument you provided to the auto_haltrun script. |
For example:
Symphony Workstation server 3.6.2.0.GA is RUNNING.
Symphony Workstation socket server 3.6.2.0.GA is RUNNING.
Symphony Webcat server 3.6.2.0.GA is RUNNING.
Symphony loadpay server 3.6.2.0.GA is RUNNING.
Symphony Z39.50 server is RUNNING.
Symphony SIP 2 server is RUNNING.
Discovery Agent is RUNNING
Related topics
FAQs: Creating an Automatic Server Halt and Run Script for UNIX Systems
FAQs: Creating an Automatic Server Halt and Run Script for Windows Servers