SysWorks©

SysWorks
User Guide


Previous Contents Index


Appendix A
Logical Names

This appendix describes the various logical names used by SysWorks in alphabetic order.

ACMS$TSS_HARDCOPY

appl_ACMS_REPLACE

An application environment logical name which indicates whether ACMS sources include their own ADU command, or whether one has to be provided for them.

appl_ALTERNATIVE_applNETSRV

An internal logical name of SysWorks

appl_CDD_PREFIX (Application)

An application environment logical name indicating which prefices and suffices to use in generated CDD/Repository definitions. If true, use a directory prefix such as appl_FIELDS. and appl_RECORDS., otherwise use name prefix and suffix such as appl_ and _REC.

appl_CMS_GROUP

Indicates the name of the CMS group to be automatically used in association with the application's CMS library.

appl_CMS_PATH (Application)

An application environment logical name indicating the preferred default for DEVTOOLS CMS commands which use the /PATH list qualifier.

It indicates a list of the CMS generations to be automatically used in association with the application's CMS library instead on the latest from the mainline.

If this logical name is present, the DEVTOOLS CMS and SRCCTL commands will delete, fetch, reserve etc. the first generation found in this list.

This behaviour is significantly different to using these commands from CMS itself. If this logical name is not present, the DEVTOOLS CMS and SRCCTL actions will be performed on the main line of descent in the CMS library, much as they would with a direct CMS command.

appl_CMS_VARIANT

An application environment logical name indicating the preferred default for DEVTOOLS CMS commands which use the /VARIANT qualifier.

It indicates the letter to be used in automatically creating variant generations in the application's CMS library.

When this logical is used, the DEVTOOLS CMS and SRCCTL commands extends the functionality of the CMS CREATE ELEMENT command such that when a new element is created, it is reserved and replaced so that a variant exists. This is useful in conjunction with the appl_CMS_PATH logical name. Using them together, a maintenance or maintenance testing class will always have variant generations as members.

By default, variants are not created. A typical value would be the letter A for maintenance and maintenance testing environments.

appl_DEVELOPER_STYLE

Indicates the style of development and maintenance application environment directories. Permitted values include:
Code Usage
COMMON Developers share common documentation, library, software and work directories. This is the default development style.
INDIVIDUAL Each developers work sub-directory is placed at the beginning of a search list for the documentation, library, software and work directory logical names. This style should not be used when ACMS is being used, as ACMS cannot use search lists to replace objects.
PRIVATE Developers do not have sub-directories below the runtime and work directories, or sub-directories below their login default directory for each application environment to which they have been granted access. It is up to the application to decide where to set the developers default directory. This is typically done within the application's ENTER.COM command procedure.
SPECIFIC  

appl_DFLT_DEV_ENVR (Application)

An application environment specific default development environment code.

appl_DFLT_DTST_ENVR (Application)

An application environment specific default development testing environment code.

appl_DFLT_MNT_ENVR (Application)

An application environment specific default maintenance environment code.

appl_DFLT_MTST_ENVR (Application)

An application environment specific default maintenance testing environment code.

appl_DFLT_PROD_ENVR

appl_IMAGE_IDENTIFICATION_NAME

A variable indicating the default image identification prefix used during builds. If this logical name is not defined, the application code is used as the image identification prefix by default. Any explicit IDENTIFICATION clause in an images linker options file overrides the default image identification.

appl_LOGICALS_TIME

The date and time at which the application environments LOGICALS.COM command procedure was last executed. This is used so that the application environments logical name table will be repopulated when a new version of the LOGICALS.COM command procedure is built.

appl_STATE

A variable indicating the current state of an application. This is normally set to available after the application environments LOGICALS.COM command procedure has been executed.

appl_TDMS_REPLACE

appl_VERSION

A variable indicating the version of the application.

The application version is used for the following:

appl_dat-dir_DIR

An application environment data directory. If an application has multiple data directories, this logical name should be a search list including each such directory.

appl_doc-dir_DIR

An application environment documentation directory.

appl_jnl-dir_DIR

An application environment journal directory.

appl_lib-dir_DIR

An application environment library directory.

appl_run-dir_DIR

An application environment runtime directory.

appl_sft-dir_DIR

An application environment software directory.

appl_src-dir_DIR

An application source directory.

appl_src-dir_ROOT

