DOCS

Structure of Rochade Initialization Files

All the settings that are required for calling a Rochade component can be described in a Rochade initialization file:

  • The initialization file for starting the Rochade Server contains all the value assignments for the server-specific settings.
  • The initialization file for starting a component that uses an RPL connection contains settings that concern the server connection, communication parameters, references to the predialog for starting the RPL client, and value assignments for variables.

The Rochade initialization files have this basic format:

[<section>]<setting>=<val><setting>=<section>...

where:

  • <section> is the name of a section of the initialization file.
  • <setting> is the name of a setting.
  • <val> is the value of a setting.

These are the main properties of a Rochade initialization file:

  • An initialization file is divided into as many sections as you require.
  • Every individual section is identified by a <section> name. Under UNIX and Windows, this name must appear in square brackets.

    Under z/OS, these restrictions apply:

    • The names of the sections must be entered in angle brackets.
    • In all references to $IMPORT, $CMDLINE, and $ENVIRONMENT, the percent sign (%) is used instead of the dollar sign ($) to keep the initialization file code page independent.
    • Example:

      %IMPORT=%CMDLINE

    • In references to external files, the ampersand character (&) is used instead of the at sign (@).
    • Example:

      STARTUP=&DATCLIE

      These exceptions for z/OS are restricted to the initialization file.

      Each section of the initialization file consists of a group of related settings. You can enter as many value assignments as you require in a section.

      The value assignments can have these formats:

    • <setting>=<val>
    • Assigns the value <val> to the setting <setting>.

      Example:

      MODE=BATCH specifies that MODE has the value BATCH.

    • <setting>=$(<varname>)
    • Assigns the value of the environment variable <varname> to the setting <setting>.

      Example:

      CODEPAGE=@$(RODIR)\bin\c1252.ipc specifies that the Rochade variable CODEPAGE has the value @C:\Rochade\bin\c1252.ipc if you set the environment variable RODIR via set RODIR=C:\Rochade.

    • <setting>=<section>[@<inifile>] [; <section>[@<inifile>] ...
    • Lets you branch to the section named <section> in the initialization file <inifile>. For details, see Reserved Names for Settings.

    • <setting>=
    • Assigns the Rochade-logical value NIL to <setting>.

      Example:

      DB1= specifies that DB1 has the value NIL.

  • In Rochade, these elements are case-sensitive:
    • The names of sections and settings under all operating systems except Windows.
    • Values of settings under all operating systems.

    Example:

    vars=varsect

    ...

    [VARSECT]

    ...

    In Windows, the VARSECT section is accessed within the initialization file. In all other operating systems, the section name varsect is not found.

  • The name of a setting is positioned on the left of the assignment character "=". Blanks in the beginning or end of a setting are not taken into account. Therefore, these two statements are identical:
  • PARM =CC

    PARM=CC

  • The value of a setting is positioned on the right of the assignment character "=". Blanks at the end of a value are not part of the value of the setting. Therefore, these two statements are identical:
  • PARM=CC

    PARM= CC

  • The value of a setting can contain as many characters and equal signs as required. These two statements are valid value assignments:
  • EVENTLOG=LINK=LOG

    The LOGFILE setting has the value LINK=LOG.

    SEMI=;

    The SEMI setting contains a ; (semicolon).

  • In the settings CODEPAGE, CODEPAGE_FILES, $IMPORT, and STARTUP in the initialization file, you can access a file and specify particular values. Access to a file is always symbolized by the at sign (@) in front of a file name.
  • In every section of the initialization file, you can branch to a further initialization file or to another section of the same initialization file with the reserved $IMPORT setting. The maximum nesting depth is six.

Defining Global RPL Variables

This setting has special meaning in the RPL client initialization file:

VARS=<vsect>

It serves to determine the section in which you can define global RPL variables for Rochade.

Global RPL variables are created in Rochade on the basis of settings in the section <vsect>. The variables receive the values assigned in these settings.

Example:

[CLISTART]

...

VARS=ROVARS

...

[ROVARS]

DB1=AP-DATA

DB2=AP-PROC

$EDIT=B

$ED=c:\tmp\edfile

Reserved Section Names

These names are not allowed for sections in the initialization file because they have a special meaning for the $PROFILE command (see ASG-Rochade Programmer’s Guide Volume 1):

  • $CMDLINE lets you access keyword parameters that were specified when the Rochade component was called.
  • $ENVIRONMENT lets you access environment variables of the operating system. The exact meanings of the variables depend on the operating system.

Reserved Names for Settings

These names must not be used for initialization file settings because they have a special meaning for the $PROFILE command (see the ASG-Rochade Programmer’s Guide Volume 1) and settings by these names are actually written by Rochade components:

  • $CURDIR, which provides the name of the currently set directory for the client. If you have specified a work directory, this is the current directory. Otherwise, the current directory is the directory from which the client was started.
  • You can access $CURDIR using the reserved section name $ENVIRONMENT. For more information, see Reserved Section Names and Accessing Reserved Settings and Sections.

  • $EXECUTABLE, which contains the program call for the current client. If a path was also specified with the program call, it, too, is part of the program call. The parameters required for the start of the client are not part of this setting.
  • You can access $EXECUTABLE using the reserved section name $CMDLINE. For more information, see Reserved Section Names and Accessing Reserved Settings and Sections.

  • $IMPORT, which you can use to jump to other initialization files or other sections of the same initialization file. Settings of the current initialization file that were determined before the $IMPORT setting was encountered have priority over (such as, are not overwritten by) settings of the same name specified in the section or initialization file specified by $IMPORT.

The $IMPORT setting has this format:

$IMPORT=[<section>][@<inifile>][;[<section>][@<inifile>]]...

where:

  • <section> is a section name.
  • <inifile> is the name of the initialization file.

You can branch to various sections of various initialization files <inifile> by entering the names of the sections in <section> and the names of the files in <inifile>. For sections located in the current initialization file, you do not need to enter the file name since the name of the current initialization file is the default value for <inifile>. If <section> is not specified, the start section of the current initialization file is used by default.

For z/OS, you can find a description of the options for specifying the initialization file in Specifying Files under z/OS.

Example:

[ROCLI]

$IMPORT=CLIGLOBAL;MESSAGES@J:\ROCHADE\ROCHADE.INI

...

[BATCH]

MODE=BATCH

$IMPORT=CLIGLOBAL

[CLIGLOBAL]

SERVER1=MYSERV

MODE=DIALOG

In this example, [CLIGLOBAL] is located within the current initialization file, and a section [MESSAGES] is expected to exist in the file Rochade.ini on drive J (for example, a network drive) in the directory Rochade. This section, for instance, might contain settings for message files, such as ROAPIMSG.E=@J:\Rochade\bin\rorapieng.imf.

Further, if you start the client with the ROCLI section, the MODE setting will have the value DIALOG, and if you start the client with the BATCH section, the MODE setting will have the value BATCH.

  • $INIFILE, which provides the full path name of the initialization file as specified in the client call. If no initialization file was specified, the setting contains the default value. For more information, see Starting Rochade Server.
  • $PID, which provides the process identification for the client. The process identification is a character string consisting of no more than seven characters. It can be used for constructing unique file names.
  • $STARTSECTION, which provides the name of the initialization file section that was specified in the client call. If no section name was specified, then this setting contains the presumed default value.
  • You can access this setting via the section name $CMDLINE, $ENVIRONMENT, and $CMDLINE, see Reserved Section Names.