BMC AMI DevX Workbench for Eclipse—CSS TP parameters

PORT_CONFIG

The PORT_CONFIG statement defines the start of a CSS TP definition section and denotes the port number where the TP is to be run.

Default: none

Required: no

AUDIT

CREDENTIALS

The optional CREDENTIALS statement is used to enable or disable the ability of BMC AMI DevX Workbench for Eclipse users to optionally save their login credentials in a secure cache on their workstation when connecting to the port defined by this configuration section.

Values: ENABLE|DISABLE

ENABLE allow users to optionally save their credentials. This is the default action if CREDENTIALS is not coded.

DISABLE disallow the ability for users to save their login credentials on their workstation. The Save credentials checkbox shown during BMC AMI DevX Workbench for Eclipse login will be disabled and no login information will be saved on the workstation hard drive.

Default: ENABLE

Required: no

CXTPMSGS

The CXTPMSGS statement can be used to reduce the number of messages issued to the HCI job log as a result of actions by BMC AMI DevX Workbench for Eclipse users. A setting of FULL is recommended.

Values: FULL|QUIET|NONE

FULL All CXTP messages are issued

QUIET The frequently issued user activity messages CXTPMAI013I and CXTPREQ035I are suppressed; all other messages are issued.*

NONE No CXTP messages are issued.

Default: FULL

Required: no

DISABLE_HLQ_WILDCARD

If disabled, BMC AMI DevX Workbench for Eclipse users are prevented from creating a filter with a wildcard in the high-level qualifier.

Values: NO|YES

Default: NO

Required: no

ENDEVOR

The ENDEVOR statement indicates to Host Explorer that CA-ENDEAVOR support is to be enabled.

Values: NO|YES

YES CA-ENDEVOR is enabled for use by Host Explorer.

NO CA-ENDEVOR is disabled for use by Host Explorer.

Default: NO

Required: no

FILEAID

The FILEAID statement indicates to Host Explorer whether BMC AMI DevX Data Studio's Data Privacy or File-AID/Eclipse support is to be enabled.

Values: NO|YES

YES BMC AMI DevX Data Studio's Data Privacy and/or File-AID/Eclipse support is enabled for use by Host Explorer.

NO BMC AMI DevX Data Studio's Data Privacy and/or File-AID/Eclipse support is disabled for use by Host Explorer.

Default: YES

Required: no

SYSOUT

The SYSOUT statement provides a mechanism to allow installations to impose a “by user ID” level of security by viewing output in the JES Explorer view of BMC AMI DevX Workbench for Eclipse. This optional setting will cause attempts to view output by users to be denied unless they are the owning user ID. This means that no user can view any other user's output except for their own.

A setting of USERID does not override any rules enforced by your security software. Any rules in place that are more restrictive than by-userID security will continue to be enforced by your security software.

Values: USERID|DEFAULT

USERID enables the by-userID security.

DEFAULT rules of your installation's security software profiles and the JESSPOOL resource class will dictate the handling of output. We recommend using the JESSPOOL resource class and your security software for the best and most flexible security arrangement that meets your installation's requirements.

Default: DEFAULT

Required: no

UNITNAME

This optional parameter allows the specification of an esoteric unit name if the default name of VIO is not defined or not desired. Some functions performed by BMC AMI DevX Workbench for Eclipse require the CSS TP to allocate a temporary data set. The allocation requires the specification of a UNIT esoteric name. Typical esoteric names used by the different versions of MVS are VIO, SYSDA, and SYSALLDA.

Values: unitname an esoteric unit name defined to the operating system.

Default: VIO

Required: no

NOTIFYONLY

