SysWorks©

SysWorks
Command Reference Manual


Previous Contents Index

If the context is not a user home environment, the value will be blank.

CUR_VAR

After the action is performed the global symbol CUR_VAR will contain the variant code of the application environment.

If the context is not an application environment, or the variant is the mainline, the value will be blank.

CUR_VSN

After the action is performed the global symbol CUR_VSN will contain the version code of the application environment.

If the context is not an application environment, or the version is the default version, the value will be blank.


Qualifiers

/ADD

Specifies that the context be added to the search list of contexts rather than becoming the primary context of the process. This qualifier is used to allow a context such as an application environment to see and use the information in another context. This is sometimes referred to as chaining. Typically this qualifier is used in an applications ENTER.COM to indicate dependencies on other applications.

This qualifier is incompatible with the /REMOVE qualifier.

/CLUSTER

Specifies that the action specified with the /SAVE or /UNSAVE qualifier be performed on the cluster wide save file.

By default, /NODE is assumed.

/COMMON

Specifies that the various directory logical names should point directly to the application environment's shared directories. This qualifier overrides the value specifies in the appl_DEVELOPER_STYLE or SWDEV_DEVELOPER_STYPE logical names.

By default, the appl_DEVELOPER_STYLE, or if not present the SWDEV_DEVELOPER_STYPE logical name indicates the desired scope. If neither are present, /COMMON is assumed if ACMS is licensed in the node, otherwise /SPECIFIC is assumed.

This qualifier is incompatible with the /SCOPE and /SPECIFIC qualifiers which also specify the scope for working on an application environment.

/NODE[=node-name]

Specifies that the action specified with the /SAVE or /UNSAVE qualifier be performed on a node specific save file. If no node name is specified, the name of the current node is assumed.

By default, /NODE is assumed.

/REMOVE

Specifies that the context be removed from the search list of contexts rather than becoming the primary context of the process.

This qualifier is incompatible with the /ADD qualifier.

/SAVE

Specifies that the action of the APPLICATION command is saved so that when the user logs in, an appropriate APPLICATION command is performed for the user.

/SCOPE={COMMON|SPECIFIC|sub-directory}

Specifies the scope for working on an application environment.

Using /SCOPE=COMMON is equivalent to /COMMON.

Using /SCOPE=SPECIFIC is equivalent to /SPECIFIC.

Using /SCOPE=sub-directory specifies that the various directory logical names should be search lists, pointing firstly to the indicated sub-directory of each pertinant application directory, and then to the application environment's shared directories. This qualifier overrides the value specifies in the appl_DEVELOPER_STYLE or SWDEV_DEVELOPER_STYPE logical names.

By default, the appl_DEVELOPER_STYLE, or if not present the SWDEV_DEVELOPER_STYPE logical name indicates the desired scope. If neither are present, /COMMON is assumed if ACMS is licensed in the node, otherwise /SPECIFIC is assumed.

This qualifier is incompatible with the /COMMON and /SCOPE qualifiers which also specify the scope for working on an application environment.

/SPECIFIC

Specifies that the various directory logical names should be search lists, pointing firstly to the developers private work or runtime directory, and then to the application environment's shared directories. This qualifier overrides the value specifies in the appl_DEVELOPER_STYLE or SWDEV_DEVELOPER_STYPE logical names.

By default, the appl_DEVELOPER_STYLE, or if not present the SWDEV_DEVELOPER_STYPE logical name indicates the desired scope. If neither are present, /COMMON is assumed if ACMS is licensed in the node, otherwise /SPECIFIC is assumed.

This qualifier is incompatible with the /COMMON and /SCOPE qualifiers which also specify the scope for working on an application environment.

/UNSAVE

Specifies that any previously saved actions of the APPLICATION, ENVIRONMENT, GROUP or HOME commands are unsaved. This will result in the user being left in the home area after logging in. The exception to this is when a node specific /UNSAVE is performed, and there is still a cluster wide saved action, which is the action which will be subsequently performed upon login.