An application source directory root. For example:


 FIN_SRC_ROOT:[CMSLIB] 

would be the directory specification for a typical CMS library.

appl_wrk-dir_DIR

An application environment work directory.

CDD$DEFAULT

CMS$LIB (Application)

The application CMS library. This logical should have one of the following values:

CUR_APP (Job)

A replica of the CUR_APP symbol.

CUR_ARC (Job)

A replica of the CUR_ARC symbol.

CUR_ENV (Job)

A replica of the CUR_ENV symbol.

CUR_GRP (Job)

A replica of the CUR_GRP symbol.

CUR_SCP (Job)

A replica of the CUR_SCP symbol.

CUR_TYP (Job)

A replica of the CUR_TYP symbol

CUR_USR (Job)

A replica of the CUR_USR symbol.

DECW$DISPLAY

DECW$MONITOR_DENSITY (DECW$SERVERn_TABLE)

A logical name set by DECwindows/Motif which indicates the screen density in dots per inch.

DECW$USER_DEFAULTS (User, System)

This logical name points to the directory which contains all the users DECwindows control files. It either points to s sub-directory of [.DECW] in the users home directory or directly to the users home directory itself (if the [.DECW] sub-directory is not present).

DECW$XSIZE_IN_PIXELS (DECW$SERVERn_TABLE)

A logical name set by DECwindows/Motif which indicates the horizontal screen size in pixels. Typical values include 1024 and 1280.

DECW$YSIZE_IN_PIXELS (DECW$SERVERn_TABLE)

A logical name set by DECwindows/Motif which indicates the vertical screen size in pixels. Typical valies include 768, 864 and 1024.

DISK

The search list of all the DISK_envr: search lists.

DISK$

The search list of all DISK$volume: logical names.

DISK$volume

The logical name for a mounted disk volume.

DISK_envr

The search list for a logical disk.

DTM$LIB (Application)

SWRK_ALLOW_UIC_CHANGES

SWRK_APUC_USR

SWRK_BUILD_PHASES

This logical name indicates the list of phases to use when the BUILD/PHASES=ALL qualifier is used. Note that by default, /PHASES without an argument assumes /PHASES=DESCRIP. The default phase list if this logical cannot be translated is /PHASE=(SETUP,SCAN,RULES,DESCRIP). See the BUILD command in the Command Dictionary for more details on phases.

SWRK_CAPTIVE_USER_COMMAND

Specifies the DCL command used for captive users. The default command is:


    @SWRK_SFT_DIR:SWRK_MENU_SYSTEM 

This logical name may be set explicitly in the system logical name table or implicitly in the SysWorks logical name table by virtue of being a system variable.

SWRK_CAPTIVE_USER_MENU

Specifies the entry command (i.e. parameter) to be applied to the captive user command.

This logical name may be set explicitly in the system logical name table or implicitly in the SysWorks logical name table by virtue of being a system variable.

SWRK_CHANGE_UIC_FLAG

SWRK_CONTROL_JOB_TIMEOUT

SWRK_CURRENT_TARGET

SWRK_DECW_LOG_FILE_ACTION

SWRK_DEFAULT_APPL_USER_CLASS

SWDEV_DEVELOPER_STYPE

SWRK_DFLT_DEV_ENVR

SWRK_DFLT_DTST_ENVR

SWRK_DFLT_MNT_ENVR

SWRK_DFLT_MTST_ENVR

SWRK_DIALOUT_DEVICE

SWRK_DISK_CHECK_INTERVAL

SWRK_INSTALL_DIR

SWRK_MONITOR_INTERVAL

SWRK_NET_CMD_ALL_TYPE

SWRK_NEXT_APPL_START

SWRK_NEXT_APPL_STOP

SWRK_NEXT_DISK_CHECK

SWRK_NEXT_JOB_CHECK

SWRK_NEXT_MIDNIGHT

SWRK_NEXT_PROCESS_CHECK

SWRK_NEXT_TIME_SYNC

SWRK_NODE_LEVEL

SWRK_OPCOM_FORWARD_FLAG

SWRK_PARAMETER

SWRK_PREFERRED_EDITOR

SWRK_PROCESS_CHECK_INTERVAL

SWRK_REMOTE_WINDOW_APPLICATIONS

SWRK_REMOTE_WINDOW_NODE