Deprecated. The NOTIFYONLY statement allows an optional reduction of notification messages that are received by other LPARs in a more tightly coupled shared JES spool environment. For example, a job executed on one LPAR may have its notification posted to another LPAR. In addition, the TSO user ID (the user ID specified in the JOB card) being logged on to one LPAR or another influences the routing choice made by the system. Because of these variables, some notification messages may be received by BMC AMI DevX Workbench for Eclipse for jobs executed on other LPARs even if LOCAL is specified. Despite these occasional exceptions, coding this statement allows for a substantial reduction in notification message traffic sent back to BMC AMI DevX Workbench for Eclipse users.

Values: ALL|LOCAL

ALL means that notification messages issued by other systems are to be included in the job notification back to BMC AMI DevX Workbench for Eclipse.

LOCAL means that only job notification messages from the LOCAL LPAR where this configuration is running should be included in the job notifications returned to BMC AMI DevX Workbench for Eclipse. 

Default: ALL

Required: no

READTIMEOUT

The read timeout value is the number of seconds BMC AMI DevX Workbench for Eclipse will wait for a response from the mainframe before terminating the request and notifying the user.

READTIMEOUT specifies number of seconds to be used for the read timeout value for all users connecting to this port. Users will be able to set their read timeout values to a lower value (shorter time period), but will not be able to exceed the duration value specified. Values below 30 may cause frequent interruptions to the user's session as some requests can take longer to execute than others.

Values: 0 to 999 seconds. Coding 0 allows individual users to set the read time out duration without limitation.

Default: 0

Required: no

APPLICATION

The APPLICATION statement identifies an application profile name also known to the system security software which can optionally be used to further restrict access to the TP port to specific users or groups.

User access to this TP port can be restricted by use of an APPL class profile if it is supported by your security software (such as RACF). To use an APPL class profile to restrict access to certain users or groups, specify an application name. The name can be any name you choose to represent the port or system on which this TP is executing, for example WBPROD, WBTEST, or CXTP01. Then add the chosen name as a profile in the APPL class to your security software database.

User access can then be controlled by assigning user IDs or groups to have READ access to that profile. Users or groups that do not have READ access will not be permitted to use the port and their BMC AMI DevX Workbench for Eclipse session will be terminated.

If the APPLICATION profile name is not specified, then access to the TP port is based on user ID and password authentication only. This is the default action and is consistent with the behavior of all prior releases of BMC AMI DevX Workbench for Eclipse. Therefore, most installations should not specify an APPLICATION profile name and allow user authentication based on user ID and password only.

Values: 1 to 8-character application profile name to be assigned to this TP port represented by this TP Configuration. This same name must be made known to the security software.

Default: none

Required: no

CONSOLEPOE

The CONSOLEPOE statement parameter gives the TP the capability to name a console, which is also defined to your system security software in the CONSOLE class. This console name is used to issue JES CANCEL and PURGE commands on behalf of BMC AMI DevX Workbench for Eclipse as a security Port of Entry (POE). Use of the CONSOLEPOE statement provides a mechanism for installations to use conditional security rules to control which users or groups may issue commands to the system using the WHEN(CONSOLE(console-name)) clause in security profiles.

Security rules at some installations require a console name as a Port of Entry in order to validate the authority of the command. At present, BMC AMI DevX Workbench for Eclipse only issues $CJ commands (JES2) or *MODIFY J=, C commands (JES3).The console name specified by the CONSOLEPOE statement may be any name and the console name chosen must be defined to the system security software as a console in the CONSOLE class. For RACF users, example statements used to define the console are shown here. The console name may also be a console already defined to the CONSOLE class, such as SDSF.

The console name chosen should not be the same name an existing hardware console. There is no physical relationship between the JES Explorer console port of entry name and a real MCS console.

Values: 2- to 8-character name also defined to the CONSOLE security class. After specifying a CONSOLEPOE statement, the next time a JES Explorer user wishes to cancel a job or purge output, the resulting command will be issued under the authority of the named console as a security port of entry.

This means that security rules in place that specify conditional access, for example the commonly used WHEN(CONSOLE(SDSF)) syntax, can also be specified with conditional access using the named console from the CONSOLEPOE statement, for example WHEN(CONSOLE(CXTP01)).