/WORK

Specifies that the users work directory if found will become the default directory. This overrides any defaulting to the users runtime directory when such would be the case.

Examples

#1

$ CONTEXT APPLICATION FIN DEV
      

Set the users context to the development environment of the FIN application.

#2

$ CONTEXT APPLICATION/ADD UTL
      

Add the UTL application to the users current application context. The environment of UTL used is the same as that of the current application.

#3

$ CONTEXT GROUP ADMIN/SAVE
      

Set the users context to the ADMIN group and saves this as the users default login context.


CREPRC

Creates a detached interactive process with a mailbox command stream.

Format

CREPRC[/qualifiers]


Qualifiers

/COMMAND=(command[,...])

Specifies one or more DCL commands to be sent to the process.

The MAILBOX command may also be used to send commands to a process created by the CREPRC command.

Note that the last command sent to a process created by the CREPRC command, should be a STOP/ID=0 or LOGOUT command, otherwise the process will continuously be waiting for more commands from its command stream mailbox.

/DEFINE_LOGICAL=logical-name

Specifies a logical name that is set to the name of the created processes command stream mailbox device. The logical name is placed in the process logical name table.

/ERROR=label

Transfers control to the location specified by the label keyword (in the current command procedure) when a create error occurs. If no error routine is specified and an error occurs during the creation of the process, the current ON condition action is taken.

Overrides any ON condition action specified.

If an error occurs and the target label is successfully given control, the reserved global symbol $STATUS retains the error code.

/NAME=process-name

Defines a name for the created process. The process name can have from 1 to 15 alphanumeric characters. The process name is implicitly qualified by the group number of the process's user identification code (UIC).

If you do not specify a process name, the created process has a null name by default.


Examples

#1

$ MAILBOX/CREATE CMD_MBX
      


CVTDCL

Converts a DCL command procedure source into a DCL command procedure including appending any shared DCL subroutine sources.

Format

CVTDCL source-file-spec[,...] target-filespec


Parameters

source-filespec[,...]

Specifies an existing DCL command procedure to be compressed.

target-filespec

Specifies the resultant compressed DCL command procedure.

Description

The CVTDCL convenience command is provided as a shorthand for the following command:


      DEVTOOLS PREPROCESS/COMPRESS=DCL 

See DEVTOOLS PREPROCESS for more details.


Examples

#1

$ CVTDCL/LOG FIN_TST_COPY.COM [.TMP]
%SWRK-I-FILGEN, DISK_DEV3:[FIN.WRK.SLJ.TMP]FIN_TST_COPY.MMS_INC generated
      


CVTMMS

Convert a source into an MMS script.

Format

CVTMMS file-spec[,...] [mms-file-spec]


Parameters

file-spec[,...]

Specifies one or more source files to be converted into an MMS script. There is no default file type - if you do not specify a file type for an input file, the utility will not convert any sources to MMS scripts.

You can specify more than one input file specification and each one may include wildcards or the file list (i.e. @file-spec) construction.

mms-file-spec[,...]

Specifies the output MMS script file. By default, the name of the input file with a file type of .MMS_INC is assumed.

Description

The CVTMMS convenience command is provided as a shorthand for the following command:


      DEVTOOLS CONVERT/GENERATE/DEFAULT=TARGET=.MMS_INC 

See DEVTOOLS CONVERT/GENERATE for more details.


Examples

#1

$ CVTMMS SWRK_TST_COPY.COB
%SWRK-I-FILGEN, SWRK_TST_COPY.MMS_INC generated
      


CVTPAR

Converts the DCL P1 - P8 parameters (or any other set of symbols) into a single symbol.

Format

CVTPAR symbol-name


Parameters

symbol-name

Specifies the name of the symbol to receive the resultant converted parameters.

The final length of this resultant symbol must be less than or equal to 255 characters.

If an error occurs during processing, no attempt is made to set the symbol's value. Thus, if the symbol already exists, its value is not be changed, and if it doesn't exist, it remains undefined.


Qualifiers

/DEPTH=depth

Specifies the depth of substitution that the resultant symbol will undergo. The effect is to multiply the number of double quotes that are placed around sensitive parts of the parameters. For each level of depth, each sensitive part of a parameter is surrounded by two to the power of the depth number of double quotes.

For example /DEPTH=3 would cause each sensitive part of a parameter to be surrounded by eight double quotes.

By default, /DEPTH=1 is assumed.

/GLOBAL

Specifies that the symbol be placed in the global symbol table. If you do not specify the /GLOBAL qualifier, the symbol is placed in the local symbol table.

/LOCAL (Default)

Specifies that the symbol be placed in the local symbol table for the current command procedure.

/PARAMETERS[=(sym-nam[,...])]

Specifies the actual symbols to be used as parameters. By default, /PARAMETERS=(P1,P2,P3,P4,P5,P6,P7,P8) is assumed.

Examples

#1

{system-prompt}
{user-response}
      


DBAMAN

Invokes the SysWorks Database Tools menu which may be used to manage the day to day operations of a database and changes to its configuration.

This is an alternative convenience command for the DBAMNU command.

See DBAMNU for more details.


DBAMNU

Invokes the SysWorks Database Tools menu which may be used to manage the day to day operations of a database and changes to its configuration.

Within this menu, the following items are provided or supported:

Note that many steps are also defined as tasks, and where such a relationship exists, the step and task have the same name, although a task may well execute other steps in addition to its named equivalent step (see the IMPORT task example above).


Format

DBAMNU [sub-command-or-task]

The following sections provide information about each of the tasks which can be selected from the database tools menu.


DBAMNU Actions

A sequence of actions may be specified as a single job. Most of the tasks on the DBAMNU menu results in one or a small number of actions being performed. Compound actions are merged where appropriate. For example the DROP action actually expands to the sequence CLOSE, DROP, DELETE. However, if the sequence CLOSE, DROP was specified, the resultant sequence would still ve CLOSE, DROP, DELETE i.e. there would not be two CLOSE actions.

DBAMNU Parameters

The following sections provide information about each of the parameters which are used to control the actions of the tasks selected from the database tools menu.


DBAMNU Parameters AIJ_NUM

You may specify the number of after image journals which will be created.

If one after image journal is requested, an extensible journal is created. If more than one journal is requested, fixed size circular journals are created, and the automatic journal backup server is enabled.

A response of NONE indicates that no after image journals should be created and that after image journalling should be disabled.


DBAMNU Parameters AIJ_SIZ

You may specify the size of the aij files.

It is recommended that each after image journal file should be large enough to hold all the journalling data generated between journal backups. Typically journals are backed up daily, so this size should be at least the size of a days work.


DBAMNU Parameters APPL_COD

The application code controls which application the SysWorks Database Tools job is run in.

DBAMNU Parameters BUF_SIZ

You may specify the size of a database buffer.

It is recommended that the buffer size be a multiple of the minimum page size.

The following table lists the default buffer size for a given minimum page size.
Minimum Page Size Default Buffer Size
1 16
2 32
3 27
4 32
5 25
6 36
7 49
8 40


DBAMNU Parameters CLS_SCP

You may close a database on a single node or clusterwide.

DBAMNU Parameters CPY_TYP

You may copy a database directly (code is DATABASE) or from a backup (code is BACKUP). Note that the source database must exist even if the BACKUP option is chosen since the SysWorks Database Tools must search the database for storage area information.

DBAMNU Parameters ENVR_COD

The environment code controls which environment the SysWorks Database Tools job is run in. Note that where a database is copied, two environments are required -- see ENVR_COD_SOURCE and ENVR_COD_TARGET for more details.

DBAMNU Parameters ENVR_COD_SOURCE

The source environment code controls which environment the SysWorks Database Tools job copies a database from.

DBAMNU Parameters ENVR_COD_TARGET

The target environment code controls which environment the SysWorks Database Tools job copies a database to.

DBAMNU Parameters EXP_FCT

You may change the size of the database by a percentage factor. Values must be between -99% and +1000%. A factor of 0 should leave the database at its current size, although snapshot files may be reduced in size. A factor of -99% should result is a database with area files only 1% of the previous size. A value of +1000% should result in a database with area files 10 times their previous size.

DBAMNU Parameters EXT_MTH

The are multiple ways to extract schema information from the database. The extraction method values currently supported include:
Code Usage
BOTH Use both an RMU/EXTRACT command and SQL SHOW statements.
RMU Use an RMU/EXTRACT command.
SHOW Use SQL SHOW statements.

DBAMNU Parameters GBL_BUF

You may specify the default number of global buffers which will be created when the database is opened. The value must be an integer between 10 and 999999999 which specifies how many global buffers to create.

DBAMNU Parameters LOD_JNL

Indicates whether database after image journalling is enabled or disabled during a load action. A value of YES indicates that the after image journal is left enabled. A value of NO (the default value) indicates that it is disabled before the load and re-enabled afterwards.

DBAMNU Parameters LOD_PRC

Specifies a DCL command procedures which will be executed as part of the load action. This procedure is executed after all the indices have been dropped from all the tables involved in the load.

DBAMNU Parameters OPN_BUF

You may override the default number of global buffers created when the database is opened. A value of DEFAULT (which is also the default value if you press [Enter] or [Return]), will not override the default value for the database. Other values must be an integer between 10 and 999999999 which specifies how many global buffers to create.

DBAMNU Parameters OPN_SCP

You may open a database on a single node or clusterwide.

DBAMNU Parameters OPN_USG

You may open a database for private or public access. With private access, the application is not marked as started to PROMPT users will not have access. With public access, the application is marked as started and therefore all normal processing may take place.

DBAMNU Parameters PAG_SIZ

You may specify the minimum size of a database page.

The value must be an integer between 1 and 63.

It is recommended that the buffer size be a multiple of the minimum page size. Where different page sizes are or may be used, the buffer size should be a multiple of each page size. As a result, the following page size sets are suggested:

Minimum Page Size Buffer Size Page Sizes
2 2 2
2 4 2, 4
2 6 2, 3, 6
2 8 2, 4, 8
2 10 2, 5, 10
2 12 2, 3, 4, 6, 12
2 14 2, 7, 14
2 16 2, 4, 8, 16
2 18 2, 3, 6, 9, 18
2 20 2, 4, 5, 10, 20
2 22 2, 11, 22
2 24 2, 3, 4, 6, 8, 12, 24
2 26 2, 13, 26
2 28 2, 4, 7, 14, 28
2 30 2, 3, 5, 6, 10, 15, 30
2 32 2, 4, 8, 16, 32
2 34 2, 17, 34
2 36 2, 3, 4, 6, 9, 12, 18, 36
2 38 2, 19, 38
2 40 2, 4, 5, 8, 10, 20, 40
2 42 2, 3, 6, 7, 14, 21, 42
2 44 2, 4, 11, 22, 44
2 46 2, 23, 46
2 48 2, 3, 4, 6, 8, 12, 16, 24, 48
2 50 2, 5, 10, 25, 50
2 52 2, 4, 13, 26, 52
2 54 2, 3, 6, 9, 18, 27, 54
2 56 2, 4, 7, 8, 14, 28, 56
2 58 2, 29, 58
2 60 2, 3, 4, 5, 6, 10, 12, 15, 20, 30, 60
2 62 2, 31, 62
3 3 3
3 6 3, 6
3 9 3, 9
3 12 3, 4, 6, 12
3 15 3, 5, 15
3 18 3, 6, 9, 18
3 21 3, 7, 21
3 24 3, 4, 6, 8, 12, 24
3 27 3, 9, 27
3 30 3, 5, 6, 10, 15, 30
3 33 3, 11, 33
3 36 3, 4, 6, 9, 12, 18, 36
3 39 3, 13, 39
3 42 3, 6, 7, 14, 21, 42
3 45 3, 5, 9, 15, 45
3 48 3, 4, 6, 8, 12, 16, 24, 48
3 51 3, 17, 51
3 54 3, 6, 9, 18, 27, 54
3 57 3, 19, 57
3 60 3, 4, 5, 6, 10, 12, 15, 20, 30, 60
3 63 3, 7, 9, 21, 63
4 4 4
4 8 4, 8
4 12 4, 6, 12
4 16 4, 8, 16
4 20 4, 5, 10, 20
4 24 4, 6, 8, 12, 24
4 28 4, 7, 14, 28
4 32 4, 8, 16, 32
4 36 4, 6, 9, 12, 18, 36
4 40 4, 5, 8, 10, 20, 40
4 44 4, 11, 22, 44
4 48 4, 6, 8, 12, 16, 24, 48
4 52 4, 13, 26, 52
4 56 4, 7, 8, 14, 28, 56
4 60 4, 5, 6, 10, 12, 15, 20, 30, 60
5 5 5
5 10 5, 10
5 15 5, 15
5 20 5, 10, 20
5 25 5, 25
5 30 5, 6, 10, 15, 30
5 35 5, 7, 35
5 40 5, 8, 10, 20, 40
5 45 5, 9, 15, 45
5 50 5, 10, 25, 50
5 55 5, 11, 55
5 60 5, 6, 10, 12, 15, 20, 30, 60
6 6 6
6 12 6, 12
6 18 6, 9, 18
6 24 6, 8, 12, 24
6 30 6, 10, 15, 30
6 36 6, 9, 12, 18, 36
6 42 6, 7, 14, 21, 42
6 48 6, 8, 12, 16, 24, 48
6 54 6, 9, 18, 27, 54
6 60 6, 10, 12, 15, 20, 30, 60
7 7 7
7 14 7, 14
7 21 7, 21
7 28 7, 14, 28
7 35 7, 35
7 42 7, 14, 21, 42
7 49 7, 49
7 56 7, 8, 14, 28, 56
7 63 7, 9, 21, 63
8 8 8
8 16 8, 16
8 24 8, 12, 24
8 32 8, 16, 32
8 40 8, 10, 20, 40
8 48 8, 12, 16, 24, 48
8 56 8, 14, 28, 56
9 9 9
9 18 9, 18
9 27 9, 27
9 36 9, 12, 18, 36
9 45 9, 15, 45
9 54 9, 18, 27, 54
9 63 9, 21, 63
10 10 10
10 20 10, 20
10 30 10, 15, 30
10 40 10, 20, 40
10 50 10, 25, 50
10 60 10, 12, 15, 20, 30, 60
11 11 11
11 22 11, 22
11 33 11, 33
11 44 11, 22, 44
11 55 11, 55
12 12 12
12 24 12, 24
12 36 12, 18, 36
12 48 12, 16, 24, 48
12 60 12, 15, 20, 30, 60
13 13 13
13 26 13, 26
13 39 13, 39
13 52 13, 26, 52
14 14 14
14 28 14, 28
14 42 14, 21, 42
14 56 14, 28, 56
15 15 15
15 30 15, 30
15 45 15, 45
15 60 15, 20, 30, 60
16 16 16
16 32 16, 32
16 48 16, 24, 48
17 17 17
17 34 17, 34
17 51 17, 51
18 18 18
18 36 18, 36
18 54 18, 27, 54
19 19 19
19 38 19, 38
19 57 19, 57
20 20 20
20 40 20, 40
20 60 20, 30, 60
21 21 21
21 42 21, 42
21 63 21, 63
22 22 22
22 44 22, 44
23 23 23
23 46 23, 46
24 24 24
24 48 24, 48
25 25 25
25 50 25, 50
26 26 26
26 52 26, 52
27 27 27
27 54 27, 54
28 28 28
28 56 28, 56
29 29 29
29 58 29, 58
30 30 30
30 60 30, 60
31 31 31
31 62 31, 62


Previous Next Contents Index