Workstation definition

The name must start with a letter, and can contain alphanumeric characters, dashes, and underscores. It can contain up to 16 characters.

Do not use in this field any of the reserved words specified in List of reserved words when defining jobs and job streams.

perJob

Your license consumption is evaluated based on the number of jobs that run on the workstation each month.

perServer

Your license consumption is evaluated based on the number of chargeable HCL Workload Automation components installed on the workstation.

If you install a dynamic agent and a fault-tolerant agent on the same workstation in the same path, the agents share the same license file. As a result, only the license type which is defined later in time is applied. For this reason, it is advisable to define the same license type for both agent workstations.

The name must start with a letter, and can contain alphanumeric characters, dashes, and underscores. It can contain up to 80 characters.

For host names, valid characters are alphanumeric, including dash (-). The maximum length is 51 characters.

If you are defining a remote engine workstation, specify the host name of the system where the remote engine is installed.

For workload broker workstations

Specify the value of the TWS.Agent.Port property of the TWSAgentConfig.properties file.

For remote engine workstations using HTTP protocol to communicate with the remote engine

Specify the HTTP port number of the remote engine.

For other types of workstations

Specify the value assigned in the localopts file for variable nm port.

The default value for this field is 31111. Specify a value in the range from 1 to 65535.

For workload broker workstations

Ignore this attribute.

For remote engine workstations using HTTPS protocol to communicate with the remote engine

Specify the HTTPS port number of the remote engine.

For other types of workstations

Specify the value assigned in the localopts file for variable nm ssl port. The value must be different value from the value assigned to nm port variable in the localopts file.

If securitylevel is specified, but this attribute is missing, the default value for this field is 31113. Specify a value in the range from 1 to 65535.

When used in remote engine workstation definitions it represents the time zone set on the HCL Workload Automation remote engine.

See Managing time zones for valid time zone names.

HCL Workload Automation ignores domain setting when defined for extended agents, except when the host attribute is set to $MASTER.

This setting is mandatory for standard agent and dynamic workload broker workstations.

For remote engine workstations, agents, pools and dynamic pools:

The broker workstation hosting the workstation. This field cannot be updated after the remote engine workstation creation.

For extended agents

The workstation with which the extended agent communicates and where its access method is installed. The hosting workstation cannot be another extended agent.

If the hosting workstation is a domain manager for which you have defined a backup, you can specify one of the following values to ensure the extended agent is not isolated if the hosting workstation becomes unavailable:

$MASTER

To indicate that the host workstation for the extended agent is the master domain manager.

$MANAGER

To indicate that the host workstation for the extended agent is the domain manager. In this case you must specify the domain where the agent is located.

In this case make sure that the extended agent methods are installed also on the backup workstation. You can enable and disable the automatic resolution of the $MASTER key using the mm resolve master option in the localopts file.

Specify NULL when defining an extended agent for PeopleSoft, SAP, or Oracle.

• You can change fault-tolerant agent, standard agent, extended agent, domain manager and dynamic workload broker workstations to any workstation type, with the exception of dynamic agent, pool, dynamic pool, and remote engine.
• You cannot change the type of dynamic agent, pool, dynamic pool, and remote engine.

fta

If you define a fault-tolerant agent, that is an agent workstation that launches jobs and resolves local dependencies without a domain manager. This is the default value for this attribute.

You must specify fta if you want to assign the workstation the role of backup domain manager or backup master domain manager.

Specify fta for IBM isystems running as limited fault-tolerant agents.

s-agent

If you define a standard agent, that is an agent workstation that launches jobs only under the direction of its domain manager.

x-agent

If you define an extended agent, that is an agent workstation that launches jobs only under the direction of its hosting workstation. Extended agents can be used to interface HCL Workload Automation with non-HCL systems and applications. To create an extended agent for SAP, define an r3batch access method. Consider the following example:

CPUNAME XA_R3
  OS OTHER
  NODE na TCPADDR 32111
  FOR MAESTRO HOST LONDON ACCESS "r3batch"
    TYPE X-AGENT
    AUTOLINK OFF
    BEHINDFIREWALL OFF
    FULLSTATUS OFF
END

For more information, see Scheduling Job Integrations with HCL Workload Automation.

manager

If you define a domain manager, that is a workstation that manages a domain. When defining this type of workstation, specify:

Server

NULL

Domain

The name of the domain the workstation manages, if different from MASTERDM domain.

You specify that a workstation is a manager also in the manager field of the Domain definition. HCL Workload Automation automatically checks that the values specified in these fields are consistent.

broker

If you define a dynamic workload broker workstation, that is a workstation that runs both existing job types and job types with advanced options. It is the broker server installed with the master domain manager and the dynamic domain manager. It hosts the following workstations:

• Extended agent
• Remote engine
• Pool
• Dynamic pool
• Agent. This definition includes the following agents:
  • agent
  • HCL Workload Automation Agent
  • agent for z/OS

  For more information about the agent for z/OS, see HCL Workload Automation: Scheduling with the Agent for z/OS.