Note that the use of the CONSOLEPOE statement to establish a security port of entry for conditional access to the JES2.CANCEL.* or JES3.MODIFY.* security profiles only allows a user to issue the necessary command into the system. Actual execution of the command and the authority to do so against the affected job or job output is still enforced by JES2 or JES3 and is subject to the security profiles of the JESSPOOL class.

Default: none

Required: no

INACTIVITY

The INACTIVITY statement controls whether users connected to Workbench for Eclipse should time out due to inactivity. When the INACTIVITY statement is specified with a non-zero value, users connected but inactive for the specified timeout value, are logged off from HCI, their TP subtask purged and its resources (including any enqueues) released. When a Workbench for Eclipseh user is purged due to inactivity, the user will have to reconnect and sign-on again, when they wish to resume work.

A timeout value of 0 means no inactivity scan is performed and no users are purged due to inactivity. The INACTIVITY statement must be uncommented (remove the asterisk from column 1) and a non-zero value specified in order to activate the inactivity scan feature.

Default: 0

Values: 0 to 32767 representing inactivity timeout specified in minutes.

Required: no

CSPF

The CSPF statement identifies the data set name of the Shared Profile the contents of this data set are used for various Code Debug functionality. The data set name is not checked for validity until it is actually used and referenced by a Host Explorer user session.

Code one CSPF statement along with the appropriate data set name previously assigned.

Default: none

Values: 1 to 44-character valid data set name of the Shared Profile data set.

Required: no

HPERPLIB

The HPERPLIB is only needed if you are using the Performance Test/Eclipse plug-in. It is required for the Performance Test/Eclipse client to function.

Default: none

Values: The fully qualified data set name of the BMC AMI DevX Performance Test panel library. It must be from the same release as the BMC AMI DevX Performance Test load library specified in the STEPLIB of the HCI JCL.

Required: no

APPLID

The APPLID statement identifies VTAM applids for the secondary (SLU) side of the TSO connection for use by Code Debu/Eclipse users engaged in Code Debug TSO debugging sessions. One APPLID statement is required for each active debugging session. APPLIDs are freed after use and can be reused by the same or another Code Debug/Eclipse user when they initiate subsequent debugging sessions.

The APPLIDs specified can be defined to VTAM in the same domain as the TSO applid, or can be in another domain if the cross domain resources (CDRSC) are properly configured.

Up to 100 APPLIDs are supported. You should specify as many unique APPLIDs as you expect to have concurrent active debugging sessions at one time. In most cases, 30 is more than enough. Code one APPLID statement per line, with one applid in each statement.

Default : none

Values: The name of a VTAM applid reserved for use by Code Debug/Eclipse users during Code Debug TSO based debugging sessions.

Required: no

STASK

The STASK statement is used to indicate the name of the JCL procedure in a system PROCLIB in case the CSS TP must run as a started-task. You must specify STASK if:
 

• ENDEVOR is chosen
• BMC AMI DevX Data Studio's Data Privacy or File-AID/Eclipse plug-ins are implemented
• this HCI will be used to support Strobe Web Services.

The name of the procedure should be any 4-characters of your choice or that your installation requires. The last 4-characters should be 0000. The supplied sample procedure has the name CXSS0000. When the HCI starts a TP using this procedure, the last 4-characters will be automatically replaced by the TP number. Thus, each TP that starts will have a unique jobname (for example, CXSS0001, CXSS0002, etc.)

Default: none

Values: 1 to 8-character name of a started-task procedure in a system PROCLIB for use by the CSS TP.

This is NOT the same procedure you created for the SSAS_PROC. Do not specify CXSSAS here. 

Required: no

DSNHLQ

During the internal operation of the BMC AMI mainframe products that are used by BMC AMI DevX Workbench for Eclipse, sometimes cataloged data sets are created temporarily and then deleted at the end of the operation. If your installation requires that cataloged data sets that are created new must begin with a fixed high level qualifier, you may specify the qualifier using the DSNHLQ statement.

If your installation does not require a fixed qualifier, leave the DSNHLQ statement commented out (leave the asterisk in column 1). Most installations should leave this statement commented out.

Default: none

Values: The high-level qualifier that should be affixed to the beginning of internally generated data set names. The high-level qualifier chosen must meet the rules for all data set name qualifiers as required by the operating system.

Required: no

EXCLUDE

The optional EXCLUDE statement is used to exclude one or more data set names from being presented to BMC AMI DevX Workbench for Eclipse. Any data set names specified on an EXCLUDE statement will not be visible in the data set tree view of Host Explorer within Workbench for Eclipse regardless of the filter mask settings.

While system security profiles would normally be used to limit user access to data sets, there are instances where it is desirable to restrict BMC AMI DevX Workbench for Eclipse access to certain data sets (for example SCLM project data sets), while still allowing users to access those data sets via other non-BMC AMI DevX Workbench for Eclipse methods such as TSO/ISPF. The EXCLUDE statement will accomplish this by causing BMC AMI DevX Workbench for Eclipse not to “see” the excluded data sets while the users still retain whatever security access rights they normally have.

Specify one data set per EXCLUDE statement. A fully qualified data set name may be specified or a partial data set name using a trailing asterisk (*) as a simple wild card (must be the last character of the name). Enter as many EXCLUDE statements as are needed to specify all of the data sets to be excluded from BMC AMI DevX Workbench for Eclipse. Remove the asterisk from column 1 of an EXCLUDE statement to make it active.

Default: none

Values: The fully qualified data set name or a partial data set name with a terminating asterisk character.

Required: no

JOURNAL

The JOURNAL statement identifies the data set names of the journal data sets to be used by the Shared Services Address Space (SSAS). If the SSAS is not defined (and the SSAS statement above is not coded), then the JOURNAL statement may be omitted. The journal data sets contain debugging information to assist in problem determination if difficulties should occur in using the SSAS. As journal data sets are filled, the SSAS will switch to the next available journal data set. If all journals are full, the SSAS will switch to the first journal specified and repeat the process. This functionality is identical to that of the HCI journaling feature.

Code one, two, or three JOURNAL statements, along with the data set name of the journal data set to be used. The format of the JOURNAL statement is:

Default: none

Values: 1 to 44-character valid data set name of a journal data set created earlier. The name is not checked for validity until it is actually used and referenced by the SSAS.

Required: no

OIDCARD

The OIDCARD statement can limit Workbench for Eclipse sign-on access to the HCI port to accept sign-ons only from operator identification (OID) card holders. This means that a valid card must be used for BMC AMI DevX Workbench for Eclipse sign-on. DEFAULT

Default: DEFAULT

Values: ONLY|DEFAULT

ONLY indicates a valid OID card can be used for a sign-on and no user ID/password entry by BMC AMI DevX Workbench for Eclipse is accepted.

DEFAULT indicates that a user ID/password or a valid OID card can be accepted.

Required: no

TSOACCT

Specifies that the CSS TP should not send TSO ACCT(DEFAULT).

Values: NO|BYPASS

Default: none

Required: no

SSAS_PROC

The SSAS_PROC statement identifies the JCL procedure name and SSAS_NAME identifies the address space name to be used by the Shared Services Address Space (SSAS).

The SSAS_PROC statement does not need to be coded when DDIO support using Host Explorer, BMC AMI DevX Data Studio's Data Privacy z/OS metadata retrieval, or Code Coverage/Eclipse is not desired, If the SSAS_PROC statement is not coded, and a Host Explorer user attempts to issue any requests for services, the user will receive return code 1532, indicating that the SSAS_PROC is not defined. This parameter is paired with SSAS_NAME.