SWRK_REMOTE_WINDOW_PREFIX

SWRK_RESTART_MONITOR

SWRK_SHORT_USERNAME

SWRK_SHUTDOWN_REASON

SWRK_SHUTDOWN_REBOOT

SWRK_SHUTDOWN_TIME

SWRK_SPAWN_COMMANDS

Indicates which utilities (if any) are automatically started as kept sub-processes by SysWorks.

When a user logs in, SysWorks checks this logical name and defines the standard symbols for the utilities indicated to execute a DCL command procedure which starts the kept sub-rpocess (if not currently present) and ATTACHes to it.

Each utility name is separated by a backslash and is allowed to have one asterisk present as per the DCL symbol assignment syntax.

The following utility codes are currently supported:


Examples

#1

$define swrk_spawn_commands "cdo\ed*it\mail"
      

This command indicates that the CDO utility (i.e. DICTIONARY OPERATOR), an editor (i.e. LSEDIT if present otherwise EVE) and MAIL are to be automatically started as kept sub-processes and ATTACHed to when used. Note that the EDIT symbol allows ED and EDI as abbreviations.

SWRK_STARTUP_BASE

SWRK_STTY_LEVEL_str-typ

SWRK_UTILITY_LOGICALS_SCOPE

SWRK_USE_OPA0_FLAG

SWRK_USER_GROUP

SWRK_VERSION

SWRK_VUE_LIBRARY

LAD$SERVICE_DATABASE

LNM$CONTEXT

LNM$DCL_LOGICAL

LNM$FILE_DEV

LNM$SYSTEM

LNM$SYSTEM_LOCAL

LNM$USER

LNM_swrk_DATABASE

LNM_SWRK_SYSTEM

LSE$CURRENT_FILE

LSE$START_CHARACTER

LSE$START_LINE

MMS$RULES

This system logical name logical should point to the following MMS script:


 SWDOC_SFT_DIR:SWRK_MMS_RULES.MMS 

OPC$LOGFILE_ENABLE

OPC$OPA0_ENABLE

PCFS$SERVICE_DATABASE

PSDC$DATABASE

PSI$ACP_ACCOUNTING

SCA$LIBRARY

SLS$SYSTEM

SOFTPC$SYSTEM

STARTUP$CLUSTER_MEMBER

STARTUP$PHASE_NAME

STARTUP$STARTUP_LIST

STARTUP$WORKSTATION

SYS$CLUSTER

SYS$CLUSTERS

SYS$COMMAND

SYS$DISK

SYS$INPUT

SYS$LOGIN

SYS$LOGIN_DEVICE

SYS$LOGIN_ROOT

SYS$MICROVAX

SYS$NET

SYS$NODE

SYS$NODES

SYS$OUTPUT

SYS$PRINT

SYS$SCRATCH

SYS$SPECIFIC

The node specific system root as defined by OpenVMS.

SYS$SPECIFIC_node

The node specuific system root for node node as defined by SysWorks turnkey startup.

SYS$SPECIFICS

A search list of all the SYS$SPECIFIC_node: logical names defined by SysWorks turnkey startup.

SYS$STARTUP

SYS$SYSDEVICE

SYS$TOPSYS

SYSUAF

TT

USER_run-dir_DIR

USER_wrk-dir_DIR

VUE$INPUT

VUE$LIBRARY

A search list of all the directories which the DECwindows/Motif session manager checks for profile files during its startup and when the Options J Menus... task is selected from the session manager menus.

VUE$PROFILE


Appendix B
Symbols

This section describes each of the global symbols used by SysWorks to control or modify its behaviour.

Symbols of the form CUR_xxx are set by various CONTEXT sub-commands. Where lists of such sub-commands which set a symbol or clear a symbol are provided, sub-commands which are not in either list do not change the symbols value.

Symbols of the form DIR_xxx are managed by an application. If they are used, they are defined in the applications ENTER.COM and deleted in the applications EXIT.COM.

Symbols of the form SDC_xxx are managed at a system wide level and are normally defined in the site specific pre-login procedure SWRK_LCL_DIR:site_PRE_LOGIN.COM.

CUR_APP

Indicates the name of the application of the users context. Blank when the CUR_TYP symbol doesn't contain the keyword APPLICATION.

This symbol is set by the CONTEXT APPLICATION command and cleared by the CONTEXT GROUP, CONTEXT HOME and CONTEXT USER commands.

CUR_ARC

Indicates the architecture of the node on which the process exists. Blank when multi-architecture support is not provided at a system or application environment level or the CUR_TYP symbol doesn't contain the keyword APPLICATION.

This symbol is set or cleared by the CONTEXT APPLICATION, CONTEXT ENVIRONMENT, CONTEXT VARIANT and CONTEXT VERSION commands and cleared by the CONTEXT GROUP, CONTEXT HOME and CONTEXT USER commands.

CUR_ENV

Indicates the environment of the users context. Blank when the CUR_TYP symbol doesn't contain the keyword APPLICATION.

This symbol is set by the CONTEXT APPLICATION and CONTEXT ENVIRONMENT commands and cleared by the CONTEXT GROUP, CONTEXT HOME and CONTEXT USER commands.

CUR_GRP

Indicates the name of the group of the users context. Blank when the CUR_TYP symbol doesn't contain the keyword GROUP.

This symbol is set by the CONTEXT GROUP command and cleared by the CONTEXT APPLICATION CONTEXT HOME and CONTEXT USER commands.

CUR_SCP

Indicates the scope of the users context. Blank when the CUR_TYP symbol doesn't contain the keyword APPLICATION.

This symbol should contain one of the following keywords:

This symbol is set by the CONTEXT APPLICATION, CONTEXT ENVIRONMENT, CONTEXT VARIANT and CONTEXT VERSION commands and cleared by the CONTEXT GROUP, CONTEXT HOME and CONTEXT USER commands.

CUR_TYP

Indicates the type of the users current context.

This symbol should contain one of the following keywords:

It is set by the CONTEXT APPLICATION, CONTEXT ENVIRONMENT, CONTEXT GROUP, CONTEXT HOME and CONTEXT USER commands.

CUR_USR

Indicates the name of the user when the users current context is their home or personal context.

This sybol is set by the CONTEXT HOME and CONTEXT USER commands, and cleared by the CONTEXT APPLICATION and CONTEXT GROUP cxommands.

CUR_VAR

Indicates the development variant of the users context. Blank when the CUR_TYP symbol doesn't contain the keyword APPLICATION.

This symbol is set by the CONTEXT APPLICATION, CONTEXT ENVIRONMENT and CONTEXT VARIANT commands and cleared by the CONTEXT GROUP, CONTEXT HOME and CONTEXT USER commands.

CUR_VSN

Indicates the maintenance version of the users context. Blank when the CUR_TYP symbol doesn't contain the keyword APPLICATION.

This symbol is set by the CONTEXT APPLICATION, CONTEXT ENVIRONMENT and CONTEXT VERSION commands and cleared by the CONTEXT GROUP, CONTEXT HOME and CONTEXT USER commands.

DIR_CDD

Indicates the directory specification of an alternate CDD/Plus or CDD/Repository root directory. By default appl_sdc-cdd_DIR is assumed when this symbol is not present.

Normally this symbol is application dependent and should thus be set in the applications' ENTER.COM command procedure and cleared in the applications' EXIT.COM command procedure.

DIR_DOC

Indicates the directory specification of an alternate documentation directory. By default appl_sdc-doc_DIR is assumed when this symbol is not present. Normally this symbol is application dependent and should thus be set in the applications' ENTER.COM command procedure and cleared in the applications' EXIT.COM command procedure.

DIR_JNL

Indicates the directory specification of an alternate journal directory. By default appl_sdc-jnl_DIR is assumed when this symbol is not present. Normally this symbol is application dependent and should thus be set in the applications' ENTER.COM command procedure and cleared in the applications' EXIT.COM command procedure.

DIR_KIT

Indicates the directory specification of an alternate kit directory. By default appl_sdc-kit_DIR is assumed when this symbol is not present. Normally this symbol is application dependent and should thus be set in the applications' ENTER.COM command procedure and cleared in the applications' EXIT.COM command procedure.

DIR_LIB

Indicates the directory specification of an alternate library directory. By default appl_sdc-lib_DIR is assumed when this symbol is not present. Normally this symbol is application dependent and should thus be set in the applications' ENTER.COM command procedure and cleared in the applications' EXIT.COM command procedure.


Previous Next Contents Index