Register/Re-register (upgrade) an EAI Plug-In

The REG command installs or upgrades an EAI server plug-in. This command is automatically used by the EAI server plug-in’s installation script. Therefore, you only need to use this command if you need to install a plug-in for a given operating system in a shared location. You would then use the REG command to register the plug-in on all your servers.

This command automatically detects if this is the first registration of the plug-in or an upgrade for a given EAI step type.

This command does not install the plug-in file. Follow the installation procedure described in the specific EAI plug-in documentation.

Note: Before using this command, you must ensure that the run-time loading requirements are met because the library is loaded when this command is used. For example, if the library uses other system shared libraries, they must be defined in the server’s shared library path.

Syntax

sweaireg REG eai_type_name [-m machine_name] -l library [-i init_params] [-y]

where:

• eai_type_name is the short name of the EAI step type handled by the server plug-in. This can be a text string of up to 20 characters.
• machine_name is the optional name of the server in the iProcess Engine node cluster on which the plug-in is to be registered. If this value is omitted, the default is the server on which the command is being run. This can be a text string up to 256 characters.
• library is the path and file name for the plug-in. This is a text string of up to 256 characters.
• init_params is an optional value that can be used for any plug-in-specific initialization parameters. See the documentation for each plug-in to see what values can be used. If this is omitted and you do a re-registration, the existing parameters will be preserved. This can be a text string up to 1024 characters.
• -y can be used to automatically answer yes to all the sweaireg command prompts so the command is run immediately without displaying the prompts.

For a first registration, the values are written to the EAI run-time plug-in registry (the eai_run_plugins table). For a re-registration, the following message is displayed:

Re-register eai_step_name runtime plug-in version current_release_version with version install_set_release_version? (y/n)

If you enter Y, the EAI plug-in registry is updated. If you enter N, no changes will be made.

Note:

After you have registered the plug-in, you must set the EAI_NEEDS_MSDTC process attribute if the plug-in needs to use the Microsoft Distributed Transaction Coordinator (MSDTC). If you don’t do so, EAI steps using the plug-in may not function correctly or in a fully transactional manner.

For more information about process attributes and how to set them, see Administering Process Attributes.

Example

To register the EAI server plug-in for eaidb on the server called Hercules, enter the following:

sweaireg REG eaidb -m hercules -l SWDIR\lib\eaidb -y

Before exiting, the following status is displayed:

EAI Run-Time Plug-in Registration Successful:
EAI Type:	 EAIDB
Machine:	 Hercules
Version:	 1.0
Library:	$SWDIR\lib\eaidb
Init Params: