[Contents] [Prev] [Next] [Index] [Report an Error] [No Frames]

Configuring the SDX Workflow Application

To launch the local configuration tool GUI to configure workflow properties:

On the workflow engine host, log in as root or as an authorized nonroot admin user.
Launch the local configuration tool for the workflow engine.

/opt/UMC/wkf/etc/config

The Workflow Configuration window appears.

NOTE: Whenever you change the configuration of the workflow engine, you must stop and then restart the engine for the changes to take effect. The start and restart operation does not disrupt any ongoing workflow instances; their current states are saved to the persistent store and are then restored.

Execution Control Tab

Use the Execution Control tab to configure the execution of workflows. Table 41 describes the parameters.




 Table 41:  Execution Control Tab Parameters 

 Parameter
 Description

 Instance Filename

 Fully qualified path of the file that stores information about the instances of the active workflows. 


 Activation Threshold [ms]

 Minimum time before the workflow goes to a running state after having gone into a sleep state, in milliseconds. This threshold sets the interval at which the workflow engine polls itself to determine whether work is in progress.


 Sleep Threshold [ms]

 Maximum time of no state change before the workflow goes into a sleep state, in milliseconds. If the threshold is exceeded, the workflow is paused, it transitions to sleep mode, and the workflow state is put into persistent storage.


 Load Server Port

 Port on which the workflow engine listens for incoming load information requests.


 Load So Timeout [ms]

 Maximum time allowed for sending new messages on the same connection, in milliseconds.


 Thread Limit

 Maximum number of threads that the engine allocates to workflow execution.

Parameter	Description
Instance Filename	Fully qualified path of the file that stores information about the instances of the active workflows.
Activation Threshold [ms]	Minimum time before the workflow goes to a running state after having gone into a sleep state, in milliseconds. This threshold sets the interval at which the workflow engine polls itself to determine whether work is in progress.
Sleep Threshold [ms]	Maximum time of no state change before the workflow goes into a sleep state, in milliseconds. If the threshold is exceeded, the workflow is paused, it transitions to sleep mode, and the workflow state is put into persistent storage.
Load Server Port	Port on which the workflow engine listens for incoming load information requests.
Load So Timeout [ms]	Maximum time allowed for sending new messages on the same connection, in milliseconds.
Thread Limit	Maximum number of threads that the engine allocates to workflow execution.

EC—Event Adapters Tab

Use the EC—Event Adapters tab to configure the event adapters. Table 42 describes the parameters.




 Table 42:  Event Adapters Tab Parameters 

 Parameter
 Description

 Timer Adapter Class

 Fully qualified class name of the adapter. Typically, you do not change this parameter after you have specified the path.


 Timer Adapter Statefile

 Fully qualified path of a file that stores the state of the timer adapter.


 Timer Adapter Precision

 Precision of the internal timer of the adapter, in milliseconds; 500 ms is sufficient for normal use.


 E-mail Adapter Class

 Fully qualified class name of the adapter. Typically, you do not change this parameter.


 E-mail Adapter Statefile

 Fully qualified path of a file that stores the state of the e-mail adapter.


 E-mail Adapter Host

 Hostname or IP address of the incoming POP3 or IMAP mail server.


 E-mail Adapter Userid

 User ID of the account that the e-mail adapter checks for incoming e-mail.


 E-mail Adapter Pswd

 Password of the e-mail account that the e-mail adapter checks for incoming e-mail.


 E-mail Adapter Protocol

 Protocol of the incoming e-mail server: IMAP or POP3.


 E-mail Adapter Freqarg

 Frequency with which the e-mail adapter checks for e-mail, in milliseconds.


 E-mail Adapter Mailbox

 Name of the mailbox that the e-mail adapter checks for e-mail messages; you must use INBOX.


 Process Adapter Class

 Fully qualified class name of the adapter. Typically, you do not change this parameter after you have specified the path.


 Process Adapter Statefile

 Fully qualified path of a file that stores the state of the process adapter.


 Process Adapter Spawners

 Number of spawner threads; that is, threads that create external processes. This number is also the limit of concurrent external processes that the workflow engine can spawn.

Parameter	Description
Timer Adapter Class	Fully qualified class name of the adapter. Typically, you do not change this parameter after you have specified the path.
Timer Adapter Statefile	Fully qualified path of a file that stores the state of the timer adapter.
Timer Adapter Precision	Precision of the internal timer of the adapter, in milliseconds; 500 ms is sufficient for normal use.
E-mail Adapter Class	Fully qualified class name of the adapter. Typically, you do not change this parameter.
E-mail Adapter Statefile	Fully qualified path of a file that stores the state of the e-mail adapter.
E-mail Adapter Host	Hostname or IP address of the incoming POP3 or IMAP mail server.
E-mail Adapter Userid	User ID of the account that the e-mail adapter checks for incoming e-mail.
E-mail Adapter Pswd	Password of the e-mail account that the e-mail adapter checks for incoming e-mail.
E-mail Adapter Protocol	Protocol of the incoming e-mail server: IMAP or POP3.
E-mail Adapter Freqarg	Frequency with which the e-mail adapter checks for e-mail, in milliseconds.
E-mail Adapter Mailbox	Name of the mailbox that the e-mail adapter checks for e-mail messages; you must use INBOX.
Process Adapter Class	Fully qualified class name of the adapter. Typically, you do not change this parameter after you have specified the path.
Process Adapter Statefile	Fully qualified path of a file that stores the state of the process adapter.
Process Adapter Spawners	Number of spawner threads; that is, threads that create external processes. This number is also the limit of concurrent external processes that the workflow engine can spawn.

Library Tab

Use the Library tab to enable the workflow engine to instantiate workflows that are stored in JAR files and in the directory. These JAR files are organized by the JAR archivist, a library subsystem component within the workflow engine.

The JAR Archivist retrieves (reads) the workflows from the JAR files no matter where the JAR files are stored as long as the files are specified with a URL. You must specify a new URL for the file whenever you deploy a new workflow via a new JAR file. The Library tab enables you to configure up to four URLs. You can edit the /etc/workflow.properties text file to provide for more JAR archivist URLs.

You can also deploy workflows via the directory. You store the class bytecodes that define the workflow and its parameters list in a directory entry under the workflow subtree. For details about this configuration method, see Chapter 25, Building Workflows.

The Directory Archivist Base DN field must always point to the workflow subtree. If the field points to another location, the system will not find the workflow objects.

Table 43 describes the parameters.




 Table 43:  Library Tab Parameters 

 Parameter    
 Description

 JAR Archivist URL 1

 URL identifying location of a file containing workflows. 


 JAR Archivist URL 2

 URL identifying location of a file containing workflows.


 JAR Archivist URL 3

 URL identifying location of a file containing workflows.


 JAR Archivist URL 4    

 URL identifying location of a file containing workflows.


 Directory Archivist Base DN

 Base DN of the subtree containing the workflow objects.

Parameter	Description
JAR Archivist URL 1	URL identifying location of a file containing workflows.
JAR Archivist URL 2	URL identifying location of a file containing workflows.
JAR Archivist URL 3	URL identifying location of a file containing workflows.
JAR Archivist URL 4	URL identifying location of a file containing workflows.
Directory Archivist Base DN	Base DN of the subtree containing the workflow objects.

Persistent Store Tab

Use the Persistent Store tab to configure the location where the states of the active workflows are stored. Table 44 describes the parameters.




 Table 44:  Persistent Store Tab Parameter 

 Parameter
 Description

 Gatherer Filename

 Fully qualified path of the file that holds the persistent workflows (the state of the gatherer).

Parameter	Description
Gatherer Filename	Fully qualified path of the file that holds the persistent workflows (the state of the gatherer).

Repository Tab

Use the Repository (R) tab to configure the event interface. Table 45 describes the parameters.

Table 45: Repository Tab Parameters

Parameter
Description

Server Port

Port on which the workflow engine listens for events incoming from the OSM or OSMW;
port 5000.

Server So Timeout [ms]

Maximum time allowed for sending new messages on the same connection, in milliseconds.

Server Priority

Priority of the socket listening thread.

Client So Timeout [ms]

Maximum time allowed for receiving new messages on the same connection, in milliseconds.

Client Priority

Priority of each thread receiving new messages.

Client Connections Limit

Maximum number of concurrent connections.

Encoding

IANA name of the character encoding used by SDX components to exchange TCP/IP messages. The default value is UTF-8; in some JVMs it is UTF8. See your JVM vendor documentation for the appropriate value.

Event Store

Fully qualified path of the file that stores the incoming events.

Result Store

Fully qualified path of the file that stores the outgoing results.

Workflow Store

Fully qualified path of the file that stores the events that originated the active workflows.

Starter Threads

Number of threads that start workflows.

Starter Timeout [ms]

Maximum time allowed for the starter thread to start a workflow, in milliseconds.

Starter Priority

Priority of the workflow starter threads.

Reporter Threads

Number of threads that report results at the end of workflow executions.

Reporter Timeout [ms]

Maximum time allowed for results to report, in milliseconds.

Reporter Priority

Priority of the reporter threads.