Default: none

Values: 1- to 8-character valid JCL procedure name of the startup JCL for the Shared Services Address Space. The procedure specified should have been installed in a system PROCLIB earlier in the previous installation steps. The name is not checked for validity until it is actually used and referenced by a BMC AMI DevX Workbench for Eclipse user session.

Required: no

SSAS_NAME

This name is used by the console operator commands such as STOP and MODIFY in order to control the address space. .

Values: Specifies the name of the SSAS address space. The name of the address space must start with an alphabetical character.

Default: none

Required: no

SYSCMD

(This statement is reserved for future use) Enable BMC AMI DevX Workbench for Eclipse users to issue MVS system commands.

Default: none

Values: SYSTEM|SDSF|NO

SYSTEM specifies that users can only issue system commands if their user ID has valid security profiles in the OPERCMDS class. The OPERCMDS class contains a large number of possible profiles, arranged by command type and often by specific operands in the command. Consult your security software documentation for specifics about specifying command profiles for OPERCMDS. 

SDSF specifies users can issue system commands provided their user ID has read access to the security profile ISFOPER.SYSTEM in the SDSF security class. SDSF itself uses this class and profile to determine whether the TSO user should be permitted to issue commands within SDSF.

NO does not allow Workbench for Eclipse users to issue system commands.

Required: no

SYSLOG

Enable the ability of BMC AMI DevX Workbench for Eclipse users to view the system log (SYSLOG) using JES Explorer through SYSTEM or SDSF security rules.

Regardless of the rule choice, when a user ID is permitted to view the system log under that rule, JES enforces validation of viewing authority based on the user ID's profile in the JESSPOOL class.

Default: none

Values: SYSTEM specifies users can only view the system log provided their user ID has valid security profiles in the JESSPOOL class. Consult your security software documentation for information about specifying profiles for JESSPOOL.
SDSF specifies the security rules in the security profile IFSCMD.ODSP.SYSLOG.JESx in the SDSF class (where x is either 2 or 3 representing JES2 or JES3, respectively) will be used - provided the user has read access to that security profile. SDSF itself uses this class and profile to determine whether the TSO user ID should be permitted to view the system log within SDSF.
NO does not allow BMC AMI DevX Workbench for Eclipse users to view the system log.

Required: no

IMSNSQP

The IMSNSQP statement indicates that the NON-SHARED QUEUE is enabled or disabled for IMSPLEX.

Values: NO|YES

YES enables the non-shared queue for IMSPLEX.

NO disables the non-shared queue for IMSPLEX.

Default: NO

Required: no

XVMFSUM

The XVMFSUM statement indicates that the Mainframe class summary count is enabled or disabled for Code Coverage.

Values: NO|YES

YES enables the Mainframe class summary count option for Code Coverage.

NO disables the Mainframe class summary count option for Code Coverage.

Default: NO

Required: no

NOTIFY

The NOTIFY statement enables the job notification feature. This feature provides for end-of-job notifications that are generated by the NOTIFY=userid JCL parameter to be sent to the user. The NOTIFY=userid JCL parameter is used on JOB statements.

Normally, end-of-job notifications are sent to the TSO user. This remains in effect, regardless of whether the NOTIFY feature is enabled or disabled. Enabling the feature allows a copy of the same end-of-job notification to be sent to the user.

Default: NO

Values: NO|YES

YES enables the job notification feature.

NO disables the job notification feature. Note that when the NOTIFY statement is not coded, the default value is NO and no job notifications will be sent to the user.

Required: no

NOTIFY_PURGE

The NOTIFY_PURGE feature provides an automatic mechanism to purge messages that cannot be delivered to a Workstation user after a set number of days. Messages might be undeliverable because the user ID associated with the message never uses Workbench for Eclipse, or the user ID has not used BMC AMI DevX Workbench for Eclipse for a period longer than the purge duration period. Purging undeliverable messages reduces overhead and keeps the storage required to maintain the undelivered messages to a reasonable level. The NOTIFY_PURGE duration value is in days.

