Input Parameters

Code the Mainframe Server startup options in your job stream using the following rules:
cadts
Code the Mainframe Server startup options in your job stream using the following rules:
  • Include only one parameter on each input line.
  • Begin the parameter in column 1.
  • Code all input parameters using the following format.
option-name=option-value
The order in which the parameters are coded is irrelevant.
  • ACCESS=
    (
    Optional
    ) Specifies the type of SQL access available in this Mainframe Server.
    Valid Entries:
    R (read-only) or W (read/write)
    Default:
    W
    Note:
    ACCESS=R tells the Mainframe Server to reject SQL maintenance commands, such as INSERT, DELETE, UPDATE, and CREATE. It does not affect locking mechanisms that the SQL engine in the MUF uses to ensure data integrity.
  • APPLID=
    If the CAICCI communication protocol is used, APPLID=specifies the Application Identifier of the Mainframe Server. When an operation group of servers exists, the first four characters of this option must be the same for each member of the group. However, each Mainframe Server must have a unique APPLID.
    If the TCP/IP communication protocol (z/OS only) is used, APPLID=, SERVERNAME=, and TCPIP_PORT= are used as tokens to uniquely identify the
    Mainframe Server component.
    Valid Entries:
    1 to 20 alphabetic characters for APPLID and SERVERNAME, following the rules for SQL names. TCPIP_PORT must be a numeric value from 1024 through 65534.
    Default
    : No default
  • AUTHID=
    (
    Optional
    ) Specifies a valid SQL AUTHID to be used as the default by clients of this Mainframe Server. The AUTHID= parameter value is substituted in any non-qualified table, view, or procedure name in SQL queries that are transmitted through the Mainframe Server. AUTHID must already exist on the attached Multi-User Facility.
    Valid Entries:
    Any valid SQL AUTHID
    Default:
    SYSUSR
  • CODEPAGE=
    (
    Optional
    ) Specifies the code page to use when a JDBC Type 4 driver connection is made to the Server Mainframe region. The code page must be a valid EBCDIC code page that is present in the JDBC client system. It must also be available in the CLASSPATH for the application which uses a JDBC Type 4 connection. The maximum length of the code page name is 32 characters.
    Valid Entries:
    Any code page name that is a valid EBCDIC code page and is present in the client system.
    Default:
    CP037
  • CONEXIT=
    (
    Optional
    ) Specifies a user-coded connection exit to replace the security that
    provides through external security. CONEXIT is called before the call to the external security interface. A sample connection exit, SVCXTPR, is provided.
    Valid Entries:
    A valid connection exit program
    Default:
    No default (spaces)
  • DBUSERS=
    Specifies the number of
    threads to be dedicated to this Mainframe Server. The MUF uses this number to reserve threads to service requests from the Server. Any number of non-update requests can share threads. The number of concurrent update requests determines the number to request. When a client workstation issues any request causing an update, the thread being used is held for this task until the task issues a COMIT or ROLBK or requests a disconnect.
    In estimating the number of DBUSERS, consider the number of update requests operating concurrently a large percentage of the time and allocate a thread for each of these. Additionally, allocate one thread for each five concurrent read-only type requests.
    Valid Entries:
    A number from 1 to 999
    Default:
    No default
  • DDBID=
    (
    Optional
    )
    Specifies the database ID (BASEID) of the Datadictionary database (DATA-DICT) for the Datadictionary on the MUF that is accessed through this Mainframe Server.
    Valid Entries:
    A valid
    database ID
    Default:
    2
  • DDDID=
    (
    Optional
    )
    Specifies the database ID (BASEID) of the Data Definition Directory database (DDD-DATABASE) for the Datadictionary on the MUF that is accessed through this Mainframe Server.
    Valid Entries:
    A valid
    database ID
    Default:
    15
  • FORCEUPPER=
    (Optional)
    Specifies that any USERID or PASSWORD is converted to uppercase characters. This is intended to force those two values to uppercase for JDBC applications. Currently, there is no provision to convert userid and password to uppercase in the JDBC client code. This parameter has no effect on ODBC applications because the client  code converts the the userid and password to uppercase. The only exception for ODBC is when the
    ODBC Setup dialog "DataSource" dialog has the "Mixed-case Password" checkbox checked. In that case, the checkbox is ignored.
    Valid Entries:
    Y or N
    Default:
    N
  • LOGON=
    (
    Optional
    ) Specifies whether the Mainframe Server attempts to do an external security logon to validate each user.
    If LOGON=YES, each user must be authorized to access data through MUF external security.
    If LOGON=NO, user IDs are not validated through external security nor passed to MUF.
    Note:
    If LOGON=YES, the SVDBSPR module must reside in an authorized library.
    Valid Entries:
    NO or YES
    Default:
    YES
  • MUF_EOJ_OK=
    Specifies the action to take when X_EOJ_OK_S_DELAY is defined in the
    SYSIN parameter, where X_EOJ_OK_S_DELAY has a value greater than 2 and less than 999. If MUF_EOJ_OK=YES, the
    MUF terminates immediately if the only tasks within the MUF address space are held by
    .
    will terminate the next time Server attempts to post a request to the MUF or
    issues a connection timeout.
    Valid Entries:
    NO or YES
    Default:
    NO
  • PLANNAME=
    Specifies a four-character prefix that is used for all plan names created by the Mainframe Server. Must be four alphanumeric or @, $, or # characters.
    Note:
    Each Mainframe Server that is attached to a same MUF must provide a unique PLANNAME prefix to ensure that conflicting PLANNAMEs are not generated in a MUF.
    Valid Entries:
    4 alphanumeric characters, @, $, or #.
    Default:
    No default
  • PROTOCOL=
    Specifies the communication protocol that is used to transmit data between workstations or client applications and the Mainframe Server.
    If CCI is specified, the native TCP/IP protocol (z/OS only) will not be available. All other TCP/IP parameters are ignored.
    If TCP is specified, the native TCP/IP interface is initialized (z/OS only). TCPIP_PORT, TCPIP_HOST, and TCPIP_CONNECT_QUEUE can be specified or the defaults are used. See those options for their defaults. No CCI communications are allowed or seen by the Mainframe Server when using the CA Datacom Server Communication Utility (SVCOMPR) to issue commands, such as EOJ or STATUS as documented in PDC RI66876.
    If BOTH is specified, both CCI and the native TCP/IP interface are initialized (z/OS only). TCPIP_PORT, TCPIP_HOST, and TCPIP_CONNECT_QUEUE can be specified or the defaults are used. See those options for their defaults. Both CCI and TCP/IP communication protocol can be used.
    Either BOTH or TCP keywords are required to be able to use a JDBC Type 4 driver connection.
    Valid Entries:
    CCI, BOTH, TCP
    Default:
    CCI
  • RECONNECT_ATTEMPTS=
    Allows an orderly termination of any tasks and an attempt to reconnect to the MUF if it is terminated or abends. Without this startup option, the SVDBSPR region abends when the MUF to which it is connected is terminated or abends. All active connections are terminated when MUF termination occurs.
    Valid Entries:
    1 to 999
    Default:
    0
  • RECONNECT_DELAY=
    Specifies the number of minutes to wait between the retry attempts.
    Valid Entries:
    0 to 32767 (minutes)
    Default:
    0
  • SECEXIT=
    (
    Optional
    ) Specifies a user-coded security exit that is used to enhance the security that
    provides through external security. SECEXIT is called after the call to external security. A sample security exit, SVCXTPR, is provided.
    Valid Entries:
    A valid security exit program
    Default:
    No default (spaces)
  • SERVERNAME=
    Uniquely identifies the Mainframe Server region. Each Server must have a unique name.
    Valid Entries:
    1 to 32 alphabetic characters, following the rules for SQL names
    Default:
    No default
  • SQLMEM=
    (
    Optional
    ) Specifies the status of SQL statement storage when a cursor is closed. Traditionally, SQL statement storage is kept in memory for reuse if the statement is re-executed, perhaps with different parameters.
    SQLMEM=KEEP specifies that SQL statement storage is kept in memory for reuse. It allows an application to prepare a statement once and execute it multiple times without intervening prepares. JDBC applications that use the PreparedStatement interface require SQLMEM=KEEP.
    SQLMEM=FREE specifies that SQL statement storage is released upon cursor close therefore, reducing SQL memory usage in MUF. Prepared statement storage is not saved. Any attempt to re-execute a statement without an intervening prepare results in SQLSTATE 07033 and SQLCODE -134 - Unknown dynamic/cursor statement-id (
    aaaa
    ). SQLMEM=FREE reduces SQL memory usage in MUF.
    Valid Entries:
    KEEP or FREE
    Default:
    KEEP
  • SQL Plan Options
    (
    Optional
    ) The
    mainframe component behaves as a dynamic SQL application in MUF. SQL Plan Options specify input parameters for SQL preprocessor options that can be set at startup. In most cases, you do not need to change these parameters. Therefore, we recommend that you accept the defaults.
    DATE=, TIME=, and DECPOINT= parameters are probably the only parameters you may want to change. The default values for these parameters are appropriate for most PC applications.
    • SQL mode selection
      SQLMODE= DATACOM
    • Performance or Resource adjustment
      CBSIO= 0
      ISOLEVEL= C
      OPT= P
      PLNCLOSE= T
      PRTY= 7
      TIMEMIN= 0
      TIMESEC= 0
      WORKSPACE= 16
    • Debug
      MSG= NN
    • Delimiter character strings
      STRDELIM= A
    • Display format change for date, time, or decimal point.
      DATE=ISO
      • EUR dd.mm.yyyy (IBM European Standard)
      • ISO yyyy-mm-dd (International Standards Organization)(default)
      • JIS yyyy-mm-dd (Japanese Industrial Standard)
      • USA mm/dd/yyyy (USA Standard)
      TIME=JIS
      • EUR: hh.mm.ss
      • ISO hh.mm.ss
      • JIS hh:mm:ss (Default)
      • USA hh:mm AM or PM
      DECPOINT=P
      • P Specifies to use a period as a decimal point.
        (Default)
      • C Specifies to use a comma as a decimal point.
  • SUPMSG=
    (
    Optional
    ) Denotes whether the connect/disconnect messages, DSV00035I and DSV00036I, respectively, are to appear on the console/JESLOG of the Server Mainframe address space. A value of NO means that DSV00035I and DSV00036I messages are not suppressed and appear on the console/JESLOG (z/OS) and in the SYSPRINT output.console. A value of YES means that they are suppressed from the console/JESLOG but are written to the SYSPRINT output file. A value of ALL suppresses ALL messages and nothing is written including any warning or error messages.
    Valid Entries:
    NO, YES, or ALL
    Default:
    NO
  • TCPIP_CONNECT_QUEUE=
    (z/OS only)
    Specifies the number of threads that are spawned by the Server Mainframe region to service TCP/IP requests. Requires PROTOCOL=BOTH or PROTOCOL=TCP. Ignored if PROTOCOL=CCI.
    Valid Entries:
    1 to 300
    Default:
    10
  • TCPIP_DEBUG=
    No longer used and is ignored if specified.
  • TCPIP_HOST=
    (z/OS only)
    Specifies the host name or IP address that is associated with TCPIP_PORT= for TCP/IP transmissions. If TCPIP_HOST=0.0.0.0, the Mainframe Server listens on all addresses using TCPIP_PORT. Requires PROTOCOL=BOTH or PROTOCOL=TCP. Ignored if PROTOCOL=CCI.
    Code the TCPIP_HOST parameter if you are using TCP/IP (z/OS only).
    Valid Entries:
    Host name, LOCALHOST, or IP address (IPv4 or IPv6)
    Default:
    0.0.0.0
  • TCPIP_PORT=
    For z/OS only, specifies the port number on which the Mainframe Server listens for incoming TCP/IP data traffic. This port assignment must not be used by any other TCP/IP service in your environment. Required if PROTOCOL=BOTH or PROTOCOL=TCP. Ignored if PROTOCOL=CCI.
    If TCPIP_PORT is specified in the mainframe component startup option, verify that the value is from 1024 through 65535. If valid, update the PORT NUMBER field with the specified value.
    PROTOCOL=BOTH or PROTOCOL=TCP without a port number causes the
    to enable TCP/IP communication (z/OS only) on port 5465 as the default port. TCPIP_PORT=
    nnnnn
    without specifying PROTOCOL=BOTH or PROTOCOL=TCP does not enable TCP/IP communication. The PROTOCOL= value must be set to BOTH or TCP to enable TCP/IP communication.
    Valid Entries:
    1024 to 65535
    Default:
    5465
  • TIMEOUT=
    (
    Optional
    ) Specifies the time in minutes that a connection from a client application can remain idle before an automatic rollback and disconnect occurs. TIMEOUT=1440 (24 hours) specifies that no connection is ever automatically disconnected.
    Valid Entries:
    A number from 1 to 1440
    Default:
    120
  • TIMEOUTWAIT=
    (
    Optional
    ) Specifies the time interval in minutes for which the Mainframe Server waits to initiate a timeout task. The timeout task reviews all tasks and will automatically rollback and disconnect those tasks for which the value in the TIMEOUT= parameter has exceeded. This parameter allows a Mainframe Server with little or no activity to time out idle tasks. A value of 0 means that a timeout task is not started at periodic intervals and timeouts only occur when there are other tasks in the Server.
    Valid Entries:
    A number from 0 to 720
    Default:
    15 minutes
  • TRACEDIAG=
    (
    Optional
    ) Y - Opens the DIAGTRAC output file and enables the memory diagnostic trace.
    N - Disables the memory diagnostic trace.
    Valid Entries:
    Y, N
    Default:
    N
  • TRACEON=
    (
    Optional
    ) YES - Starts the Trace Facility.
    TIME - Starts the streamlined date/time stamp trace
    C - Starts the Trace Facility and writes all trace output including TCPTRACE output to SYSPRINT.
    Valid Entries:
    NO, YES, C, or TIME
    Default:
    NO
  • TRUSER
    x
    =
    uuuuuuuu
    (
    Optional
    ) Enables an SQL Syntax trace and defines the userids to trace. When enabled, the SQL syntax that is generated by the application of the user is written to SYSPRINT. The output of the SQL syntax trace is typically brief but depends on the length of the SQL statements. Up to five userids or ALL userids can be traced at one time. Trace up to five userids using TRUSER
    x
    =
    uuuuuuuu,
    where
    x
    is a number 1 through 5 and
    uuuuuuuu
    is any valid userid. TRUSER1=TRUSRALL enables the SQL syntax trace for ALL userids.
    The TRACEON=YES option overrides TRUSER
    x
    . If TRACEON=YES is also specified in the startup JCL, the SQL syntax trace entries are not displayed.
    Valid Entries:
    A valid user ID, TRUSRALL
    Default:
    No default
    Following is a sample trace entry from the TRUSERx SQL syntax trace.
    DBR: Statement for UserID: USERID01 . | | DECLARE SQL_CUR_CA_1 CURSOR FOR select * from sysadm.muf_identity | | | | DBR: Statement for UserID: USERID02 . | | DECLARE SQL_CUR_CA_1 CURSOR FOR select tab1.D_MUF_ENABLE, tab1.D_MUF_START| | _DATETIME, tab1.D_MUF_END_DATETIME, tab1.D_MUF_TYPE, tab1.D_MUF_TOTALROW, | | tab1.D_MUF_DURATION, tab1.MUF_NAME, tab1.ELAPSED_SECONDS, , tab1.| | CPU_SECONDS, tab1.DB_REQUESTS, tab1.DATA_MGR_REQUESTS, tab1.REL_MGR_REQUES| | TS tab1.REL_MGR_REQUESTS, tab1.SQL_REQUESTS, tab1.REL_SQL_REQUEST| | S, tab1.PHYSICAL_IO, tab1.PHYSICAL_READS, tab1.REL_PHYS_READS, tab| | .PHYSICAL_WRITES, tab1.REL_PHYS_WRITES, tab1.SEQ_READ_AHEAD, ...
  • URTPRTY=
    Specifies the priority that
    uses for dynamically built URTs. This parameter is required if DYNURT=YES.
    Valid Entries:
    A number from 1 to 15
    Default:
    7