agent

If you define a dynamic agent, that it is a workstation that manages a wide variety of job types, for example, specific database or file transfer jobs, in addition to traditional job types. It is hosted by the workload broker workstation. The workstation definition is automatically created and registered when you install the dynamic agent component. In its definition you can edit only the following attributes:

• Description
• Vartable

Note: If you have the enAddWorkstation global option set to "yes", the dynamic agent workstation definition is automatically added to the Plan after the installation process creates the dynamic agent workstation in the database.

rem-eng

If you define a remote engine workstation, that it is a workstation used to communicate with a remote engine when binding a locally defined job, named shadow job, to a specific job running on the remote engine, named remote job. When the two jobs are bound, the shadow job status transition maps the remote job status transition. This mapping is useful also to define and monitor dependencies of local jobs on jobs running on the remote engine; such dependencies are called cross dependencies.

For more information about shadow jobs and cross dependencies, see Defining and managing cross dependencies.

When defining this type of workstation, specify the following fields:

os

The operating system of the remote engine.

host

The name of the hosting broker workstation.

node

The hostname or the IP address of the remote engine.

When specifying the port number to use to communicate with the remote engine, use secureaddr if the protocol used is HTTPS, tcpaddr if the protocol used is HTTP. It is recommended that you specify in the timezone field the time zone set on the remote engine.

pool

If you define a pool, that is a set of dynamic agents with similar hardware or software characteristics to submit jobs to. This workstation is hosted by the workload broker workstation. In its definition you can edit only the following attributes:

• Description
• Vartable
• Members

d-pool

If you define a dynamic pool, that is a set of dynamic agents which is dynamically defined based on the requirements listed in the JSDL file specified in the resources attribute. This workstation is hosted by the workload broker workstation. In its definition you can edit only the following attributes:

• Description
• Vartable
• Requirements

On a fault-tolerant agent or on a standard agents

It means that the domain manager open the link to the agent when the domain manager is started.

On a domain manager

It means that its agents open links to the domain manager when they are started.

This setting is particularly useful when a new production plan is created on the master domain manager: As part of the production plan generation all workstations are stopped and then restarted. For each agent with autolink turned on, the domain manager automatically sends a copy of the new production plan and then starts the agent. If autolink is turned on also for the domain manager, the agent opens a link back to the domain manager.

If the value of autolink is off for an agent, you can open the link from its domain manager by running the conman link command on the agent's domain manager or the master domain manager.

Set this attribute to off if you are defining a workstation with type broker.

on

If you want the fault-tolerant agent workstation to operate in full status mode, meaning that the workstation is updated with the status of jobs and job streams running on all other workstations in its domain and subordinate domains, but not on peer or parent domains. The copy of the production plan on the agent is kept at the same level of detail as the copy of the production plan on its domain manager.

off

If you want the fault-tolerant agent workstation to be informed about the status of jobs and job streams only on other workstations that affect its own jobs and job streams. Specifying "off" can improve performance by reducing network activity.

enabled

The workstation uses SSL authentication only if its domain manager workstation or another fault-tolerant agent below it in the domain hierarchy requires it.

on

The workstation uses SSL authentication when it connects with its domain manager. The domain manager uses SSL authentication when it connects to its parent domain manager. The fault-tolerant agent refuses any incoming connection from its domain manager if it is not an SSL connection.

force

The workstation uses SSL authentication for all of its connections and accepts connections from both parent and subordinate domain managers.

force_enabled

The workstation uses SSL authentication for all of its connections to all target workstations which are set to this value. The workstation tries to establish a connection in FULLSSL mode and, if the attempt fails, it tries to establish an unsecure connection. If you plan to set different security levels between master domain manager and fault-tolerant agents, ensure all these components are at version 95 Fix Pack 4 or later. For versions earlier than 95 Fix Pack 4, the same security level is required for master domain manager and fault-tolerant agents.

If this attribute is omitted, the workstation is not configured for SSL connections and any value for secureaddr is ignored. Make sure, in this case, that the nm ssl port local option is set to 0 to ensure that netman process does not try to open the port specified in secureaddr. See Setting local options for information about SSL authentication and local options set in the TWS_home/localopts configuration file.

If you are defining a fault-tolerant agent that can work as a backup domain manager, the ServerID is used only when the workstation works as a fault-tolerant agent; the setting is ignored when the workstation works as a backup domain manager.

Within the ServerID, the ID is a single letter or a number (A-Z and 0-9). The IDs are unique to each domain manager, so you can use the same IDs in other domains without conflict. A specific ServerID can be dedicated to more than one fault-tolerant agent workstation.

The broker workstation

If the workstation is an agent workstation.

The remote engine

If the workstation is a remote engine workstation.

˂jsdl_definition:>
˂jsdl:resources>
˂jsdl:logicalResource subType="MyResourceType"/>
˂/jsdl:resources>