Site Symbolics

Endevor
18.1
Site-defined symbolics are user-defined symbolic values that you reference within dataset name specifications for base, delta, source output, include libraries, and processors (that is, you can use them wherever you can use
Endevor
symbolics).
The terms "symbol," "symbolic," and "symbolic parameter" are used interchangeably in the product and in this documentation.
The site symbolics facility enables you to define global symbols that can be used in type and processor definitions to reference data set name specifications for base, delta, source output, include libraries, and processors (that is, you can use them wherever you can use
Endevor
symbolics). Thus, commonly referenced data sets can be defined in a single location significantly easing maintenance. At execution time, all site symbolics referenced by a processor are stored with the processor symbolics in the component data. If a site symbolic is also specified as a processor symbolic, the processor symbolic (and processor symbolic override) take precedence.
When
Endevor
is initialized, the site symbolics are placed into memory. When
Endevor
is terminated, the site symbolic storage is released. If more than one
Endevor
task is executing, each task has its own discrete site symbolic storage.
To implement site symbolics, you must define the symbolic and its data value in a table that is assembled and linked into an APF-authorized library. Once this is done, you must update the SYMBOLTBL parameter in the C1DEFLTS table with the name of the site symbolics table. These actions are described next.
Site symbolics are required only if you are using USS pathname specifications for element type base or source output file definitions. Otherwise, site symbolics are optional.
Considerations When Defining Site Symbolics
Before defining the site symbolics, consider the following to ensure your success:
  • Site symbolic names must begin with a "#".
  • Site symbolic names can contain up to twelve characters, including the "#".
  • The symbolic value may be up to seventy characters long.
  • Site symbolics are referenced with an ampersand preceding the symbolic name. For example, site symbolic #VENDORLB is referenced as:
    &#VENDORLB
  • SYMDATA values must be enclosed in quotes if the value contains ampersands or quotes. For example:
    the value '&&C1SU'. sets a value of &C1SU or the value 'CICS(''SP''),NODBCS' sets a value of CICS('SP'),NODBCS
  • Quotes or ampersands imbedded in the SYMDATA value must be doubled. For example:
    the value '&&C1SU'. sets a value of &C1SU or the value '&&&&C1SU'. sets a value of &&C1SU or the value 'CICS(''SP''),NODBCS' sets a value of CICS('SP'),NODBCS
  • If you need to continue a symbol definition on a second line, place a non-blank character in column 72 and begin the next line in column 16.
Define the Site Symbolics
Use the following format to define a symbolic and its data value in the site-defined symbolics table:
$ESYMBOL SYMNAME=#symbolname,SYMDATA=symbolvalue
The following information describes the preceding format:
  • symbolname
    The symbol name must begin with the # character and is 1 to 11 characters in length. The # indicates that the symbol is defined in the site-defined symbolics table.
  • symbolvalue
    The data value associated with the site symbolic is 1 to 70 characters in length, with no restrictions on the content of the data.
    If you do not specify a data value for a symbolic,
    Endevor
    treats it as a null variable. For example, the following symbolic contains a null value:
    ESYMBOL SYMNAME= APA,SYMDATA=' ',
For example:
$ESYMBOL SYMNAME=#VENDORLB,SYMDATA=SYS2.VENDOR.LOADLIB
Use JCL member BC1JTABL in
iprfx.iqual.CSIQJCL
to assemble and link-edit the site defined symbolics table. An alternative is to employ an SMP/E USERMOD to accomplish this.
Update C1DEFLTS
After creating the symbolics table, update C1DEFLTS to reflect the table name. Use the SYMBOLTBL= parameter to define the table name. The Site Information from the C1DEFLTS panel displays the parameter value in the SYMBOLICS Table field.