Parameter	Description
Server Port	Port on which the workflow engine listens for events incoming from the OSM or OSMW; port 5000.
Server So Timeout [ms]	Maximum time allowed for sending new messages on the same connection, in milliseconds.
Server Priority	Priority of the socket listening thread.
Client So Timeout [ms]	Maximum time allowed for receiving new messages on the same connection, in milliseconds.
Client Priority	Priority of each thread receiving new messages.
Client Connections Limit	Maximum number of concurrent connections.
Encoding	IANA name of the character encoding used by SDX components to exchange TCP/IP messages. The default value is UTF-8; in some JVMs it is UTF8. See your JVM vendor documentation for the appropriate value.
Event Store	Fully qualified path of the file that stores the incoming events.
Result Store	Fully qualified path of the file that stores the outgoing results.
Workflow Store	Fully qualified path of the file that stores the events that originated the active workflows.
Starter Threads	Number of threads that start workflows.
Starter Timeout [ms]	Maximum time allowed for the starter thread to start a workflow, in milliseconds.
Starter Priority	Priority of the workflow starter threads.
Reporter Threads	Number of threads that report results at the end of workflow executions.
Reporter Timeout [ms]	Maximum time allowed for results to report, in milliseconds.
Reporter Priority	Priority of the reporter threads.

R-LDAP Tab

Use the R-LDAP tab to configure the connection between the workflow application and the LDAP directory. Table 46 describes the parameters.




 Table 46:  R-LDAP Tab Parameters 

 Parameter    
 Description

 Version    

 Version of the LDAP protocol; 2 = OpenLDAP; 3 = Meta Directory.


 Port    

 Port on which the LDAP server listens for new requests.


 Host

 IP address or hostname of the LDAP directory.


 Bind DN

 DN used for authentication with the SDX directory. This DN must be authorized to read and write SDX services, SDX subscribers, and SDX service profiles from the directory.


 Bind Password

 Password used for authentication with the SDX directory.


 Server Time Limit [s]

 Time limit for the LDAP searches on the server side, in seconds.


 Client Time Limit [ms]

 Time limit for the LDAP operations on the client side, in milliseconds.


 Connect Timeout [s]

 Time limit for establishing a connection to the directory, in seconds.


 LDAP Connection Pool Size

 Size of the pool of connections to the directory

Parameter	Description
Version	Version of the LDAP protocol; 2 = OpenLDAP; 3 = Meta Directory.
Port	Port on which the LDAP server listens for new requests.
Host	IP address or hostname of the LDAP directory.
Bind DN	DN used for authentication with the SDX directory. This DN must be authorized to read and write SDX services, SDX subscribers, and SDX service profiles from the directory.
Bind Password	Password used for authentication with the SDX directory.
Server Time Limit [s]	Time limit for the LDAP searches on the server side, in seconds.
Client Time Limit [ms]	Time limit for the LDAP operations on the client side, in milliseconds.
Connect Timeout [s]	Time limit for establishing a connection to the directory, in seconds.
LDAP Connection Pool Size	Size of the pool of connections to the directory

R-Reporter Tab

Use the R-Reporter tab to configure the reporting feature. The workflow engine reports the success or failure of a workflow execution to the OSM component by sending a TCP/IP message to the host responsible for receiving these reports. Table 47 describes the parameters.




 Table 47:  R-Reporter Tab Parameters 

 Parameter    
 Description

 Port    

 Port on which the report server listens for new requests.


 Host

 IP address or hostname of the report server.

Parameter	Description
Port	Port on which the report server listens for new requests.
Host	IP address or hostname of the report server.

Other Tab

Use the Other tab to configure parameters of the JVM that hosts the workflow and other information related to system management. Table 48 describes the parameters.




 Table 48:  Other Tab Parameters 

 Parameter
 Description

 Workflow Root

 Root directory where the Workflow application was installed.


 Workflow Java

 Directory containing the JRE used by the Workflow application.


 JVM Max Heap

 Upper limit of available memory for the maximum heap size. 
 Default value is 256 MB.


 Enable Sysman Client

 Enables the workflow engine to communicate to the SNMP agent.


 Sysman IOR

 Fully qualified path of the file containing the IOR for the SNMP agent.

Parameter	Description
Workflow Root	Root directory where the Workflow application was installed.
Workflow Java	Directory containing the JRE used by the Workflow application.
JVM Max Heap	Upper limit of available memory for the maximum heap size. Default value is 256 MB.
Enable Sysman Client	Enables the workflow engine to communicate to the SNMP agent.
Sysman IOR	Fully qualified path of the file containing the IOR for the SNMP agent.

[Contents] [Prev] [Next] [Index] [Report an Error] [No Frames]