File Syntax for Importing IDs

To import IDs, create a text file that uses the following syntax, one ID per line:

pool name,pool_type,ID,ID_type,[lease_timeout],[inactivity_timeout],[set],terminal_type,[ordinal],[host_name_alias]

The items in brackets are optional. If you include these items, do not type the brackets. If you include some optional items but omit others, retain the commas as placeholders, as in the following example:


The following table describes each parameter of this syntax.

Parameter Description
pool name One of the following:
  • A user name
  • The IP address of the client
  • The DNS name of the client
  • The name of the named pool

The user name must match a user name in the directory service used by Management & Control Services (MCS). If the client is not prompted for a user name when accessing a configuration or application, you cannot assign IDs to user names; you must assign them to named pools, IP addresses, or DNS names.

In addition, if the user types both a domain or server name and user name when accessing the configuration or application, both must be included in the data file, as in domain_1/user_1.

Pool names cannot contain spaces.

For more information about ID pools, see Configuring ID Pools.

pool_type One of the following:
Pool type
A user or group name 1
An IP address 2
A domain name 8
A named pool 4

Some products support only some of the pool types. For information about the pool types you can use, see the documentation for your product.

ID A 3270E logical unitOne of the following:

Do not assign the same ID to different pools if the ID is being used by both pools to connect to the same host.

ID_type One of the following:
The ID_type is this
A direct connection for 3270 terminal session terminal
A direct connection for a 3270 printer applet. printer
lease_timeout The number of hours that must elapse before the ID is made available for another session.

If this value is 0 or omitted, the ID is made available for another session as soon as the first session closes. This value must be the same for all entries associated with a particular pool.

For more information about the timeouts, see Reclaiming IDs.

inactivity_timeout The number of minutes of inactivity that must elapse before the session with the host closes automatically.

If this value is 0 or omitted, the session never closes automatically. This value must be the same for all entries associated with a particular pool.

set The name of an ID set.

All IDs with the same set name are grouped together.

ID sets are not used with Services Builder for CICS 3270 Bridge

terminal_type IBM Mainframe
ordinal A number other than zero. Use ordinals to control which IDs in a set are allocated to specific configurations. You must assign the same ordinal value to both the ID in the set and the session configuration that should use that ID.

If you specify an ordinal value, you must also specify a set value.

host_name_alias A name that matches a host name on the Host Mappings dialog box.

If you include a host_name_alias, the specified ID can be used only with the IP addresses or DNS names associated with that alias.

This feature is not used in Services Builder for CICS 3270 Bridge.

Related Topics
Bullet Managing CICS Terminal IDs, Overview
Bullet Configuring ID Pools
Bullet Reclaiming IDs