Default: 0

Values: 0 to 999 representing days. Messages placed in storage for delivery will be purged after the specified number of days elapses without any delivery for that message. A NOTIFY_PURGE duration value of 0 causes purging to be disabled. Approximately 5900 undelivered messages will consume 1 MB of storage.

Messages are not held across system shutdown or HCI shutdown. When the system or HCI is restarted, the message queue is emptied and collection of end-of-job notifications starts anew.

Required: no

HIPERLIB

The HPERPLIB is only needed if you are using the Performance Test/Eclipse plug-in. It is required for the Performance Test/Eclipse client to function.

Values: data set name

Default: none

Required: no

DISABLE_HLQ_WILDCARD

If disabled, Workbench for Eclipse users are prevented from creating a filter with a wildcard in the high-level qualifier.

Values: NO|YES

Default: NO

Required: no

TCP_ACEE

Indicates whether the individual user or HCI security environment will be used for cross-LPAR communications. If set to USER, each individual user will need to have their own defined OMVS segment. If set to HCI, the OMVS segment of the HCI userID will be used.

This will only affect permissions for the TCP/IP connection and has no effect on data set permissions.

Values: USER|HCI

Default: USER

Required: no

SYSNAME

A unique name to identify this connection the Code Debug/Eclipse user. The name should be descriptive so the user can identify the connection point. Typically, a CICS applid-name or operating system ID plus other descriptive information is used.

Values: Up to 20-character unique name

Default: none

Required: yes, if the CICS_ENV block is specified

SOCK

PORT

HOST

ENCPROTOCOL

PORT

Port number of the CSS TP for this HCI image.

Values: 1 to 65535

Default: none

Required: yes, if the HCI_ENV block is specified

HOST

The location of the operating system image where the HCI executes.

Values: An IPv4 address in the format of nnn.nnn.nnn.nnn, where nnn is a decimal number between 0 and 255 for each of the four sub elements, or a symbolic IP name.

Default: none

Required: yes, if the HCI_ENV block is specified

SYSNAME

User-specified description for the HCI connection point for a given LPAR. Typically, an LPAR name or operating system ID plus other descriptive information is used.

Values: Up to 20-character unique name

Default: none

Required: yes, if the HCI_ENV block is specified

LPAR

Identifier for the LPAR this HCI instance executes.

Values: 4 to 8-character LPAR name

Default: none

Required: yes, if the HCI_ENV block is specified

PORT

Code Pipeline server port. This must match the value of WZCMXPRT in the Code Pipeline start parms.

Values: Port number between 1 and 65535

Default: none

Required: yes, if the ISPW_ENV block is specified

HOST

IP address or DNS of Code Pipelineserver

Values: An IPv4 address in the format of nnn.nnn.nnn.nnn  where nnn is a decimal number between 0 and 255 for each of the four sub elements, or a symbolic IP name.

Default: none

Required: yes, if the ISPW_ENV block is specified

CTNAME

The name of the Code Pipeline/CT server that should be used by Topaz clients connecting through this HCI to access Code Pipeline life cycle data sets. This only needs to be coded if the CTLOCAL value defined to Code Pipeline does not have access to the life cycle data sets used by the Topaz clients connecting through this HCI. This optional parameter is only used in multi-site implementations of a single Code Pipeline server.

Values: A server name between 1 and 8 characters

Default: none

Required: no

PORT

HOST

ZIIP

JRNMASK

TPNAME

LINE

MAXTPS

SRVRJOB

CLASS

RULE

CLASS

RULE

PORT

DEVENT_GCS_PORT

DEVENT_TCP_PORT

TCPNAME

IPV6

DVIPA

DVIPN

RMT_URL

LOCAL_URL

TPNAME

SYSNAME

APPLID

LOGMODE

LPAR