Sunteți pe pagina 1din 197

Dollar Universe 6

Commands Manual

Version: 6.5.21
Publication Date: 2015-12
Automic Software GmbH
ii | Copyright

Copyright
Automic® and the Automic logo® are trademarks owned by Automic Software GmbH (Automic). All
such trademarks can be used by permission only and are subject to the written license terms. This
software/computer program is proprietary and confidential to Automic Software and is only available
for access and use under approved written license terms.
This software/computer program is further protected by copyright laws, international treaties and other
domestic and international laws and any unauthorized access or use gives rise to civil and criminal
penalties. Unauthorized copying or other reproduction of any form (in whole or in part), disassembly,
decompilation, reverse engineering, modification, and development of any derivative works are all
strictly prohibited, and any party or person engaging in such will be prosecuted by Automic Software.
No liability is accepted for any changes, mistakes, printing or production errors. Reproduction in whole
or in part without permission is prohibited.
© Copyright Automic Software GmbH. All rights reserved.
Other names may be trademarks of their respective holders.
Dollar Universe 6 Commands Manual | iii

Contents
1 Release Notes ...................................................................................................................... 7
2 Introduction .......................................................................................................................... 8
2.1 Presentation .................................................................................................................... 8
2.1.1 Parameter Setting Commands ................................................................................. 8
2.1.2 Settings Management Commands ........................................................................... 9
2.1.3 Operations Commands ............................................................................................. 9
2.1.4 Batch Management Commands ............................................................................... 9
2.1.5 The FTP Transfer Commands ................................................................................ 10
2.1.6 DQM Commands .................................................................................................... 10
2.1.7 VMS Queue Manager Commands ......................................................................... 10
2.1.8 Date Management Commands............................................................................... 11
2.1.9 Hidden Variables Management Commands ........................................................... 11
2.1.10 CL Commands ........................................................................................................ 11
2.1.11 OS/400 Commands ................................................................................................ 11
2.1.12 The Variables.......................................................................................................... 12
2.1.13 OpenVMS Aliases .................................................................................................. 12
2.2 General Specifications .................................................................................................. 13
2.2.1 Command Format ................................................................................................... 13
2.2.2 Use of the Commands ............................................................................................ 15
2.2.3 Which Syntax for Which Operating System ........................................................... 17
2.2.4 Naming Conventions .............................................................................................. 19
3 Parameter Commands ....................................................................................................... 21
3.1 Administration Tables ................................................................................................... 21
3.1.1 Extract and Insert ................................................................................................... 21
3.1.2 Companies.............................................................................................................. 23
3.1.3 Nodes ..................................................................................................................... 25
3.1.4 Node Variables ....................................................................................................... 27
3.1.5 Management Unit Types ........................................................................................ 28
3.1.6 Management Units ................................................................................................. 29
3.1.7 Management Unit Dependencies ........................................................................... 32
3.1.8 Management Unit Variables ................................................................................... 33
3.1.9 Domains.................................................................................................................. 35
3.1.10 Applications ............................................................................................................ 36
3.1.11 Application Directories ............................................................................................ 37
3.1.12 Management Unit Directories ................................................................................. 39
3.1.13 User Profiles ........................................................................................................... 41
3.1.14 Users ...................................................................................................................... 43
3.2 Uprocs and Sessions .................................................................................................... 45
3.2.1 Classes ................................................................................................................... 45
3.2.2 Resources............................................................................................................... 46
3.2.3 Uprocs .................................................................................................................... 51
iv | Contents

3.2.4 Sessions ................................................................................................................. 70


3.3 Scheduling .................................................................................................................... 74
3.3.1 Calendars ............................................................................................................... 74
3.3.2 Rules ....................................................................................................................... 79
3.3.3 Tasks ...................................................................................................................... 84
3.4 Triggers ....................................................................................................................... 100
3.4.1 Commands ........................................................................................................... 100
3.4.2 Families ................................................................................................................ 103
3.4.3 Description of Items .............................................................................................. 103
3.4.4 Examples .............................................................................................................. 104
3.5 Runbooks .................................................................................................................... 105
3.5.1 Commands ........................................................................................................... 105
3.5.2 Description of Items .............................................................................................. 107
3.5.3 Examples .............................................................................................................. 109
4 Operations Commands ................................................................................................... 110
4.1 Parameter Setting Objects.......................................................................................... 110
4.1.1 Resources............................................................................................................. 110
4.1.2 Tasks .................................................................................................................... 115
4.2 Operations Control ...................................................................................................... 117
4.2.1 Future Launches ................................................................................................... 117
4.2.2 Events ................................................................................................................... 123
4.2.3 Executions ............................................................................................................ 128
4.2.4 Notes .................................................................................................................... 133
4.2.5 Outages ................................................................................................................ 134
4.2.6 Exceptions ............................................................................................................ 137
4.3 Control Utilities ............................................................................................................ 141
4.3.1 Batch Engines....................................................................................................... 141
4.3.2 Executions History ................................................................................................ 142
4.3.3 The Forecast Workload ........................................................................................ 145
4.3.4 The Statistics ........................................................................................................ 146
5 Batch Management .......................................................................................................... 149
5.1 Presentation ................................................................................................................ 149
5.2 The Batch Trigger ....................................................................................................... 149
5.2.1 uxordre.................................................................................................................. 149
5.3 Control Execution Time .............................................................................................. 152
5.3.1 uxsurjob ................................................................................................................ 152
5.3.2 uxspvjob................................................................................................................ 153
5.3.3 uxalrjob ................................................................................................................. 154
6 FTP Commands ................................................................................................................ 156
6.1 uxstr FTP GET ............................................................................................................ 156
6.1.1 Commands ........................................................................................................... 156
6.1.2 Description of Items .............................................................................................. 156
6.2 uxstr FTP PUT ............................................................................................................ 157
6.2.1 Commands ........................................................................................................... 158
Dollar Universe 6 Commands Manual | v

6.2.2 Description of Items .............................................................................................. 158


7 DQM Commands .............................................................................................................. 160
7.1 Queue Management Commands ............................................................................... 160
7.1.1 Create a Batch Queue .......................................................................................... 160
7.1.2 Update Batch Queue Parameters ........................................................................ 161
7.1.3 Delete a Batch Queue .......................................................................................... 163
7.1.4 Reset a Batch Queue ........................................................................................... 163
7.1.5 Start a Batch Queue ............................................................................................. 163
7.1.6 Stop a Batch Queue ............................................................................................. 164
7.1.7 Display Batch Queue List ..................................................................................... 164
7.1.8 Show Batch Queue Status ................................................................................... 165
7.2 Job Management Commands .................................................................................... 166
7.2.1 Hold a Job............................................................................................................. 166
7.2.2 Release a Held Job .............................................................................................. 166
7.2.3 Status of a Job ...................................................................................................... 166
7.2.4 Stop a Job............................................................................................................. 167
7.2.5 Update Job Priorities ............................................................................................ 167
8 Date Management ............................................................................................................ 169
8.1 Format and Offset of Dates ........................................................................................ 169
8.1.1 Format .................................................................................................................. 169
8.1.2 Item Description .................................................................................................... 170
8.1.3 Examples .............................................................................................................. 171
8.2 Format of Dates and Offset of Time ........................................................................... 172
8.2.1 Formats................................................................................................................. 172
8.2.2 Item Description .................................................................................................... 172
8.2.3 Examples .............................................................................................................. 173
9 Hidden Variable Management ......................................................................................... 175
9.1 Commands ................................................................................................................. 175
9.1.1 Items ..................................................................................................................... 175
9.1.2 Examples .............................................................................................................. 176
10 The Command Language Procedure ........................................................................ 177
10.1 Presentation of the CL ................................................................................................ 177
10.1.1 Normalization of CL Procedures........................................................................... 177
10.1.2 The Return Code of CL Procedures ..................................................................... 177
10.1.3 Commands ........................................................................................................... 178
10.2 CL Commands ............................................................................................................ 178
10.2.1 Preventing the Cancellation of a Running Uproc ................................................. 178
10.2.2 Inserting a Step .................................................................................................... 179
10.2.3 Information Display ............................................................................................... 180
10.2.4 Generating a Message ......................................................................................... 180
10.2.5 Passing Parameters ............................................................................................. 181
10.2.6 Carry-over of Variables ......................................................................................... 182
10.2.7 Inheritance Variables ............................................................................................ 184
11 Annexes ....................................................................................................................... 187
vi | Contents

11.1 Example of Use of CL Commands ............................................................................. 187


11.1.1 Recovery Steps and Messages in a KSH Script .................................................. 187
11.1.2 Recovery Steps and Messages in a CSH Script .................................................. 188
11.2 Appendices AS/400 .................................................................................................... 188
11.2.1 Examples of OS/400 Programs ............................................................................ 188
11.2.2 Control Language Programming .......................................................................... 190
12 About Automic Software, Community and Services .............................................. 195
12.1 Automic Software Company ....................................................................................... 195
12.2 Automic Community.................................................................................................... 195
12.3 Download Center ........................................................................................................ 195
12.4 Technical Support ....................................................................................................... 196
12.5 Training and Services ................................................................................................. 196
Chapter 1 Release Notes | 7

1 Release Notes
The following is the change history. Information on bug-fixes and known errors is available in the
Workload Automation Release Notes and by contacting Automic technical support.

Date Key Features


2014-11 Dollar Universe user manuals change their look to integrate to the Automic world.
2014-12 Enhancements of FTP Uprocs and command uxstr FTP.
2015-03 Contraints on inheritance variables value
Syntax for timezones
Recursive file transfers
2015-07 Uproc types supporting inheritance variables
2015-09 Duplicate a Management Unit
New variables in file resources
Variable of type Password
2015-12 Correction in uxlst ctl command filters.
How to change a task from multiple launches per day to daily (or vice versa).
8 | Chapter 2 Introduction

2 Introduction
Welcome to the Dollar Universe Commands Guide!

2.1 Presentation
The commands described below enable interaction with the Dollar Universe engines from an external
environment (customer applications, scripts...). They are divided into groups which are presented in
the following chapters of this manual:
 Parameter commands aimed at defining or modifying Dollar Universe parameters.
 Operations commands for consulting or intervening upon operations without using the
graphical user interface.
 Batch management commands for submitting and controlling job executions.
 FTP commands to enable data transfers via FTP (except OS/400).
 DQM commands to manage batch queues and jobs in batch queues.
 Date management commands (except OS/400).
 Commands for interacting with Dollar Universe from an Uproc script.
These commands are the same for all platforms. The following rules are common to all types of
commands.

2.1.1 Parameter Setting Commands


The table below describes, by theme, all available parameter setting commands corresponding to the
query and update options of the interactive functions.
Verb: ux… add upd dup dlt shw lst tra dst ext ins rls scv
Theme:
Administration X X
Company X X X X X X
Node X X X
Node variable X X X X
MU type X X X X X
MU X X X X X X X
TIH X X X X X
Domain X X X X X X
Application X X X X X X
Application dir. X X X X X X
MU directory X X X X X X
MU variable X X X X
User X X X X X X
Class X X X X X X
Resource X X X X X X X X
Chapter 2 Introduction | 9

Verb: ux… add upd dup dlt shw lst tra dst ext ins rls scv
Theme:
Rule X X X X X X X
Uproc X X X X X X X X X X X X
Session X X X X X X X X X
Calendar X X X X X X X X X
Task X X X X X X X X X X
Run book X X X X X

2.1.2 Settings Management Commands


These commands can be used to:
 Extract setting objects from a V5 or V6 Company (that contains job events) by obtaining an
XML file.
 To verify the format of the XML file.
 To insert this setting into a V6 Company.

These commands are delivered in the Dollar Universe V6 upgrade kit and are described in the
Dollar Universe V6 Upgrade Manual.

2.1.3 Operations Commands


Available operations commands are described below by subject:
Verb: ux... add upd dlt shw lst pre rsv cnr hld rls pur rst wak str end
Theme:
Resource X X X X X
Task X X
Launch X X X X X X X X
Outage X X X X
Exception X X X X X
Event X X X X X
Execution X X X X
Note X X X X X
Engine X X X X
Execution X X
History
Forecast X
Workload
Statistics X X X X X

These commands enable interventions on current operations.

2.1.4 Batch Management Commands


Four commands are available to trigger batch jobs and oversee their execution span:
10 | Chapter 2 Introduction

 uxordre triggers a task (provoked or scheduled).


 uxsurjob tracks a Uproc’s elapsed time and interrupts it if it exceeds a predefined limit.
 uxspvjob tracks a Uproc’s elapsed time and executes a script if it exceeds a predefined limit
(precise to the second).
 uxalrjob tracks a Uproc’s elapsed time and executes a script if it exceeds a predefined limit
(precise to the second).

2.1.5 The FTP Transfer Commands


These commands use the Dollar Universe Manager for File Transfer mechanisms integrated with
Dollar Universe V6 (except OS/400).
 uxstr FTP GET: to retrieve a file via FTP
 uxstr FTP PUT: to send a file via FTP

2.1.6 DQM Commands


DQM propose:
 Batch queue management commands:
o uxaddque: Create a Batch Queue
o uxupdque: Update Batch Queue Parameters
o uxdltque: Delete a Batch Queue
o uxresetque: Reset a Batch Queue
o uxlstque: Display Batch Queue List
o uxstrque: Start a Batch Queue
o uxstpque: Stop a Batch Queue
o uxshwque: Show Batch Queue Status
 Job management commands in the batch queue:
o uxrlsjob: Release a Held Job
o uxhldjob: Hold a Job
o uxshwjob: Status of a Job
o uxstpjob: Stop a Job
o uxsetpri: Update Job Priorities

2.1.7 VMS Queue Manager Commands


In OpenVMS, jobs are launched on a DQM batch queue and are then submitted to the VMS Queue
Manager when they have the status “running”. DQM commands only impact the DQM batch queue
and VMS Queue Manager commands only impact the VMS batch queue.
Refer to the OpenVMS documentation for more information on VMS Batch Queue management.

On OpenVMS, in order to run VMS Queue Manager commands, the user must have the
OPER and SYSNAM privileges.
Chapter 2 Introduction | 11

2.1.8 Date Management Commands


On Windows/UNIX/OpenVMS, two commands are available to format or calculate date and time:
 uxdat returns a date format, an offset date or the type or position of a day in a calendar.
 uxtim converts a time (with or without a date) in a specified format. Allow the specification of
a time offset.
Refer to section "Date Management" on page 169.

2.1.9 Hidden Variables Management Commands


These commands allow the definition of variables whose values are hidden from the user in the
interfaces and logs.
 uxhideval … insert…: creates a variable and its value in the variables file.
 uxhideval … list…: lists the variables and associated values defined in the variables file..
 uxhideval … delete…: removes a variable and its value from the variables file.
 uxhideval … extract…: displays the value of a hidden variable in standard
 uxexechidden: (alias EXECHIDDEN on OS/400) executes a command passed as a
parameter using the hidden value of one or more variables.
Refer to section "Hidden Variable Management" on page 175.

2.1.10 CL Commands
uxset commands are interact with Dollar Universe from within a Uproc script:
 uxset msg (alias UXSETMSG on OS/400) sends a message to the history trace from the
Uproc script: "Generating a Message" on page 180.
 uxset step (alias UXSETSTEP on OS/400) inserts recovery steps also enabling jobs to be
followed more easily: "Inserting a Step" on page 179.
 uxset parm (alias UXSETPARM on OS/400) passes parameters to the Uprocs at the next
level of a session: "Passing Parameters" on page 181.
 uxset var (alias UXSETVAR on OS/400) carries over the values of a Uproc's variables within
a session: "Carry-over of Variables" on page 182.
 uxset info (alias UXSETINFO on OS/400) displays additional information in the job monitor:
"Information Display" on page 180.
 uxsetabort: blocks cancellation attempts from the job monitor: "Preventing the Cancellation
of a Running Uproc" on page 178.
 uxset hvar assigns values to variables and specifies which variables will be transferred to the
next Uproc(s): “Inheritance Variables” on page 184.
 uxunset hvar prevents the specified variables from being inherited by the next Uproc(s):
“Inheritance Variables” on page 184.
 uxset inheritance Sets whether or not variables will be inherited by the next Uproc(s):
“Inheritance Variables” on page 184.

2.1.11 OS/400 Commands


The commands below can be used on the command line:
12 | Chapter 2 Introduction

 UXADDFLA: Create a launch


 UXDLTFLA: Delete a launch
 UXUPDFLA: Modify a launch
 UXRLSRES : Free a resource
 UXORDRE: Trigger an existing task
Enter the name of the command + F4 to display the parameters and enter their values.

2.1.12 The Variables


A number of local environment variables, generated either by the Uproc execution or by the basic
Dollar Universe configuration, are available in the CL and can serve to retrieve various parameter
values such as the submission account, the management unit, the Uproc name or ID, etc. Refer to the
Reference Manual, section "Job parameters".
There are two main methods to generate environment variables:
 Node, MU or Uproc variables: An environment variable added on UVC can only be composed
of the variable name and value. It can be defined at the node level, the Management Unit
level or the Uproc level. Node variables are added through UVC in DUAS Node Settings >
Node Variables. Management Unit and Uproc variables are created directly on the object.
 unienv_specific file: Environment variables that are used to access external application
environments should be added to the unienv_specific file (.bat on Windows, .ksh on UNIX,
.com on OpenVMS) in data/nodefiles or on OS/400, in the UNIENVSPEC file of the
<COMPANY> library. In this case, the variable does not need to be defined at the node level.

On UNIX/Linux on OpenVMS, a variable name cannot start with a number (operating system
restriction).

2.1.13 OpenVMS Aliases


The following aliases were created for compatibility:
 UXCD: Change directory
 UXORD : Submit batch jobs
On OpenVMS, the following aliases are available:
 CDDAP: Change directory to data A
 CDDEX : Change directory to data X
 CDDIN : Change directory to data I
 CDDSI : Change directory to data S
 CDEXE : Change directory to bin
 CDLAP : Change directory to log A
 CDLEX : Change directory to log X
 CDLIN : Change directory to log I
 CDLOG : Change directory to log
 CDLSI : Change directory to log S
 CDMGR : Change directory to mgr
 CDPAP : Change directory to script directory A
Chapter 2 Introduction | 13

 CDPEX : Change directory to script directory X


 CDPIN : Change directory to script directory I
 CDPSI : Change directory to script directory S
 CDROOT : Change directory to company root directory

2.2 General Specifications


The company I/O servers must be running to execute a command.

The user that runs the command must be declared in the list of System User Patterns on
UniViewer Management Server (in UniViewer Console, Administration mode > Security >
System User Patterns) and has the required rights for running this command.

2.2.1 Command Format


A command can be broken down into five elements:
On Windows/UNIX/OpenVMS: <verb> <theme> <environment> <items> <output>
 <verb>: Definition of the command verb to be used (i.e. uxadd).
 <theme>: Definition of a theme indicating the function to be targeted (i.e. UPR).
 <environment>: Definition of the working environment: node, area, and sometimes
management unit.
 <items>: Selection of the working records defining the required information. On OS/400 all the
items must be cited in quotes.
 <output>: Identification of files containing concatenated input data necessary to the function
(input=filename) or the output file where collected data should be deposited
(output=filename).
On OS/400 the program associated to the command can be called using the same syntax:
CALL PGM(<PROGRAM>) PARM(<theme> <environment> <items> <output>)

2.2.1.1 Verb
The command verb should always be entered first. If the current job directory is not the
UNI_DIR_EXEC directory, the latter should be specified in the command (except on OpenVMS).
For example, in UNIX:
${UNI_DIR_EXEC}/uxlst UPR

This command will display the list of Uprocs in the default area.
On OS/400, the Company library must be loaded.

2.2.1.2 Theme
The theme must be inserted immediately after the verb; qualifying items can then be used in any
order.
${UNI_DIR_EXEC}/uxlst UPR

In the above example, the theme is UPR. It shows that the command concerns Uprocs.
14 | Chapter 2 Introduction

2.2.1.3 Environment
The execution of the unienv file (in the Company's root directory) must be executed to load the default
environment. The items below can be set to overwrite the default values.
 NODE= Dollar Universe node name.
If the command targets a remote node, it must be declared on the same UVMS as the Dollar
Universe local node or, for “Master UVMS/Subordinate UVMS” architecture, on a UVMS
subordinate (with the same master) that shares its nodes.
All the commands only concern the nodes of the same Company.
o On Windows/UNIX/OpenVMS: if no node is specified, the value of the variable
S_NODENAME (up to 64 characters) will be used by default.
o On OS/400 in display mode, if the node is not specified, the current node (*CURRENT) is
used.
 EXP (Production Area), SIM for simulation, INT for integration and APP for application.
o On Windows/UNIX/OpenVMS: if the area is not specified, the value of either the variable
or the symbol S_ESPEXE will be used.
o On OS/400 in display mode, if the Area is not specified, the current Area (*CURRENT) is
used.

2.2.1.4 Items
For each command a list of items is detailed:
 Compulsory items are shown in bold.
 "*" (wildcards) means that a generic value is acceptable.
On OS/400, items using the sign = must be entered in quotes. For example: ‘MU=MYMU’.

2.2.1.5 Input / Output Files


The input and output items are used mainly with Dollar Universe extraction and insertion commands
uxext and uxins to facilitate interfacing with a remote distribution product for example.
The output item can also be used by the uxshw or uxlst commands to divert output data from a screen
(default) to a disk file.
The same output file can be used for several uxext commands (applying to different types of object),
the extracted data being appended to the end of the file created by the previous commands.
It is recommended however not to use the same output file for objects belonging to different areas as
the use of generic addressing on versions of objects (Uprocs, sessions and tasks) could well cause
confusion. For example, if the same output file contains the results of the following two commands:
uxext UPR APP UPR="*" VUPR="*" output=filename
uxext UPR INT UPR="*" VUPR="*" output=filename

In the case where Uprocs with the same version exist in both areas and if the item REPL is not
specified, the Uproc/version from the application area will prevail.
If the item REPL is specified, then the Uproc/version from the integration area will overwrite the
existing record from the application area.

2.2.1.6 Return Code


Two codes can be returned by the commands:
 0 (or odd number on OpenVMS): The command has been executed correctly.
Chapter 2 Introduction | 15

 1 (or even number on OpenVMS): The command could not be executed correctly; this return
code is accepted by a message to explain the reason of the failure: syntax error, I/O server
absent etc.

2.2.2 Use of the Commands


Parameter commands mentioned in the above table may be used in the command line of the
operating system (on Windows/UNIX/OpenVMS) or in a procedure.
Operations commands mentioned in the second table and batch management commands may be
used either at the the operating system command line (on Windows/UNIX/OpenVMS) or in a
procedure.
CL commands may only be used from a Uproc script. They can only be executed in the context
supplied by Dollar Universe.
Features associated with the different operating modes are described below.

2.2.2.1 UniViewer Console Command Settings


The node settings of a Dollar Universe V6 node in the "Command Interface Settings" category are
used to define the number of characters displayed for different object names.
As a result, the object names displayed by a command may be truncated depending on the value of
these parameters. The default values are:

Setting Object Length


Display length for Node Node 64 c
Display length for MU MU 64 c
Display length for User User Account 64 c
Display length for Resource Resource 64 c
Display length for Uproc Uproc 64 c
Display length for Class Incompatibility Class 64 c
Display length for Application Application 64 c
Display length for Rule Rule 64 c
Display length for Session Session 64 c
Display length for Task Task 64 c
Display length for Labels Descriptions 40 c
Display length for variable length Variable name 64 c
Display length for variable value length Variable value 64 c
Target Uproc version when inserting in APP/INT Uproc 001
Target Session version when inserting in APP/INT Session 001

Refer to the "UniViewer Console Interface Manual for Dollar Universe" for associated node settings.

2.2.2.2 General Rules


To make commands easier to read, the character "\" (on Windows/UNIX/) or the character “-” (on
OpenVMS) or the character "+" (on OS/400) can be used to wrap to the following line.
Key words may be entered in lower or upper case; case is only distinguished in verbs and text fields.
Dollar Universe objects must all be entered in upper case; for nodes and users, the case must be
respected.
16 | Chapter 2 Introduction

2.2.2.3 DQM Command Specificities


If modifications are made to the root user’s .profile script, do the following (DQM works mainly in
memory).
 Stop DQM.
 Log out of the root session.
 Login again to the root session.
 Restart DQM.

2.2.2.4 Date Formats


From the 4.3 version of Dollar Universe upwards, all dates are entered or displayed according to the
following rule.
The node setting U_FMT_DATE (General Settings category) defines the required date format. Its
value must be built with the following components:
 YYYY: Year (four characters).
 MM: The number of the month, between 01 and 12 (two characters).
 DD: Day in the month, between 01 and 31 (two characters).
 A separator, chosen in the following characters: / or: or – or no separator. The separator, if it
is used, must separate the three components of the date and not border them.
For example, to express the date "the 21st of June 2008":
 If U_FMT_DATE is DDMMYYYY, the date displayed will be 21062008.
 If U_FMT_DATE is YYYY-DD-MM, the date displayed will be 2008-21-06.
If no value is assigned to the setting U_FMT_DATE, its default value is MM/DD/YYYY for English and
DD/MM/YYYY for French.

The OS/400 commands UX*FLA and UXORDRE use the system date format and not the
format indicated by the variable U_FMT_DATE.

2.2.2.5 On Line Help


On line help is available for all Dollar Universe commands (except uxset, uxspvjob, uxsurjob and
uxalrjob).

For inheritance variable commands, the online help can be accessed with the commands:
uxset hvar, uxunset hvar and uxset inheritance.

The on line help displays the command syntax, the list of items, their format and possible and default
values.
To display the on line help enter the command followed by "help".
For example, to display the online help for the command uxlst upr:
C:\Automic\DUAS\UNIV62_FRWPMDEV08\bin>uxlst upr help
Lists the uprocs.

uxlst UPR
[NODE]= format:64c default:S_NOEUD or S_NODENAME
[EXP | SIM | INT | APP] default:S_ESPEXE
[UPR]= format:64c * default:*
[VUPR]= format:3n * default:*
[DOM]= format:1c * default:*
[APPL]= format:64c * default:*
[INF | FULL] default:FULL
Chapter 2 Introduction | 17

[OUTPUT]=file_name
Items presented in square brackets: [ ] are optional, the others are mandatory.
Two items separated by the character: | are incompatible.
Format: Indicates the acquisition format of the data item. The number of characters followed by:
 "n" for a numerical value.
 "c" for a character string.
 "*" indicates that the wildcard character can be entered at the end of the string or alone.
Default: Indicates the default value used if no value provided. This may be the value of an
environment variable, for example: S_ESPEXE for the area.
U_FMT_DATE: Indicates that the date must be entered in the format determined by this node setting.

On OS/400, the parameters for OS/400 commands can be displayed with the F4 key. The user
can enter the value of parameters. The F11 key displays the parameter name.

2.2.3 Which Syntax for Which Operating System


Considering Windows and UNIX and OpenVMS, each of these operating systems has a list of specific
characters which may be used in a Dollar Universe command.
Add to this the characters with a specific meaning to Dollar Universe commands: space = ( ) { }.
These characters must be quoted in order to be transmitted to the Dollar Universe command without
being interpreted by the Operating System. The quotation syntax depends on the operating system.

2.2.3.1 Using Commands on Windows


+ - ( ) and space are specific characters.
One kind of quoting can be used to protect these characters: double quoting. For example: "text or
code field".
The circumflex accent can also be used to protect individual special characters, including quotation
marks. For example: text^+text^”text.
Examples
Will work:
uxadd MU MU=CENTER LABEL="Company center" TNODE=%S_NODENAME%
uxupd MU MU=CENTER LABEL="Company center (M)"
uxupd UPR EXP UPR=D_LOAD_FIL TERMINS add TERMNO=02 TERM=D_LOAD_FIL
STATUS=ABNORMAL PDATE="(-1,,)"
uxupd UPR EXP UPR=D_LOAD_FIL FORMULA LFORM="=C01 AND =C02"
uxadd MU MU=CENTER LABEL=Company^+center TNODE=%S_NODENAME%
uxupd UPR EXP UPR=D_LOAD_FIL TERMINS add TERMNO=02 TERM=D_LOAD_FIL
STATUS=ABNORMAL PDATE=^(^-1,,)
Will not work:
uxadd MU MU=CENTER LABEL=Company center TNODE=%S_NODENAME%
uxadd MU MU=CENTER LABEL='"Company center"' TNODE=%S_NODENAME%

2.2.3.2 Using Commands on UNIX


+ - ( ) * \ { } [ ] and space are specific characters.
Two kind of quoting can be used to protect these characters:
 Double quoting if the only specific character is space, for example: "text or code field". Double
quoting protects all the specific characters except ", $, `and \.
18 | Chapter 2 Introduction

 The single quoting, for example: 'text (or code field)'. Single quoting protects all the specific
characters except '.
The backslash character can also be used to protect a specific character. Example: text\$
Examples
Will work:
uxadd MU MU=CENTER LABEL="Company center" TNODE=$S_NODENAME
uxupd MU MU=CENTER LABEL="Company center \(M\)"
uxadd MU MU=CENTER LABEL='Company center (M)' TNODE=$S_NODENAME
uxupd UPR EXP UPR=D_LOAD_FIL TERMINS add TERMNO=01 TERM=D_LOAD_FIL
STATUS=ABNORMAL PDATE='(-1,,)'
uxupd UPR EXP UPR=D_LOAD_FIL FORMULA LFORM="=C01 AND =C02"
uxupd UPR EXP UPR=D_LOAD_FIL FORMULA LFORM="=C01 AND =C02"
uxupd UPR EXP UPR=D_LOAD_FIL FORMULA LFORM=C01\ AND\ =C02
Will not work:
uxadd MU MU=HEADQUART LABEL='"Company center"' TNODE=$S_NODENAME
uxadd MU MU=HEADQUART LABEL='Company center TNODE=$S_NODENAME
uxadd MU MU=CENTER LABEL=\"Company center (M)\'" TNODE=$S_NODENAME
uxupd UPR EXP UPR=D_LOAD_FIL TERMINS add TERMNO=01 TERM=D_LOAD_FIL
STATUS=ABNORMAL PDATE=\"'(-1,,)\"'
uxupd UPR EXP UPR=D_LOAD_FIL FORMULA LFORM="'=C01 AND =C02"'
uxupd UPR EXP UPR=D_LOAD_FIL FORMULA LFORM=\=C01 AND =C02

Some specific shells may need some specific quoting. This has been tested for ksh and csh.

2.2.3.3 Using Commands on OS/400


Quotes must be used to define a parameter that uses the = sign and to preserve the case.
For example:
CALL PGM(UXSHW) PARM(SES EXP 'SES=D_LOAD_BCK' LNK)

2.2.3.4 Using Commands on OpenVMS

Specific Characters
+ - ( ) and space are specific characters.
One kind of quoting can be used to protect these characters: the double quoting. For example: "text or
(code field)".
The circumflex accent can also be used to protect invidual specific characters, including quotation
marks. For example: “text^+text^”text”.
Examples
Will work:
uxadd MU MU=CENTER LABEL="Company center (M)" TNODE=TEST
uxupd UPR EXP UPR=D_LOAD_FIL TERMINS add TERMNO=02 TERM=D_LOAD_FIL
STATUS=ABNORMAL PDATE="(-1,,)"
uxupd UPR EXP UPR=D_LOAD_FIL FORMULA LFORM="=C01 AND =C02"
uxadd MU MU=CENTER LABEL=Company^ center TNODE=%S_NODENAME%
uxupd UPR EXP UPR=D_LOAD_FIL TERMINS add TERMNO=02 TERM=D_LOAD_FIL
STATUS=ABNORMAL PDATE=^(^-1,,)
Will not work:
uxadd MU MU=CENTER LABEL="""Company center M""" TNODE=TEST
uxupd UPR EXP UPR=D_LOAD_FIL FORMULA LFORM=""=C01 AND =C02""
Chapter 2 Introduction | 19

Case sensitivity
OpenVMS has two additional particularities:
 When a command is translated by the operating system, the case of the argument is
automatically changed to uppercase.
 When a foreign command (case of the Dollar Universe commands) is translated by the
operating system, sometimes (depending on the OS version), the case of the argument is
automatically changed to lowercase.
Dollar Universe objects are generally not case sensitive (uppercase by default) except for the Dollar
Universe node and user names/submission accounts (the definition of a node name must be strictly
identical on all nodes).
To protect the case sensitivity, the node name must always be protected (by double quotes) in the
different commands using the NODE and TNODE argument, the user name must always be protected
in the commands using the USER argument.
The protection is provided by quotation marks, for example: “Node”.
It is also recommended to protect all the arguments with a double quote.
Examples
uxupd NODE TNODE="Node" LABEL="""Test machine"""
uxdlt NODE TNODE="Node"

2.2.4 Naming Conventions

2.2.4.1 Length of Objects


The length of the field name and the description of the objects vary according to the version of Dollar
Universe .The table below summarizes this information:

DUAS Version <= V6 >= V6


Name Description Name Description
Application 2 20 64 64
Batch Queue 31 - 31 -
Business View / Job Chain 64 256 64 256
Calendar - 40 - 64
Class 6 20 64 64
Company 6 20 6 -
Domain 1 20 1 64
Management Type 1 20 1 64
Management Unit 10 20 64 64
Node 10 20 64 64
Outage window - - - 64
Profile 8 40 - -
Resource 20 40 64 64
Rule 8 40 64 64
Runbooks 64 64
Session 10 30 64 64
Submission Account 12 - 64 64
20 | Chapter 2 Introduction

DUAS Version <= V6 >= V6


Name Description Name Description
Task - - 64 64
Template (task, calendar…) 10 - 64 -
Trigger - - 64 -
Uproc 10 60 64 64

Certain objects do not appear in this list as they are specific to UVMS.

2.2.4.2 Authorized Characters


With Dollar Universe V6, object names can contain (by default) the following characters:
A-Z 0-9 _ - . [ ] ( ) space @ # $
 The space character, when authorized, cannot be used as the first character.
 The lower case characters are automatically converted to uppercase except for Node names,
user accounts, and submission accounts.
 Unicode is also supported

Only the authorized characters (A to Z, 0 to 9 and _ ) are supported for Company names. On
OpenVMS, the character “$” is supported for batch queue names (i.e. SYS$BATCH).
Those specials characters should be escaped (using a backslash \ or surrounding them with
single quotes ‘$’ in order to avoid these special symbols being interpreted by the shell.

Object Name
Application Default
Batch Queue A-Z 0-9 _
Business View / Job Chain Default
Calendar Default 1st character: A-Z 0-9
Class Default
Company A-Z 0-9 _
Domain A-Z
MU Default 1st character: A-Z 0-9
MU Type A-Z 0-9
Node A-Z a-z 0-9_ - . space forbidden
Resource Default
Rule Default
Runbook Default
Session Default
Submission Account Default
Task Default
Template (task, calendar…) Default
Trigger Default
Uproc Default
Chapter 3 Parameter Commands | 21

3 Parameter Commands

3.1 Administration Tables


Command output differs between Dollar Universe V5 and Dollar Universe V6. The output will
change when a package is sent from DUAS V5 to DUAS V6.

3.1.1 Extract and Insert

3.1.1.1 Commands
uxext ADM: Extract all or part of an administration table.

Item Format Default


TSOC= 6c *
TNODE= 64c *
DOM= 1c *
APPL= 64c *
CLASS= 64c *
TYPUG= 1c *
MU= 64c *
HDP
USER= 64c *
REPERT
REPL
OUTPUT=filename
NOVERIF

Example:
uxext ADM APPL=B* OUTPUT="c:\temp\adm.ext"

uxins ADM: Insert information obtained from an extraction into the corresponding administration
table.

Item Format Default


TSOC= 6c *
TNODE= 64c *
DOM= 1c *
APPL= 64c *
CLASS= 64c *
TYPUG= 1c *
MU= 64c *
HDP
USER= 64c *
22 | Chapter 3 Parameter Commands

Item Format Default


REPERT
REPL
INPUT=filename

Example:
uxins ADM APPL=* INPUT="c:\temp\adm.ext"

3.1.1.2 Description of Items


TSOC: Company table. Format 6 alphanumeric upper-case characters.
Enter a Company code (wildcard accepted)
TNODE: Node table. Format: 64 alphanumeric characters.
Enter a node code (wildcard accepted).
DOM: Domain table. Format 1 alphabetic character.
Enter a domain code (wildcard accepted).
APPL: Application table and application directories. Format: 64 alphanumeric characters.
Enter an application code (wildcard accepted).
o Application table, if REPERT is not mentioned.
o Application directories table if REPERT is supplied; in this case, the directories of all
applications entered in the table are extracted (the directories of every application
contained in the input file are inserted).
CLASSE: Table of incompatibility classes. Format: 64 alphanumeric characters.
Enter an incompatibility class (wildcard accepted).
TYPUG: Management Unit Type table. Format: 1 alphanumeric character.
Enter a Management Unit code (wildcard accepted)
MU: Management Unit table and Management Unit directories. Format: 64 alphanumeric characters.
Enter a Management Unit code (wildcard accepted)
o Management Unit table if REPERT is not mentioned
o Management Unit directories table if REPERT is supplied; in this case, if an application
code in entered (with APPL), the directories corresponding to the
Application/Management Unit pairs (defined by input values – including wildcards) are
extracted from the Management Unit directories table. If no application code is supplied, a
default of "*" (all applications are considered in the extraction or insertion) is applied.
HDP: Management Unit dependencies table. The extraction is performed globally (no selection is
possible).
USER: User table. Format: 64 alphanumeric characters.
Enter a user name (wildcard accepted)

The above items are mutually incompatibles (extraction of a single table at any one time),
except for APPL and MU used with REPERT to indicate the Management Unit directories
table. At least one of these items is required.

REPERT: Application or Management Unit directories.


Combined with APPL and/or MU determine the table to be processed.
REPL: Replacement option.
Chapter 3 Parameter Commands | 23

Indicates whether the extracted (or inserted) record deletes and replaces the record that
already exists in the destination file; by default, extraction (or insertion) is refused for each
record that already exists (indicated by a message for each occurrence).
OUTPUT: Output file for the uxext command. The file name is compulsory.
INPUT: Input file for the uxins command. The file name is compulsory.
NOVERIF: Only to be used with the uxext command.
The NOVERIF option forces the command to skip the checking of the output data file before
the insertion of the new records. This enhances the performances and can only be used for
the creation of a new output data file.

3.1.1.3 Examples
uxext ADM APPL=BK output=c:\temp\DOC.ext

Extracts the application BK from the current company and archives the data in file
c:\temp\DOC.ext.
uxins ADM APPL=* input=c:\temp\DOC.ext

Inserts all applications from file c:\temp\DOC.ext into the current environment (company and
node).
uxext ADM MU=S* output=c:\temp\DOC.ext
uxext ADM MU=A* output=c:\temp\DOC.ext

Extracts all management units of types S and A; and archives the data in file
c:\temp\DOC.ext.
uxins ADM MU=* input=c:\temp\DOC.ext

Inserts all management units in file c:\temp\DOC.ext into the current environment (Company
and node).

3.1.2 Companies
These commands are presented for compatibility purposes only. They are inconsequential.

3.1.2.1 Commands
uxadd SOC: Adds a company into the company table.

Item Format Default


TSOC= 6c
LABEL= 20c
MASTER= 64c
LOCK | UNLOCK UNLOCK
DIR= 60c

Example:
uxadd SOC TSOC=EXAMPL LABEL=\"new company\" DIR="c:\EXAMPL"

uxupd SOC: Modifies the characteristics of a company.

Item Format Default


TSOC= 6c *
LABEL= 20c
24 | Chapter 3 Parameter Commands

Item Format Default


MASTER= 64c
LOCK | UNLOCK
DIR= 60c

Example:
uxupd SOC TSOC=EXAMPL DIR="d:\EXAMPL"

uxshw SOC: Displays the characteristics of a company.

Item Format Default


TSOC= 6c *
OUTPUT=filename

Example:
uxshw SOC TSOC=*

uxdlt SOC: Deletes a company from the company table.


Item Format Default
TSOC= 6c *

Example:
uxdlt SOC TSOC=EXAMPL

uxlst SOC: Lists the companies in the company table.

Item Format Default


TSOC= 6c * *
INF | FULL FULL
OUTPUT=filename

Example:
uxlst SOC

3.1.2.2 Description of Items


TSOC: Company code. Format: 6 alphanumeric upper-case characters.
Enter a company code (wildcard accepted except for uxadd).
LABEL: Company descriptive label. Format: 20 alphanumeric characters.
LOCK: Lock Uprocs and sessions during transfer.
Default: UNLOCK.
MASTER: Master node of the company. Format: 64 alphanumeric characters.
Default: local node.
TPU: Text editor used under OpenVMS only for Uproc and logs files. Default: EDT.
DIR: Company installation directory.
Compulsory for uxadd. Format: 60 alphanumeric characters.
INF: Display option. Confines display to the names of the objects. Alternative value: FULL (by default).
Displays all available information on the list of objects.
OUTPUT: Storage of results.
Chapter 3 Parameter Commands | 25

If the item is not supplied, the output is sent to screen.

3.1.3 Nodes

3.1.3.1 Commands
uxadd NODE: Adds a node to the node table. These commands are presented for compatibility
purposes only. They are inconsequential. The DUAS V6 nodes are created by UVMS.
Item Format Default
TNODE= 64c
LABEL= 64c
MONI | NOMONI NOMONI
DEV | NODEV DEV
PROD | NOPROD PROD
DIR= 60c
XDIR= 60c
SDIR= 60c
IDIR= 60c
ADIR= 60c
DDIR= 60c
PDIR= 60c

Example:
uxadd NODE TNODE=Mickey LABEL=\"Test machine\" DIR="C:\UNIV56"
XDIR="C:\UNIV56\exp\data" SDIR="C:\UNIV56\sim\data"
IDIR="C:\UNIV56\int\data" ADIR="C:\UNIV56\app\data" DDIR="C:\UNIV56\exec"
PDIR="C:\UNIV56\exec"

uxupd NODE: Modifies the characteristics of a node. These commands are presented for
compatibility purposes only. They are inconsequential. The DUAS V6 nodes are synchronized by
UVMS.

Item Format Default


TNODE= 64c *
LABEL= 64c
MONI | NOMONI
DEV | NODEV
PROD | NOPROD
DIR= 60c
XDIR= 60c
SDIR= 60c
IDIR= 60c
ADIR= 60c
DDIR= 60c
PDIR= 60c

Example:
26 | Chapter 3 Parameter Commands

uxupd NODE TNODE=Mickey LABEL=\"Test node\"

uxshw NODE: Displays the characteristics of a node.

Item Format Default


TNODE=* 64c *
OUTPUT=filename

Example:
uxshw NODE TNODE=A*

uxlst NODE: Lists the nodes in the node table.

Item Format Default


TNODE=* 64c * *
INF | FULL FULL
OUTPUT=filename

Example:
uxlst NODE OUTPUT="c:\temp\LstNode.txt"

3.1.3.2 Description of Items


TNODE: Node code. Enter a node code (wildcard accepted except for uxadd).
Format: 64 alphanumeric characters.
LABEL: Label describing the node. Format: 64 alphanumeric characters.
MONI: Central job monitoring node. Default: NOMONI.
DEV: Development site. Default: DEV.
DEV: The node can be used in the Application and Integration areas.
NODEV: The node cannot be used in the Application and Integration areas.
PROD: Production site. Default: PROD.
PROD: The node can be used in the Simulation and Production areas.
NOPROD: The node cannot be used in the Simulation and Production areas.
DIR: Company table installation directory.
Compulsory for uxadd. Format: 60 alphanumeric characters.
ADIR: Application area directory.
Format: 60 alphanumeric characters.
IDIR: Integration area directory.
Format: 60 alphanumeric characters.
SDIR: Simulation area directory.
Format: 60 alphanumeric characters.
XDIR: Production area directory.
Format: 60 alphanumeric characters.
DDIR: Directory of programs in development.
Format: 60 alphanumeric characters.
PDIR: Directory of programs in production.
Format: 60 alphanumeric characters.
Chapter 3 Parameter Commands | 27

INF: Display option. Confines display to the names of the objects. Alternative value: FULL (by default).
Displays all available information on the list of objects.
OUTPUT: Storage of results. If not specified output will be displayed on the screen..

3.1.3.3 Examples
uxshw NODE TNODE=Asterix

Displays the definition of the Asterix node.

3.1.4 Node Variables


The node variables of the node are accessible in the UniViewer Console by selecting Administration>
Nodes>Node Settings>Node Variables category.

3.1.4.1 Commands
uxadd NVAR: add a specific node variable.

Item Format Default


NODE= 64c S_NODE or
S_NODENAME
VARNAME= 256c
VVALUE= 1024c
OVERWRITE=Y | N 1c

Example:
uxadd nvar varname=var1 vvalue=val1

uxupd NVAR: update a node variable value.

Item Format Default


NODE= 64c S_NODE or
S_NODENAME
VARNAME= 256c *
VVALUE= 1024c
OVERWRITE=Y | N 1c Y

Example:
uxupd nvar varname=var1 vvalue=new overwrite=Y

uxdlt NVAR: delete a specific node variable.

Item Format Default


NODE= 64c S_NODE or
S_NODENAME
VARNAME= 256c *

Example:
uxdlt nvar varname=VAR1

uxlst NVAR: lists the node variables.


28 | Chapter 3 Parameter Commands

Item Format Défaut


NODE= 64c S_NODE or
S_NODENAME
VARNAME= 256c * *
OUTPUT=file_name

Example:
uxlst NVAR OUTPUT="c:\temp\LstVarNode.txt"

3.1.4.2 Description of Items


NODE: node code. Format: 64 alphanumeric characters.
VARNAME: node’s variable name. Format: 256 alphanumeric characters. Compulsory except for
uxlst, wildcard accepted except for uxadd
VVALUE: variable’s value. Compulsory for uxadd and uxupd
OVERWRITE: overwrite of the variable’s value if it already exists.
 Y: (by default) the existing value is overwritten by the new value.
 N: The existing value is not overwritten by the new value and the command ends in error (if
the variable already exists).
OUTPUT: Storage of results. If not specified output will be displayed on the screen.
Examples
uxadd NVAR VARNAME=NEW_VAR VVALUE="value"

Create the node variable NEW_VAR with “value” as the value for the current node.
uxupd NVAR VARNAME=NEW_VAR VVALUE="new_value" OVERWRITE=Y

update the node variable NEW_VAR with "new_value" for the value for the current node.

3.1.5 Management Unit Types

3.1.5.1 Commands
uxadd MUT: Create a Management unit type to the MU type table.

Item Format Default


MUT= 1c
LABEL= 20c

Example:
uxadd MUT MUT=A LABEL=Agencies

uxupd MUT: Modifies the characteristics of a Management unit type.

Item Format Default


MUT= 1c *
LABEL= 20c

Example:
uxupd MUT MUT=S LABEL=Stocks

uxshw MUT: Displays the characteristics of a Management unit type.


Chapter 3 Parameter Commands | 29

Item Format Default


MUT= 1c *
OUTPUT=filename

Example:
uxshw MUT MUT=A

uxdlt MUT: Deletes a Management unit type from the type table.

Item Format Default


MUT= 1c *

Example:
uxdlt MUT MUT=T

uxlst MUT: Lists the Management unit types in the type table.

Item Format Default


MUT=* 1c * *
INF | FULL FULL
OUTPUT=filename

Example:
uxlst MUT OUTPUT="c:\temp\LstMut.txt"

3.1.5.2 Description of Items


MUT: Management unit type. Format: 1 alphanumeric character.
Enter a type code (wildcard accepted except for uxadd).
LABEL: Label describing the Management unit type. Format: 20 alphanumeric characters.
INF: Display option. Confines display to the names of the objects.
Alternative value: FULL (by default). Displays all available information on the list of objects
INF and FULL are mutually incompatible.
OUTPUT: Storage of results. If not specified output will be displayed on the screen.

3.1.5.3 Examples
uxadd MUT MUT=A LABEL=Agencies
uxadd MUT MUT=H LABEL=Headquarters

Creates Management Unit types "A", labeled "Agencies", and "H", labeled "Headquarters".
uxlst MUT

Lists all Management unit types defined together with their accompanying labels

3.1.6 Management Units

3.1.6.1 Commands
uxadd MU: Adds a Management unit into the Management unit table.
30 | Chapter 3 Parameter Commands

Item Format Default


MU= 64c
TNODE= 64c
LABEL= 64c
DEV | NODEV DEV
PROD | NOPROD PROD
TZ= +/-4n +0000
USER= 64c

Example:
uxadd MU MU=HEADQUART LABEL=\"Company headquarters\" TNODE=%S_NODENAME%

uxdup MU: Duplicates a Management Unit with all its characteristics

Item Format Default


MU= 64c
TMU= 64c
LABEL= 64c

Example:
uxdup MU MU=HEADQUART TMU=LOCAL LABEL=\"Local Office\"

uxupd MU: Modifies the characteristics of a Management unit.

Item Format Default


MU=* 64c *
TNODE= 64c
LABEL= 64c
DEV | NODEV
PROD | NOPROD
TZ= +/-4n
USER= 64c*

Example:
uxupd MU MU=%S_NODENAME% LABEL=\"Local node\"

uxshw MU: Displays the characteristics of a Management unit.

Item Format Default


MU= 64c *
TNODE= 64c* *
TZ= +/-4n *
USER= 64c* *
OUTPUT=filename

Example:
uxshw MU MU=A_YORK

uxdlt MU: Deletes a Management unit from the Management unit table.

Item Format Default


MU= 64c *
Chapter 3 Parameter Commands | 31

Example:
uxdlt MU MU=S_YORK

uxlst MU: Lists the management units in the Management unit table.

Item Format Default


MU= 64c * *
TNODE= 64c
TZ= +/-4n
INF | FULL | LOCAL INF
USER= 64c *
OUTPUT=filename

Example:
uxlst MU OUTPUT="c:\temp\LstMu.txt"

3.1.6.2 Description of Items


MU: Management Unit code. Format: 64 alphanumeric characters.
Enter a Management Unit code (wildcard accepted except for uxadd and uxdup).
TMU: Enter the Management unit code of the target MU in case of duplication. Format: 64
alphanumeric characters.
LABEL: Label describing the Management Unit. Format: 64 alphanumeric characters.
DEV: Development site. Default: DEV.
DEV: The Management unit can be used in the Application and Integration areas.
NODEV: The Management unit cannot be used in the Application and Integration areas.
PROD: Production site. Default: PROD.
PROD: The Management unit can be used in the Simulation and Production areas.
NOPROD: The Management unit cannot be used in the Simulation and Production areas.
TNODE: Node of residence of management unit. Format: 64 alphanumeric characters.
Compulsory with uxadd, selection criteria with uxshw and uxlst
TZ: Offset between Management Unit time and system time. Selection criteria with uxshw and uxlst.
Format:
 +/-HHMM: "+" or "-" followed by 2 characters for the number of hours and 2 characters for the
number of minutes.
 Or "Continent/Town". The syntax is from IANA (http://www.iana.org/time-zones ). For
example: "America/Montreal", "Europe/Paris", "Asia/Hong_Kong"… Selecting a time zone for
an MU allows a time difference that varies with the summer / winter time without user
intervention. In addition, there is no dependence on the time zone of the machine.

The engines systematically apply this offset: scheduling, creating a launch, restarting an
execution.

USER: Submission account associated to the Management unit by default. Format: 64 alphanumeric
characters.
INF: Display option (by default). Confines display to the names and description of the objects.
Alternative value: FULL
Displays all available information on the list of objects: name, description, node, MU time
offset
32 | Chapter 3 Parameter Commands

If LOCAL is shown, only Management units of the local NODE will be listed.
INF, FULL and LOCAL are mutually incompatible.
OUTPUT: Storage of results. If not specified output will be displayed on the screen.

3.1.6.3 Examples
uxadd MU MU=A_YORK label=\"YORK agency\" TNODE=Mickey
uxadd MU MU=A_BRISTOL label=\"BRISTOL agency\" TNODE=%S_NODENAME%
uxadd MU MU=HEADQUART label=\"Company Headquarters\" TNODE=%S_NODENAME%

creates a type "A" Management Unit, "A_YORK", labeled "YORK agency", on the remote
NODE Mickey, and creates the Management Units "A_BRISTOL" and "HEADQUART" on the
local node.
uxadd MU MU=MU_NY label=\”MU for NY\” TNODE=%S_NODENAME% TZ=-0600
uxadd MU MU=MU_NDL label=\”MU for NDL\” TNODE=%S_NODENAME% TZ=+0300

Both MU_NY and MU_NDL are physically located on a server based in Paris. New York is six
hours behind Paris so the offset for MU_NY will be “–0600”. New Delhi is three hours before
Paris so the offset for MU_NDL will be “+0300”. A Task scheduled to run at 20h on MU_NY
will therefore be calculated to start at 02h00 Paris time. The same task scheduled to run at
20h on MU_NDL will be calculated to run at 17h Paris time.
uxupd MU MU=MU_NY USER=administrator

Updates the MU_NY Management unit by defining the submission account by default:
administrator
uxshw MU MU=A_YORK
Displays the definition of the YORK agency Management Unit
uxshw MU mu=* TZ=+0500

Shows all Management units with an offset of "plus five hours"


uxlst MU LOCAL

Lists Management Units resident on the local node, (thus, YORK agency does not feature
there).

3.1.7 Management Unit Dependencies

3.1.7.1 Commands
uxadd HDP: Adds a dependency to the Management unit dependencies table.

Item Format Default


MU= 64c
DEPMU= 64c

Example:
uxadd HDP MU=HEADQUART DEPMU=A_YORK

uxshw HDP: Displays the characteristics of a dependency.

Item Format Default


MU= 64c *
DEPMU= 64c *
Chapter 3 Parameter Commands | 33

Item Format Default


OUTPUT=filename

Example:
uxshw HDP MU=HEADQUART DEPMU=*

uxdlt HDP: Deletes a dependency from the Management unit dependencies table.

Item Format Default


MU= 64c *
DEPMU= 64c *

Example:
uxdlt HDP MU=A_YORK DEPMU=A_BRISTOL

uxlst HDP: Lists the dependencies in the Management unit dependencies table.

Item Format Default


MU= 64c * *
DEPMU= 64c * *
OUTPUT=filename

Example:
uxlst HDP OUTPUT=c:\temp\LstHdp.txt

3.1.7.2 Description of Items


MU: Management unit origin of the dependency. Format: 64 alphanumeric characters.
Enter a Management unit code (wildcard accepted except for uxadd).
DEPMU: Management unit dependent on the origin Management unit. Format: 64 alphanumeric
characters.
Enter a Management unit code (wildcard accepted except for uxadd).
OUTPUT: Storage of results. If the item is not supplied, the output is sent to screen.

3.1.7.3 Examples
uxadd HDP MU=HEADQUART DEPMU=A_YORK
uxadd HDP MU=HEADQUART DEPMU=A_BRISTOL

Creates a relationship between the HEADQUART management unit and the YORK and
BRISTOL branch management units.
uxlst HDP MU=HEADQUART

Displays relationships list of the Headquarters Management unit

3.1.8 Management Unit Variables

3.1.8.1 Commands
uxadd MUVAR: create a variable for a Management unit.

Item Format Default


MU= 64c
34 | Chapter 3 Parameter Commands

VARNAME= 256c
VVALUE= 1024c
OVERWRITE=Y | N 1c

Example:
uxadd muvar mu=HEADQUART varname=VAR1 vvalue=val1

uxupd MUVAR: update the value of a Management unit variable.

Item Format Default


MU= 64c
VARNAME= 256c *
VVALUE= 1024c
OVERWRITE=Y | N 1c Y

Example:
uxupd muvar mu=HEADQUART varname=VAR1 vvalue=val2 overwrite=Y

uxdlt MUVAR: delete a management unit variable.

Item Format Default


MU= 64c
VARNAME= 256c *

Example:
uxdlt nvar mu=HEADQUART varname=VAR1

uxlst MUVAR: list the management unit variables.

Item Format Default


MU= 64c
VARNAME= 256c * *
OUTPUT=file_name

Example:
uxlst muvar mu=HEADQUART OUTPUT="c:\temp\LstMuVar.txt"

3.1.8.2 Description of Items


MU: Management unit name with the variable. Format: 64 alphanumeric characters.
VARNAME: MU variable name. Format: 256 alphanumeric characters. Compulsory except for uxlst,
wildcard accepted except for uxadd
VVALUE: variable value. Compulsory for uxadd and uxupd
OVERWRITE: overwrite of the variable value if it already exists.
 Y: by default, the existing value is overwritten by the new value.
 N: the existing value is not overwritten by the new value and the command ends in error (if
the variable already exists).
OUTPUT: storage of results. If not specified output will be displayed on the screen.

3.1.8.3 Examples
uxadd MUVAR MU=HEADQUART VARNAME=NEW_VAR VVALUE="value"
Chapter 3 Parameter Commands | 35

Create the MU variable NEW_VAR with the "value" value for the Management unit
HEADQUART.
uxupd MUVAR MU=HEADQUART VARNAME=NEW_VAR VVALUE="new_value" OVERWRITE=Y

Update the NEW_VAR variable with the "new_value" value for the Management unit
HEADQUART.

3.1.9 Domains

3.1.9.1 Commands
uxadd DOM: Adds a domain to the domains table.

Item Format Default


DOM= 1c
LABEL= 64c ""

Example:
uxadd DOM DOM=T LABEL=\"Technical activities\"

uxupd DOM: Modifies the characteristics of a domain.

Item Format Default


DOM= 1c *
LABEL= 64c

Example:
uxupd DOM DOM=V LABEL=\"General services\"

uxshw DOM: Displays the characteristics of a domain.

Item Format Default


DOM= 1c *
OUTPUT=filename

Example:
uxshw DOM DOM=*

uxdlt DOM: Deletes a domain from the domain table.

Item Format Default


DOM= 1c *

Example:
uxdlt DOM DOM=V

uxlst DOM: Lists the domains in the domains table.

Item Format Default


DOM= 1c * *
INF | FULL FULL
OUTPUT=filename

Example:
uxlst DOM OUTPUT="c:\temp\LstDom.txt"
36 | Chapter 3 Parameter Commands

3.1.9.2 Description of Items


DOM: Domain code. Format: 1 alphabetic character.
Enter a domain code (wildcard accepted except for uxadd).
LABEL: Label describing the domain. Format: 64 alphanumeric characters.
INF: Display option. Confines display to the names of the objects. Alternative value: FULL (by default).
Displays all available information on the list of objects
OUTPUT: Storage of results. If not specified output will be displayed on the screen.

3.1.9.3 Examples
uxadd DOM DOM=T LABEL=\"Technical activities\"

Creates a domain T with the label "Technical activities ".


uxlst DOM

Lists the defined domains and their labels

3.1.10 Applications

3.1.10.1 Commands
uxadd APPL: Adds an application into the application table.

Item Format Default


APPL= 64c
LABEL= 64c
DOM= 1c

Example:
uxadd APPL APPL=DB DOM=T LABEL=\"Data Base\"

uxupd APPL: Modifies the characteristics of an application.

Item Format Default


APPL= 64c *
LABEL=
DOM= 1c

Example:
uxupd APPL APPL=BK DOM=T

uxshw APPL: Displays the characteristics of an application.

Item Format Default


APPL= 64c *
OUTPUT=filename

Example:
uxshw APPL APPL=BK

uxdlt APPL: Deletes an application from the application table.


Chapter 3 Parameter Commands | 37

Item Format Default


APPL= 64c *

Example:
uxdlt APPL APPL=DB

uxlst APPL: Lists the applications in the application table.

Item Format Default


APPL= 64c *
INF | FULL FULL
OUTPUT=filename

Example:
uxlst APPL OUTPUT="c:\temp\LstAppl.txt"

3.1.10.2 Description of Items


APPL: Application code. Format: 64 alphanumeric characters.
Enter an application code (wildcard accepted except for uxadd).
LABEL: Label describing the application. Format: 64 alphanumeric characters.
DOM: Code of the domain associated with the application. Format: 1 alphanumeric character.
INF: Display option. Confines display to the names of the objects. Alternative value: FULL (by default).
Displays all available information on the list of objects
INF and FULL are mutually incompatible.
OUTPUT: Storage of results. If not specified output will be displayed on the screen.

3.1.10.3 Examples
uxadd APPL APPL=BK DOM=T LABEL=Backup

Creates an application BK, with the label "Backup", belonging to domain T.


uxshw APPL APPL=BK

Displays the definition of the application Backup

3.1.11 Application Directories

3.1.11.1 Commands
uxadd APD: Adds an application directory into the application directories table.

Item Format Default


APPL= 64c
TNODE= 64c
DDIR= 60c
PDIR= 60c

Example:
uxadd APD APPL=BK TNODE=Mickey DDIR="d:\temp\dev" PDIR="d:\temp\expl"
38 | Chapter 3 Parameter Commands

uxupd APD: Modifies the characteristics of an application directory.

Item Format Default


APPL= 64c *
TNODE= 64c *
DDIR= 60c
PDIR= 60c

Example:
uxupd APD APPL=BK TNODE=%S_NODENAME% PDIR="c:\temp\prod"

uxshw APD: Displays the characteristics of an application directory.

Item Format Default


APPL= 64c *
TNODE= 64c *
OUTPUT=filename

Example:
uxshw APD APPL=BK TNODE=*

uxdlt APD: Deletes an application directory from the application directories table.

Item Format Default


APPL= 64c *
TNODE= 64c *

Example:
uxdlt APD APPL=BK TNODE=Mickey

uxlst APD: Lists the application directories.

Item Format Default


APPL=* 64c * *
TNODE=* 64c * *
DEV | PROD | ALL ALL
OUTPUT=filename

Example:
uxlst APD OUTPUT="c:\temp\LstApd.txt"

3.1.11.2 Description of Items


APPL: Application code. Format: 64 alphanumeric characters.
Enter an application code (wildcard accepted except for uxadd).
TNODE: Node code. Format: 64 alphanumeric characters.
Enter a node code (wildcard accepted except for uxadd).
DEV: Development universe. Displays the development universe applications directories
Mutually exclusive with PROD and ALL
PROD: Production universe. Displays the production universe applications directories
Mutually exclusive with DEV and ALL
ALL: Both universes. Displays the applications directories of both universes
Chapter 3 Parameter Commands | 39

Mutually exclusive with DEV and PROD


DDIR: Development universe directory.
Format: 60 alphanumeric characters.
PDIR: Production universe directory.
Format: 60 alphanumeric characters.
OUTPUT: Storage of results. If not specified output will be displayed on the screen.

3.1.11.3 Examples
uxadd APD APPL=BK TNODE=%S_NODENAME% DDIR=c:\temp\dev PDIR=c:\temp\expl

Creates directories for the application BK on the local NODE. The directory for the
development universe is "c:\temp\dev" and for the production universe, "c:\temp\expl".
uxshw APD APPL=BK TNODE=*

Displays the definition of the directories of the application BK


uxupd APD APPL=BK TNODE=%S_NODENAME% PDIR=c:\temp\prod

Modifies the directory of the application BK on the local node for the production universe in
"c:\temp\prod"
uxlst APD

Lists the defined application directories

3.1.12 Management Unit Directories

3.1.12.1 Commands
uxadd MUD: Adds a management unit directory to the Management unit directories table.

Item Format Default


MU= 64c
APPL= 64c
XDIR= 60c
SDIR= 60c
IDIR= 60c
ADIR= 60c

Example:
uxadd MUD MU=HEADQUART APPL=BK XDIR="c:\temp\BK\exp" SDIR="c:\temp\BK\sim"
IDIR="c:\temp\BK\int" ADIR="c:\temp\BK\app"

uxupd MUD: Modifies the characteristics of a MU directory.

Item Format Default


MU= 64c *
APPL= 64c *
XDIR= 60c
SDIR= 60c
IDIR= 60c
ADIR= 60c
40 | Chapter 3 Parameter Commands

Example:
uxupd MUD MU=HEADQUART APPL=BK XDIR="c:\temp\BK\prod"

uxshw MUD: Displays the characteristics of a MU directory.

Item Format Default


MU= 64c *
APPL= 64c *
APP | INT | SIM | EXP
OUTPUT=filename

Example:
uxshw MUD MU=HEADQUART APPL=*

uxdlt MUD: Deletes a MU directory from the MU directories table. This is done for every area.

Item Format Default


MU= 64c *
APPL= 64c *

Example:
uxdlt MUD MU=HEADQUART APPL=PR

uxlst MUD: Lists, per area, the MU directories.

Item Format Default


MU= 64c * *
APPL= 64c * *
APP | INT | SIM | EXP | ALL ALL
OUTPUT=filename

Example:
uxlst MUD OUTPUT="c:\temp\LstMud.txt"

3.1.12.2 Description of Items


MU: Management unit code. Format: 64 alphanumeric characters.
Enter a management unit code (wildcard accepted except for uxadd).
APPL: Application code. Format: 64 alphanumeric characters.
Entering an Application code (wildcard accepted except for uxadd)
APP: Application area. Displays the access path to the Application area directory
Mutually exclusive with INT, SIM, EXP or ALL
INT: Integration area. Displays the access path to the Integration area directory
Mutually exclusive with APP, SIM, EXP or ALL
SIM: Simulation area. Displays the access path to the Simulation area directory
Mutually exclusive with APP, INT, EXP or ALL
EXP: Production area. Displays the access path to the Production area directory
Mutually exclusive with APP, INT, SIM or ALL
ALL: All areas. Displays the access path to all area directories
Mutually exclusive with APP, INT, SIM or EXP
Chapter 3 Parameter Commands | 41

ADIR: Application area directory.


Format: 60 alphanumeric characters.
IDIR: Integration area directory.
Format: 60 alphanumeric characters.
SDIR: Directory for the Simulation area.
Format: 60 alphanumeric characters.
XDIR: Directory for the Production area.
Format: 60 alphanumeric characters.
OUTPUT: Storage of results. If not specified output will be displayed on the screen.

3.1.12.3 Examples
uxadd MUD MU=HEADQUART APPL=BK XDIR=c:\temp\exp SDIR=c:\temp\sim
IDIR=c:\temp\int ADIR=c:\temp\app

Creates directories for the management unit Headquarters for the application BK. The
directories are, for the application area: "c:\temp\app", for the integration area: "c:\temp\int",
for the simulation area: "c:\temp\sim", and for the production area: "c:\temp\exp".
uxshw MUD MU=HEADQUART APPL=*

Displays the definition of the directories of the headquarters' Management unit

3.1.13 User Profiles


These commands are presented for compatibility purposes only. They are inconsequential for Dollar
Universe V6.

3.1.13.1 Commands
uxadd PROF: Adds a user's profile into the profiles table.

Item Format Default


PROF= 8c
LABEL= 40c

Example:
uxadd PROF PROF=PROFECA LABEL=\"Production test\"

uxupd PROF: Modifies the label of a profile.

Item Format Default


PROF= 8c *
LABEL= 40c

Example:
uxupd PROF PROF=PROFECA LABEL=\"Test of the production\"

uxdlt PROF: Deletes a profile from the profile table.

Item Format Default


PROF= 8c *

Example:
42 | Chapter 3 Parameter Commands

uxdlt PROF PROF=PROFECA

uxlst PROF: Lists the profiles in the profile table.

Item Format Default


PROF= 8c *
OUTPUT=filename

Example:
uxlst PROF PROF=*

uxext AUT: Extracts the complete definition of a profile.

Item Format Default


AUT
PROFIL= 8c *
OUTPUT=filename
REPL
NOVERIF

Example:
uxext AUT PROFIL=* OUTPUT="c:\temp\Profil.ext" REPL

uxins AUT: Inserts the complete definition of a profile in the corresponding Dollar Universe files.

Item Format Default


AUT
PROFIL= 8c *
INPUT=filename
REPL

Example:
uxins AUT PROFIL=* INPUT="c:\temp\Profil.ext"

3.1.13.2 Description of Items


PROFIL: Profile code. Format: 8 alphanumeric characters.
Requires the profile code (wildcard accepted except for uxadd)
LABEL: Label describing the resource. Format: 40 alphanumeric characters.
REPL: Replacement option.
Indicates whether the record extracted (or inserted) deletes and replaces the record that
already exists in the destination file; by default, the extraction (or insertion) is refused for each
record that already exists (indicated by a message in each occurrence).
OUTPUT: Storage of results. The file name is compulsory for the uxext command.
If not specified output will be displayed on the screen.
INPUT: Input file for the uxins command. The file name is compulsory.
NOVERIF: only to be used with the uxext command.
The NOVERIF option forces the command to skip the checking of the output data file before
the insertion of the new records. This enhances the performances and can only be used for
the creation of a new output data file.
Chapter 3 Parameter Commands | 43

3.1.14 Users
These commands using the USER object only target submission accounts. User connection rights
(UVC, commands mode) are defined by UVMS; refer to the UniViewer Administration Manual for the
description of these commands.

3.1.14.1 Commands
uxadd USER: Adds a submission account. In Windows the user service is also created and started (if
the password is furnished).

Item Format Default


USER= 64c
CODE= 3c
PROF= 8c
DEV | PROD | BOTH
TYPE=WIN | OTH
SYSUSER= 256c
SYSPWD= 64c
LABEL= 64c

Example:
uxadd USER USER=eca TYPE=WIN SYSUSER=Administrator SYSPWD=123456

uxupd USER: Modifies the characteristics of a submission account.

Item Format Default


USER= 64c *
PROF= 8c
SYSUSER= 256c
SYSPWD= 64c
LABEL= 64c

Example:
uxupd USER USER=eca SYSUSER=LocalSystem

uxshw USER: Displays the characteristics of a submission account.

Item Format Default


USER= 64c *
TYPE=WIN | OTH *
CODE= 3c *
DEV | PROD | BOTH
OUTPUT=filename

Example:
uxshw USER USER=eca

uxdlt USER: Deletes a submission account. On Windows, the user service is also deleted.

Item Format Default


USER= 64c *
44 | Chapter 3 Parameter Commands

Example:
uxdlt USER USER=eca

uxlst USER: Lists the submission accounts in the user table.

Item Format Default


USER= 64c * *
CODE= 3c *
DEV | PROD | BOTH
INF | FULL FULL
OUTPUT=filename

Example:
uxlst USER OUTPUT="c:\temp\LstUser.txt"

3.1.14.2 Description of itEms


USER: Submission account name in Dollar Universe. Format: 64 alphanumeric characters (wildcard
accepted except for uxadd).
TYPE: User type. WIN for Windows systems, OTH for the other systems. Value by default:
o In Windows: WIN
o For the other systems: OTH
SYSUSER: System user name, it must exist on the system. Format 256 characters. Value by default:
o In UNIX/OpenVMS: identical to USER
o In Windows: LocalSystem
SYSPWD: Only in Windows 32, service user password. Compulsory if SYSUSER is not LocalSystem.
LABEL: description. Format 64 characters max.
CODE: For compatibility only. Author code associated with the user. Format: 3 characters: 0 to 9, A to
Z (uppercase).
PROF: For compatibility only. Profile associated with the user. Format: 8 alphanumeric characters.
DEV: For compatibility only. Type of submission account
For the uxadd command, one of the following three values is compulsory (there is no default
value):
o DEV: The user can only be used as submission account in the Application and Integration
areas.
o PROD: The user can only be used as a submission account in the Simulation and
Production areas.
o BOTH: The user can be used as submission account in every area.
INF: Display option. Confines display to the names of the objects. Alternative value: FULL (by default).
Displays all available information about the list of objects
OUTPUT: Storage of results. If not specified output will be displayed on the screen.

3.1.14.3 Examples
uxadd user user=eca type=WIN sysuser=localsystem

Creates the « eca » submission account on Windows and the service user associated as
LocalSystem
Chapter 3 Parameter Commands | 45

uxadd USER USER=admin

Creates the "admin" submission account.


uxshw USER USER=admin

Displays the admin submission account definition:


Command: uxshw user user=admin

TYPE | user

ITEMS | user : admin


| type : WIN
| prof : PROFADM
| both
| code : ad1
| sysuser : LocalSystem
| syspwd : ******
| user service: STARTED (for LocalSystem)
|

3.2 Uprocs and Sessions

3.2.1 Classes

3.2.1.1 Commands
uxadd CLASS: Adds a class to the class table.

Item Format Default


CLASS= 64c
LABEL= 64c ""

Example:
uxadd CLASS CLASS=UPDATE LABEL=\"General updates\"

uxupd CLASS: Modifies the characteristics of a class.

Item Format Default


CLASS= 64c *
LABEL= 64c

Example:
uxupd CLASS CLASS=EDIT LABEL=\"General printouts\"

uxshw CLASS: Displays the characteristics of a class.

Item Format Default


CLASS= 64c *
OUTPUT=filename

Example:
uxshw CLASS CLASS=EDIT

uxdlt CLASS: Deletes a class from the class table.


46 | Chapter 3 Parameter Commands

Item Format Default


CLASS= 64c *

Example:
uxdlt CLASS CLASS=UPDATE

uxlst CLASS: Lists the classes in the class table.

Item Format Default


CLASS= 64c * *
INF | FULL FULL
OUTPUT=filename

Example:
uxlst CLASS OUTPUT="c:\temp\LstClass.txt"

3.2.1.2 Description of Items


CLASS: Class code. Format: 64 alphanumeric characters.
Enter a Class code (wildcard accepted except for uxadd).
LABEL: Label describing the class. Format: 64 alphanumeric characters.
INF: Display option. Confines display to the names of the objects. Alternative value: FULL (by default).
Displays all available information about the list of objects
OUTPUT: Storage of results. If not specified output will be displayed on the screen.

3.2.1.3 Examples
uxadd CLASS CLASS=EDIT LABEL="Printouts"
uxadd CLASS CLASS=UPDATE LABEL=\"Updates\"

Creates the EDIT class labeled "Editions" and the UPDATE class "Updates".
uxlst CLASS

Lists the defined classes

3.2.2 Resources

3.2.2.1 Commands
uxadd RES: Adds a resource to the resources list.

Item Format Default


RES= 64c
LABEL= 64c ""
NATURE=FIL | LOG | SAE | SAJ | 3c
SCR | SYS | SPM | DSK | PRC | QUE
| SYS
FNAME=filename 60c *
DIR=dir_name 256c *
LOCK | UNLOCK UNLOCK
Chapter 3 Parameter Commands | 47

Item Format Default


CLEAR | NOCLEAR CLEAR
REGEXP | NOREGEXP NOREGEXP
QT1= 4n 0
QT2= 4n 0
FREQ= 30...86400 30
PARAM= 1024c
VALIDITY= 5n 60

Examples:
uxadd RES RES=TESTFILE LABEL=\"Awaiting test file\" NATURE=FIL
DIR=c:\\temp\\ FNAME=TestFile FREQ=30
uxadd RES RES=D_BASE LABEL=\"Base protection\" NATURE=LOG FNAME=!UG!!ESP!
QT1=10 QT2=10 NOCLEAR

uxupd RES: Modifies the characteristics of a resource.

Item Format Default


RES= 64c *
LABEL= 64c
NATURE=FIL | LOG | SAE | SAJ | 3c
SCR | SYS | SPM | DSK | PRC | QUE
| SYS
FNAME=filename 60c *
DIR=dir_name 256c *
LOCK | UNLOCK
CLEAR | NOCLEAR
REGEXP | NOREGEXP
QT1= 4n
QT2= 4n
FREQ= 30...86400

Example:
uxupd RES RES=D_FIL_PAY FNAME=pay_!DTRAIT!

uxshw RES: Displays the definition and allocation of a resource. Refer to section "Resources" on
page 110.
Item Format Default
RES= 64c *
ESP=X | S | I | A | * 1c * " " *
MU= 64c * " " *
TSOC= 6c * " " *
PDATE= YYYYMMDD * " *
"
INF | RSV | FULL INF
OUTPUT=filename

Example:
uxshw RES RES=D_*
48 | Chapter 3 Parameter Commands

uxdlt RES: Deletes a resource.

Item Format Default


RES= 64c *

Example:
uxdlt RES RES=TESTFILE

uxlst RES: Lists the resources.

Item Format Default


RES= 64c * *
INF | FULL FULL
OUTPUT=filename

Example:
uxlst RES OUTPUT="c:\temp\LstRes.txt"

uxext RES: Extracts the complete definition of a resource.

Item Format Default


RES=* 64c *
REPL
OUTPUT=filename
NOVERIF

Example:
uxext RES RES=D_* OUTPUT="c:\temp\Res.ext"

uxins RES: Inserts the complete definition of a resource in the corresponding Dollar Universe files.

Item Format Default


RES=* 64c *
REPL
INPUT=filename

Example:
uxins RES RES=* INPUT="c:\temp\Res.ext"

3.2.2.2 Description of Items


RES: Resource reference. Format: 64 alphanumeric characters.
Requires the reference of the resource (wildcard accepted except for uxadd)
LABEL: Label describing the resource. Format: 64 alphanumeric characters.
NATURE: Defines the nature of the resource. In UNIX, Windows and OpenVMS, the possible values
are FIL (file), LOG (logical), SAE (SAP event), SAJ (SAP job), SCR (script), SYS (System). SPM (SP
Monitor) is only available on UNIX and Windows.
FNAME: File or resource name. Format: 60 characters max.
Enter the file name associated with a resource of the nature FIL or SCR or, if using a logical
resource, enter the name of a "virtual file" used for checking the resource.
This name may contain the variables !UG! or !MU!, !DTRAIT! or !PDATE!, !ESP! or !AREA!
and !SOC! or !COMP! which will be translated during the associated Uproc's condition check
(depending on the execution context). It can also contain the wildcard "*".
Chapter 3 Parameter Commands | 49

If the nature of the resource is FIL:


o The variables !APP!, !SESS! and !UPR! can also be used.
o The name may contain any variables if they are entered between exclamation marks, for
example !VARIABLE!.
o Used with the keyword REGEXP, this field corresponds to a regular expression.
REGEXP | NOREGEXP: Indicates that a regular expression is used to parse for a file or files. The
default value is NOREGEXP.
The following characters are supported for regular expressions:
o A wildcard: any character “.”
o Repeat: zero or more occurrences of previous character or class “*”
o Line positions: beginning of line “^”
o Line position: end of line “$”
o Character class: any one character in set. Example: [clas]
o Inverse class: any one character not in set. Example: [^clas]
o Range: any characters within the specified range. Example: [0-9]
o Escape: literal use of metacharacter “x”. Example: \x
o Word position: beginning of word. Example: \<xyz
o Word position: end of word. Example: xyz\>
FREQ: Supervisor verification cycle.
The format for the verification period is 30 to 86400 seconds. The default value is 30 s.
PARAM: (For a Script-type resource only) corresponds to the list of parameters to be passed to the
script during its execution.
 Parameters must be separated by spaces.
 They can contain variable elements of Dollar Universe (! UG!,! DTRAIT!, "SOC" and "ESP").
 They may contain variables known to the execution environment of Uproc.
 The maximum length is 60 characters. Once the values are defined, they cannot be more
than 1024 characters.
VALIDITY: For a Script-type resource, the validation frequency is the period during which the return
code of the script will be considered valid for checking the condition of the resource. The time validity
value must be superior to the supervisor verification cycle.
DIR: File location. For a resource of the FIL and SCR nature only, accepts the file access path.
Format: 256 characters max.
This name may contain the variables !UG!, !DTRAIT!, !ESP! and !SOC! that will be translated
during the associated Uproc's condition check (depending on the execution context). It can
also contain the wildcard "*".
UNLOCK: Allocate the resource. Use of LOCK is incompatible with QT1 or QT2.
Indicates that the associated Uproc will be able to assign itself all or part of the resource
quotas
If the key word LOCK is used, the associated Uproc will assign itself the totality of the
resource quotas during execution, preventing any other Uproc conditioned by the same
resource from running simultaneously.
QT1 or QT2: Allocation quotas (levels 1 and 2 respectively). Format: from 0 to 9999.
50 | Chapter 3 Parameter Commands

In the uxadd or uxupd commands, enable the definition of maximum quotas which may be
assigned during the execution of a uxhld command or during the execution of a Uproc
conditioned by this resource. The use of QT1 and QT2 is incompatible with LOCK.
CLEAR: Resource de-allocation. Releases the selected resource
In the uxadd or uxupd commands, resources will only effectively be released upon
completion of the conditioned Uproc. The conditioned Uproc will release only those quotas
which it previously held.
NOCLEAR indicates that the resource quota held will not be released when the conditioned
Uproc completes: The uxrls command must be run to de-allocate the resource.
INF: Technical information. Displays the resource definition information
Other values: FULL and RSV; see section "Resources" on page 110.
The three items are mutually incompatible.
REPL: Replacement option.
Indicates whether the record extracted (or inserted) deletes and replaces the record that
already exists in the destination file; by default, the extraction (or insertion) is refused for each
record that already exists (indicated by a message in each occurrence).
OUTPUT: Storage of results. The file name is compulsory for the uxext command.
If not specified output will be displayed on the screen.
INPUT: Input file for the uxins command. The file name is compulsory.
NOVERIF: Only to be used with the uxext command.
The NOVERIF option forces the command to skip the checking of the output data file before
the insertion of the new records. This enhances the performances and can only be used for
the creation of a new output data file.

3.2.2.3 Examples
uxadd RES RES=D_FIL_PAY LABEL=\"Awaiting pay file\" NATURE=FIL
FNAME=paye_!DTRAIT! DIR=c:\temp\ LOCK CLEAR
uxadd RES RES=D_BASE LABEL=\"Base protection \" NATURE=LOG FNAME=!UG!!ESP!
DIR=c:\temp QT1=10 QT2=10 NOCLEAR
Creates two resources:
o The resource D_FIL_PAY which indicates the arrival of the file c:\temp\paye_!DTRAIT!.
This resource is exclusive and release is automatic when the conditioned Uproc
completes.
o The resource D_BASE concerns protection of access to a base. This is a logical resource
specific to the area and to the Management unit executing the conditioned Uproc. It can
be shared and must be released by a uxrls command in a Uproc script.
uxadd RES RES=D_FILE LABEL=\"file search\" nature=FIL FNAME= a[1-8][1-
8][a|b].[.]txt DIR=c:\temp

Creates the resource D_FILE which uses a regular expression to parse for files in the
directory c:\temp. The resource parses for files that start with “a”, followed by two numbers,
each between 1 and 8, “a” OR “b”, any character and the file extension .txt.
The following files would match these criteria:
a34br.txt
a51a8.txt
The following files would not match these criteria:
a81a8.txt
Chapter 3 Parameter Commands | 51

a34de.txt
uxshw RES RES=D_*

Displays the definition of the previously created resources


uxext RES RES=D_* output=c:\temp\DOC.ext

Extracts all resources beginning with D_ from the current environment and archives the data
in the file c:\temp\DOC.ext.
uxins RES RES=* input=c:\temp\DOC.ext

Inserts all resources of file c:\temp\DOC.ext in the current environment (Company, node)

3.2.3 Uprocs

3.2.3.1 Commands
uxadd UPR: Adds a Uproc into the Uprocs list: only general information is defined. Additional
information will be entered by updating the Uproc (uxupd).

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
UPR= 64c
VUPR= 64n
LABEL= 64c ""
FPERIOD=N | D | W | T | F | M | 2 | 3 | Q | S | Y 1c N
UPT=CL_INT | CL_EXT | CMD | FTP_GET | 10c CL_INT
FTP_PUT…
CLFIL=filename 128c
CL_INT=filename 256c
COMMAND= 256c
EXECDIR= 256c
SHELL= 512c
SHELLARG= 256c
DOM= 1c
APPL= 64c
CLASS= 64c
MEMO=N | O | A 1c N
NBPER= 2n 0
RETRY=(NNN,MM)
DEFINFO= 50c “”
DEFSEV= 4n “” or 0
INTERACTIVE I NONINTERACTIVE NONINTERACTIV
E

Examples:
uxadd UPR EXP UPR=D_LOAD_FIL LABEL=\”Loading of file\” FPERIOD=W APPL=BK
MEMO=O NBPER=1 UPT=CL_EXT CLFIL=”c:\temp\D_LOAD_FIL.bat”
uxadd UPR EXP UPR=CMD_UPR LABEL=\”My Command Uproc\” UPT=CMD COMMAND=netstat
EXECDIR=/temp FPERIOD=D APPL=EJ MEMO=O NBPER=1
52 | Chapter 3 Parameter Commands

uxupd UPR: Modifies a Uproc’s general information: Defines additional characteristics such as
conditions, completion instructions, incompatibilities.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
UPR= 64c *
VUPR= 64n *

Only one of the families described here can be used in the uxupd command.
GENINF: General information.

Item Format Default


LABEL= 64c
FPERIOD=N | D | W | T | F | M | 2 | 3 | Q | S | Y 1c
UPT=CL_INT | CL_EXT | CMD | FTP_GET | FTP_PUT… 10c
CLFIL=filename 128c
CL_INT=filename 256c
COMMAND= 256c
EXECDIR= 256c
SHELL= 256c
SHELLARG= 256c
DOM= 1c
APPL= 64c
CLASS= 64c
MEMO=N | O | A 1c
NBPER= 2n
RETRY=(NNN,MM) (3n, 2n)
DEFINFO= 50c
DEFSEV= 4n
INTERACTIVE I NONINTERACTIVE
DIR_FILES= 256c

Example:
uxupd UPR EXP UPR=D_LOAD_FIL GENINF FPERIOD=D

UPR_STATUS: Determines the way the Uproc’s completion status will be handled.

Item Format Default


ENABLE=Y|N|y|n 1c
SET=C|A 1c C
RETCODE=value[,EQ | LO | GT | NE] 4n[,2c]
EXT_RETCODE=n1;n2;[n3,n4];[n5,n6]/n7 64c
STRING= 128c
SEARCH_FILE= 256c Job log

Examples:
uxupd UPR EXP UPR=STATUS_UPR UPR_STATUS ENABLE=Y SET=A RETCODE=0.LO
uxupd UPR EXP UPR=STATUS_UPR UPR_STATUS ENABLE=N
Chapter 3 Parameter Commands | 53

uxupd UPR EXP UPR=STATUS_UPR UPR_STATUS ENABLE=Y SET=C STRING=Execution_OK


SEARCH_FILE=/data/result_file.txt

CTLDUR: Launch duration control of a Uproc.

Item Format Default


MAXDUR= (HHHMMSS|3n,K | F | C=256c) | NONE
MINDUR= (HHHMMSS|3n,R | C=256c) | NONE
MAXWDUR= (HHHMMSS|3n,F | A | C=256c) | NONE

Examples:
uxupd upr upr=MY_UPROC ctldur maxdur="(0010203,F)"
uxupd upr upr=MY_UPROC ctldur maxdur="(0010203,R)"
uxupd upr upr=MY_UPROC ctldur maxdur="(0010203,C=C:\my\own\script.bat)"
uxupd upr upr=MY_UPROC ctldur maxdur=NONE

NOTIFY: Sets up e-mail notification on completion or launch of a Uproc.

Item Format Default


MAIL=Y|N 1c N
COMPLETED=Y|N 1c N
ABORTED=Y|N 1c N
REFUSED=Y|N 1c N
TIMEOVERRUN=Y|N 1c N
JOBLOG=Y|N|value 1c | 4n N
RECIPIENT="email1;email2…" 256c empty

Example:
uxupd UPR EXP UPR=DEF_UPR NOTIFY MAIL=Y ABORTED=Y REFUSED=Y JOBLOG=400
recipient="admin@Automic.com;admin_du@Automic.com"

LAUNCHVAR add: Adds variables.

Item Format Format Format Format


VARNAME= 20c 20c 20c 20c
VTYPE=D | Q | T | P D Q P T (default)
VFORMAT= "YYYY/MM/DD" 3n (length) 3n (length)
"MM/DD/YYYY"
"DD/MM/YYYY"
VALMIN= 12n
VALMAX= 12n
VVALUE= "10c" 12n 256c 256c

Examples:
uxupd UPR EXP UPR=D_LOAD_FIL LAUNCHVAR add VARNAME=VARDATE VTYPE=D
VFORMAT="YYYY/MM/DD" VVALUE="2002/07/01"
uxupd UPR EXP UPR=D_LOAD_FIL LAUNCHVAR add VARNAME=VARNUM VTYPE=Q VVALUE=123
uxupd UPR EXP UPR=D_LOAD_FIL LAUNCHVAR add VARNAME=VARTXT VVALUE=\"Last
var\"
uxupd UPR EXP UPR=D_LOAD_FIL LAUNCHVAR add VARNAME=PASSWD VTYPE=P
VVALUE=MyPassword

LAUNCHVAR dlt: Deletes variables.


54 | Chapter 3 Parameter Commands

Item Format Default


VARNAME= 20c

Example:
uxupd UPR EXP UPR=D_LOAD_FIL LAUNCHVAR dlt VARNAME=VARTXT

INCCLASS add: Adds incompatibility classes.

Item Format Default


XCLASS= 6c

Example:
uxupd UPR EXP UPR=D_LOAD_FIL INCCLASS add XCLASS=BACKUP

INCCLASS dlt: Deletes incompatibility classes.

Item Format Default


XCLASS= 6c

Example:
uxupd UPR EXP UPR=D_LOAD_FIL INCCLASS dlt XCLASS=BACKUP

TERMINS add: Adds completion instructions.

Item Format Default


TERMNO= 2n
TERM= 64c
PDATE= ANY | SAME | (±n,n,n) | (a, ,n) SAME
MU= SAME | "mu(MU_CODE)" | "mut(T)" | "hdp({XY})" SAME
SESS= ANY | SAME | SAMERUN | expl(SESS_CODE) ANY
USER= any | same ANY
STATUS= terminated | abnormal TERMINATED

Example:
uxupd UPR EXP UPR=D_LOAD_FIL TERMINS add TERMNO=01 TERM=D_LOAD_FIL PDATE="(-
1,,)" STATUS=ABNORMAL

TERMINS dlt: Deletes completion instructions.

Item Format Default


TERMNO= 2n

Example:
uxupd UPR EXP UPR=D_LOAD_FIL TERMINS dlt TERMNO=01

DEPCON add: Adds a dependency condition.

Item Format Default


CONDNO= 2n
DEP= 64c
PDATE= ANY | SAME | (±n,n,n) | (a, ,n) SAME
DTYPE= A|W|C|H
MU= SAME | "mu(MU_CODE)" | "mut(T)" | "hdp({XY})" SAME
ONE | ALL ONE
SESS= ANY | SAME | SAMERUN | expl(SESS_CODE) ANY
Chapter 3 Parameter Commands | 55

Item Format Default


USER= ANY | SAME ANY
STATUS= TERMINATED | ABNORMAL | ABSENT TERMINATED
EXPECT | EXCLUD EXPECT
NOFATAL | FATAL NOFATAL

Examples:
uxupd UPR EXP UPR=D_BACKUP DEPCON add CONDNO=01 DEP=D_LOAD_FIL
MU="mu(SATURN)"
uxupd UPR EXP UPR=D_BACKUP DEPCON add CONDNO=02 DEP=D_LOAD_FIL
MU="hdp({AH})"

DEPCON dlt: Deletes dependency condition. The launch formula must be updated first with the
complete new launch formula.

Item Format Default


CONDNO= 2n

Example:
uxupd UPR EXP UPR=D_BACKUP DEPCON dlt CONDNO=01

INCCON add: Adds incompatibility condition.

Item Format Default


CONDNO= 2n
INC= 64c
PDATE= SAME | ANY SAME
MU= SAME | "mu(MU_CODE)" | "mut(T)" | "hdp({XY})" SAME
SESS= ANY | SAME | SAMERUN | expl(SESS_CODE) ANY
USER= ANY | SAME ANY
EXPECT | EXCLUD EXPECT
NOFATAL | FATAL NOFATAL

Example:
uxupd UPR EXP UPR=D_BACKUP INCCON add CONDNO=01 INC=D_BACKUP PDATE=ANY

INCCON dlt: Deletes incompatibility condition. The launch formula must be updated first with the
complete new launch formula.

Item Format Default


CONDNO= 2n

Example:
uxupd UPR EXP UPR=D_BACKUP INCCON dlt CONDNO=02

RESCON add: Adds resource condition.

On Solaris (intel and sparc) in order to access the parsing feature for resource conditions, the
command /usr/xpg4/bin/grep must be available.

Item Format Default


CONDNO= 2n
RES= 64c
PDATE= ANY | SAME | (±n,n,n) | (a, ,n) SAME
56 | Chapter 3 Parameter Commands

Item Format Default


DTYPE= A|W|C|H
MU= SAME | "mu(MU_CODE)" | "mut(T)" | "hdp({XY})" SAME
ONE | ALL ONE
VERIF | NOVERIF VERIF
UNLOCK | LOCK UNLOCK
EXPECT | EXCLUD EXPECT
NOFATAL | FATAL NOFATAL
ATTRIB= EXIST | SIZE | DATEUNCHANGE |
SIZEUNCHANGE | DATCREA | DATMOD |
GROUP | PARSING
OPER= # | = | < | > | <= | >= | ~=
VALUE= 255c
QT1= 4n 0
QT2= 4n 0

Example:
uxupd UPR EXP UPR=D_LOAD_FIL RESCON add CONDNO=01 RES=D_FIL_PAY

RESCON dlt: Deletes resource condition. The launch formula must be updated first with the complete
new launch formula.
Item Format Default
CONDNO= 2n

Example:
uxupd UPR EXP UPR=D_LOAD_FIL RESCON dlt CONDNO=03

SUCCESSOR add: Creates a successor Uproc

Item Format Default


SUCC_UPR= 64c

Example:
uxupd UPR EXP UPR=UPROC_1 SUCCESSOR add SUCC_UPR=D

SUCCESSOR dlt: Deletes a successor Uproc

Item Format Default


SUCC_UPR= 64c

Example:
uxupd UPR EXP UPR=UPROC_1 SUCCESSOR dlt SUCC_UPR=D

FORMULA: Launch formula.

Item Format Default


LFORM= 255c

Example:
uxupd UPR EXP UPR=D_LOAD_FIL FORMULA LFORM=\"=C01 AND =C02\"

FTP_GET: Retrieve files by FTP.


Chapter 3 Parameter Commands | 57

Item Format Default


PARTNER= 16c
ORIGIN_FILENAME= 256c ""
ORIGIN_PATHNAME= 256c
TARGET_FILENAME= 256c ""
TARGET_PATHNAME= 256c
LOGON= 32c anonymous
PASSWORD= 32c
MODE=ASCII | BINARY ASCII
ACTION=REPLACE | ABORT | NONE ABORT
CRLF | NOCRLF Flag NOCRLF
DELETE | NODELETE Flag NODELETE
NEWER | NONEWER Flag NONEWER
RECURSIVE | NORECURSIVE Flag NORECURSIVE
BUFFER_SIZE= 2n 32
RETRY= 1c
UMASK= 3c

Example:
uxupd UPR EXP UPR=GET_FILES FTP_GET PARTNER=”WinXP” ORIGIN_PATHNAME=”/tmp/”
CRLF TYPE=BINARY UMASK=700 ACTION=REPLACE RETRY=3

FTP_PUT: Send files by FTP.

Item Format Default


PARTNER= 16c
ORIGIN_FILENAME= 256c ""
ORIGIN_PATHNAME= 256c
TARGET_FILENAME= 256c ""
TARGET_PATHNAME= 256c
LOGON= 32c anonymous
PASSWORD= 32c
MODE=ASCII | BINARY ASCII
ACTION=REPLACE | ABORT | APPEND | ABORT
NONE
DELETE | NODELETE Flag NODELETE
NEWER | NONEWER Flag NONEWER
RECURSIVE | NORECURSIVE Flag NORECURSIVE
BUFFER_SIZE= 2n 32
RETRY= 1c

Example:
uxupd UPR EXP UPR=PUT_FILE FTP_PUT PARTNER=”192.168.1.100”
ORIGIN_FILENAME=”data.txt” TARGET_PATHNAME=”/tmp/” ACTION=ABORT

uxdup UPR: Duplicates an Uproc with all its characteristics. If this Uproc has an internal script, it is
also duplicated.
58 | Chapter 3 Parameter Commands

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
UPR= 64c
VUPR= 3n
TUPR= 64c
TVUPR= 3n
TLABEL 64c

Example:
uxdup UPR EXP UPR=IU_TEST VUPR=000 TUPR=IU_TEST2 TVUPR=000
TLABEL=\"Duplicated Uproc\"

uxshw UPR: Displays the characteristics of a Uproc (its script if internal), its variables (the password
type variables values are displayed as stars *******), its launch formula and the details of the
conditions. In order to avoid displaying the (internal) script, the node setting
U_UPR_SCRIPT_NODISP (Advanced Settings category) can be used. Refer to the UniViewer
Interface for Dollar Universe Manual.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
UPR= 64c *
VUPR= 3n *
DOM= 1c *
APPL= 64c *
SCRIPT
OUTPUT=filename

Example:
uxshw UPR EXP UPR=D_LOAD_FIL

uxdlt UPR: Deletes a Uproc.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
UPR= 64c *
VUPR= 3n *

Example:
uxdlt UPR UPR=TEST*

uxlst UPR: Lists the Uprocs.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
UPR= 64c * *
VUPR= 3n * *
DOM= 1c * *
APPL= 64c * *
INF | FULL FULL
OUTPUT=filename

Example:
Chapter 3 Parameter Commands | 59

uxlst UPR OUTPUT="c:\temp\lstUpr.txt"

uxtra UPR: Transfers the Uprocs to another area (same company and same node).

Item Format Default


APP | INT | SIM 3c S_ESPEXE
UPR= 64c *
VUPR 3n *
TESP= I|S|X

Example:
uxtra UPR app UPR=D_* TESP=X

uxscv UPR: Defines the current version of a Uproc (in the application or integration area only).

Item Format Default


INT | APP 3c S_ESPEXE
UPR= 64c *
VUPR= 3n *

Example:
uxscv UPR APP UPR=D_* VUPR=002

uxrls UPR: Unlocks a Uproc.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
UPR= 64c *
VUPR= 3n *

Example:
uxrls UPR UPR=*

uxext UPR: Extracts the complete definition of a Uproc (with its CL if this was declared internal).

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
UPR= 64c *
VUPR= 3n *
REPL
ENABLE | NOENABLE ENABLE
OUTPUT=filename
NOVERIF

Example:
uxext UPR EXP UPR=D_* OUTPUT="c:\temp\upr.ext"

uxins UPR: Inserts the complete definition of a Uproc in the corresponding Dollar Universe files (with
its CL).

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
UPR= 64c *
VUPR= 3n *
60 | Chapter 3 Parameter Commands

Item Format Default


REPL
ENABLE | NOENABLE ENABLE
INPUT=filename

Example:
uxins UPR EXP UPR=* INPUT=c:\temp\upr.ext

If Uprocs were extracted from production or simulation areas (version 000), they can now be inserted
in integration or application areas by prior definition of the new value of the Uproc version
(S_VUPR_REINSERT node setting, Command Interface Settings category):
S_VUPR_REINSERT=XYZ

XYZ is the new value of the Uproc version. It should be at least 001 to be inserted in
integration or application areas.

All the following insertion commands will use this setting to define the version of the inserted
Uprocs (whatever the target area).

3.2.3.2 Families
Only one of the families described here can be used in the uxupd command.

Family Description
GENINF Enables a Uproc’s general information to be updated.
CTLDUR Allows update of duration control information for the lauch of a Uproc.
UPR_STATUS Determines the way the Uproc’s completion status will be handled.
NOTIFY Sets up e-mail notification on launch or completion of the Uproc.
LAUNCHVAR Enables Uproc variables to be created, to be assigned values, or to be deleted.
INCCLASS Defines the classes with which a Uproc is incompatible. The Uprocs membership class is
defined in its general information.
TERMINS Defines the events which will be purged upon completion of the Uproc.
DEPCON Defines the conditions of dependency upon other Uprocs together with the corresponding
details.
RESCON Defines resource conditions together with the corresponding details.
INCCON Defines conditions of incompatibility with individual Uprocs together with the corresponding
details.
FORMULA Defines or updates the Uproc's launch formula. This family must be used whenever a
condition has been added or deleted in order to redefine the effective order of examination
during the condition checking phase of the launch.
SUCCESSOR Defines the order of consideration for the successors of the current Uproc.
FTP_GET Defines a FTP_GET Uproc.
FTP_PUT Defines a FTP_PUT Uproc.

3.2.3.3 Description of Items


UPR: Uproc code. Format: 64 alphanumeric characters.
Requires a Uproc code (wildcard accepted except for uxadd).
TUPR: Uproc code, result of the duplication. Format: 64 alphanumeric characters.
VUPR: Uproc version. Accepts a Uproc version (explicit value). Format: 3 numeric characters.
Chapter 3 Parameter Commands | 61

By default, for the uxext command, all versions of the Uprocs entered are extracted
(irrelevant for SIM and EXP areas).
For other commands, the version is compulsory in the APP and INT areas; it is not ignored in
the SIM and EXP areas (systematically equal to 000).
TVUPR: Uproc version, result of the duplication. Format: numeric characters.
DOM: Domain code. Format: 1 alphanumeric character.
Enables the selection of Uprocs associated with a domain.
APPL: Application code. Format: 64 alphanumeric characters.
Enables the selection of Uprocs associated with an Application (wildcard accepted).
LABEL: Label describing the Uproc. Format: 640 alphanumeric characters.
TLABEL: Uproc label, result of the duplication. Format: 64 alphanumeric characters.
FPERIOD: Functional period.
Indicates the processing date format that will be associated with execution of the Uproc
Possible values are: N: none, D: day, T: ten days, W: week, F: two weeks, M: month, 2: two
months, 3: three months, Q: four months, S: six months, Y: year.
UPT: Uproc type.
For a Uproc with internal CL, enter CL_INT. For a Uproc with external CL, enter CL_EXT, for
a Command type Uproc, enter CMD. Select FTP_GET or FTP_PUT for file transfers. Other
types will be available depending on the Dollar Universe Managers installed.
CLFIL: external CL file associated with the Uproc. May only be used with the Uproc type CL_EXT.
Format: 128 characters maximum
Indicates the access path and name of the procedure associated with the Uproc
CL_INT: path targeting a single file whose contents will be copied as an internal script for a CL_INT
type Uproc.
COMMAND: command line to be executed. May only be used with the Uproc type CMD. Format: 256
characters maximum. The command line must include:
o The path to the command (otherwise the directories of the PATH variable will be
searched for the command),
o The command and its arguments.
The command path and arguments may contain variables using the syntax: !VARIABLE!.
Refer to the reference manual for how to manipulate these variables.
EXECDIR: execution directory of the command line. May only be used with the Uproc type CMD.
By default, this is the home directory of the submission account executing the Uproc. Format:
258 characters maximum.
SHELL: shell used to execute the Uproc command. For example: "/bin/sh". This item only applies to
Uprocs of type CMD.
For example: SHELL=/usr/bin/ruby
SHELLARG: optional arguments of this shell. This item only applies to Uprocs of type CMD.
For example: SHELLARG="-e !CMD!"
When the Uproc runs, The command becomes: "/usr/bin/ruby -e !CMD!" (!CMD! being the
command defined in the Uproc).
If the command in the Uproc is: sleep(10), the command line is:
/usr/bin/ruby -e sleep(10)
DOM: Domain code. Format: 1 alphanumeric character.
Indicates the domain with which the Uproc is associated.
62 | Chapter 3 Parameter Commands

APPL: Application code. Format: 64 alphanumeric characters.


Indicates the application with which the Uproc is associated.
CLASS: Uproc membership class. Format: 64 alphanumeric characters.
Indicates the Uproc's membership class.
MEMO: Memorization of the Uproc.
Indicates how the Uproc is memorized in the operations events file. Three values are
possible:
o N: not memorized (default value).
o O: one execution.
o A: all executions.
Whenever the Uproc is memorized (O or A selection), the item NBPER must also be supplied.
NBPER: Number of Uproc periods memorized. Format: 2 numeric characters.
Indicates the number of periods (functional) for which events will be kept in the operations
events file.
The default value is: 0 (without limit).
RETRY: If the keyword is used: when the Launcher determines that the job in question finishes with
an “aborted” status, the Launcher will re-run the job until it completes successfully. Format (NNN,MM),
where:
o NNN: is the maximum number of retries. Maximum 999.
o MM: is the interval in minutes between each retry. From the end of the previous run and
the start of the next. If the value is 0, the retry will be immediate. Maximum=59 minutes.
DEFINFO: default value of the Uproc’s Information parameter, which is shown in the job monitor.
Free text truncated to 50 characters if longer. Optional, empty by default
DEFSEV: default value of the Uproc’s Severity parameter, which is shown in the job monitor.
Integer from 0000 to 9999 on 4 digits. Optional, empty by default
INTERACTIVE: In Windows only, the Job is submitted in interactive mode by the "Interactive
Desktop" service.
NOINTERACTIVE: The job is submitted in batch mode through the service user's submission
account. If no service user is available, the system attempts to submit the job interactively
through the "Interactive Desktop" service.
DIR_FILES: path targeting a directory in which the content will be copied as Uproc files.
ENABLE: enables or disables management of the Uproc’s completion status.
Can only be used with the STATUS family. Compulsory. Format: 1 character: Y, y, N, n.
Y or y: enables management of the completion status
N or n: disables management of the completion status
SET: new completion status of the Uproc if the defined rule is true.
Can only be used with the STATUS family. Format: 1 character: C (status Completed, default
value) or A (status Aborted).
RETCODE: test the Uproc’s script return code (on UNIX/OpenVMS) or the variable RESEXE (on
Windows).
Can only be used with the STATUS family. Incompatible with EXT_RETCODE, STRING and
SEARCH_FILE. Mandatory. Format: 4n[,2c].
Value: expected return code. Positive or negative integer. Compulsory
Chapter 3 Parameter Commands | 63

Direction: value test operator. Optional, the default value is EQ (equal). The possible values
are: EQ (equal), GT (greater than), LO (less than) or NE (not equal).
EXT_RETCODE: test the Uproc’s script return code (on UNIX/OpenVMS) or the variable RESEXE
(on Windows).
 Can only be used with the STATUS family. Incompatible with RETCODE, STRING and
SEARCH_FILE. Mandatory. Format: n1;n2;[n3,n4];[n5,n6]/n7 up to 64 characters maximum.
The list of values can contain:
o A simple value. Format: * or a positive or negative integer.
Example: -2
o A range of positive or negative integers. format: [min,max],
Example: [-10,10]: from -10 to 10 inclusive.
o Values calculated from a multiple: Format N/m
Example: */3: all multiples of 3 (including negatives).
o Values calculated within a range using a specific multiple (m): format [min.max]/m
Example: [1,10]/4: 4 and 8.
Each of the values or ranges must be separated by a colon. The whole list should not exceed
64 characters. For example:
-2;[-10,10];*/3;[1,10]/4
STRING: test for the presence of a character string in the file specified by the item SEARCH_FILE.
Can only be used with the STATUS family. Incompatible with RETCODE and
EXT_RETCODE. Mandatory. Format: 128 characters. If the string includes spaces, it must be
enclosed in quotes.
SEARCH_FILE: file to be searched for the character string STRING.
Can only be used with the STATUS family. Incompatible with RETCODE and
EXT_RETCODE. Optional, by default the Uproc’s job log is used. Format: 256 characters. If
the string includes spaces, it must be enclosed in quotes.
MAXDUR: controls run time that lasts too long. Format: (HHHMMSS, K | F | C = 256c) or NONE to
reset the value. If the specified time (HHHMMSS) is reached before the termination of the Uproc, the
chosen action is executed:
 K: stop the Uproc
 F: force the status to completed
 C: launch the script specified: Enter the path and name of the script to run (maximum 256
characters).
MINDUR: controls run time that’s too short. Format: (HHHMMSS, R | C = 256c) or NONE to reset the
value. If the Uproc finishes before the specified time (HHHMMSS), the chosen action is executed:
 R: resumption of Uproc
 C: executes the script specified: Enter the path and name of the script to run (maximum 256
characters)
MAXWDUR: controls a wait period before the execution. Format: (HHHMMSS,F | A | C=256c) or
NONE to reset the value. If the allowed wait time (HHHMMSS) prior to execution is exceeded, the
designated action is triggered.
 F: force the status to Completed
 A: force the status to Aborted
 C: executes the script specified: Enter the path and name of the script to run (maximum 256
characters).
64 | Chapter 3 Parameter Commands

REPL: Replacement option.


Indicates whether the record extracted (or inserted) deletes and replaces the record already
existing in the destination file; by default, extraction (or insertion) is refused for each existing
record (indicated by a message at each occurrence).
ENABLE: Unlock option. Default value.
Indicates whether the Uproc will be inserted in a locked or unlocked state. Unlocking (Option
06) will be necessary before any modification to a Uproc if the object is inserted with the
qualifier NOENABLE.
MAIL: enables e-mail notification for this Uproc. Format: Y or N.
Y (yes): enables e-mail notification when a selected status (see below) occurs.
N (no): disables e-mail notification. Default value.
COMPLETED: Format: Y or N (default). Indicates whether the Completed status is to trigger e-mail
notification (value Y: yes).
ABORTED: Format: Y or N (default). Indicates whether the Aborted status is to trigger e-mail
notification (value Y: yes).
REFUSED: Format: Y or N (default). Indicates whether the Refused status is to trigger e-mail
notification (value Y: yes).
TIMEOVERRUN: Format: Y or N (default). Indicates whether the Time overrun status is to trigger e-
mail notification (value Y: yes).
JOBLOG: Indicates whether the log of the Uproc is to be attached to the e-mail. Format:
o N: default value, the log of the Uproc is not attached to the e-mail sent.
o Y: the log of the Uproc is not attached to the e-mail sent, whatever its size.
o 4 numerical characters: the log of the Uproc is not attached to the e-mail provided that its
size does not exceed the value indicated in kilobytes.
RECIPIENT: List of recipient e-mail addresses for the notification. To use more than one address on
Unix, it is compulsory to put the list in quotes “ “ (optional for windows).
Format: 256 characters maximum: "email1;email2;…"
VARNAME: A variable’s name. Format: 20 alphanumeric characters.
Requires the name of a Uproc variable to be entered. Data input is compulsory.
VTYPE: A variable’s type. Format: Q for quantity, T for text, P for password or D for date (the
selection is exclusive).
The variable may be of one of three types: Text, password, quantity or date. The type
determines a variable’s format. Data input is compulsory.
VFORMAT: A variable’s format.
For a date-type variable, the format must be selected from one of the following three values:
YYYY/MM/DD, DD/MM/YYYY or MM/DD/YYYY.
For a text or a password type variable, the format expresses the maximum length of text to be
entered (quotation marks not included): Absolute maximum, and by default, 255 characters.
Data input is compulsory except for quantity-type variables, where this information has no
significance.
VALMIN, VALMAX: Range of values exclusively for quantity-type variables. Data input is not
compulsory.
VALMIN and VALMAX must indicate in which range the value of the variable is to be entered.
VALMIN signifies the lower value of this range, VALMAX, the upper.
Format: 12 numerical characters.
Default values: 0 and 999999999999.
Chapter 3 Parameter Commands | 65

VVALUE: A variable’s value. Data input is compulsory. The value of a password variable must be
entered in clear but is not displayed in the output of the command.
A variable’s value must be compatible with its type, its format and, if appropriate, its range
otherwise the command will be refused.
If the value contains non-alphanumeric characters (eg. spaces, /…) it must be enclosed within
quotation marks.
XCLASS: Uproc incompatibility class.
Indicates that the Uproc is incompatible with all Uproc members of this class.
Format: Between brackets, the various incompatibility classes are separated by commas;
spaces are prohibited.
Example: XCLASS=(CLASS1.CLASS2): The Uproc is declared incompatible with classes
CLASS1 and CLASS2.
TERMNO: The completion instruction's identification number. Format: 2 numeric characters.
A number is associated with each instruction; two different instructions may not have the
same number.
TERM: Completion instruction. Format: 64 alphanumeric characters.
Specifies the Uproc code corresponding to the event that must be purged by the completion
instruction.
SUCC_UPR: Uproc successor. Format: 64 characters.
Specifies the Uproc successor of the current Uproc. Successor Uprocs are checked in the
order they are added and can only be added one at a time. Example: uxupd UPR EXP
UPR=UPROC1 SUCCESSOR add UPROC1_SUCCESSOR_1.
CONDNO: The condition's identification number. Format: 2 numeric characters.
A number is associated with each condition (irrespective of the type); two different conditions
cannot have the same number.
DEP: Dependency condition. Format: 64 alphanumeric characters.
Specifies the Uproc code concerned by the dependency condition.
INC: Incompatibility condition. Format: 64 alphanumeric characters.
Specifies the Uproc code concerned by the incompatibility condition.
RES: Resource condition. Format: 64 alphanumeric characters.
Specifies the resource code concerned by the resource condition.
PDATE: Control by processing date.
Specifies the required offset between the conditioned Uproc's processing date and that of the
conditioning Uproc or resource.
Format: Depending on the functional period of the conditioning Uproc, it is expressed as "+ or
-" a number of calendar units (see below) in brackets, separated by commas.
If one of the calendar units monitored must be the same, no value is required.
For example PDATE=(+1.-1.) for a functional period of DAY may be translated by: day +1,
month –1, same year.
If the same processing date (globally) is required, the keyword SAME may be used; if the
control is required on the same calendar unit, a white character may be used in the triplet
(See last example).
If control should not take account of the processing date, the keyword ANY may be used; if
the control is not required on a particular calendar unit, the letter "a" may be used in the
triplet. For example, PDATE=(a, , ) can be translated by: at any day in the same month and
the same year.
66 | Chapter 3 Parameter Commands

The following table summarizes the calendar units proposed, according to the functional
period (F.P.) of the Uproc:

Calendar units
Functional Day Week 10 2 weeks Month 2 3 4 6 Year
period days months months months months
None
Day * * *
Week * *
10 days * * *
2 weeks * * *
Month * *
2 months * *
3 months * *
4 months * *
6 months * *
Year *

DTYPE: Control by processing date.


Indicates the type of day to consider for the conditioning Uprocs with a day functional period.
Format
o A: Any: Whatever the type of day: worked, closed or holiday, the indicated shifting is
counted in calendar days.
o W: Worked: The indicated shifting is counted in worked days (in relation with the
reference calendar of the considered management units).
o C: Closed: The indicated shifting is counted in closed days.
o H: Holiday: The indicated shifting is counted in holiday days.
MU: Control by Management units.
Indicates on which series of Management units the condition must be sought.
If the check is to apply to the same Management unit, the keyword SAME may be used.
If the check is to apply to a specific Management unit, the checking expression will be
mu(code_MU), where code_MU represents the management unit code in question (64
alphanumeric characters).
If the check is to apply to a management unit type, the checking expression will be mut(T),
where T represents the management unit type (1 alphanumeric character).
If the check is to apply to the hierarchical dependencies between Management units, the
checking expression will be hdp({XY}), where X represents the type of the Management units
targeted (1 alphanumeric character) and Y the Management unit type origin of the
dependency (1 alphanumeric character).
ONE: Target Management units.
Used only for dependency or resource conditions, in cases where checking of the
Management units is directed at an MU type or a HDP.
ONE means that the condition is expected on at least one of the targeted Management units;
selecting ALL implies that the condition is expected on all of the Management units targeted.
The default value is ONE.
SESS: Control by session.
Chapter 3 Parameter Commands | 67

Indicates for which session the condition must be sought.


If the check does not consider the notion of session, the keyword any may be used.
If the check applies to any execution of the same session the keyword same may be used.
If the check applies to the same run of the same session, the keyword same run may be
used.
If the check applies to an explicit session, the checking expression will be expl(COD_SESS),
where COD_SESS is the code of the session in question.
STATUS: Required state.
Indicates the expected Uproc status (dependency condition or completion instruction only)
If the expected status is "COMPLETED", the keyword TERMINATED may be used (default
value).
If the expected status is "ABORTED" the keyword ABNORMAL may be used.
If the expected condition is "ABSENT" the keyword ABSENT may be used.
USER: Submission account.
Indicates the type of submission account for which the condition must be sought.
If the check applies to the same submission account, the keyword same may be used.
If the check does not consider the notion of submission account, the keyword any may be
used (default value).
EXPECT: Boolean logic.
Indicates that the condition expressed is sought as "true" (default value)
If the condition sought should be the opposite of that expressed, the keyword EXCLUD may
be used.
NOFATAL: Launcher behavior if condition not satisfied.
If the condition expressed is not satisfied at the Uproc's first condition check, the launcher will
declare the launch in an "EVENT_WAIT" state. The Uproc's conditions will be checked again
upon appearance of the expected event (default value).
If the condition expressed is not satisfied at the Uproc's first condition check and the keyword
FATAL was used, the launcher will declare the launch in a "LAUNCH REFUSED" state, no
further attempts will be made to launch this particular job.
VERIF: File verification.
Indicates whether the launcher must verify the physical presence of the resource during the
Uproc's condition check (default)
If verification is not required, in which case it will be seen as a logical resource, the keyword
NOVERIF may be used.
UNLOCK: Resource Allocation.
The conditioned Uproc receives only those quotas defined in the condition (default value).
Other Uprocs conditioned on this resource may run, depending on the quotas available.
If the keyword LOCK is used, the conditioned Uproc assigns itself the totality of the resource
during its execution and no other Uproc conditioned by this resource will be able to run.
If the resource condition is declared as UNLOCK on a resource defined as "LOCK", the
behavior will be identical.
ATTRIB: Attribute to verify. Requires the resource type attribute (the various attributes are described
in the Reference Manual in the chapter entitled “Resource conditions”).
OPER: Operator. Used for resources of the FIL type.
VALUE: Value. Used for resources of the FIL type.
68 | Chapter 3 Parameter Commands

QT1 and QT2: Quotas required. Numeric value between 0 and 9999; 0 by default
If using a condition and a resource declared as "UNLOCK", during condition-checking the
launcher verifies whether the quotas expressed in the condition are effectively available. If
they are, the Uproc will be submitted for execution and will block the corresponding quotas.
Several Uprocs may thus share a given resource.
LFORM: Launch formula.
Expresses the entire launch formula for the Uproc in question, and the current action
o Cnn: condition number nn.
o =: the condition is sought true.
o #: the condition is sought false.
o AND: both conditions must be checked.
o OR: one or other of the two conditions must be checked.
o The "AND" has priority over the "OR", and brackets may be used to define the groups of
conditions assembled by "OR".
For example: LFORM="=C01 AND (=C02 OR #C03)"
INF: Display option. Confines display to the names of the objects. Alternative value: FULL (by default).
Displays all available information on the list of objects
INF and FULL are mutually incompatible.
OUTPUT: Storage of results. The file name is compulsory for the uxext command
If not specified output will be displayed on the screen.
INPUT: Input file for the uxins command. The file name is compulsory.
TESP: Area code, target of the transfer: X for Production, S for Simulation or I for Integration.
NOVERIF: Can only to be used with the uxext command.
The NOVERIF option forces the command to skip the checking of the output data file before
the insertion of the new records. This enhances the performance and can only be used for the
creation of a new output data file.
SCRIPT: Can only be used with the command uxshw upr.
This parameter enables the display of the Uproc’s script in the output when the node setting
U_UPR_SCRIPT_NODISP (Advanced Settings category) is set to Yes. Refer to the UniViewer
Interface for Dollar Universe Manual.
By default this variable is not defined and the Uproc script is displayed even if the SCRIPT
parameter is absent in the command.
PARTNER: Physical name or IP address of the target machine
ORIGIN_FILENAME: Name of the file to be transfered. By default all files in the directory.
ORIGIN_PATHNAME: Name of the directory that contains the files to be transfered. By default the
FTP connection user’s home directory. * forbidden
TARGET_FILENAME: Target file name. Unchanged by default.
TARGET_PATHNAME: File reception directory. By default the home directory of the Uproc’s
submission user account. * forbidden
LOGON: FTP connection user
PASSWORD: FTP connection user password. Passwords are invisible in the GUI.
MODE: Type of transfer (ASCII or BINARY)
ACTION: Behavior if the target file exists: REPLACE, APPEND (FTP_PUT only), ABORT or NONE.
Chapter 3 Parameter Commands | 69

CRLF: All CR characters are converted to LF during ASCII transfer. No conversion by default except
for submissions. CRLF option is not available for FTP_PUT.
DELETE: Deletes the origin file is the transfer is successful. If not the file is kept.
NEWER: Transfers the file if its modification date is later than the target file.
RECURSIVE: Transfers whole files and subdirectories of the ORIGIN_PATHNAME (the
ORIGIN_FILENAME and the TARGET_FILENAME must not be edited). When using the recursive
option, the recursion depth limit is set to 150 directories. NORECURSIVE by default.
The RECURSIVE option uses the FTP LIST command internally to get a list of files and
directories on the remote server. The expected server answer must be formated so each line
starts with the file permissions in UNIX format. Since this answer varies from a server to
another, the feature will not work if the answer has a different format. Should this happen, a
failover option is available: it tests each single file on the specified remote server location with
a FTP CWD command to check the existence of a directory. The failover option is less
performant but it can be enabled with the U_FT_GET_DIR_FAILOVER node setting in the
"Node Settings – FTP Settings" category.
BUFFER_SIZE: Sets the communications buffer size in blocks of 512 bytes. If valorized, the format is
integer/2n with a minimum value of 1 and maximum value is 64.
RETRY: Number of retries in case of failure.
UMASK: Mask applied to local file permissions. Format: 3 numerical characters.
 FTP_GET Uprocs: If UMASK is not set or set to 000, files are downloaded with 666
permissions by default (for a root user) or 640 (for a non-root user). Otherwise, file
permissions are obtained by subtracting UMASK from the default value (666 or 640).
 FTP_PUT Uprocs: UMASK is not available. On UNIX OS, files are uploaded with their original
permissions. On Windows, files are uploaded with 755 permissions (the octal permissions
doesn't natively exists for Windows).

3.2.3.4 Examples
uxadd UPR EXP UPR=D_LOAD_FIL LABEL=\"Loading of file\" FPERIOD=d UPT=CL_EXT
CLFIL=c:\temp\D_LOAD_FIL.bat APPL="BK" memo="O" NBPER=1

Creates the Uproc D_LOAD_FIL, version 000, with the label "Loading of file" in the current
environment (company, node) in the production area, functional period: day, command file:
c:\temp\ D_LOAD_FIL.bat, application BK (domain T), memorized for one execution, one
period.
uxadd UPR EXP UPR=DEF_UPR APPL=U_ UPT=CL_EXT CLFIL=C:\script.bat
DEFINFO=\"Default information for this Uproc\" DEFSEV=0001

Creates the Uproc DEF_UPR of type CL_EXT (script: "C:\script.bat"), with the default values
of the parameters Information at "Default information for this Uproc" and Severity at 1.
uxupd UPR EXP UPR=D_LOAD_FIL RESCON add CONDNO=01 RES=D_FIL_PAY
uxupd UPR EXP UPR=D_LOAD_FIL RESCON add CONDNO=02 RES=D_BASE LOCK
uxupd UPR EXP UPR=D_LOAD_FIL FORMULA LFORM=\"=C01 AND =C02\"

Modifies Uproc D_LOAD_FIL to define a launch formula for it consisting of two resource
conditions in AND, the first concerning the presence of the file resource D_FIL_PAY and the
second the complete availability of the logical resource D_BASE.
uxadd UPR EXP UPR=D_BACKUP LABEL=Backup FPERIOD=d UPT=CL_EXT
CLFIL=c:\temp\D_BACKUP.bat APPL=BK

Creates the Uproc D_ BACKUP in the production area with the label "Backup" in the current
environment, functional period: day, command file: c:\temp\D_BACKUP.bat, application BK
(domain T).
uxupd UPR EXP UPR=D_BACKUP DEPCON add CONDNO=01 DEP=D_LOAD_FIL
70 | Chapter 3 Parameter Commands

uxupd UPR EXP UPR=D_BACKUP FORMULA LFORM="=C01"

Modifies Uproc D_BACKUP to define a launch formula for it. It consists of a dependence
condition on Uproc D_LOAD_FIL (with the status Completed by default). This Uproc’s script
will release the resource D_BASE allocated in total by Uproc D_LOAD_FIL.
uxupd UPR UPR=D_LOAD_FIL LAUNCHVAR add VARNAME=VARTXT VTYPE=T
VVALUE="XY_VARTXT" VFORMAT="30"

Creates for Uproc D_LOAD_FIL a text-type variable, VARTXT, with a maximum length of 30
characters and a default value of " XY_VARTXT ".
uxupd UPR UPR=D_LOAD_FIL LAUNCHVAR add VARNAME=VARDATE VTYPE=D
VVALUE="1999/12/31" VFORMAT="YYYY/MM/DD"

Creates a date-type variable for Uproc D_LOAD_FIL in the year/month/day format with a
default value of 1999/12/31.
uxext UPR EXP UPR=D* output=c:\temp\DOC.ext

Extracts all Uprocs beginning with D_ from the Production area and archives the data in the
file c:\temp\DOC.ext.
uxins UPR EXP UPR=* input=c:\temp\DOC.ext

Inserts all UPROCS of file c:\temp\DOC.ext in the current environment (COMPANY, NODE)
in the Production AREA unless they already exist

3.2.4 Sessions

3.2.4.1 Commands
uxadd SES: Adds a session to the session list.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
SES= 64c
VSES= 3n
LABEL= 64c ""
HEADER= 64c
FATHER= Uproc_code(nnn)
SONOK= ((Uproc_code(nnn),{XY})
(Uproc_code(nnn),{XY})
(Uproc_code(nnn),mu_code)...)
SONKO= ((Uproc_code(nnn),{XY})
(Uproc_code(nnn),{XY})
(Uproc_code(nnn),mu_code)...)

Examples:
uxadd SES EXP SES=SES_TEST LABEL=\"Create session\" HEADER=IU_TEST
FATHER=IU_TEST SONOK="((IU_TEST2)(IU_TEST3(001)))" SONKO="((IU_ALARM(002)))"
\
FATHER=IU_TEST2 SONOK="((IU_TEST3(003),{A }))" \
FATHER=IU_TEST3\(003\) SONOK="((D_BACKUP))" SONKO="((IU_ALARM(004)))"
uxadd SES EXP SES=D_LOAD_BCK label=\"Load file\" HEADER=D_LOAD_FIL
FATHER=D_LOAD_FIL SONOK="((D_BACKUP))"

uxdup SES: Duplicates a session.


Chapter 3 Parameter Commands | 71

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
SES= 64c
VSES= 3n
TSES= 64c
TVSES= 3n
TLABEL 64c

Example:
uxdup SES EXP SES=TEST VSES=000 TSES=TEST2 TVSES=000 TLABEL=\"Duplicated
session\"

uxshw SES: Displays the characteristics of a session.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
SES= 64c *
VSES= 3n *
LST | LNK LST
OUTPUT=filename

Example:
uxshw SES EXP SES=SES_TEST LNK

uxdlt SES: Deletes a session.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
SES= 64c *
VSES= 3n *

Example:
uxdlt SES EXP SES=SES_TEST

uxlst SES: Lists the sessions.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
SES= 64c * *
VSES= 3n * *
INF | FULL FULL
OUTPUT=filename

Example:
uxlst SES OUTPUT=c:\temp\LstSes.txt

uxtra SES: Transfers the sessions to another area (same company and same node).

Item Format Default


APP | INT | SIM 3c S_ESPEXE
SES= 64c *
VSES 3n *
72 | Chapter 3 Parameter Commands

Item Format Default


TESP= I|S|X

Example:
uxtra SES app SES=D_* TESP=X

uxext SES: Extracts the complete definition of a session.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
SES= 64c *
VSES= 3n *
REPL
OUTPUT=filename
NOVERIF

Example:
uxext SES EXP SES=D_* output=c:\temp\ses.ext

uxins SES: Inserts the complete definition of a session into the corresponding Dollar Universe files.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
SES= 64c *
VSES= 3n *
REPL
ENABLE | NOENABLE ENABLE
INPUT=filename

Example:
uxins SES EXP SES=* INPUT=c:\temp\ses.ext

If sessions were extracted from the simulation or production area (version 000), they can now be
inserted in integration or application areas by prior definition of the new value of the version
(S_VSES_REINSERT node setting, Command Interface Settings category):
S_VSES_REINSERT=XYZ

XYZ the new value of the session version should be at least 001 to be able to be inserted in
integration or application areas.

All the following insertion commands will use this setting to define the version of the inserted
sessions (whatever the target area).

3.2.4.2 Description of Items


SES: Session code. Format: 64 alphanumeric characters.
Requires a session code (wildcard accepted except for uxadd)
TSES: Session code, result of the duplication. Format: 64 alphanumeric characters.
VSES: Session version. Format: 3 numeric characters.
Accepts a session version (explicit value). By default, all versions of the sessions entered are
extracted (irrelevant for EXP or SIM).
TVSES: Session version, result of the duplication. Format: 3 numeric characters.
Chapter 3 Parameter Commands | 73

LABEL: Label describing the session. Format: 64 alphanumeric characters.


TLABEL: Session label, result of the duplication. Format: 64 alphanumeric characters.
HEADER: Session header Uproc. First Uproc code at the head of the session
FATHER: Describes the preceding Uproc in the branch of the session. Preceding Uproc of the
branch,

This code may be followed by the number of the occurrence of the Uproc within the session (3
numeric characters) following the following syntax: UPROC_CODE(nnn).

SONOK: Describes the subsequent Uproc in the normal processing path. Previous note applies.
Uproc child code in relation to the FATHER
Several Uprocs may be described on the same path, in which case the codes are shown in
brackets. The entire path is itself also enclosed in brackets, for example:
((CODE_UPR1)(CODE_UPR2(001))(CODE_UPR3.{XY})(CODE_UPR3.MU_CODE)).
{XY} indicates a HDP expression.
MU_CODE indicates a management unit code.
SONKO: Describes the subsequent Uproc in the error processing path.
Uproc child code in relation to the FATHER, same comment as above
REPL: Replacement option.
Indicates whether the record extracted (or inserted) deletes and replaces the record already
existing in the destination file; by default, extraction (or insertion) is refused for each existing
record (indicated by a message for each occurrence).
ENABLE: Unlocking option. Default value.
Indicates whether the session will be inserted in a locked state. Unlocking (option 06) will be
necessary before any modification can be made to the session, if the object is inserted with
the qualifier NOENABLE.
LST: List of Uprocs in the session. The default value of the command uxshw
The outcome of the command uxshw should be the list of Uprocs in the session. If a Uproc is
mentioned more than once in the Session, it will show up only once in this list.
Incompatible with the use of LNK
LNK: Links of Uprocs in the session.
The outcome of the command uxshw should show the session in the form of a table
describing the links between the Uprocs and the normal path or fallback routine.
Incompatible with the use of LST
INF: Display option. Confines display to the names of the objects. Alternative value: FULL (by default).
Displays all available information on the list of objects
OUTPUT: Storage of results. The file name is compulsory for the uxext command.
If not specified output will be displayed on the screen.
INPUT: Input file for the uxins command. The file name is compulsory.
TESP: Area code, target of the transfer: X for Production, S for Simulation or I for Integration.
NOVERIF: only to be used with the uxext command.
The NOVERIF option forces the command to skip the checking of the output data file before
the insertion of the new records. This enhances the performances and can only be used for
the creation of a new output data file.
74 | Chapter 3 Parameter Commands

3.2.4.3 Examples
uxadd SES EXP SES=SES_TEST LABEL=\"Create session\" HEADER=IU_TEST
FATHER=IU_TEST SONOK=((IU_TST000)(IU_TST001(001))) SONKO=((IU_ERR))
FATHER=IU_TST000 SONOK=((IU_TST002.{A })) FATHER=IU_ERR
SONOK=((IU_TST001(002))) FATHER=IU_TST001(002) SONKO=((IU_ALARM))

Creates a session called "SES_TEST" in the current environment (company, node) depicted
below:

IU_TEST

IU_TST000 IU_TST001 IU_ERR

IU_TST002 IU_TST001
{A }

IU_ALARM

uxdlt SES EXP SES=SES_TEST

Deletes the session "SES-TEST" in the current environment (company, node).


uxadd SES EXP SES=D_LOAD_BCK LABEL=\"File load\" HEADER=D_LOAD_FIL
FATHER=D_LOAD_FIL SONOK=((D_BACKUP))

Creates the session D_LOAD_BCK consisting of the header D_LOAD_FIL followed by the
Uproc D_BACKUP on a normal path on the same executing management unit.
uxshw SES EXP SES=D_LOAD_BCK LNK

Displays the previously created session with the Uprocs which it consists of and the links
between them
uxext SES EXP SES=D_* OUTPUT=c:\temp\DOC.ext

Extracts all sessions starting with D_ from the Production area, and archives the data in the
file "c:\temp\DOC.ext".
uxins SES EXP SES=* INPUT=c:\temp\DOC.ext

Inserts all sessions from the file "c:\temp\DOC.ext" into the current environment (company,
node) in the production AREA unless they already exist

3.3 Scheduling

3.3.1 Calendars

3.3.1.1 Commands
uxadd CAL: Adds a calendar to the list of calendars or inserts one or more years into an existing
calendar.
Item Format Default
EXP | SIM | INT | APP 3c S_ESPEXE
MU= 64c
LABEL= 64c ""
Chapter 3 Parameter Commands | 75

Item Format Default


NOMODEL | MODEL NOMODEL
FRHOLI | NOFRHOLI FRHOLI
SINCE= YYYY
BEFORE= YYYY
WEEK= W C H 7c WWWWWCC

Example:
uxadd CAL EXP MU=\" 00\" LABEL=\"Default calendar\" SINCE=2001 BEFORE=2011

uxupd CAL: Modifies the characteristics of a calendar.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
MU= 64c *
LABEL= 64c
NOMODEL | MODEL
DSINCE= U_FMT_DATE
DBEFORE= U_FMT_DATE
ATTR=W | C | H | ALL
TO=W | C | H
DAY=MON | TUE | WED | THU | FRI | SAT | SUN | ALL ALL

Example:
uxupd CAL EXP MU=HEADQUART DSINCE=20021226 DBEFORE=20021231 ATTR=ALL TO=C

uxshw CAL: Displays the characteristics of a calendar.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
MU= 64c *
NOMODEL | MODEL
SINCE= YYYY
BEFORE= YYYY
OUTPUT=filename

Example:
uxshw CAL EXP MU=HEADQUART SINCE=2002 BEFORE=2002

uxdlt CAL: Deletes a calendar.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
MU= 64c *
NOMODEL | MODEL NOMODEL
SINCE= YYYY
BEFORE= YYYY

Example:
uxdlt CAL EXP MU=HEADQUART SINCE=1997 BEFORE=2000
76 | Chapter 3 Parameter Commands

uxlst CAL: Lists the calendars.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
MU= 64c * *
INF | FULL FULL
OUTPUT=filename

Example:
uxlst CAL OUTPUT=c:\temp\LstCal.txt

uxtra CAL: Transfers the calendars in another area (same company and same node).

Item Format Default


APP | INT | SIM 3c S_ESPEXE
MU= 64c *
MODEL | NOMODEL NOMODEL
TESP= I|S|X

Example:
uxtra CAL app MU=D_* MODEL TESP=X

uxext CAL: Extracts the definition of a (template) calendar (full range).

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
UG= | MU= 64c *
MODEL
REPL
OUTPUT=filename
NOVERIF

Example:
uxext CAL EXP MU=HEADQUART output=c:\temp\cal.ext

uxins CAL: Inserts the definition of a calendar into the corresponding Dollar Universe files (full
range).

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
UG= | MU= 64c *
MODEL
CIBLE= (MU_code,...)
REPL
INPUT=filename

Example:
uxins CAL EXP MU=* CIBLE=HEADQUART INPUT=c:\temp\cal.ext

3.3.1.2 Description of Items


MU (or UG): Calendar's associated management unit. Format: 64 alphanumeric characters.
Chapter 3 Parameter Commands | 77

Accepts a model identifier or a Management unit (wildcard accepted except for uxadd)
The default calendar may be reached using the management unit " 00" (blank 00) or " "
(blank).
UG enables a Management unit or a model to be entered (commands uxext and uxins).
MODEL: Type of calendar. Default value: NOMODEL.
A model calendar must be extracted / inserted or distributed in order to become operational.
"MU" in this case expresses the identifier of the model.
LABEL: Label describing the calendar. Format: 64 alphanumeric characters.
SINCE: First year of calendar. Format: 4 numeric characters.
Indicates the year from which the calendar is to start (minimum value: current year minus
one).
BEFORE: Last year of calendar. Format: 4 numeric characters.
Indicates the last year created (included) in the calendar (minimum value: current year plus
two).
FRHOLI: With French holidays. Indicates that the calendar will be created with French public holidays
If the keyword NOFRHOLI is shown, the calendar will be created without French holidays
(default value).
WEEK: Creation mask. Indicates which creation mask for the week is used to create the calendar.
Format: for seven days of the week (from Monday to Sunday); the type of day may be:
o W: working
o C: closing
o H: holiday
For example: WEEK=(WWWWWCC): working from Monday through Friday, closed on
Saturday and Sunday (default value).
DSINCE: Update starting date. Indicates the first day on which the update is applied.
Format: Indicated by the setting U_FMT_DATE.
DBEFORE: Update finishing date. Indicates the last day (included) on which the update is applied.
Format: Indicated by the setting U_FMT_DATE.
ATTR: Selection on the type of day. Indicates which type of day will be affected by the update.
Format: W (working), C (closing), H (holiday) or ALL (default value).
TO: New type. Indicates the new type of the selected days
Format: W (working), C (closing), H (holiday).
DAY: Day of week selection. Indicates which day of the week (or which series of days) will be
updated.
Format
o MON: Monday.
o TUE: Tuesday.
o WED: Wednesday.
o THU: Thursday.
o FRI: Friday.
o SAT: Saturday.
o SUN: Sunday.
78 | Chapter 3 Parameter Commands

o or ALL: Irrespective of the day in the week (default value).


For examples: DAY=(SAT,MON): Saturdays and Mondays, DAY=WED: Wednesdays.
CIBLE: Target management units for insertions. The input is compulsory. Used only by uxins. Format
o *: wildcards are accepted.
o A Management Unit code, if only one management unit is targeted.
o (MU_CODE,MU_CODE,…) if multiple management units are targeted, MU_CODE being
a management unit code.
Indicates, for the selected template calendars, the management units to be targeted (the
model/template will be used to create as many calendars as there are management units in
the target list).
If two distinct models result in the generation of the same calendar (possibly in the same
command), the second insertion is rejected, as it would be if the calendar already existed (a
warning message is provided with each rejection). If the option "REPL" is used, the last
insertion overwrites the existing calendar.
If CIBLE=*, any non-model calendar contained in the input file will be inserted with their
original MU, which must already exist on the target machine. If it does not exist the calendar
will not be inserted.
This feature makes it easy to implement backup/restore operations for the whole active
scheduling base using the 4 commands listed below. It is recommended to export/import
model and non-model calendars separately.
uxext CAL MU=* OUTPUT=c:\temp\cal_nomod.ext
uxins CAL MU=* CIBLE=* INPUT=c:\temp\cal_nomod.ext
uxext CAL MU=* MODEL OUTPUT=c:\temp\cal_mod.ext
uxins CAL MU=* MODEL CIBLE=* INPUT=c:\temp\cal_mod.ext

REPL: Replacement option.


Indicates whether the extracted (or inserted) record cancels and replaces the years already
existing in the destination file (or calendar); by default, the extraction (or insertion) is refused
(a message signaling this at every occurrence) for each record which already exists.
INF: Display option. Confines display to the names of the objects. Alternative value: FULL (by default).
Displays all available information on the list of objects
OUTPUT: Storage of results. The file name is compulsory for the uxext command.
If not specified output will be displayed on the screen.
INPUT: input file for the uxins command. The file name is compulsory.
TESP: Area code, target of the transfer: X for Production, S for Simulation or I for Integration.
NOVERIF: only to be used with the uxext command.
The NOVERIF option forces the command to skip the checking of the output data file before
the insertion of the new records. This enhances the performance and can only be used for the
creation of a new output data file.

3.3.1.3 Examples
uxadd CAL EXP MU=\" 00\" SINCE=1998 BEFORE=2005 LABEL=\"Default calendar\"
uxadd CAL EXP MU=HEADQUART LABEL=\"Headquarters calendar\" SINCE=1995
BEFORE=2005

Adds (or replaces) the years 1998 to 2005 to the default calendar in the current environment
(company, node and area) and creates the calendar for the HEADQUART management unit
in the current environment (company, node and area).
Chapter 3 Parameter Commands | 79

uxupd CAL EXP MU=HEADQUART DSINCE=19991227 DBEFORE=19991231 ATTR=ALL TO=C

Modifies the calendar for the HEADQUART Management unit in the current environment
(company, node and area) to make the period from 27/12/99 to 31/12/99 closed if the setting
U_FMT_DATE has the value YYYYMMDD
uxdlt CAL EXP MU=HEADQUATER SINCE=1995 BEFORE=1997

Deletes the years 1995, 1996 and 1997 from the calendar for the HEADQUART Management
unit in the current environment (company, node and area)
uxext CAL EXP MODEL MU=MOD output=c:\temp\DOC.ext

Extracts the model calendar "MOD" from the production area and archives the data in file
c:\temp\DOC.ext.
uxins CAL EXP MODEL MU=MOD CIBLE=MOD input=c:\temp\DOC.ext

Inserts the model calendar "MOD" from the file c:\temp\DOC.ext as a model calendar in the
production area of the current environment (company, node) unless it already exists.
uxins CAL EXP MU=MOD CIBLE=HEADQUART input=c:\temp\DOC.ext

Inserts the model calendar "MOD" from the file c:\temp\DOC.ext. as calendar for the
HEADQUART management unit in the production area of the current environment (company,
node) unless it already exists.

3.3.2 Rules

3.3.2.1 Commands
uxadd RUL: Adds a rule into the rules list.

Item Format Default


RUL= 64c
LABEL= 64c ""
PERIOD=(n[d | w | m | q | y | h | wd | cd | 4c (1d)
mo | tu | we | th | fr | sa | su | fm | fq | fy])
POS=(±n[w | c | d | wd | cd | h | mo | tu | 5c (+1d)
we | th | fr | sa | su])
AUTHO=(ynn,ynn,ynn,ynn,ynn,ynn,ynn) 29c (ynn,ynn,ynn,ynn,ynn,ynn,ynn)
OFFSET=N | F | P 1c N
AUTHOD=±(dn) 86c +(1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,
20,21,22,23,24, 25,26,27,28,29, 30,31)
AUTHOM=(mn) 28c (1,2,3,4,5,6,7,8,9,10,11,12)
TODW=A | E |S 1c A
SHIFTW=(±n[d | w | c | h] 1c
TODC=A | E |S 1c A
SHIFTC=(±n[d | w | c | h] 1c
TODH=A | E |S 1c A
SHIFTH=(±n[d | w | c | h] 1c

Examples:
uxadd RUL RUL="LWDM" LABEL=\"last working day of the month\" PERIOD="(1M)"
POS="(-1W)"
uxadd RUL RUL="5DMO+" LABEL=\"the 5th of the month offset +\" PERIOD="(1M)"
POS="(+5C)" OFFSET=F
80 | Chapter 3 Parameter Commands

uxadd RUL RUL="NO_SUN" LABEL=\"except Sundays\"


AUTHO="(YYY,YYY,YYY,YYY,YYY,YYY,NNN)"
uxadd RUL RUL="1-15wd" LABEL=\"every working day from 1 to 15\" PERIOD=(1d)
POS=(+1w) AUTHOD=+(1,2,3,4,5,6,7,8,9,10,11,12,13,14,15)

uxupd RUL: Modifies a rule.

Item Format Default


RUL= 64c *
LABEL= 64c
PERIOD=(n[d | w | m | q | y | wd | cd | mo 4c
| tu | we | th | fr | sa | su | fm | fq | fy])
POS=(±n[w | c | d | wd | cd | h | mo | tu | 5c
we | th | fr | sa | su])
AUTHO=(ynn,ynn,ynn,ynn,ynn,ynn,ynn) 29c
OFFSET=N | F | P 1c
AUTHOD=±(dn) 86c +(1,2,3,4,5,6,7,8,9,10,11,12,13,14,15, 16,17,18,
19,20,21,22,23,24,25,26,27,28,29,30,31)
AUTHOM=(mn) 28c (1,2,3,4,5,6,7,8,9,10,11,12)
TODW=A | E |S 1c A
SHIFTW=(±n[d | w | c | h] 1c
TODC=A | E |S 1c A
SHIFTC=(±n[d | w | c | h] 1c
TODH=A | E |S 1c A
SHIFTH=(±n[d | w | c | h] 1c

Example:
uxupd RUL RUL="5DMO+" LABEL=\"the 5th working day of the month offset +\"
POS="(+5W)" OFFSET=N

uxshw RUL: Displays the characteristics of a rule.

Item Format Default


RUL= 64c *
OUTPUT=filename

Example:
uxshw RUL RUL="5DMO+"

uxdlt RUL: Deletes a rule.

Item Format Default


RUL= 64c *

Example:
uxdlt RUL RUL=NO_SUN

uxlst RUL: Lists the rules.

Item Format Default


RUL= 64c * *
INF | FULL FULL
OUTPUT=filename

Example:
uxlst RUL OUTPUT=c:\temp\LstRul.txt
Chapter 3 Parameter Commands | 81

uxext RUL: Extracts the complete definition of a rule.

Item Format Default


RUL= 64c *
REPL
OUTPUT=filename
NOVERIF

Example:
uxext RUL RUL=* output=c:\temp\rul.ext

uxins RUL: Inserts the complete definition of a rule into the corresponding Dollar Universe files.

Item Format Default


RUL= 64c *
REPL
INPUT=filename

Example:
uxins RUL RUL=* INPUT=c:\temp\rul.ext

3.3.2.2 Description of Items


RUL: Rule code. Format: 64 alphanumeric characters plus the characters "+" and "-".
Enter the rule code (wildcard accepted except for uxadd).
LABEL: Label describing the rule. Format: 64 alphanumeric characters.
PERIOD: Periodicity of the rule. Format: A number of d (days), w (weeks) or m (months).
d: Day
w: Week
m: Month
q: Trimester
y: Year
h: Holiday
wd: Working day
cd: Day off
mo: Monday
tu: Tuesday
we: Wednesday
th: Thursday
fr: Friday
sa: Saturday
su: Sunday
fm: Fiscal month
fq: Fiscal trimester
fy: Fiscal year
POS: Position in the period.
82 | Chapter 3 Parameter Commands

Indicates the number of the day sought (numbering starts at +1 for the first day and -1 for the
last), and the type of day counted: W (working) or C (calendar).
w: working (for compatibility; equal to "wd")
c: calendar (for compatibility; equal to "d")
d: day
wd: working day
cd: day off
h: holiday
mo: Monday
tu: Tuesday
we: Wednesday
th: Thursday
fr: Friday
sa: Saturday
su: Sunday
Format: In brackets, 2 (signed) numeric characters followed by type of day. For example: (-
1wd): minus one working day.
AUTHO: Weekly authorization mask. Values: Y (yes) or N (No).
Indicates, for each day of the week (from Monday to Sunday) the validity of the date
calculated, bearing in mind the type of day (working, closing or holiday).
Format: For each day, the trio (value in brackets - working closing holiday) shows whether the
calculation is id. Each day is separated from the next by commas. For example the default
value is: AUTHO=(YNN,YNN,YNN,YNN,YNN,YNN,YNN).
OFFSET: Offset. Format: n (no), f (following) or p (previous). Default value: n (no).
Indicates the offset to be applied if the date calculated is not authorized in the mask of the
week:
AUTHOD: List of authorized days in the month. By default, all days are authorized.
"+" indicates that the days are counted from the beginning of the month, "-" indicates that the
days are counted from the end of the month.
Format: 86 characters maximum. For clarification, "1" indicates the first day from the
beginning (+) or the end (-), "2" indicates the second day from the beginning (or the end) etc.
AUTHOM: List of authorized months in the year. By default, all months are authorized.
Format: 28 characters maximum. For clarification, each month is represented by a number: 1
for January, 2 for February etc. A month not in the list is a month for which calculation of the
date is forbidden.
TODW: authorization for a working day: Format 1 character:
A: authorized
E: excluded
S: excluded with shift
SHIFTW: shift for working days, obligatory if TODW=S
H: holiday
W: working day
C: off day
Chapter 3 Parameter Commands | 83

TODC: authorization for an off day: Format 1 character:


A: authorized
E: excluded
S: excluded with shift
SHIFTC: shift for working days, obligatory if TODC=S
H: holiday
W: working day
C: off day
TODH: shift for holiday, obligatory if: Format 1 character:
A: authorized
E: excluded
S: excluded with shift
SHIFTH: shift for holiday, obligatory if: TODH=S
H: holiday
W: working day
C: off day
INF: Display option. Confines display to the names of the objects. Alternative value: FULL (by default).
Displays all available information about the list of objects
REPL: Replacement option.
Indicates whether the record extracted (or inserted) deletes and replaces the record already
existing in the destination file; by default, extraction (or insertion) is refused for each existing
record (indicated by a message at each occurrence).
OUTPUT: Storage of results. The file name is compulsory for the uxext command
If not specified output will be displayed on the screen.
INPUT: Input file for the uxins command. The file name is compulsory.
NOVERIF: Only to be used with the uxext command.
The NOVERIF option forces the command to skip the checking of the output data file before
the insertion of the new records. This enhances the performances and can only be used for
the creation of a new output data file.

3.3.2.3 Examples
uxadd RUL RUL=LWDM LABEL=\"last working day of the month\" PERIOD=(1m)
POS=(-1wd)

Creates the rule "LWDM" "last working day of the month", with a period of 1 month positioned
on the last working day, the default authorization mask and no offset, in the current
environment (company and node)
uxadd RUL RUL=5CDMO+ LABEL=\"the 5th of the month offset +\" PERIOD=(1m)
POS=(+5d) OFFSET=f

Creates the rule "5CDMO" "fifth of the month, offset to the next working day", with a period of
1 month, position on the fifth, with the default mask (work days only authorized) and an offset
to the next workday day, in the current environment (company and node).
uxadd RUL RUL=NO_SUN LABEL=\"except Sundays\" PERIOD=(1d) POS=(+1d)
AUTHO=(YYY,YYY,YYY,YYY,YYY,YYY,NNN)
84 | Chapter 3 Parameter Commands

Creates the rule "every day except Sunday", having a period of 1 day, and positioned on the
same day, with an authorization mask that refuses Sunday irrespective of the type of day, in
the current environment (company and node).
uxadd RUL RUL=10DMFY8 LABEL=\"ev 10d;not 21to25;not in aug\" PERIOD=(10d)
POS=(+1wd) AUTHO=(yyy,yyy,yyy,yyy,yyy,nnn,nnn)
AUTHOD=+(1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,26,27,28,29,30,3
1) AUTHOM=(1,2,3,4,5,6,7,9,10,11,12)

creates the rule "every 10 days, except from the 21 to the 25, except in August", with a period
of 10 days, position on the first calendar day of the period, all days of the week except
Saturday and Sunday, except from the 21 to the 25 inclusive, except in August.
uxlst RUL

Lists the rules of the current environment (company and node)


uxdlt RUL RUL=NO_SUN

Deletes the rule "NO_SUN" in the current environment (company and node)

3.3.3 Tasks

3.3.3.1 Commands
uxadd TSK: Adds a task to the task list. This command only creates the basic task envelope: other
information should be entered using the uxupd command.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
TSK= 64c *
SES= 64c ""
VSES= 3n
UPR= 64c
VUPR= 3n
MU= 64c
MODEL | NOMODEL NOMODEL

TECHINF: General information

Item Format Default


TYPE=S | O | P | C 1c
LABEL= 64c
USER= 64c
PRINTER= 4c IMPR
PRTY= 3n 100
QUEUE= 31c SYS_BATCH
(SYS$BATCH on OpenVMS)
PDATE=(±n,±n,W | C) (0,0,C)
[OFFSET]=±nn[D|C|H|W] or NONE NONE
PDATE_OFFSET=Y|N 1c N
HOLD | NOHOLD NOHOLD
DISABLE | ENABLE ENABLE
Chapter 3 Parameter Commands | 85

Item Format Default


MULT | NOMULT NOMULT
AUTOREL | NOAUTOREL NOAUTOREL
FORCE | NOFORCE NOFORCE
HISTORY | NOHISTORY HISTORY
SERIAL | PARALLEL SERIAL
OPT_W_EVENT | OPT_WO_EVENT OPT_WO_EVENT

Example:
uxadd TSK EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL MU=HEADQUART TECHINF TYPE=S
USER=admin

uxupd TSK: Updates a task and enables additional information to be defined when creating a new
task.
Item Format Default
EXP | SIM | INT | APP 3c S_ESPEXE
TSK= 64c *
SES= 64c *
VSES= 3n *
UPR= 64c *
VUPR= 3n *
MU= 64c *
MODEL | NOMODEL NOMODEL
TTYPE= S | O | P | C | * 1c

TECHINF: Technical information.

Item Format Default


TYPE=S | O | P | C 1c
USER= 64c
PRINTER= 4c
PRTY= 3n
QUEUE= 31c
PDATE=(±n,±n,W | C)
HOLD | NOHOLD
DISABLE | ENABLE
MULT | NOMULT
AUTOREL | NOAUTOREL
FORCE | NOFORCE
HISTORY | NOHISTORY
SERIAL | PARALLEL
OPT_W_EVENT | OPT_WO_EVENT

Example:
uxupd TSK EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL MU=HEADQUART TECHINF
USER=univ56e PDATE="(-1,0,W)"

PARENT:
86 | Chapter 3 Parameter Commands

Item Format Default


PARENT_TSK=TSK_CODE | ANY 64c ANY
PARENT_MU= MU_CODE | ANY 64c ANY

uxupd TSK EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL MU=HEADQUART PARENT

CTLDUR:

Item Format Default


HEULIM=(HHMM,B)

uxupd TSK EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL MU=HEADQUART CTLDUR

IMPL add: Adds rules to a Task.

Item Format Default


RULE=((RULE_CODE,U_FMT_DATE)(…,…))
SDATE= U_FMT_DATE (deprecated)
START_VALID= U_FMT_DATE
END_VALID= U_FMT_DATE or
NONE

Example:
uxupd TSK EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL MU=HEADQUART IMPL add
rule="(("LWDM",20020701)("5DMO+",20020701))"
uxupd TSK EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL MU=HEADQUART IMPL add
rule="(("++FWDM",01/01/2010))"
uxupd TSK EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL MU=HEADQUART IMPL add rule="(("-
+FWDM",01/01/2010))"

IMPL dlt: Deletes rules.

Item Format
RULE= ((RULE_CODE,U_FMT_DATE)(…,…))

Example:
uxupd TSK EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL MU=HEADQUART IMPL dlt
rule="("5DMO+",20020701)"

EXPLI add: Adds explicit dates.

Item Format
EDATE= ((U_FMT_DATE,hhmm,hhh,mm,U_FMT_DATE) (…,…,…,…,…))

Example:
uxupd TSK EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL MU=HEADQUART EXPLI add
EDATE="((20021230,2100,005,00,20021231)(20021130,2100,005,00,20021130))"

EXPLI dlt: Deletes explicit dates.

Item Format
EDATE= ((U_FMT_DATE,hhmm,hhh,mm,U_FMT_DATE) (…,…,…,…,…))

Example:
uxupd TSK EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL MU=HEADQUART EXPLI dlt
EDATE="(20021130,2100,005,00,20021130)"

EXCLU add: adds exclusion dates.


Chapter 3 Parameter Commands | 87

Item Format
XDATE= ((U_FMT_DATE)(…))

Example:
uxupd TSK EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL MU=HEADQUART EXCLU add
XDATE="((20021231)(20030101))"

EXCLU dlt: Deletes exclusion dates.

Item Format
XDATE= ((U_FMT_DATE)(…))

Example:
uxupd TSK EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL MU=HEADQUART EXCLU dlt
XDATE="((20021231))"

INTERVAL add: Adds an exclusion window to the task.

Item Format
EXCLUSION= ((U_FMT_DATE,hhmm,U_FMT_DATE,hhmm)(…,…,…,…,…))

Example:
uxupd TSK EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL MU=HEADQUART INTERVAL add
EXCLUSION="((20061230,2100,20070331,1630)(20071201,2000,20071231,1000))"

INTERVAL dlt: deletes an exclusion window from the task.

Item Format
EXCLUSION= ((U_FMT_DATE,hhmm,U_FMT_DATE,hhmm)(…))

Example:
uxupd TSK EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL MU=HEADQUART INTERVAL dlt
EXCLUSION="((20061230,2100,20070331,1630))"

TIME: Daily launch windows.

Item Format
DALW= (hhmm,hhh,mm)
MON= (hhmm,hhh,mm)
TUE= (hhmm,hhh,mm)
WED= (hhmm,hhh,mm)
THU= (hhmm,hhh,mm)
FRI= (hhmm,hhh,mm)
SAT= (hhmm,hhh,mm)
SUN= (hhmm,hhh,mm)

Example:
uxupd TSK EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL MU=HEADQUART TIME
DALW="(2100,005,00)" WED="(1900,005,00)"

TIME: Multiple launch windows.

Item Format
MULW= ((hhmm,hhmm,mmm),hhh,mm)

Example:
88 | Chapter 3 Parameter Commands

uxupd TSK EXP UPR=D_LOAD_FIL MU=HEADQUART TIME


MULW="((2000,2359,030),000.15)"

TIME: time at whiçh an automatically relaunched task is scheduled.

Item Format
RELW= ((hhmm),hhh,mm,hhh,mm,nnnn,hhh,mm)

Example:
uxupd TSK EXP UPR=D_LOAD_FIL MU=HEADQUART TIME
RELW="((2000,2359)0010,000,0000)"
TIME: Provoked launch windows.

Item Format
PRLW= (hhmm,hhh,mm, hhmm,hhmm) or
(ONDEMAND,hhh,mm,hhmm,hhmm)

Example:
uxupd TSK EXP UPR=D_LOAD_FIL MU=HEADQUART TECHINF TYPE=P
uxupd TSK EXP UPR=D_LOAD_FIL MU=HEADQUART TIME
PRLW="(0800,012,00,1300,1400)"

TIME: scheduling timetable of a cyclical task.

Item Format
CYCLICAL= ((hhhhh,mm),(U_FMT_DATE),(hhmm),(hhh,mm))

Example:
uxupd TSK EXP UPR=D_LOAD_FIL MU=HEADQUART TECHINF TYPE=C
uxupd TSK EXP UPR=D_LOAD_FIL MU=HEADQUART TIME
CYCLICAL="((00022,30),(20060823),(1837),(000,10))"

LAUNCHVAR add: Adds variables.

Item Format
VARNAME= 20c
VVALUE= depends on the variable definition

Example:
uxupd TSK UPR=D_LOAD_FIL MU=HEADQUART LAUNCHVAR add VARNAME=VARTXT
VVALUE=XY_VARTXT_VALTSK

LAUNCHVAR dlt: Deletes variables.

Item Format
VARNAME= 20c

Example:
uxupd TSK UPR=D_LOAD_FIL MU=HEADQUART LAUNCHVAR dlt VARNAME=VARTXT

uxdup TSK: Duplicates a task.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
TSK= 64c
SES= 64c
Chapter 3 Parameter Commands | 89

Item Format Default


VSES= 3n
UPR= 64c
VUPR= 3n
MU= 64c
TTYPE=S | O | P | C 1c
MODEL | NOMODEL NOMODEL
TTSK= 64c
TSES= 64c
TVSES= 3n
TUPR= 64c
TVUPR= 3n
TMU= 64c
TMODEL | TNOMODEL TNOMODEL

Example:
uxdup TSK EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL VUPR=000 MU=HEADQUART
TSES=D_LOAD_BCK TUPR=D_LOAD_FIL TVUPR=000 TMU=HEADQUART TMODEL

uxshw TSK: Displays the characteristics of a task.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
TSK= 64c *
SES= 64c * ""
VSES= 3n *
UPR= 64c *
VUPR= 3n *
MU= 64c *
MODEL | NOMODEL NOMODEL
TTYPE=S | O | P | C | * 1c*
OUTPUT=filename

Example:
uxshw TSK EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL MU=HEADQUART | more

uxdlt TSK: Deletes a task.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
TSK= 64c* *
SES= 64c * ""
VSES= 3n *
UPR= 64c *
VUPR= 3n *
MU= 64c *
MODEL | NOMODEL NOMODEL
90 | Chapter 3 Parameter Commands

Item Format Default


TTYPE=S | O | P | C | * 1c*

Example:
uxdlt TSK EXP UPR=D_LOAD_FIL MU=HEADQUART

uxlst TSK: Lists available tasks.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
SES= 64c * *
TSK= 64c TSK(SES)(VSES)(UPR)(VUPR)
VSES= 3n * *
UPR= 64c * *
VUPR= 3n * *
MU= 64c * *
MODEL | NOMODEL NOMODEL
TTYPE=S | O | P | C | * 1c
INF | FULL INF
MUTIME | ASTIME
OUTPUT=filename

Example:
uxlst TSK FULL OUTPUT=c:\temp\LstTsk.txt

uxtra TSK: Transfers the tasks in another area (same company and same node).

Item Format Default


APP | INT | SIM 3c S_ESPEXE
TSK= 64c *
SES= 64c *
VSES= 3n *
UPR= 64c *
VUPR= 3n *
MU= 64c *
MODEL | NOMODEL NOMODEL
TESP= I|S|X

Example:
uxtra TSK app UPR=D_* VUPR=* SES=D_* VSES=* MU=* TESP=X

uxext TSK: Extracts the complete definition of a task (template or not).

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
TSK= 64c TSK(SES)(VSES)(UPR)(VUPR)
SES= 64c * *
VSES= 3n *
UPR= 64c * *
Chapter 3 Parameter Commands | 91

Item Format Default


VUPR= 3n *
MU= 64c * *
MODEL NOMODEL
REPL
OUTPUT=filename
NOVERIF

Example:
uxext TSK EXP MU=H* UPR=D_* OUTPUT=c:\temp\tsk.ext

uxins TSK: Inserts the task definition (template or not) into the corresponding Dollar Universe files for
the same area and the same version of Dollar Universe than the extraction and with the status Active /
Disabled it had at the time of its extraction.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
TSK= 64c TSK(SES)(VSES)(UPR)(VUPR)
SES= 64c * ""
VSES= 3n *
UPR= 64c *
VUPR= 3n *
MU= 64c *
MODEL NOMODEL
CIBLE=(MU1,MU2,…) *
REPL
INPUT=filename

Examples:
uxins TSK EXP MU=* UPR=* CIBLE=HEADQUART INPUT=c:\temp\tsk.ext
uxins TSK EXP MU=* UPR=* MODEL CIBLE=model INPUT=c:\temp\tsk.ext

If tasks were extracted from production area, they can now be inserted in simulation, integration or
application areas by prior definition of the new value of the version (S_VUPR_REINSERT and
S_VSES_REINSERT node settings, Command Interface Settings category):
S_VUPR_REINSERT=XYZ
S_VSES_REINSERT=STU

XYZ being the new value of the Uproc version should be at least 001 to insert the task in
integration or application areas.
STU the new value of the session version should be at least 001 to insert the task in
integration or application areas.

All the following insertion commands will use these settings to define the version of the
inserted Uprocs, session or tasks (whatever the target area).

3.3.3.2 Families
The families, listed below, are mutually exclusive in the uxupd command.
TECHINF: Technical information.
Enables the task's technical information to be defined (user account, batch queue etc...).
92 | Chapter 3 Parameter Commands

PARENT: Main Task of a specific task.


CTLDUR: Time limit. Stops Task execution if it exceeds the specified time
TIME: Launch windows.
Enables definition of daily or multiple-daily launch windows for both scheduled and optional
tasks and the launch times for cyclical tasks together with launch and exclusion windows for
provoked tasks

To change a task from multiple launches per day to daily (or vice versa), first execute a
command to change the task type (MULT ou NOMULT), then execute a second command to
define the time(s) (TIME).
IMPL: Implicit schedule.
Enables the attribution of a scheduling rule, its application date and the task's schedule by
date
EXPLI: Explicit schedule.
Enables the definition of explicit scheduling dates together with the associated processing
date
EXCLU: Exclusion dates.
Enables the prohibition of specific implicitly calculated schedule dates for this task
INTERVAL: Exclusion window.
This defines exclusion windows during which the scheduling of future launches (using rules in
the task) will be inhibited.
LAUNCHVAR: A task’s variables.
Enables task variables to be created with values, or to be deleted. These variables must be
selected from the list of variables of the Uproc identifying the task.

3.3.3.3 Description of Items


UPR: Uproc code. Format: 64 alphanumeric characters.
Requires a Uproc code (wildcard accepted except for uxadd) – compulsory if TSK is not
indicated.
TUPR: Task’s Uproc code, result of the duplication. Format: 64 alphanumeric characters.
VUPR: Uproc version. Format: 3 numeric characters.
Accepts a specific Uproc version number. By default, all versions of specified Uprocs are
considered (irrelevant for SIM and EXP).
TVUPR: Uproc version of the task, result of the duplication. Format: 3 numeric characters.
Compulsory for uxdup tsk
TSK: Task code, compulsory if UPR is not specified. Format: 64 alphanumeric characters. If the Task
code is empty, the default value is: TSK(SSS)(VVV)(UUU)(VVV) with:
o (SSS)(VVV): code and Session version
o (UUU)(VVV): code and Uproc version
TTSK: Task code resulting from duplication. Format: 64 alphanumeric characters.
SES: Session code. Format: 64 alphanumeric characters.
The session code (wildcard accepted except for uxadd).
TSES: Task’s session code, result of the duplication. Format: 64 alphanumeric characters.
VSES: Session version. Format: 3 numeric characters.
Chapter 3 Parameter Commands | 93

Accepts a specific session version number. By default, all versions of specified sessions are
considered (irrelevant for SIM and EXP).
TVSES: Session version of the task, result of the duplication. Format: 3 numeric characters.
MU (or UG): Model or Management unit code. Format: 64 alphanumeric characters.
Requires a management unit code (wildcard accepted except for uxadd) or in the case of a
model an identifier; data input compulsory.
TMU: Management unit code of the task, result of the duplication. Format: 64 alphanumeric
characters.
TYPE: Type of task in its definition. Format: S (scheduled), O (optional), P (provoked) or C (cyclical).
TTYPE: Filter on the task type. Format: S (scheduled) O (optional), P (provoked) or C (cyclical).
MODEL: Nature of task. Indicates that the task selected is a model. Nothing needs to be specified for
a non-model task.
The MODEL argument specifies, to the uxins command, which the task has to be inserted as
model. The task will be inserted as non-model if nothing is specified (even if the task has
been extracted as a model one).
TNOMODEL: Nature of the task generated by the duplication. Specifies that the result of the
duplication has to be a non-model task
TMODEL has to be used to duplicate a task in a model one.
PDATE: Processing date calculation algorithm.
Enables calculation of a processing date which is automatically offset from that normally
supplied by the calculator.
Format: (J,U,T) where:
o J: is the number of days offset (signed) for a Uproc with a functional period, otherwise 0,
o U: is the number of functional period units to offset: if the required offset is a number of
days, this value should be "0".
o T indicates whether the offset is calculated in working (W) or calendar (C).
Default value: The processing date is normally calculated in relation to the scheduled date at
the start of the launch window.
For example: PDATE=(-1,0,C): minus one calendar day in the same month.
OFFSET: Offset applied to the date that the job would be normally scheduled by the calculator. The
offset is a number of days, and can be applied either forward or back (+ or -).
Format: ±nn[D|C|H|W] or NONE
o ±nn: Number of days (positive or negative), less than or equal to 99.
o D: Shift in calendar days
o C: Shift in closing days
o H: Shift in holidays
o W: Shift in working days
o NONE: No shift
PDATE_OFFSET:
o Y: The processing date is calculated after calculating OFFSET (possibly)
o N: The processing date is calculated from the original date in V5 but from the launch date
in V6.
For example: if a rule is created that specifies a run on the first working day of each week. A
task uses this rule with a rule offset of 1. If Monday is a closed day, the run will then be
Tuesday. The processing date will be:
94 | Chapter 3 Parameter Commands

In V5:
o Wednesday if PDATE_OFFSET=Y.
o Monday if PDATE_OFFSET=N.
In V6:
o Wednesday if PDATE_OFFSET=Y.
o Tuesday if PDATE_OFFSET=N.
PRINTER: Printer. Not used under UNIX and Windows.
PRTY: Priority. Format: 3 numeric characters between 001 and 255. Default value: 100.
Task's priority upon entering the batch queue
QUEUE: Batch queue. Format: 31 alphanumeric characters ("$" accepted under OpenVMS).
Batch queue into which the task will be submitted. Default value: SYS_BATCH (SYS$BATCH
on OpenVMS).
USER: Submission account. Format: 64 alphanumeric characters.
User account under which the task will be run
HOLD: Simulated task. Default value: NOHOLD: non-simulated task.
HOLD and DISABLE are incompatibles.
DISABLE: Disabled task. ENABLE: Enabled task
HOLD and DISABLE are incompatibles.
FORCE: Forced launch at end of window. Default value: NOFORCE.
Indicates that, if at the end of the launch window the task is in an EVENT_WAIT state, it will
be submitted for execution regardless.
HISTORY: execution details of the Uprocs in the Task will be permanently recorded in the execution
History.
Default value: HISTORY. Opposite: NOHISTORY: no permanent record.
SERIAL: type of launch. Default value: SERIAL.
The next launch of the task will be calculated at the end of the task’s launch window. The
value PARALLEL means that parallel launches are possible because the next launch is
calculated at the start of the launch window.
OPT_W_EVENT: for an optional task, the event will be created (status Terminated, if the Uproc is
stored) even if the optional task did not run because of its planning.
Default value: OPT_WO_EVENT: the event will not be created.
PARENT_TSK: Main task code to with the specified Task (already created) will be tied.
o ANY: the inclusion of the optional task by the main task is based on codes and the MU
Session (Dollar Universe V5 behavior).
:PARENT_TSK and PARENT_MU must be consistent.
PARENT_MU: Management unit Code of the main task to which the specific task (already created)
will be tied:
o Management unit code
o ANY: the inclusion of the optional task by the main task is based on codes and the MU
session (Dollar Universe V5 behavior).
:PARENT_TSK and PARENT_MU must be consistent.
HEULIM: Control the time limit for implementation of the Task. Beyond this time, the task will be
stopped. Format: (HHMM, B):
Chapter 3 Parameter Commands | 95

o HHMM: is the deadline for implementing the Task: all Uprocs if a Session.
o (HHMM,B): the current Task jobs are suspended (on UNIX and OpenVMS only) beyond
the specified time.
o (HHMM,): the jobs are stopped beyond the time indicated.
MULT: Multiple launches.
Indicates that there are multiple launches per day. The time family must therefore be
accompanied by the keyword MULW.
Default value: NOMULT. In that case, the time family should therefore be accompanied by the
keyword DALW for a scheduled task or PRLW for a provoked task.

To change a task from multiple launches per day to daily (or vice versa), first execute a
command to change the task type (MULT ou NOMULT), then execute a second command to
define the time(s) (TIME).
AUTOREL: Automatic relaunch. In this case the TIME family should be supplemented with the
keyword RELW.
Default value: NOAUTOREL.
CIBLE: Insertion Management units targets. Mandatory. Used only with uxins. Format:
o *: wildcard accepted,
o A Management Unit code, if the target is unique,
o (MU_CODE,MU_CODE,…) in case there is a multiple target, MU_CODE is the
management unit code..
If two distinct tasks result of the insertion of the same task (possibly in the same command),
the second insertion is rejected, as it would be if the task already existed (a warning message
is provided with each rejection). If the option "REPL" is used, the last insertion overwrites the
first one.
With CIBLE=*, the non-models task are inserted with their origin Management Unit (the one
specified when extracted). The management unit specified in the import data file is
dynamically checked and has to exist on the target node. In case the management unit does
not exist on the target node, the task is not inserted. This does not block the insertion of the
next tasks contained in the extraction data file.
This functionality allow the backup/restore of the complete active schedule with the 4
following commands (It is recommended to do two different extractions, one for the model
tasks and one for the non-model tasks).
uxext TSK SES=* UPR=* MU=* OUTPUT=c:\temp\tsk_nomod.ext
uxins TSK SES=* UPR=* MU=* CIBLE=* INPUT=c:\temp\tsk_nomod.ext
uxext TSK SES=* UPR=* MU=* MODEL OUTPUT=c:\temp\tsk_mod.ext
uxins TSK SES=* UPR=* MU=* MODEL CIBLE=* INPUT=c:\temp\tsk_mod.ext

REPL: Replacement option.


Indicates whether the extracted (or inserted) record cancels and replaces the record already
existing in the destination file (or task); by default, the extraction (or insertion) is refused (a
message signaling this at every occurrence) for each record which already exists.
INF: Display option. Confines display to the names of the objects. Alternative value: FULL (by default).
Displays all available information on the list of objects
ASTIME or MUTIME: Reference time used by the command. If MUTIME is used, the column MU
TIME OFFSET is displayed (uxlst). If this flag is not used in the command:
o If the U_TREF node setting is not defined or is "ASTIME", reference time is the server.
o If the U_TREF node setting is "MUTIME", reference time is the Management Unit.
96 | Chapter 3 Parameter Commands

DALW: Daily launch windows. Must be associated with the keyword NOMULT
Indicates the start of the launch window and its duration. A standard window may be defined
whatever the day of the week (keyword: DALW); exceptions may be made for each day
(keywords: MON, TUE, WED, THU, FRI, SAT, SUN)
Format: DALW=(HHMM,HHH,MM):
o HHMM: Starting time of the window, in hours and minutes,
o HHH: Duration of the window in hours,
o MM: Duration of the window in minutes.
The number of characters used for entering the hours and minutes must be respected
exactly.
MULW: Multiple daily launch windows. Must be associated with the keyword MULT.
Enables the definition of multiple launch windows within a day
Format: MULW=((HHMM,HHMM,MMM),HHH,MM):
o HHMM,HHMM: Start and end of the calculation, in hours and minutes,
o MMM: Frequency of the calculation,
o HHH: Launch window duration in hours,
o MM: Launch window duration in minutes.
The module (HHMM,HHMM,MMM) may be repeated as many times as necessary.
The number of characters for entering the hours and minutes must be respected exactly.
RELW: Launch times for a task with automatic relaunch. This must be associated with the AUTOREL
keyword.
A validity window can be defined to determine the delay between relaunches and the
maximum number of retries.
Format: RELW=((hhmm),hhh,mm,hhh,mm,nnnn,hhh,mm)
o HHMM: start time validity window in hours and minutes
o HHH,MM: Task launch window duration in hours and minutes
o HHH,MM: time to wait in hours and minutes after the task execution to restart the job
o NNNN: maximum number of relaunches during the window of validity. 0000 expresses an
unlimited number
o HHH,MM: maximum duration
The number of characters used to express hours and minutes must be respected.
PRLW: Provoked task launch window.
Enables the definition of launch and exclusion windows
By default, no launch window is defined: The task will be submitted as soon as it is provoked.
Format: PRLW=(HHMM,HHH,MM,HHMM,HHMM):
o HHMM: Start of Launch Window, or ONDEMAND keyword to launch the task
immediately,
o HHH: Duration of the window in hours,
o MM: Duration of the window in minutes,
o HHMM,HHMM: Start and end time of the exclusion window,
The number of characters for entering the hours and minutes must be respected exactly.
CYCLICAL: Launch timetable for a cyclical task.
Chapter 3 Parameter Commands | 97

Format: CYCLICAL=((hhhhh,mm),(U_FMT_DATE),(hhmm),(hhh,mm)):
o HHHHH,MM: duration of the scheduling cycle.
o U_FMT_DATE: date of origin.
o HHMM: time of origin.
o HHH,MM: duration of the launch window.
The number of characters in the hours and minutes entry must be correct.
RULE: Task scheduling rule.
Enables the addition of one or more scheduling rules to the task (or deleting existing ones)
Format: ((RULE_CODE,A_DATE)( RULE_CODE,A_DATE)…) where:
o RULE_CODE is the code of the rule in question. By default, RULE_CODE is an inclusion
rule. An inclusion rule can also begin with a “+” character. An exclusion rule must start
with the “-”. If the specified rule code corresponds to a rule with a name that begins with
'+' or '-', it is mandatory to add the “+” sign for an inclusion rule or the “-” sign for an
exclusion rule to the beginning of the RULE_CODE.
o A_DATE is the rule's application date for the task with the format indicated by the value of
the setting U_FMT_DATE.
The module (RULE_CODE, A_DATE) may be repeated a maximum of seven times in the
same command.
The number of A_DATE characters must be respected exactly.
SDATE: First schedule date. Indicates from which date the task must be scheduled.
Format: Indicated by the value of the setting U_FMT_DATE. SDATE is maintained for
compatibility, START_VALID and END_VALID should be used instead.
START_VALID: Start of validity date or first schedule date. Indicates from which date the task must
be scheduled.
Format: Indicated by the value of the setting U_FMT_DATE.
END_VALID: End of validity date. No launches will be generated after this date.
Format: Indicated by the value of the setting U_FMT_DATE, or NONE if no end date is
planned.
EDATE: Explicit dates. Adds or deletes an explicit schedule date to the task. Format
((E_DATE,HHMM,HHH,MM,P_DATE)…) where:
o E_DATE is the explicit launch date with the format indicated by the value of the setting
U_FMT_DATE,
o HHMM is the launch window start time,
o HHH is the launch window duration in hours,
o MM is the launch window duration in minutes,
o P_DATE is the processing date associated with the scheduled, with the format indicated
by the value of the setting U_FMT_DATE.
The module (E_DATE,HHMM,HHH,MM,P_DATE) may be repeated in the same command as
many times as there are explicit dates to be added or deleted.
The number of characters must be respected exactly.
XDATE: Exclusion dates. Enables exclusion dates to be added to or deleted from the task.
Format: ((X_DATE)…) where:
o X_DATE is the date on which implicitly scheduled launches are to be prohibited, with the
format indicated by the value of the setting U_FMT_DATE.
98 | Chapter 3 Parameter Commands

The module (X_DATE) may be repeated as many times in the same command as there are
exclusion dates to be added or deleted.
The number of characters must be respected exactly.
EXCLUSION: exclusion window. Enables an exclusion window to be added to or deleted from the
task.
Format: ((U_FMT_DATE,hhmm,U_FMT_DATE,hhmm)(…)) where:
U_FMT_DATE: is the start date of the exclusion window.
HHMM: is the start time of the exclusion window.
U_FMT_DATE: is the end date of the exclusion window.
HHMM: is the end time of the exclusion window.
The module can be repeated as many times in the same command as there are exclusion
windows to be added or deleted.
The number of characters must be correct.
VARNAME: A variable’s name. Format: A maximum of 20 alphanumeric characters.
This name must be selected from the list of variables of the Uproc identifying the task. Data
input is compulsory.
VVALUE: The value of the variable in the task.
If the default value of the Uproc variable has to be modified, V value must be entered.
If the value contains non-alphanumeric characters (e.g. spaces, /…) it must be enclosed
within quotation marks.
The format must be compatible with the format declared upon creation of the variable in the
Uproc. The value must fall within the range defined for a quantity-type variable.
OUTPUT: Storage of results. The file name is compulsory for the uxext command
If not specified output will be displayed on the screen.
INPUT: Input file for the uxins command. The file name is compulsory.
TESP: Area code, target of the transfer: X for Production, S for Simulation or I for Integration.
NOVERIF: Only to be used with the uxext command.
The NOVERIF option forces the command to skip the checking of the output data file before
the insertion of the new records. This enhances the performances and can only be used for
the creation of a new output data file.

3.3.3.4 Examples
uxadd TSK EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL MU=HEADQUART TECHINF type=S
USER=admin

Creates a task from the session D_LOAD_BCK, with the Uproc header D_LOAD_FIL on the
non-model HEADQUART management unit in the production area. Once the task has been
scheduled the submission account is admin. This task cannot generate a launch since no
dates has been defined.
uxupd TSK EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL MU=HEADQUART TECHINF PDATE=(-
1,0,W)

Updates the task created above by indicating that the calculation of the processing date is
"minus one working day" relative to the date of the launch’s first condition check. Other
parameters have kept their values.
uxupd TSK EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL MU=HEADQUART TIME
DALW=(2100,005,00) WED=(1900,005,00)
Chapter 3 Parameter Commands | 99

Updates the task created above by indicating launch times: Every day for 5 hours from
21.00hrs except Wednesdays – 5 hours from 19.00hrs.
uxupd TSK EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL MU=HEADQUART IMPL ADD
rule=(("LWDM",19990501)("5CDMO",19990501))

Updates the task created above by indicating a scheduling according to the two rules
"LWDM" (last working day in the month) and "5CDMO+" (fifth day of the month offset to the
next working day) with dates of application foreseen for 1st May 1999 where the setting
U_FMT_DATE has the value YYYYMMDD.
uxupd TSK EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL MU=HEADQUART IMPL add
rule="(("++FWDM",01/01/2010))"

Updates the task created above by indicating a scheduling according to the inclusion rule
“++FWDM” (First working day of every month) with the date of application foreseen for the
January 1s 2010 where the setting U_FMT_DATE has the value of DD/MM/YYYY.
uxupd TSK EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL MU=HEADQUART IMPL add rule="(("-
+FWDM",01/01/2010))"

Updates the task created above by indicating a scheduling according to the exclusion rule “-
+FWDM” (First working day of every month) with the date of application foreseen for the
January 1s 2010 where the setting U_FMT_DATE has the value of DD/MM/YYYY.
uxupd TSK EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL MU=HEADQUART EXPLI ADD
EDATE=((19991230,2100,005,00,19991231))

Updates the task created above by creating an explicit date for 30th December 1999 at 21.00
hrs for 5 hours with the processing date of 31st December 1999 where the setting
U_FMT_DATE has the value YYYYMMDD.
uxupd TSK EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL MU=HEADQUART EXCLU ADD
XDATE=((19991231))

Updates the task created above by creating an exclusion date for 31st December 1999 where
the setting U_FMT_DATE has the value YYYYMMDD.
uxadd TSK EXP UPR=D_LOAD_FIL MU=HEADQUART TECHINF TYPE=P USER=admin

Creates a provoked task of the Uproc D_LOAD_FIL on the non-model HEADQUART


Management unit in the production area. The submission account is admin.
uxupd TSK EXP UPR= D_LOAD_FIL MU=HEADQUART TIME
PRLW="(ONDEMAND,000,00,0000,0000)"

Launches the task immediately.


uxlst TSK EXP UPR=D_* FULL

Lists the tasks which have just been created together with their characteristics.
uxupd TSK UPR=D_LOAD_FIL MU=SIEGE LAUNCHVAR ADD VARNAME=VARTXT
VVALUE=XY_VARTXT_TSK

Modifies the value of the variable VARTXT defined for D_LOAD_FIL by giving a value by
default of "XY_VARTXT_TSK" for this variable in the task.
uxupd TSK UPR=D_LOAD_FIL MU=SIEGE LAUNCHVAR ADD VARNAME=VARDATE
VVALUE=2000/01/01

Modifies the value of the variable VARDATE defined for D_LOAD_FIL by giving a value by
default of "2000/01/01" for this variable in the task.
uxext TSK EXP MU=MOD UPR=D_* MODEL output=c:\temp\DOC.ext

Extracts all model tasks "MOD" from the production area whose Uproc begins with D_ and
archives the data in the file c:\temp\DOC.ext.
uxins TSK EXP MU=* UPR=* CIBLE=HEADQUART input=c:\temp\DOC.ext

Inserts all (non template) tasks of the file c:\temp\DOC.ext as tasks of the HEADQUART
management unit in the current environment (company, node) in the production area unless
they already exist.
100 | Chapter 3 Parameter Commands

uxins TSK EXP MU=* UPR=* CIBLE=* MODEL input=c:\temp\DOC.ext

Inserts all tasks of the file c:\temp\DOC.ext as template tasks in the current environment
(company, node) in the production area unless they already exist.
uxadd upr exp upr=UPR_1 appl=U_ fperiod=d
uxadd ses exp ses=SES_1 header=UPR_1
uxadd ses exp ses=SES_2 header=UPR_1
uxadd MU MU=MU_1 TNODE=%S_NODENAME%
uxadd MU MU=MU_2 TNODE=%S_NODENAME%
uxadd USER USER=USER_1
uxadd tsk exp tsk=parent_task ses=SES_1 upr=UPR_1 MU=MU_1 TECHINF TYPE=o
USER=USER_1
uxadd tsk exp tsk=child_task ses=SES_2 upr=UPR_1 MU=MU_1 TECHINF TYPE=o
USER=USER_1
uxupd tsk exp tsk=child_task MU=MU_1 PARENT PARENT_TSK=parent_task
PARENT_MU=MU_2

This example shows the creation of 2 specific Tasks linked to a main task.

3.4 Triggers

3.4.1 Commands
uxadd TRIG: Adds a trigger in the triggers list with a custom event type. The event types custom and
_SAPJOB are exclusive and have different event properties.
Item Format Default
TRIG= 64c
TYPE= 64 c
ENABLE | DISABLE ENABLE
TRANSMITTED | NOTTRANSMITTED TRANSMITTED
LABEL= 64c
APP | INT | SIM | EXP 3c S_ESPEXE
NODE=

Example:
uxadd TRIG TRIG=TRIG_1 TYPE=WINDOWS_EVENT LABEL=TRIGGER_WINDOWS
uxadd TRIG: Adds a trigger in the triggers list with a _SAPJOB event type
Item Format Default
TRIG= 64c
TYPE=_SAPJOB
ENABLE | DISABLE ENABLE
TRANSMITTED | NOTTRANSMITTED TRANSMITTED
LABEL= 64c
APP | INT | SIM | EXP 3c S_ESPEXE
NODE=

Example:
Chapter 3 Parameter Commands | 101

uxadd TRIG TRIG=SAP_trig TYPE=_SAPJOB ENABLE EXP

uxupd TRIG: Modifies the characteristics of a trigger.


Item Format Default
TRIG= 64c
TYPE= 64c
LABEL= 64c
ENABLE | DISABLE
TRANSMITTED | NOTTRANSMITTED

Example:
uxupd TRIG TRIG=TRIG_1 LABEL=TRIGGER_WINDOWS DISABLED

ACTION: Determines the specifications for launching the task associated with the trigger.
Item Format Défaut
ACTION 64c
TSK 64c
MU 64c
MODEL | NOMODEL NOMODEL
DURATION HHHMM

Example:
uxupd TRIG TRIG=TRIG_33 ACTION TSK=TASK_33 MU=calpm001 DURATION=00045

CONDITIONS add: Adds a condition based on event properties. This command is not available for
_SAPJOB type triggers.
Item Format Default
NAME= 64c
VALUE= 64c

Examples:
uxupd TRIG TRIG=TRIG_001 CONDITIONS add NAME=FILE_RESOURCE VALUE=FILE01
uxupd TRIG TRIG=TRIG_WINDOWS CONDITIONS add NAME=FILE_SIZE VALUE=2KB

CONDITIONS upd: Modifies the conditions in a trigger with a custom event.


Item Format Default
NAME= 64c
VALUE= 64c

Example:
uxupd TRIG TRIG=TRIG01 CONDITIONS upd NAME=FILE VALUE=FILE01

CONDITIONS upd: Modifies the condition of a trigger with a _SAPJOB event.


Item Format Default
NAME= SAPJOB_NAME | SAPJOB_STATUS | *
SAPJOB_GROUP | SAP_JOBUSER
VALUE= 64c

Example:
uxupd TRIG TRIG=TRIG_2 CONDITIONS upd NAME=SAPJOB_NAME VALUE=2

Once a _SAPJOB type trigger is created, conditions can only be modified, they cannot be
added or removed.
102 | Chapter 3 Parameter Commands

CONDITIONS dlt: Deletes the condition in a trigger. This command is not available for _SAPJOB type
triggers.
Item Format Default
NAME= 64c
VALUE= 64c

Example:
uxupd TRIG TRIG=TRIG22 CONDITIONS dlt NAME=FILE_RESOURCE

uxdup TRIG: Duplicates an existing trigger.


Item Format Default
TRIG= 64c
TTRIG= 64c
TTYPE= 64c
TTSK= 64c
TLABEL= 64c
APP | INT | SIM | EXP S_ESPEXE
NODE=

Example:
uxdup TRIG TRIG=TEST_11 TTRIG=TEST_22 TLABEL=duplicate

uxshw TRIG: Displays the characteristics of a trigger.


Item Format Default
TRIG 64c
TYPE= 64c
OUTPUT=filename
APP | INT | SIM | EXP S_ESPEXE
NODE= 64c

Example:
uxshw TRIG TRIG=TRIG_01

uxdlt TRIG: Deletes a trigger.


Item Format Default
TRIG= 64c
EXP | SIM | INT | APP S_ESPEXE
NODE=

Example:
uxdlt TRIG TRIG=TRIG_01

uxlst TRIG: Lists available triggers.


Item Format Default
TRIG= 64c
TYPE= 64c | _SAPJOB
EXP | SIM | INT | APP S_ESPEXE
OUTPUT=filename
INF | FULL INF

Example:
Chapter 3 Parameter Commands | 103

uxlst TRIG FULL OUTPUT="C:\temp\lsttrigger.ext"

uxext TRIG: Extracts the complete definition of a trigger.


Item Format Default
TRIG= 64c
TYPE= 64c | _SAPJOB
EXP | SIM | INT | APP S_ESPEXE
OUTPUT=filename

Example:
uxext TRIG TRIG=TRIG_01 OUTPUT="C:\temp\trigger.txt"

uxins TRIG: Inserts the complete definition of a trigger in the corresponding Dollar Universe files.
Item Format Default
TRIG= 64c
TYPE= 64c
EXP | SIM | INT | APP S_ESPEXE
INPUT=filename

Example:
uxins TRIG TRIG=TRIG01 INPUT="C:\temp\trigger.txt"

3.4.2 Families
CONDITIONS: The conditions for filtering event properties.
ACTION: The specifications for launching the trigger (task, MU, duration, template and non template).

3.4.3 Description of Items


TRIG: Trigger name. Format 64 alphanumeric characters.
TTRIG: Trigger name, result of the duplication. Format: 64 alphanumeric characters.
LABEL: Label describing the trigger. Format: 64 alphanumeric characters.
TLABEL: Trigger label, result of the duplication. Format: 64 alphanumeric characters.
TYPE: Event type. Format: 64 alphanumeric characters. Built-in types starting with a _ are reserved
and have predefined properties and conditions.
The current built-in type is: _SAPJOB
NAME: Name of the event property. Format: 64 alphanumeric characters. _SAPJOB properties are
predefined:
o SAPJOB_NAME: Name of the SAP job, format 64 characters, empty by default.
o SAPJOB_STATUS: AFRSP by default (aborted, finished, running, scheduled or
preliminary). In the cases of status duplication, all occurrences after the first match are
ignored. For example: "name=SAPJOB_STATUS value=AFFRSPF" is equivalent to
"name=SAPJOB_STATUS value=AFRSP".
The following table shows the mapping between the different values of status:
Letter SAP client interface DUAS CLI
A Canceled Aborted
F Finished Finished
104 | Chapter 3 Parameter Commands

Letter SAP client interface DUAS CLI


R Active Running
S Scheduled Preliminary
P Released Scheduled
- Ready -

o SAPJOB_GROUP: user group, * by default


o SAPJOB_USER: SAP user name, * by default
VALUE: Expected value of the event property
TSK: Task code. Format: 64 alphanumeric characters. If the Task code is empty, the default value is:
TSK(SSS)(VVV)(UUU)(VVV) with:
o (SSS)(VVV): code and Session version
o (UUU)(VVV): code and Uproc version
MU: Management Unit code. Format: 64 alphanumeric characters.
ENABLE: Enabled trigger. DISABLED: Disabled trigger
DURATION: Launch window of the task. Format: HHHMM
INPUT: Input file for the uxins command. The file name is compulsory.
OUTPUT: Storage of results. The file name is compulsory for the uxext command. If the item is empty
the exit will be on the screen.
TRANSMITTED | NOTTRANSMITTED: Determines if the event property conditions are applied to the
task of the trigger with the associated values.
FULL: Displays the task name and Management Unit of the task linked to the trigger.
Alternative value (by default) INF: displays only the trigger header.
FULL and INF are mutually incompatible.
NOMODEL: Nature of the task.
Indicates that the selected task is not a model
MODEL indicates that the selected task is a model.

3.4.4 Examples
uxadd TRIG TRIG=TRIG_WINDOWS TYPE=WINDOWS_EVENT LABEL=WINDOWS_EVENT_TRIGGER
ENABLE TRANSMITTED

Creates a trigger based on a WINDOWS_EVENT event type. The trigger is enabled but has
no associated task.
uxupd TRIG TRIG=WINDOWS_EVENT ACTION TSK=TASK_1 MU=CALPM002 NOMODEL
DURATION=00330

Adds a task to the trigger created above on the Management Unit CALPM002, the nature is
non template and the launch window is 3 hours and 30 minutes.
uxupd TRIG TRIG=WINDOWS_EVENT DISABLED

Updates the trigger created about and modifies the trigger to disabled. If the specified event
type is received, the trigger will not launch the associated task.
uxupd TRIG TRIG=WINDOWS_EVENT CONDITIONS add NAME=FILE_NAME VALUE=REPORT.ext

Updates the trigger created above by adding the condition FILE_NAME with the value
REPORT.ext. If this file is found, then the trigger will launch the associated task.
Chapter 3 Parameter Commands | 105

uxupd TRIG TRIG=WINDOWS_EVENT CONDITIONS upd NAME=FILE_NAME


VALUE=ACCOUNT.ext

Updates the trigger created above by modify the condition FILE_NAME value to
ACCOUNT.ext.
uxadd TRIG TRIG=TRIG_SAP TYPE=_SAPJOB LABEL=SAP_JOB_TRIGGER TRANSMITTED

Creates a _SAPJOB type trigger that will transmit event properties if there is an associated
task.
uxupd TRIG TRIG=SAPJOB CONDITIONS upd SAPJOB_NAME=NEW_JOB

Modifies the SAPJOB_NAME condition of the trigger SAPJOB from * (by default) to
NEW_JOB.
uxext TRIG EXP TRIG=MAIL* output=c:\temp\user\FILE.ext

Extracts all triggers with name starting with “MAIL” in the production Area and archives the
data in the file c:\temp\user\FILE.ext.
uxins TRIG EXP input=c:\temp\user\FILE.ext

Inserts all triggers from the file c:\temp\FILE.ext in the current Dollar Universe production
environment.

3.5 Runbooks

3.5.1 Commands
uxadd BOOK: Create a new run book.

Item Format Default


BOOK= 64c
AREA=A | I | S | X 4c
DOM= 1c *
APPL= 64c *
TSK= 64c *
MU= 64c *
UPR= 64c *
SES= 64c *
USER= 64c *
QUEUE= 31c *
INFO= 50c *
SEV= 4n *
TYPE=BK_INT | BK_URL | BK_FILE_TXT | BK_FILE_BIN 12c BK_INT
FILE= 256c
URL= 256c
TEXT= 1024c “”

Example:
uxadd BOOK book=RUNBOOK1 area=X upr=TEST type=BK_INT text=\”runbook\”

uxupd BOOK: Update a run book.


106 | Chapter 3 Parameter Commands

Item Format Default


BOOK= 64c
AREA= A | I | S | X 4c *
DOM= 1c *
APPL= 64c *
TSK= 64c *
MU= 64c *
UPR= 64c *
SES= 64c *
USER= 64c *
QUEUE= 31c *
INFO= 50c *
SEV= 4n *
TYPE=BK_INT | BK_URL | BK_FILE_TXT | BK_FILE_BIN 12c
FILE= 256c
URL= 256c
TEXT= 1024c

Example:
uxupd book book=RUNBOOK1 type=BK_URL URL="http://http://www.automic.com/en/"

uxshw BOOK: Display the characteristics of a run book.

Item Format Défaut


BOOK= 64c *
TYPE=BK_INT | BK_URL | BK_FILE_TXT | BK_FILE_BIN 12c *
AREA= A | I | S | X 4c * *
DOM= 1c * *
APPL= 64c * *
TSK= 64c * *
MU= 64c * *
UPR= 64c * *
SES= 64c * *
USER= 64c * *
QUEUE= 31c * *
INFO= 50c * *
SEV= 4n * *
OUTPUT=file_name

Example:
uxshw BOOK BOOK=RUN*

uxlst BOOK: List the run books.

Item Format Default


BOOK= 64c *
TYPE=BK_INT | BK_URL | BK_FILE_TXT | BK_FILE_BIN 12c *
Chapter 3 Parameter Commands | 107

Item Format Default


AREA= 3c *
DOM= 1c *
APPL= 64c *
TSK= 64c *
MU= 64c *
UPR= 64c *
SES= 64c *
USER= 64c *
QUEUE= 31c *
INFO= 50c *
SEV= 4n *
FULL | INF FULL
OUTPUT=file_name

Example:
uxlst BOOK FULL OUTPUT=c:\temp\LstBook.txt

uxdlt BOOK: Delete a run book.

Item Format Default


BOOK= 64c

Example:
uxdlt BOOK BOOK=RUNBOOK1

uxext BOOK: Extracts the complete definition of a run book.

Item Format Default


BOOK=* 64c *
REPL
OUTPUT=filename

Example:
uxext BOOK BOOK=D* OUTPUT="c:\temp\Book.ext"

uxins BOOK: Inserts the complete definition of a run book in the corresponding Dollar Universe files.

Item Format Default


BOOK=* 64c *
REPL
INPUT=filename

Example:
uxins BOOK BOOK=* INPUT="c:\temp\Book.ext"

3.5.2 Description of Items


BOOK: enter the run book’s name. Format 64 alphanumeric characters.
The information below selects the executions that the runbook displays.
108 | Chapter 3 Parameter Commands

AREA: area(s) in which the run book must be used. Enter 1 to 4 characters from A, I, S, X
 A: Application Area
 I: Integration Area
 S: Simulation Area
 X: Production Area
DOM: Enter the application execution code (1 alphanumeric character) for which the runbook must be
used or*.
APPL: Enter the job application code (64 alphanumeric characters) for which the runbook must be
used or *.
TSK: Enter the Task code (64 alphanumeric characters) for which the runbook must be used or *.
MU: Enter the Management unit code (64 alphanumeric characters) for which the runbook must be
used or *.
SES: Enter the session code (64 alphanumeric characters) for which the runbook must be used or *.
UPR: Enter the Uproc code (64 alphanumeric characters) for which the runbook must be used or *.
USER: Enter the job’s user account code (64 alphanumeric characters) for which the runbook must be
used or *.
QUEUE: Enter the DQM job queue code (31 alphanumeric characters) for which the runbook must be
used or *.
INFO: Enter the job Information field code (50 alphanumeric characters) for which the runbook must
be used or *.
SEV: Enter the code for the job serverity value (4 alphanumeric characters) for which the runbook
must be used or *.
TYPE: Type of run book. (Format 12 alphanumeric characters). Enter one of the four values below:
 BK_INT: Internal run book (value by default for uxadd). Complete this information by the
TEXT item below:
TEXT: Enter the instructions that appear when the run book file is displayed.
 BK_URL: External URL. Complete this information (obligatory) with the URL item below.
URL: Enter the name of the URL to open using quote marks.
 BK_FILE_TEXT: External text file. Complete this information (obligatory) with the FILE item
FILE below.
 BK_FILE_BIN: External executable file. Complete this information (obligatory) with the FILE
item FILE below.
FILE: Enter the name of this file to open or execute. The maximum size of an attached file is
10 MB. Once the file is attached and the runbook is saved, the file is copied in the Dollar
Universe /data/runbooks subdirectory.
INF: Display option. Limit display to object names. Other value: FULL (by default).
Display all available information on the object list.
REPL: Replacement option.
Indicates whether the record extracted (or inserted) deletes and replaces the record that
already exists in the destination file; by default, the extraction (or insertion) is refused for each
record that already exists (indicated by a message in each occurrence).
INPUT: Input file for the uxins command. The file name is compulsory.
OUTPUT: Storage of results. The file name is compulsory for the uxext command. If the item is empty
the exit will be on the screen.
Chapter 3 Parameter Commands | 109

3.5.3 Examples
uxadd BOOK book=TEST appl=COMPTA type=BK_FILE_TEXT FILE=c:\temp\text.txt

Create a run book (all areas by default) named TEST for all the COMPTA application jobs.
This run book will be available in an external file: c: \ temp \ text.txt.
110 | Chapter 4 Operations Commands

4 Operations Commands

4.1 Parameter Setting Objects

4.1.1 Resources

4.1.1.1 Commands
The resource must have been condition-checked with quotas before being able to execute one of the
uxhld, uxrls or uxshw commands.
uxhld RES: Enables total or partial allocation of a resource.

If the resource contains one or more of the following variable elements !SOC!, !MU! (or !UG!)
or !DTRAIT!, quota allocated will take into account the value of these elements in the
command. If the resource contains none of the variable elements !SOC!, !MU! (or !UG!) or
!DTRAIT!, any values provided for these elements in the command will be ignored.

Item Format Default


RES= 64c *
LOCK | QT1= & QT2=
QT1= 4n 0
QT2= 4n 0
MU= 64c * " " *
PDATE= YYYYMMDD * " " *
ESP= X|S|I|A|*"" *
TSOC= 6c * " " *

Example:
uxhld RES RES=D_BASE QT1=4

uxrls RES: Enables total or partial de-allocation of a resource.

Item Format Default


RES= 64c *
CLEAR | QT1= & QT2=
QT1= 4n 0
QT2= 4n 0
MU= 64c * " " *
PDATE= YYYYMMDD * " " *
ESP= X|S|I|A|*"" *
TSOC= 6c * " " *

The uxrls res command invokes the I/O servers of all areas and can be time consuming. In
order to optimize the performance, the node setting U_RES_AVAIL_AREAS (Advanced
Chapter 4 Operations Commands | 111

Settings category) should be set to the area code of the active areas. Refer to the UniViewer
Interface for Dollar Universe Manual.

The OS/400 command UXRLSRES frees a resource from the command line. The F4 key allows the
user to enter each parameter individually. The F11 key displays the name of each parameter.
Example:
uxrls RES RES=D_BASE CLEAR

uxshw RES: Displays details of the definition and allocation of a resource.

Item Format Default


RES= 64c *
TSOC= 6c *" "
MU= 64c *" "
PDATE= YYYYMMDD * " "
ESP= X|S|I|A|*""
INF | FULL | RSV INF
OUTPUT=file name

Example:
uxshw RES RES=D_*

uxrsv RES: Enables a resource to be reserved for a task so as to define a scheduling priority.

Item Format Default


RES= 64c *
EXP | SIM | INT | APP 3c S_ESPEXE
TSK= 64c
UPR= 64c
VUPR= 3n
SES= 64c
VSES= 3n
MU= 64c
QT1= 4n
QT2= 4n
ESP= X|S|I|A|*""
TSOC= 6c * " "
PDATE= YYYYMMDD * " "

Example:
uxrsv RES RES=D_FIL_PAY ESP=X UPR=TEST_ECA MU=$S_NODENAME QT1=10 QT2=0
PDATE=$S_DATRAIT

Warning: The S_DATRAIT variable is defined internally in the Uproc script.


uxcnr RES: Enables reservation of a resource via the command uxrsv to be deleted.

Item Format Default


RES= 64c *
EXP | SIM | INT | APP 3c S_ESPEXE
TSK= 64c
UPR= 64c *
112 | Chapter 4 Operations Commands

Item Format Default


VUPR= 3n
SES= 64c
VSES= 3n
MU= 64c
TSOC= 6c * " "
ESP= X|S|I|A|*""
PDATE= YYYYMMDD * " "

Example:
uxcnr RES RES=D_FIL_PAY ESP=X UPR=TEST_ECA MU=$S_NODENAME PDATE=$S_DATRAIT

Warning: The S_DATRAIT variable is defined internally in the Uproc script.


uxpre RES: Deletes the event resources for which the quotas have been released. (!UG!, !PDATE!,
!SOC! or !ESP! can be used to variabalize the resource).

Item Format Default


RES= 64c *
EXP | SIM | INT | APP 3c S_ESPEXE
MU= 64c *
PDATE= YYYYMMDD * " "
TSOC= 6c * " "
ESP= X|S|I|A|*""

4.1.1.2 Description of Items


RES: Resource identifier. Format: 64 alphanumeric characters.
Requires the reference of the resource (wildcard accepted with the uxshw command using
the FULL option)
TSOC: Company code. Format: 6 alphanumeric characters.
Enables the selection of Resources which refer to a company either in the file name or its
localization
Use of the "*" (asterisk) will select all resources referring to a company. Use of the character
"" (blank) will select all resources which contain no company reference
ESP: Area code. Format: 1 character: "X" "S" "I" "A" "*" or " ".
Enables the selection of resources which refers to a area either in the file name or its
localization.
Use of the "*" (asterisk) will select all resources referring to an area. Use of the character " "
(blank) will select all resources which bear no area reference.
For commands uxrsv and uxcnr, enables specification of in which area the task which has
made the reservation is to be found. The default area is that described by the variable
S_ESPEXE.
TSK: Task code that reserves or liberates the resource. Format: 64 alphanumeric characters.
Mandatory if UPR is absent.
UPR: Uproc code. Format: 64 alphanumeric characters. Only commands uxrsv and uxcnr.
Requires entry of a Uproc code which is the identifier of the task which reserves or releases
the resource. (Generic value accepted except for uxrsv). Compulsory if TSK is absent.
Chapter 4 Operations Commands | 113

VUPR: Uproc version. Format: 3 numerical characters. Only commands uxrsv and uxcnr.
Allows a particular version of a Uproc to be entered.
By default, all versions of filled-in Uprocs are considered (serves no purpose with SIM and
EXP).
SES: Session code. Format: 64 alphanumeric characters. Only commands uxrsv and uxcnr.
Requires entry of a session code which is the identifier of the task which reserves or releases
the resource. (Generic value accepted except for uxrsv).
VSES: Session version. Format: 3 numerical characters. Only commands uxrsv and uxcnr.
Allows a particular version of a session to be entered. By default, all versions of filled-in
sessions are considered (serves no purpose with SIM and EXP).
MU: Management unit. Format: 64 alphanumeric characters.
Enables the selection of resources which refers to a management unit either in the file name
or its localization
Use of the "*" (asterisk) will select all resources referring to an management unit. Use of the
character " " (blank) will select all resources which bear no management unit reference.
For commands uxrsv and uxcnr, enables the task which reserves or releases the resource to
be identified.
PDATE: Processing date. Format: YYYYMMDD.
Enables the selection of resources which refers to a processing date either in the file name or
its localization
Use of the "*" (asterisk) will select all resources referring to a processing date. Use of the
character "" (blank) will select all resources which bear no processing date reference
For commands uxrsv and uxcnr, enables the task which reserves or releases the resource to
be identified.
QT1 or QT2: Level 1 & 2 allocation quotas. Format: from 0 to 9999.
In the uxhld command, these quotas enable the values shown to be allocated by the
execution of the command, insofar as they are available. Use of QT1 or QT2 is incompatible
with LOCK.
In the uxrsv command, these quotas enable, at the time of execution of the command and for
the Task specified, reservation of the values shown insofar as these quotas are available.
In the uxrls res (or UXRLSRES on OS/400) command, these quotas release the quota
values indicated. Use of QT1 or QT2 is incompatible with CLEAR.
LOCK: Allocation. Reserves the totality of the selected resource
Used in uxhld, the resource is totally reserved. LOCK usage is incompatible with QT1 or
QT2.
CLEAR: Resource de-allocation. Releases the selected resource
Used in uxrls res (or UXRLSRES on OS/400) command, the resource’s quotas are released
in totality whatever the origin of the initial allocation. The use of CLEAR is incompatible with
QT1 or QT2.
FULL: Display Resource allocation.
Displays all information concerning a resource allocation: the source Uproc, quotas allocated
by a Uproc, quotas allocated by commands, available quotas.
Alternative value RSV: Enables display of the reservations of the resource.
Alternative value INF: Refer to the chapter "Resources" on page 46.
INF, FULL and RSV are mutually incompatible.
OUTPUT: Storage of results. If not specified output will be displayed on the screen.
114 | Chapter 4 Operations Commands

4.1.1.3 Examples
uxhld RES RES=D_BASE QT1=4

Allocates a Level 1 quota of 4 units to the resource "D_BASE" in the current environment
(Company & node)
uxshw RES RES=D_BASE FULL

Displays allocations of the resource D_BASE in the current environment (company, node), for
example:

Query Res: D_BASE * *


Use of resource quotas
Resource: D_BASE Mode: Exec:
Quotas maxi Auto. Alloc. Man. Alloc. Remainder
0010 0010 0000 0000 0004 0000 0006 0010
Maxi quotas: Displays the maximum values for quotas 1 and 2.
Auto. Alloc: Displays the values of quotas 1 and 2 allocated by running Uprocs,
Man. Alloc: Displays the values of quotas 1 and 2 allocated by completed Uprocs or by uxhld
RES commands,
Free: Displays the values of quotas 1 and 2 remaining for future allocations.
If, during execution of the Uproc D_LOAD_FIL (which has a resource condition on the whole
of D_BASE), an identical command is executed on the management unit and the area of
execution, the following result is obtained:

Query Res: D_BASE * *


Use of resource quotas
Resource: D_BASE Mode: Exec:
Quotas maxi Auto. Alloc. Man. Alloc. Remainder
0010 0010 0000 0000 0004 0000 0006 0010

Use of resource quotas


Resource: D_BASE X MICKEY Mode: Exec: EXCL
Session Uproc Ar M.U. Proc.Dat Qta1 Qta2 X Numproc
D_LOAD_FIL X MICKEY 0010 0010 O 0000013
Quotas maxi Auto. Alloc. Man. Alloc. Remainder
0010 0010 0010 0010 0000 0000 0000 0000
The resource D_BASE is actually made up of two resources (symbolized in the example by
the two boxes) depending on its execution environment. The first allocation results from the
execution of the uxhld command, the second from the execution of the Uproc D_LOAD_FIL.
o Resource: Shows the resource reference followed by the area, the processing date, the
management unit or the Company if the corresponding key words are incorporated in the
resource name. This is the case here for D_BASE whose name is defined by !UG!!ESP!.
o Exec: EXCL shows that the resource has been allocated exclusively to the execution of
the Uproc.
o Session Uproc Ar M.U. Proc.Dat Qta1 Qta2 X Numproc: Shows the context in which
the resource has been allocated, Ar for area, Proc.Dat for processing date, Qta for quota.
uxrls RES RES=D_BASE ESP=* MU=* clear
Chapter 4 Operations Commands | 115

Releases all the quotas of the resource D_BASE allocated on behalf of all management units
and areas.
uxrsv RES RES=PRIO_ORDO ESP=X UPR=IU_DT1 MU=S01 QT1=90 QT2=0
PDATE=${S_DATRAIT}

Reserves, for the task defined by the Uproc IU_DT1, the Management unit S01 in the
production area, for the current processing date, the resource with the reference
PRIO_ORDO with a quota QT1 of 90.
If the resource has a maximum quota QT1 of 100, 10 remain unallocated after the execution
of the command. Another task which has not reserved any of this resource can be run if its
condition on this resource requires a quota of 10 or less.
uxrsv RES RES=PRIO_ORDO ESP=X UPR=IU_DT2 MU=S01 QT1=10 QT2=0
PDATE=$D_DATRAIT

These last two commands define a priority for condition checking by Dollar Universe. The task
which has reserved the most quotas will be run first, in this case the one defined on Uproc
IU_DT1.
uxcnr RES RES=PRIO_ORDO ESP=X UPR=IU_DT2 MU=S01 PDATE=$D_DATRAIT

Releases the reservation made on the resource PRIO_ORDO by the task defined by Uproc
IU_DT2, management unit S01 in the production area.

4.1.2 Tasks

4.1.2.1 Commands
uxhld TSK: Disables a task.
uxrls TSK: Reactivates a task.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
TSK= 64c *
SES= 64c * ""
VSES= 3n *
UPR= 64c *
VUPR= 3n *
MU= 64c *
TTYPE=S | O | P | C | * 1c*
MODEL | NOMODEL NOMODEL

Example:
uxhld TSK EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL MU=HEADQUART
uxrls TSK EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL MU=HEADQUART

uxlst TSK: Lists the tasks.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
TSK= 64c* *
SES= 64c * *
VSES= 3n * *
UPR= 64c * *
116 | Chapter 4 Operations Commands

Item Format Default


VUPR= 3n * *
MU= 64c * *
MODEL | NOMODEL NOMODEL
TTYPE=S | O | P | C | * 1c* *
FULL INF
OUTPUT=filename

Example:
uxlst TSK FULL OUTPUT=c:\temp\LstTsk.txt

4.1.2.2 Description of Items


TSK: Task code. Format: 64 alphanumeric characters. Incompatible with UPR, SES and USER. If the
Task code is empty, the default value is: TSK(SSS)(VVV)(UUU)(VVV) with:
o (SSS)(VVV): code and Session version
o (UUU)(VVV): code and Uproc version
UPR: Uproc code. Format: 64 alphanumeric characters.
Requires the Uproc code (wildcards are accepted except for uxadd) compulsory.
VUPR: Uproc version number. Format: 3 numeric characters.
Accepts the specific version number of a Uproc. By default all versions of a Uproc are
considered (irrelevant for SIM & EXP Areas).
SES: Session code. Format: 64 alphanumeric characters.
Requires the Session code (wildcards are accepted except for uxadd) compulsory.
VSES: Session version number. Format: 3 numeric characters.
Accepts the specific version number of a Session. By default all versions of a Session are
considered (irrelevant for SIM & EXP Areas).
MU: Management unit or model identifier. Format: 64 alphanumeric characters.
Requires a management unit code (wildcards accepted except for uxadd) or in the case of a
model task any identifier. Compulsory
TTYPE: Filter on the task type: S (planned), O (optional), P (provoked), C (cyclical) or *.
NOMODEL: Nature of the task.
Indicates that the selected task is not a model
MODEL indicates that the selected task is a model.
FULL: Display option. Displays all available information on the list of tasks
Alternative value (by default) INF: displays only the task header.
FULL and INF are mutually incompatible.
OUTPUT: Storage of results. If not specified output will be displayed on the screen.

4.1.2.3 Examples
uxhld TSK EXP UPR=D_LOAD_FIL SES=D_LOAD_BCK MU=HEADQUART NOMODEL

Deactivates the non-model task of the session D_LOAD_BCK whose Uproc header is
D_LOAD_FIL on the HEADQUART Management unit in the production area
uxlst TSK EXP UPR=D_LOAD_FIL SES=D_LOAD_BCK MU=HEADQUART FULL
Chapter 4 Operations Commands | 117

Lists all the characteristics of the task which has just been deactivated
uxrls TSK EXP UPR=D_LOAD_FIL SES=D_LOAD_BCK MU=HEADQUART

Reactivates the task of the Uproc IU_TEST on the HEADQUART Management unit in the
production area

4.2 Operations Control

4.2.1 Future Launches

4.2.1.1 Commands
uxadd FLA: Adds a future launch to the list of future launches.
This command displays the created launch number in the standard output. The format is "numlaunch
nnnnnnn".
Item Format Default
EXP | SIM | INT | APP 3c S_ESPEXE
TSK= 64c
SES= 64c ""
VSES= 3n
UPR= 64c
VUPR= 3n
MU= 64c
PRINTER= 4c
PRTY= 3n 100
QUEUE= 31c SYS_BATCH
(SYS$BATCH on OpenVMS)
USER= 64c
LSTART= (U_FMT_DATE,hhmm) System time
LEND= (U_FMT_DATE,hhmm) System time + 5 minutes
EXLW= (hhmm,hhmm) (0000,0000)
PDATE= U_FMT_DATE
LAUNCHVAR= ((var,val),…)
FORCE | NOFORCE NOFORCE
BYPASS | NOBYPASS NOBYPASS
MUTIME | ASTIME
VARTSK | NOVARTSK
INFO 50c
SEV 4n or " "

The OS/400 command UXADDFLA allows the user to create a launch from the command line. The F4
key allows the user to enter each parameter individually. The F11 key displays the name of each
parameter.
Example:
118 | Chapter 4 Operations Commands

uxadd FLA UPR=D_LOAD_FIL MU=HEADQUART USER=sup500e LSTART="(20020901.2000)"


LEND="(20020901.2200)" PDATE=20020901 LAUNCHVAR="((VARDATE,2010/01/01))"

uxupd FLA: Updates a future launch.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
TSK= 64c
SES= 64c *
VSES= 3n *
UPR= 64c *
VUPR= 3n *
MU= 64c *
NSEQ= 7n *
SINCE= (U_FMT_DATE,hhmm)
BEFORE= (U_FMT_DATE,hhmm)
STATUS= L | H | W | O | R 1c
PRINTER= 4c
PRTY= 3n
QUEUE= 31c
USER= 64c
LSTART= (U_FMT_DATE,hhmm)
LEND= (U_FMT_DATE,hhmm)
EXLW= (hhmm,hhmm)
NOW
PDATE= U_FMT_DATE
LAUNCHVAR= ((var,val),…)
FORCE | NOFORCE
BYPASS | NOBYPASS
MUTIME | ASTIME
INFO 50c
SEV 4n or " "

The OS/400 command UXUPDFLA allows the user to modify a launch from the command line. The
F4 key allows the user to enter each parameter individually. The F11 key displays the name of each
parameter.
Example:
uxupd FLA UPR=D_LOAD_FIL MU=HEADQUART LAUNCHVAR="((VARNUM,693))"
NSEQ=0000175

uxdlt FLA: Deletes a future launch.


uxhld FLA: Disables a future launch.
uxrls FLA: Reactivates a future launch.
For these three commands, the syntax is as follows:
Item Format Default
EXP | SIM | INT | APP 3c S_ESPEXE
TSK= 64c
Chapter 4 Operations Commands | 119

Item Format Default


SES= 64c *
VSES= 3n *
UPR= 64c *
VUPR= 3n *
MU= 64c *
NSEQ= 7n *
SINCE= (U_FMT_DATE,hhmm)
BEFORE= (U_FMT_DATE,hhmm)
STATUS= L|H|W|O|R

The OS/400 command UXDLTFLA allows the user to delete a launch from the command line. The F4
key allows the user to enter each parameter individually. The F11 key displays the name of each
parameter.
Example:
uxdlt FLA UPR=D_LOAD_FIL MU=HEADQUART NSEQ=0000175
uxhld FLA EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL MU=HEADQUART NSEQ=*
uxrls FLA EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL MU=HEADQUART NSEQ=*

For uxdlt FLA, if SES=* is not included, only launches executed without a session are
targeted, if SES=* is included, all launches are targeted.

uxshw FLA: Displays the characteristics of a future launch.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
TSK= 64c
SES= 64c * ""
VSES= 3n *
UPR= 64c *
VUPR= 3n *
MU= 64c *
NSEQ= 7n *
SINCE= (U_FMT_DATE,hhmm)
BEFORE= (U_FMT_DATE,hhmm)
STATUS= L|H|W|O|R
OUTPUT=filename

Example:
uxshw FLA EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL MU=HEADQUART NSEQ=* |more

uxlst FLA: Lists the future launches.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
TSK= 64c
SES= 64c * ""
VSES= 3n * *
UPR= 64c * *
120 | Chapter 4 Operations Commands

Item Format Default


VUPR= 3n * *
MU= 64c * *
NUPR= 7n
NSESS= 7n
NSEQ 7n *
SINCE= (U_FMT_DATE,hhmm)
BEFORE= (U_FMT_DATE,hhmm)
STATUS= L|H|W|O|R
FULL | INF INF
ASTIME | MUTIME
OUTPUT=filename

Example:
uxlst FLA FULL OUTPUT=c:\temp\LstFla.txt

4.2.1.2 Description of Items


TSK: Task code. Format: 64 alphanumeric characters. Incompatible with UPR, SES and USER
UPR: Uproc code. Format: 64 alphanumeric characters.
Requires the Uproc code (wildcard accepted except for uxadd)
VUPR: Uproc version. Format: 3 numeric characters.
Accepts a specific Uproc version number. By default, all versions of specified Uprocs are
considered (irrelevant for SIM and EXP).
SES: Session code. Format: 64 alphanumeric characters.
Requires a session code (wildcard accepted except for uxadd)
VSES: Session version. Format: 3 numeric characters.
Accepts a specific session version number. By default, all versions of specified sessions are
considered (irrelevant for SIM and EXP).
MU: Management unit code. Format: 64 alphanumeric characters.
Requires a Management unit code (wildcard accepted except for uxadd).
NUPR, NSESS: execution number of Uproc / of session. Format: 7 alphanumeric characters or *.
NSEQ: Launch number. Format: 7 numeric characters.
Indicates the launch sequence number (distinguishes between otherwise identical launches).
Compulsory, except for uxadd
SINCE: Start of selection window.
Determines, based on their scheduled time slot, to observe the launches (all launches are
extracted with the time slot has a nonempty intersection with the range of observation).
o On Windows/UNIX/OpenVMS, the format is: (U_FMT_DATE,HHMM). The format of the
date is indicated by the value of the setting U_FMT_DATE, hours and minutes on four
characters. The number of characters must be respected exactly.
o On OS/400, the date must be entered in the format used by the system. The time format
is HHMMSS.
BEFORE: End of selection window.
Chapter 4 Operations Commands | 121

o On Windows/UNIX/OpenVMS, the format is: (U_FMT_DATE,HHMM). The format of the


date is indicated by the value of the setting U_FMT_DATE, hours and minutes on four
characters. The number of characters must be respected exactly.
o On OS/400, the date must be entered in the format used by the system. The time format
is HHMMSS.
STATUS: Launch status. By default, all launches are considered.
Enables launches to be selected according to their status, by entering one or more of the
following values (separated by a comma):
o L: Waiting for launch
o H: Held (disabled)
o W: Event wait
o O: Launch window overrun
o R: Launch refused
PRINTER: Printer. Not used under UNIX and Windows.
PRTY: Priority. Format: 3 numeric characters between 001 and 255. Default value: 100.
Task’s priority upon entering the batch queue
QUEUE: Batch queue. Format: 32 alphanumeric characters ("$" accepted under OpenVMS).
Batch queue into which the task will be submitted. Default value: SYS_BATCH (SYS$BATCH
on OpenVMS).
USER: Submission account. Format: 64 alphanumeric characters.
User account under which the launch will be run
FORCE: Forced launch at the end of period. Default value: NOFORCE.
Indicates that, if at the end of the Launch Window the task is in an EVENT_WAIT state, it will
be submitted for execution regardless
CENTRAL: Obsolete, present for compatibility only.
RESTART: Obsolete, present for compatibility only.
BYPASS: Bypass condition check. Indicate that the conditions associated with the Uproc will not be
examined. The Uproc will therefore be able to run even if its required conditions are not satisfied. In
the case of a launch applying to a session, only the first Uproc of the session may be launched
without a condition check, the other Uprocs will have their conditions checked as normal.
o On Windows/UNIX/OpenVMS: Default value: NOBYPASS.
o On OS/400: Y (yes) for a launch with no bypass; N (No) otherwise, default value.
LSTART: Starting date and time of launch window, by default the launch is immediate.
o On Windows/UNIX/OpenVMS, the format is: (U_FMT_DATE,HHMM) where
U_FMT_DATE is the starting date of the launch window with the format indicated by the
value of the setting U_FMT_DATE, HHMM is the starting time of the launch window. The
number of characters must be respected exactly. Compulsory for uxadd. Incompatible
with NOW.
o On OS/400, the date must be entered in the format used by the system. The time format
is HHMMSS.
LEND: Finishing date and time of launch window, the length of the launch window is 5 minutes by
default.
o On Windows/UNIX/OpenVMS, the format is: (U_FMT_DATE,HHMM) where
U_FMT_DATE is the finishing date of the launch window with the format indicated by the
value of the setting U_FMT_DATE, HHMM is the finishing time of the launch window. The
122 | Chapter 4 Operations Commands

number of characters must be respected exactly. Compulsory for uxadd. Incompatible


with NOW
o On OS/400, the date must be entered in the format used by the system. The time format
is HHMMSS.
EXLW: Launch exclusion window.
o On Windows/UNIX/OpenVMS, the format is: (HHMM,HHMM) where (HHMM is the
starting time of the exclusion window, HHMM) is the finishing time of the exclusion. The
number of characters must be respected exactly. Incompatible with NOW
o On OS/400, the date must be entered in the format used by the system. The time format
is HHMMSS.
NOW: Start time of the launch window: Current time of node where the environment was loaded and a
time span of 5 minutes.
Can only be used with uxupd FLA command on Windows/UNIX/OpenVMS. Incompatible
with LSTART LEND and EXLW.
PDATE: Processing date qualifying the launch. The actual value depends of the functional period of
the Uproc.
o On Windows/UNIX/OpenVMS, the format is indicated by the value of the setting
U_FMT_DATE. The number of characters must be respected exactly.
o On OS/400, the date must be entered in the format used by the system.
LAUNCHVAR: The complete list of launch variables and their values. Format: ((var,val),(var)…)
The list is enclosed within brackets and quotation marks. Each variable-value pair is
bracketed and separated from the following one by a comma (with no space).
The variable’s name must be selected from the list of Uproc variables identifying the launch.
Where the value of the variable is indicated, this value replaces the value of the task or Uproc
variable. If the value is not indicated (there must be no comma present) the default value of
the task or Uproc variable is taken into account.
If the value contains non-alphanumeric characters (eg. spaces, /…) it must be enclosed within
quotation marks.
The format of the value must be compatible with the format declared upon creation of the
variable in the Uproc.
The output of the command doesn't display the value of password type variables.
INF: Information display option. Default value. Displays only the names of launches
Alternative value: FULL; gives access to all launch information.
INF and FULL are mutually incompatible.
ASTIME or MUTIME: reference time used by the command. If MUTIME is used, the column MU TIME
OFFSET is shown (uxlst). If this parameter is not used in the command:
o if the node setting U_TREF is not defined or is equal to "ASTIME": the reference time is
that of the server,
o if the node setting U_TREF is equal to "MUTIME": the reference time is that of the
Management Unit.
On OS/400, the parameter TYPETIME can take the MUTIME or ASTIME values; the default
value is ASTIME.
VARTSK: The launch is created using the values of variables of the corresponding task (if it exists).
Otherwise, the launch is not created using the values of variables of the corresponding task (if it
exists) but using the values of the variables of the Uproc defining the launch.
o On Windows/UNIX/OpenVMS: other value: NOVARTSK
Chapter 4 Operations Commands | 123

o On OS/400: Y (yes) to use the task variables values (default value); N (No) to use the
Uproc variables values.
INFO: Launch Information field.
If the INFO argument is present and not set to " " (space character), the launch's Information
field will contain the value of the INFO argument.
If the INFO argument is missing or set to " " (space character), the contents of the launch's
Information field will respect the following rules:
o By default the launch’s Information field will take the value of the Uproc’s Information field
if it has been defined.
o If the Uproc Information field is not specified and the U_FMT_INFO node setting has been
set (Advanced Setting category), the launch Information field will contain the launch’s
Uproc and session labels. Refer to the UniViewer Interface for Dollar Universe Manual.
SEV or SEVERITY (on OS/400): Launch Severity field.
If the SEV/SEVERITY argument is present and not set to " " (space character), the launch’s
Severity field will contain the value of the SEV argument.
If the SEV/SEVERITY argument is missing or set to " " (space character), the launch’s
Severity field will take the value of the Uproc Severity field.
OUTPUT: Storage of results. If not specified output will be displayed on the screen.

4.2.1.3 Examples
uxadd FLA EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL VUPR=000 MU=HEADQUART USER=admin
LSTART=(19990507.1255) LEND=(19990507.1700) PDATE=19990605 FORCE

Creates a launch from the session D_LOAD_BCK, whose Uproc header is D_LOAD_FIL on
the HEADQUART management unit in the production area for the admin user account.
Launch is planned for 7th May 1999 from 12.55 to 17.00 with the "force launch at end of
window" option where the setting U_FMT_DATE has the value YYYYMMDD.
uxupd FLA EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL VUPR=000 MU=HEADQUART NOFORCE
NSEQ=0000002

Updates the launch created above by indicating that the launch will no longer require "force
launch at end of window", had this been previously specified. The sequence number NSEQ is
supplied by a uxlst fla command.
uxhld FLA EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL VUPR=000 MU=HEADQUART
NSEQ=0000002

Suspends the launch created above.


uxadd fla upr=IU_LPR mu=X01 user=root pdate=00/00/0000
lstart="(08/01/98,1000)" lend="(09/12/98,1000)"
launchvar="((VARTXT,TXT__FLA),(VARDATE,2010/01/01))"

Creates the launch of Uproc IU_LPR on management unit X01 with new values for the two
values of the task
uxupd fla upr=IU_LPR mu=X01 nseq="*" launchvar=((VARNUM,693))

Modifies the value of the variable VARNUM, the values of VARTXT and VARDATE are
conserved.

4.2.2 Events

4.2.2.1 Commands
uxadd EVT: Adds an event to the events base.
124 | Chapter 4 Operations Commands

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
SES= 64c ""
VSES= 3n
NSESS= 7n
UPR= 64c
VUPR= 3n
MU= 64c
USER= 64c
STEP= 2n 00
PDATE= U_FMT_DATE
NSTAT=S | P | E | T | A | W 1c T

Example:
uxadd EVT EXP SES=D_LOAD_BCK NSESS=0000010 UPR=D_LOAD_FIL MU=HEADQUART
USER=univ56e PDATE=20021030 NSTAT=E

uxupd EVT: Updates an event.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
SES= 64c * ""
VSES= 3n *
NSESS= 7n
UPR= 64c *
VUPR= 3n *
NUPR= 7n
MU= 64c *
USER= 12c
STEP= 2n
PDATE= U_FMT_DATE
NSTAT=S | P | E | T | A | W 1c T
STATUS= S | P | E | T | A | * AT

Example:
uxupd EVT EXP SES=\" \" UPR=D_LOAD_FIL MU=HEADQUART NUPR=0000118 NSTAT=A

uxshw EVT: Displays the characteristics of an event.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
SES= 64c * ""
VSES= 3n *
NSESS= 7n
UPR= 64c *
VUPR= 3n *
NUPR= 7n
Chapter 4 Operations Commands | 125

Item Format Default


MU= 64c *

PDATE= U_FMT_DATE
SINCE= (U_FMT_DATE,hhmm)
BEFORE= (U_FMT_DATE,hhmm)
STATUS=S | P | E | T | A | * *
OUTPUT=filename

Example:
uxshw EVT EXP SES=* UPR=* MU=HEADQUART

uxdlt EVT: Deletes an event from the events base.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
SES= 64c * ""
VSES= 3n *
NSESS= 7n
UPR= 64c *
VUPR= 3n *
NUPR= 7n
MU= 64c *
PDATE= U_FMT_DATE
STATUS=S | P | E | T | A | * AT
SINCE= (U_FMT_DATE,hhmm)
BEFORE= (U_FMT_DATE,hhmm)

Example:
uxdlt EVT EXP SES=\" \" UPR=D_LOAD_FIL MU=HEADQUART PDATE=20020831
USER=admin

uxlst EVT: Lists the events.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
SES= 64c *
VSES= 3n *
NSESS= 7n
UPR= 64c *
VUPR= 3n *
NUPR= 7n
PDATE= U_FMT_DATE
MU= 64c *
SINCE= (U_FMT_DATE,hhmm)
BEFORE= (U_FMT_DATE,hhmm)
STATUS=S | P | E | T | A | * *
126 | Chapter 4 Operations Commands

Item Format Default


FULL | INF INF
OUTPUT=filename

Example:
uxlst EVT FULL OUTPUT=c:\temp\LstEvt.txt

4.2.2.2 Description of Items


TSK: Task code. Format: 64 alphanumeric characters.
UPR: Uproc code. Format: 64 alphanumeric characters.
Requires a Uproc code (wildcard accepted except for uxadd)
VUPR: Uproc version. Format: 3 numeric characters.
Accepts a specific Uproc version number. By default, all versions of specified Uprocs are
considered (irrelevant for SIM and EXP).
NUPR: Uproc execution number. Format: 7 numeric characters.
Accepts the execution number of the Uproc. This number enables the differentiation of two
otherwise identical events applying to the same Uproc within the same session for the same
management unit, and the same processing date.
SES: Session code. Format: 64 alphanumeric characters.
Is the session code (wildcard accepted except for uxadd)
VSES: Session version. Format: 3 numeric characters.
Accepts a specific session version number. By default, all versions of specified sessions are
considered (irrelevant for SIM and EXP).
NSESS: Session execution number. Format: 7 numeric characters.
Accepts the execution number of the session. This number enables the differentiation of two
events applying to the same session for the same Management unit and the same processing
date.
MU: Management unit code. Format: 64 alphanumeric characters.
Requires a Management unit code (wildcard accepted except for uxadd) compulsory.
SINCE: Start of selection window. Default: (000000.0000).
Will select all events whose execution date and time intersects the specified selection
window.
Format: (U_FMT_DATE,HHMM). The format of the date is indicated by the value of the
setting U_FMT_DATE, hours and minutes on four characters. The number of characters must
be respected exactly.
BEFORE: End of selection window. Default: (99991231.2359).
Format: (U_FMT_DATE,HHMM). The format of the date is indicated by the value of the
setting U_FMT_DATE, hours and minutes on four characters. The number of characters must
be respected exactly.
STATUS: Event status.
Enables events to be selected depending on their status, by entering of one or more of the
following values (separated by a comma or not):
o S: Condition check in progress (Started)
o P: Waiting execution (Pending)
o E: Execution in progress
Chapter 4 Operations Commands | 127

o T: Completed
o A: Aborted
USER: Submission account. Format: 64 alphanumeric characters.
Submission account for which the event is used.
NSTAT: Event status. Indicates the status to which the event must set.
Format: 1 alphabetic character from the following:
o S: Condition check in progress (Started)
o P or W: Waiting execution (Pending)
o E: Execution in progress
o T: Completed
o A: Aborted
STEP: Step number of the event. Format: 2 numeric characters.
Indicates the step number associated with the event.
PDATE: Processing date associated with the event. The number of characters must be respected
exactly.
Format indicated by the value of the setting U_FMT_DATE. The value depends on the
functional period of the Uproc.
INF: Information display option. Default value. Displays only the names of events.
Alternative value: FULL; gives access to all information about events.
INF and FULL are mutually incompatible.
OUTPUT: Storage of results. If not specified output will be displayed on the screen.

4.2.2.3 Examples
uxadd EVT EXP UPR=D_LOAD_FIL MU=HEADQUART USER=admin PDATE=19990507 NSTAT=T

Creates an event from the Uproc D_LOAD_FIL on the HEADQUART Management unit in the
production area for the admin user account with the status completed for a date in the format
YYYYMMDD
uxupd EVT EXP SES=\" \" UPR=D_LOAD_FIL MU=HEADQUART NSTAT=A

Modifies the status of the event created above by indicating that it now has the status
aborted. The item SES here shows that the session name is blank.
uxadd EVT EXP SES=D_LOAD_BCK NSESS=0000001 UPR=D_LOAD_FIL MU=HEADQUART
USER=admin PDATE=19990507 NSTAT=A

Creates an event from the session D_LOAD_BCK and the Uproc D_LOAD_FIL on the
HEADQUART management unit in the production area for the admin user account with the
status aborted for a date in the format YYYYMMDD
uxdlt EVT EXP SES=\" \" UPR=D_LOAD_FIL MU=HEADQUART USER=* STATUS=A
SINCE=(19990507.0000) BEFORE=(19990508.0000)

Deletes all the events of the Uproc D_LOAD_FIL without session SES_TEST created in the
production area between 7th May 1999 and 8th May 1999 with the status aborted for a date in
the format YYYYMMDD.
128 | Chapter 4 Operations Commands

4.2.3 Executions

4.2.3.1 Commands
uxpur CTL: Purges execution records from the executions list.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
TSK= 64c*
SES= 64c * ""
VSES= 3n *
NSESS= 7n *
UPR= 64c *
VUPR= 3n *
NUPR= 7n *
MU= 64c *
SINCE= (U_FMT_DATE,hhmm)
BEFORE= (U_FMT_DATE,hhmm)
STATUS= S|P|E|F|T|A|*
OUTPUT=filename

Example:
uxpur CTL EXP SES=* UPR=* MU=* SINCE=(20020101,0000) BEFORE=(20020701,0000)
uxend CTL: Stops a running execution (status "E") and consequently every process associated with
it. The status is consequently set to aborted ("A"). If the execution of the Uproc is protected by a
uxsetabort command (see paragraph "Preventing the Cancellation of a Running Uproc" on page
178), a message informs the user of the result of the command uxend ctl: postponed to the end of
the protected zone or abandoned.
Item Format Default
EXP | SIM | INT | APP 3c S_ESPEXE
TSK= 64c*
SES= 64c * ""
VSES= 3n *
NSESS= 7n *
UPR= 64c *
VUPR= 3n *
NUPR= 7n *
MU= 64c *
SINCE= (U_FMT_DATE,hhmm)
BEFORE= (U_FMT_DATE,hhmm)
STATUS= HORSWPEFTA* E
OUTPUT=filename

Example:
uxend CTL EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL MU=HEADQUART

uxrst CTL: Re-launches an execution.


Chapter 4 Operations Commands | 129

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
TSK= 64c*
SES= 64c * ""
VSES= 3n *
NSESS= 7n *
UPR= 64c *
VUPR= 3n *
NUPR= 7n *
MU= 64c *
SINCE= (U_FMT_DATE,hhmm)
BEFORE= (U_FMT_DATE,hhmm)
STATUS= T|A
LW= (hhmm,hhmm) (0000,0000)
STEP= 2n 00
LAUNCHVAR= ((var,val),…)
BYPASS | NOBYPASS NOBYPASS
PCHAIN_RELAUNCH= FROMABORTED |
ONLYABORTED
OUTPUT=filename

Example:
uxrst CTL EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL MU=HEADQUART LW=(1600.1700)
BYPASS LAUNCHVAR=((VARTXT,O),(VARNUM,200))

uxlst CTL: Lists execution records according to selection criteria.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
TSK= 64c*
SES= 64c * ""
VSES= 3n *
NSESS= 7n *
UPR= 64c *
VUPR= 3n *
NUPR= 7n *
MU= 64c *
NSEQ 7n *
SINCE= (U_FMT_DATE,hhmm)
BEFORE= (U_FMT_DATE,hhmm)
NOTIFY
STATUS= HORSWPEFTA* *
RECOVER
INF | HST | LOG | FULL | INF
FULL INFO | MGT | VAR
ASTIME | MUTIME
130 | Chapter 4 Operations Commands

Item Format Default


OUTPUT=filename

Example:
uxlst CTL EXP FULL OUTPUT=c:\temp\LstCtl.txt

4.2.3.2 Description of Items


TSK: Task code. Format: 64 alphanumeric characters.
UPR: Uproc code. Format: 64 alphanumeric characters.
Requires a Uproc code (wildcard accepted except for uxrst).
VUPR: Uproc version. Format: 3 numeric characters.
Accepts a specific Uproc version number. By default, all versions of specified Uprocs are
considered (irrelevant for SIM and EXP).
NUPR: Uproc execution number. Format: 7 numeric characters.
Accepts the execution number of the Uproc. This number enables the differentiation of two
otherwise monitor events applying to the same Uproc within the same session for the same
management unit, and the same processing date.
SES: Session code. Format: 64 alphanumeric characters.
Is the session code (wildcard accepted except for uxrst).
VSES: Session version. Format: 3 numeric characters.
Accepts a specific session version number. By default, all versions of specified sessions are
considered (irrelevant for SIM and EXP).
NSESS: Session Execution number. Format: 7 numeric characters.
Accepts the execution number of the session. This number enables the differentiation of two
monitor events applying to the same session for the same management unit and the same
processing date.
MU: Management unit code. Format: 64 alphanumeric characters.
Requires a management unit code (wildcard accepted except for uxrst).
NSEQ: Launch number. Format: 7 numeric characters.
Indicates the launch sequence number (distinguishes between otherwise identical launches).
SINCE: Start of selection window. Default: (000000.0000).
Will select all jobs whose execution beginning date and time intersects the specified selection
window.
Format: (U_FMT_DATE,HHMM). The format of the date is indicated by the value of the
setting U_FMT_DATE, hours and minutes on four characters. The number of characters must
be respected exactly.
BEFORE: End of selection window. Default: (99991231.2359).
Will select all jobs whose execution ending date and time intersects the specified selection
window.
Format: (U_FMT_DATE,HHMM). The format of the date is indicated by the value of the
setting U_FMT_DATE on four characters. The number of characters must be respected
exactly.
NOTIFY: filter on the date (Default value: "").
Chapter 4 Operations Commands | 131

Associated with SINCE and/or BEFORE, it filters the executions on their last update date
(update done by the Dollar Universe engine, for example a status update: Executing ->
Completed)
In case NOTIFY is not specified, the executions are filtered on the beginning and ending
execution dates.
STATUS: Status of an execution. By default, all executions are considered.
Enables monitor events to be selected depending on their status, by entering of one or more
of the following values (separated by a comma):
o H: Disabled (Held)
o O: Time overrun
o R: Refused (at condition check)
o S: Started
o W: Event wait
o P: Pending
o E: Running
o F: Completion in progress
o T: Completed
o A: Aborted
o *: display only the last execution for a given job, regardless of job's status. If a job has
been relaunched, only the last execution will be displayed.
RECOVER: Displays all the executions of jobs (item STATUS=*) at the time the command uxlst CTL
was executed. If a job has been relaunched, all the executions will be listed.
USER: Job's submission account. Format: 64 alphanumeric characters.
Jobs can be selected according to their submission account. By default, all submission
accounts are considered.
LW: Relaunch window. Format (HHMM,HHMM) where:
o (HHMM is the starting time of the relaunch window in hours and minutes.
o HHMM) is the finishing time of the restart period in hours and minutes.
The number of characters must be respected exactly.
STEP: Restart step. Format: 2 numeric characters.
Indicates the step number from which restart will be initiated
LAUNCHVAR: The complete list of execution variables and their values. Format: ((var,val),(var)…)
The list is enclosed within brackets and quotation marks. Each variable-value couple is
bracketed and separated from the following one by a comma (with no space).
The variable’s name must be selected from the list of launch variables.
Where the value of the variable is indicated, this value replaces the value of the launch
variable. If the value is not indicated (there must be no comma present) the default value of
the launch, task or Uproc variable is taken into account.
If the value contains non-alphanumeric characters (eg. spaces, /…) it must be enclosed within
quotation marks.
The format of the value must be compatible with the format declared upon creation of the
variable in the Uproc.
BYPASS: Launch without condition check. Default value: NOBYPASS.
132 | Chapter 4 Operations Commands

The conditions associated with the Uproc will not be verified. The Uproc therefore will be able
to run even if its conditions are not satisfied. If the launch is for a session, only the first Uproc
of the session will benefit from launching without condition check; the following Uprocs will
have their conditions checked as normal.
INF: Display option. Default value.
Displays the names and statuses only of those executions under Job monitoring
Alternative value: HST; displays the engine records of all selected executions.
Alternative value: LOG; displays the log file of all selected executions.
Alternative value: FULL; displays all information about executions.
Alternative value: FULL INFO; displays executions with matching Information and Severity
values.
Alternative value: VAR; displays the variables value of the execution.
INF, FULL, LOG, HST and VAR are mutually incompatible.
LOG is incompatible with OUTPUT.
ASTIME or MUTIME: reference time used by the command. If MUTIME is used, the column MU TIME
OFFSET is shown (uxlst). This flag is not used in the command:
o If the node setting U_TREF is not defined or is equal to "ASTIME": the reference time is
that of the server.
o If the node setting U_TREF is equal to "MUTIME": the reference time is that of the
Management Unit.
PCHAIN_RELAUNCH: Utilization by Dollar Universe Manager for SAP Solutions.
o FROMABORTED: Aborted jobs (and their eventual successors) are relaunched.
o ONLYABORTED: Only the aborted jobs are aborted.
OUTPUT: Storage of results. If not specified output will be displayed on the screen OUTPUT is
incompatible with LOG.

4.2.3.3 Examples
uxrst CTL EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL MU=HEADQUART LW=(1600.1700)
BYPASS

Relaunches, in the production area, the session D_LOAD_BCK from the Uproc D_LOAD_FIL
on the HEADQUART management unit, between 16.00 and 17.00, without examining the
conditions attached to this Uproc. This relaunch is possible because the corresponding event
exists with the status Aborted.
uxlst CTL EXP SES=D_LOAD_BCK MU=HEADQUART INF

Shows the status of all jobs of session D_LOAD_BCK on the HEADQUART management unit
from the job monitor in the production area
uxlst CTL UPR=IU* SINCE=(2001/06/12.1200) BEFORE=(2001/06/13.1200) NOTIFY

Extract all the records updated (by the Dollar Universe engine) between 2001/06/12 at noon
and 2001/06/13 at noon (for a YYYY/MM/DD date format).
uxpur CTL EXP UPR=D_* MU=HEADQUART SINCE=(19990501.1200)
BEFORE=(19990508.1200)

Purges the job monitor of all jobs of the Uproc D_* on HEADQUART management unit
between 1st May 1999 at 12.00 and 8th May 1999 at 12.00 for a date in the format
YYYYMMDD
uxrst CTL UPR=IU_LPR MU=X01 NUPR=%NUMPROC%
LAUNCHVAR="((VARTXT,O),(VARNUM,200))"
Chapter 4 Operations Commands | 133

Modifies two of the values of the launch variables at the time of the execution recovery
command. The other values remain as defined for the launch.

4.2.4 Notes

4.2.4.1 Commands
uxadd NOTE: Add a note to a job (launch or run).

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
NUPR= | NSEQ= 7n
NOTE= 1024c

Example:
uxadd note note="texte" nupr=2

uxupd NOTE: Update a note associated to a job.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
NUPR= | NSEQ= 7n
NOTE= 1024c

Example:
uxupd note note="texte" nupr=2

uxshw NOTE: Display the characterstics of a note.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
MU= 64c * *
UPR= 64c * *
TSK= 64c * *
NUPR= | NSEQ= 7n *
SES= 64c * *
NSESS 7n * *
OUTPUT=file_name

Example:
uxshw NOTE NSEQ=*

uxdlt NOTE: Delete a note.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
NUPR= | NSEQ= 7n *

Example:
uxdlt note nupr=2

uxlst NOTE: List all the notes.


134 | Chapter 4 Operations Commands

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
MU= 64c * *
UPR= 64c * *
TSK= 64c * *
NUPR= | NSEQ= 7n *
SES= 64c * *
NSESS 7n * *
INF | FULL INF
OUTPUT=file_name

Example:
uxlst note OUTPUT=c:\temp\LstNote.txt

4.2.4.2 Description of Items


NOTE: Note text that must be associated to a job. Format: 1024 alphanumeric characters.
Compulsory for uxadd and uxupd
NUPR: Uproc execution number. Format: 7 alphanumeric characters. Compulsory for uxadd, uxupd,
uxshw and uxdlt if NSEQ is absent
NSEQ: Launch number. Format: 7 alphanumeric characters. Compulsory for uxadd, uxupd, uxshw
and uxdlt if NUPR is absent, if the NUPR value is 0, or if the associated job is in “Time Overrun”
status.
MU: Job Management unit filter. Format: 64 alphanumeric characters or *.
UPR: Uproc filter. Format: 64 alphanumeric characters or *.
SES: Session filter. Format: 64 alphanumeric characters or *.
NSESS: Session execution number filter. Format: 7 alphanumeric characters or*.
TSK: Task filter. Format: 64 alphanumeric characters or *.
INF: Information display option. Value by default
Other value: FULL: Access to all information.
INF and FULL are incompatible.
OUTPUT: Storage results. If the item is blank, the exit is on the screen.

4.2.4.3 Examples
uxadd note nupr=12345 note=\"note text\"

Create a note for execution with the Uproc number is 12345.


uxadd note nseq=123456 note=\"launch wait\"

Create a note for execution with the Uproc number is 12345.

4.2.5 Outages

4.2.5.1 Commands
uxadd OUT: Create an outage within a list of outages.
Chapter 4 Operations Commands | 135

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
TYPE=G | T | M 1c
MU= 64c
MUT= 1c
LABEL= 64c ""
OSTART= (U_FMT_DATE,hhmm)
OEND= (U_FMT_DATE,hhmm)

Example:
uxadd OUT EXP TYPE=M MU=HEADQUART LABEL=\"2009-05-18:12-14h\"
OSTART=(20090518,1200) OEND=(20090518,1400)

uxshw OUT: Displays the characteristics of all the outages situated between the items SINCE and
BEFORE (if specified).

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
TYPE=G | T | M | * 1c *
MU= 64c * *
MUT= 1c * *
SINCE= (U_FMT_DATE,hhmm)
BEFORE= (U_FMT_DATE,hhmm)
OUTPUT=file_name

Example:
uxshw OUT EXP TYPE=M MU=HEADQUART SINCE=(20090101,0000)
BEFORE=(20090630,2359)

uxdlt OUT: Deletes all outages situated between the items SINCE and BEFORE (if specified).

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
TYPE=G | T | M 1c *
MU= 64c * *
MUT= 1c * *
SINCE= (U_FMT_DATE,hhmm)
BEFORE= (U_FMT_DATE,hhmm)

Example:
uxdlt OUT EXP TYPE=M MU=HEADQUART SINCE=(20090101,0000)
BEFORE=(20090630,2359)

uxlst OUT: Lists all maintenance windows situated between the items SINCE and BEFORE (if
specified).

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
TYPE=G | T | M 1c * *
MU= 64c * *
MUT= 1c * *
136 | Chapter 4 Operations Commands

INF | FULL FULL


SINCE= (U_FMT_DATE,hhmm)
BEFORE= (U_FMT_DATE,hhmm)
OUTPUT=file_name

Example:
uxlst OUT OUTPUT=c:\temp\LstOutage.txt

4.2.5.2 Description of Items


TYPE: Choice of the Management unit targeted by the outage. Format: G, M, T or * (* not allowed
with uxadd).
G: All Management Units located on the node. targeted by the command. The items MU and
MUT cannot be used.
M: Management unit specified in the item MU. MUT cannot be used.
T: Management unit Type specified in the item MUT. MU must not be used.
MU: Management unit code. Format: 64alphanumerical characters.
Enter a Management unit code (generic values are accepted except with uxadd).
MUT: Management unit Type. Format: 1 alphanumerical character.
Enter a Management unit Type (generic values are accepted except with uxadd).
LABEL: Description of the outage. Format: 64 alphanumerical characters.
OSTART: start of the outage for the command uxadd. Default: (000000,0000).
OEND: End of the outage or the command uxadd. Default (99991231,2359)
SINCE: Start of the observation period. Allows the selection of outages to be observed; all outages
that either start or finish within the observation period will be selected
Format: (U_FMT_DATE,HHMM) the format of the date is governed by the setting
U_FMT_DATE, hours and minutes in 4 characters. The number of characters must be
respected.
BEFORE: end of the observation period.
Format: (U_FMT_DATE,HHMM) the format of the date is governed by the setting
U_FMT_DATE, hours and minutes in 4 characters. The number of characters must be
respected.
INF: Limits the display to the name and description of objects. The alternative option FULL (default)
displays all information available about the list of objects: Type, MU, MU Type, label, window. The
options INF and FULL are mutually exclusive.
OUTPUT: name of the file where output will be saved. If not specified output will be displayed on the
screen.

4.2.5.3 Examples
uxadd OUT EXP TYPE=M MU=HEADQUART LABEL=\" HEADQUART 2009-05-18:12-14h\"
OSTART=(20090518,1200) OEND=(20090518,1400)

Creates an outage between midday and 2pm May 18th 2009 for the Management Unit HEADQUART
in the Production Area
uxadd OUT EXP TYPE=G LABEL=\"GENERAL 2009-05-18:14-16h\"
OSTART=(20090518,1400) OEND=(20090518,1600)

Creates a general outage (All MUS) in the Production Area between 2pm and 4pm May 18th 2009
If both outages are created in the Production Area May 18th 2009:
Chapter 4 Operations Commands | 137

 Launches for the MU HEADQUART that were scheduled to start between midday and 2pm
will be postponed to 4pm (accumulation with the general maintenance window).
Certain launches that should have been launched before midday could be postponed till 4pm
(depending on their average elapsed time).
 Launches for other MUs will be launched up until 2pm (depending on their average elapsed
time). If the average elapsed time is too long they will be postponed till 4pm.

4.2.6 Exceptions

4.2.6.1 Commands
uxadd OEX: Add an exception to the lists of exceptions.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
TYPE=SKIP | BYPASS | HOLD | JUMP
MU= | MUT= 64c | 1c
UPR= 64c
VUPR= 3n
TSK= 64c
TASK_MU= 64c
SES= 64c ""
VSES= 3n
NUMLANC= 7n
NUMSESS= 7n
NUMORDART_SE= 7n
EVT | NOEVT NOEVT
LABEL= 64c
PDATE= U_FMT_DATE
ESTART= (U_FMT_DATE,hhmm) NOW
EEND= (U_FMT_DATE,hhmm) NOW + 1 jour
MAXCOUNT= 6n 1

Example:
uxadd OEX type=SKIP MU=MY_MU1 UPR=UPRTEST

uxupd OEX: Update an exception.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
TYPE=SKIP | BYPASS | HOLD | JUMP
MU= | MUT= 64c | 1c
UPR= 64c
VUPR= 3n
TSK= 64c
SES= 64c
138 | Chapter 4 Operations Commands

Item Format Default


VSES= 3n
NUMLANC= 7n
NUMSESS= 7n
NUMORDART_SE= 7n
EVT | NOEVT
LABEL= 64c
PDATE= U_FMT_DATE
ESTART= (U_FMT_DATE,hhmm)
EEND= (U_FMT_DATE,hhmm)
LSTART= (U_FMT_DATE,hhmm)
LEND= (U_FMT_DATE,hhmm)
MAXCOUNT= 6n

Example:
uxupd oex UPR=UPRTEST MU=MY_MU1 Label=Exception

uxdlt OEX: Delete an exception.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
TYPE=SKIP | BYPASS | HOLD | JUMP
MU= | MUT= 64c | 1c
UPR= 64c
VUPR= 3n *
TSK= 64c *
SES= 64c *
VSES= 3n *
NUMLANC= 7n *
NUMSESS= 7n *
NUMORDART_SE= 7n *
PDATE= U_FMT_DATE *
ESTART= (U_FMT_DATE,hhmm) *
EEND= (U_FMT_DATE,hhmm) *

Example:
uxdlt oex MU=MY_MU1 upr=UPRTEST type=SKIP

uxlst OEX: List the exceptions.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
TYPE=SKIP | BYPASS | HOLD | JUMP *
MU= | MUT= 64c | 1c *
UPR= 64c *
VUPR= 3n *
TSK= 64c *
Chapter 4 Operations Commands | 139

SES= 64c *
VSES= 3n *
NUMLANC= 7n *
NUMSESS= 7n *
NUMORDART_SE= 7n *
PDATE= U_FMT_DATE *
ESTART= (U_FMT_DATE,hhmm) *
EEND= (U_FMT_DATE,hhmm) *
FULL | INF INF
OUTPUT=file_name

Example:
uxlst oex full output=c:\temp\LstOex.txt

4.2.6.2 Description of Items


TYPE: exception type. Compulsory for uxadd. Enter one of the four keywords below:
 SKIP: launch with examination of conditions but without executing the script
 BYPASS: launch without control check (without examination of conditions)
 Hold: launch suspended
 JUMP: no launch: examination of conditions, no script execution
MU: Management unit code. Format: 64 alphanumeric characters. Compulsory for uxadd (wildcard
value accepted except for uxadd), incompatible with MUT.
MUT: Management unit type code. Format: 1 alphanumeric character. Compulsory for uxadd
(wildcard value accepted except for uxadd), incompatible with MU.
UPR: Uproc code. Format: 64 alphanumeric characters. Compulsory for uxadd (wildcard value
accepted except for uxadd).
VUPR: Uproc version. Format: 3 alphanumeric characters. Allows entry of a particular Uproc version
(useless with SIM and EXP)
TSK: Task code. Format: 64 alphanumeric characters.
TASK_MU: The task’s Management Unit code. Format: 64 alphanumeric characters. The task's
Management Unit may differ from the exception's Management Unit in the case of a Session if a
specific Management Unit or HDP was defined, as with an optional or provoked task. If a task code is
not provided, this field is not considered. If a Task code is provided and this field is left empty, then
the exception's Management Unit code is automatically assigned to the task's Management Unit code.
SES: Session code. Format: 64 alphanumeric characters. Compulsory if NUMSESS is specified.
VSES: Session version. Format: 3 alphanumeric characters (useless with SIM and EXP).
NUMLANC: Launch number. Format: 7 alphanumeric characters. Incompatible with MUT
Enters a launch number. This number is used to distinguish two launches on the same task
for the same processing date.
If NUMLANC is filled with a value >0, VUPR (if different from default value), SES (if
necessary) and VSES (idem) must also be provided.
NUMSESS: Session execution number. Format: 7 alphanumeric characters.
Enters the session execution number. This number is used to distinguish two launches on the
same session on the same Management unit for the same processing date.
140 | Chapter 4 Operations Commands

NUMORDART_SE: Uproc number in the session. Format: 7 alphanumeric characters. Compulsory if


NUMSESS is specified and for JUMP exceptions.
This number differentiates two Uprocs in the same session.
EVT: for JUMP exceptions, the user can choose to create an event (EVT) or not (NOEVT), even if the
execution did not occur. By default no events are created.
LABEL: Exception description. Format: 64 alphanumeric characters.
PDATE: Processing date associated with the launch. The number of characters must be respected
exactly.
Format specified by the setting U_FMT_DATE value. The value depends on the functional
period of the Uproc.

If PDATE is entered in zeros (i.e. 00/00/0000,0000) for uxadd and uxupd oex commands, the
exception has no specified processing date and will only be applied on launches without
processing date.

ESTART:
o For uxadd: date and hour of the exception window start. Format: (U_FMT_DATE,hhmm).
o For the other commands, filter on this window.
EEND:
o For uxadd: date and hour of the end of the exception window. Format:
(U_FMT_DATE,hhmm).
o For the other commands, filter on this window.

If ESTART and EEND are entered in zeros (i.e. 00/00/0000,0000) then the exception has no
specified time range.

LSTART: new date and hour of the exception window start. Format: (U_FMT_DATE,hhmm).
LEND: new date and hour of the exception window end. Format: (U_FMT_DATE,hhmm).
MAXCOUNT: Enter the launch number on which the exemption is applied. In addition, the exception
will not be applied even if the timeframe is valid nor even if the processing date is valid.
INF: Information display options. Value by default
Other value: FULL: Accesses all the information.
INF and FULL are incompatibles.
OUTPUT: Storage of results. If not specified output will be displayed on the screen.
The description of this item is furnished in the item dictionary.

4.2.6.3 Examples
uxadd OEX EXP TYPE=BYPASS UPR=D_LOAD_FIL MU=SIEGE PDATE=20110714

creates a "no launch control" type exception for the Uproc D_LOAD_FIL launch for the
SIEGE Management unit in the production area for a date in the YYYYMMDD format.
uxupd OEX EXP TYPE=JUMP UPR=D_LOAD_FIL MU=SIEGE

Update this exception to change it to JUMP.


uxdlt OEX EXP TYPE=JUMP UPR=D_LOAD_FIL MU=SIEGE PDATE=20110714

Delete the exception previously created and updated.


Chapter 4 Operations Commands | 141

4.3 Control Utilities

4.3.1 Batch Engines


These commands are presented for compatibility purposes only. They are inconsequential. The ux*
fnc commands, described in the Installation Manual, should be used instead in V6.

4.3.1.1 Commands
uxend ATM: Stops the engines.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
CAL | LAN | ECH | SURV | ALL ALL

Example:
uxend ATM EXP

uxstr ATM: Starts the engines and defines the exchanger cycle.
uxwak ATM: Wakes up the engines. This command may be used to wake up an engine on a remote
machine.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
CAL | LAN | ECH | SURV | ALL ALL
CYCLE= 6n 120

Example:
uxstr ATM EXP LAN
uxwak ATM NODE=saturn EXP LAN
uxlst ATM: Displays the status of the selected engines along with information about the last stop,
start and programmed wakeup.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
CAL | LAN | ECH | SURV | ALL ALL
OUTPUT=filename

Example:
uxlst ATM EXP OUTPUT=c:\temp\LstAtmExp.txt

The command uxlst fnc, which lists the status of all services of Dollar Universe (schedulers
and technical processes), is described in the installation manual in the paragraph "List the
Services".

4.3.1.2 Description of Items


CAL: Selects the calculator engine.
Incompatible with ALL, LAN, ECH and SURV
LAN: Selects the launcher engine.
Selection incompatible with ALL, CAL, ECH and SURV
142 | Chapter 4 Operations Commands

ECH: Selects the exchanger engine.


Selection incompatible with ALL, CAL, LAN and SURV
SURV: Selects the supervisor engine.
Selection incompatible with ALL, CAL, LAN and ECH
ALL: Selects all engines.
Selection incompatible with CAL, LAN, ECH and SURV
CYCLE: Exchanger cycle. Format: 6 numeric characters. 120 seconds by default.
Indicates, (in seconds), the frequency at which the exchanger engine will wake to renew
attempts to establish unsatisfied connections.
The value of this cycle can only be modified using the uxstr command.
OUTPUT: Storage of results. If not specified output will be displayed on the screen.

4.3.1.3 Examples
uxend ATM EXP ALL

Stops all engines in the production area


uxstr ATM EXP CAL

Starts up the calculator engine in the production area


uxlst ATM EXP

Displays the information of all engines in the production area


uxwak ATM NODE=Mickey EXP LAN

Wakes up the launcher engine on the Mickey node in the production area

4.3.2 Executions History

4.3.2.1 Commands
uxshw HCX: Displays an execution.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
TSK= 64c* *
SES= 64c * ""
NSESS= 7n * ""
UPR= 64c *
NUPR= 7n * *
MU= 64c *
STATUS= S | P | E | F | T | A | H | O | R 1c* *
|W|L|*
USER= 64c * *
PDATE= U_FMT_DATE
SINCE= (U_FMT_DATE,hhmm)
BEFORE= (U_FMT_DATE,hhmm)
HIST | TECH | PLPR | VAR| PARM
Chapter 4 Operations Commands | 143

Example:
uxshw HCX EXP UPR=IU_TEST NUPR=* MU=* TECH

uxlst HCX: Lists the executions according to the selection criteria.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
TSK= 64c* *
SES= 64c * *
NSESS= 7n * *
UPR= 64c * *
NUPR= 7n * *
MU= 64c * *
STATUS= S | P | E | F | T | A | H | O | R | W | L | * 1c* *
USER= 64c * *
PDATE= U_FMT_DATE
SINCE= (U_FMT_DATE,hhmm)
BEFORE= (U_FMT_DATE,hhmm)
MUTIME | ASTIME
OUTPUT=filename

Example:
uxlst HCX EXP STATUS=A OUTPUT=c:\temp\LstCtl.txt

4.3.2.2 Description of Items


TSK: Task code. Format: 64 alphanumeric characters.
UPR: Uproc code. Format: 64 alphanumeric characters.
Requires a Uproc code (wildcard accepted). Mandatory for uxshw
NUPR: Uproc execution number. Format: 7 numeric characters.
Accepts the execution number of the Uproc. This number enables the differentiation of two
otherwise monitor events applying to the same Uproc within the same session for the same
management unit, and the same processing date.
SES: Session code. Format: 64 alphanumeric characters.
If the session code (wildcard accepted). Default value *.
NSESS: Session execution number. Format: 7 numeric characters.
Accepts the execution number of the session. This number enables the differentiation of two
monitor events applying to the same session for the same Management unit and the same
processing date.
MU: Management unit code. Format: 64 alphanumeric characters.
Requires a Management unit code (wildcard accepted). Mandatory for uxshw
STATUS: Status of an execution. By default, all executions are considered.
Enables monitor executions to be selected depending on their status, by entering of one or
more of the following values (separated by a comma):
o S: Started
o P: Pending
144 | Chapter 4 Operations Commands

o E: Running
o F: Completion in progress
o T: Completed
o A: Aborted
o H: Disabled (held)
o O: time Overrun
o R: Refused (at condition check)
o W: Event wait
o L: Launch wait
o *: all previous statuses including recoveries
USER: Execution's submission account. Format: 64 alphanumeric characters.
Executions can be selected according to their submission account. By default, all submission
accounts are considered.
PDATE: Processing date associated with the execution. The number of characters must be respected
exactly.
Format indicated by the value of the setting U_FMT_DATE. The value depends on the
functional period of the Uproc.
SINCE: Start of selection window. Default: (000000.0000).
Will select all executions whose execution date and time intersects the specified selection
window.
Format: (U_FMT_DATE,HHMM). The format of the date is indicated by the value of the
setting U_FMT_DATE, hours and minutes on four characters. The number of characters must
be respected exactly.
BEFORE: End of selection window. Default: (99991231.2359).
Format: (U_FMT_DATE,HHMM). The format of the date is indicated by the value of the
setting U_FMT_DATE, hours and minutes on four characters. The number of characters must
be respected exactly.
HIST | TECH | PLPR | VAR: Display option. Mandatory.
HIST: displays the engine records of the selected executions.
Alternative value: TECH displays the technical information of the selected executions.
Alternative value: PLPR displays the launch information of the selected executions.
Alternative value: VAR displays the variables value of the selected executions.
Alternative value: PARM: display execution settings.
HIST, TECH, PLPR, PARM and VAR are mutually incompatible.
ASTIME or MUTIME: reference time used by the command. If MUTIME is used, the column MU TIME
OFFSET is shown (uxlst). If this flag is not used in the command:
o If the node setting U_TREF is not defined or is equal to "ASTIME": the reference time is
that of the server.
o If the node setting U_TREF is equal to "MUTIME": the reference time is that of the
Management unit.
OUTPUT: Storage of results. If not specified output will be displayed on the screen.

4.3.2.3 Examples
uxshw HCX EXP UPR=D_LOAD_FIL NUPR=* SES=D_LOAD_BCK NSESS=* MU=SIEGE VAR
Chapter 4 Operations Commands | 145

Displays the variables of the Uproc D_LOAD_FIL in the D_LOAD_BCK session on the SIEGE
Management unit
uxlst HCX SINCE="(06/01/04,0000)" BEFORE="(06/30/2004.0000)"

Lists the executions history of the default area between the 1st and the 30th of June 2004

4.3.3 The Forecast Workload

4.3.3.1 Commands
uxlst PRV: Calculates the forecast workload for the indicated period.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
TSK= 64c*
SES= 64c *
UPR= 64c *
MU= 64c *
DSINCE= U_FMT_DATE
DBEFORE= U_FMT_DATE
TSINCE= hhmmss
TBEFORE= hhmmss
MUTIME | ASTIME
OUTPUT=filename

Example:
uxlst PRV EXP SES=D* UPR=* MU=HEADQUART DSINCE=20020701 TSINCE=000000
DBEFORE=20021231 TBEFORE=000000

4.3.3.2 Description of Items


TSK: Task code (wildcard accepted). Format: 64 alphanumeric characters.
UPR: Uproc code. Format: 64 alphanumeric characters.
Requires the entering of an Uproc code (generic value accepted)
SES: Session code. Format: 64 alphanumeric characters.
Requires the entering of a session code (generic value accepted)
MU: Management unit code. Format: 64 alphanumeric characters.
Requires the entering of a Management unit code (generic value accepted)
DSINCE: Calculation starting date. Format: indicated by the value of the setting U_FMT_DATE.
DBEFORE: Calculation finishing date. Format: indicated by the value of the setting U_FMT_DATE.
TSINCE: Calculation starting time.
Format: 6 numeric characters with the format HHMMSS (hour, minutes, seconds).
TBEFORE: Calculation finishing time.
Format: 6 numeric characters with the format HHMMSS (hour, minutes, seconds).
ASTIME or MUTIME: reference time used by the command. If MUTIME is used, the column MU TIME
OFFSET is shown (uxlst). If this flag is not used in the command:
146 | Chapter 4 Operations Commands

o If the node setting U_TREF is not defined or is equal to "ASTIME": the reference time is
that of the server.
o If the node setting U_TREF is equal to "MUTIME": the reference time is that of the
Management Unit.
OUTPUT: Results storing. If not specified output will be displayed on the screen.

4.3.3.3 Example
uxlst PRV APP UPR=RCA_DEB MU =* DSINCE=01011997 DBEFORE=31121998
TSINCE=000000 TBEFORE=235959

Calculates the forecast workload of the Application area between the 1st of January 1997 and the
31st of December 1998

SESSION VER UPROC VER MU DATE


000 RCA_DEB 001 ISM 02011997 02011997 1200 02011997 1300
RC 001 RCA_DEB 001 ISM 02011997 02011997 1200 02011997 1300
RC_TEST 001 RCA_DEB 001 ISM 02011997 02011997 1200 02011997 1300
000 RCA_DEB 001 ISM 02011998 02011998 1200 02011998 1300
RC 001 RCA_DEB 001 ISM 02011998 02011998 1200 02011998 1300
RC_TEST 001 RCA_DEB 001 ISM 02011998 02011998 1200 02011998 1300
The first date is the processing date affected to the launch.
The second date / time is the date and the time of the starting launch window.
The third date / time is the date and the time of the finishing launch window.

4.3.4 The Statistics

4.3.4.1 Commands
uxshw STA: Displays the statistics of a task.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
SES= 64c * *
UPR= 64c *
MU= 64c *
TSK= 64c*
INF | FULL INF
STAUPR I STASES I BOTH BOTH
OUTPUT=filename

Example:
uxshw STA EXP SES=D_LOAD_BCK UPR=D_LOAD_FIL MU=HEADQUART FULL

uxdlt STA: Deletes a task from the list of statistics.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
SES= 64c * *
UPR= 64c *
MU= 64c *
Chapter 4 Operations Commands | 147

Item Format Default


TSK= 64C*
STAUPR I STASES I BOTH BOTH

Example:
uxdlt STA SES=D_LOAD_BCK UPR=D_LOAD_FIL MU=HEADQUART

uxlst STA: Lists the statistics.

Item Format Default


EXP | SIM | INT | APP 3c S_ESPEXE
SES= 64c * “ ”
UPR= 64c * *
MU= 64c * *
TSK= 64c* *
FULL | INF FULL
STAUPR I STASES I BOTH BOTH
OUTPUT=filename

Example:
uxlst STA FULL OUTPUT=c:\temp\LstSta.txt

4.3.4.2 Families
The families described below are mutually exclusive in a single uxupd command (obsolete).
STATIST add: Adds execution statistics to a task: CPU time, elapsed time and page faults.
STATIST upd: Modifies execution statistics of a task: CPU time, elapsed time or page faults.
STATIST dlt: Deletes an execution from the statistics: CPU time, elapsed time and page faults.

4.3.4.3 Description of Items


UPR: Uproc code. Format: 64 alphanumeric characters.
Requires a Uproc code (wildcard accepted except for uxadd) - compulsory.
SES: Session code. Format: 64 alphanumeric characters.
Is the session code (wildcard accepted except for uxadd)
MU: Management unit code. Format: 64 alphanumeric characters.
Requires a Management unit code (wildcard accepted except for uxadd) - compulsory.
TSK: Task code. Format: 64 alphanumeric characters
NBEXEC: Execution number. Format: 2 numeric characters between 00 and 99.
When the command "uxupd … STATIST add" is executed, the NBEXEC number has to be
larger than the last execution number saved for this task. If not, the command is refused. The
execution number existing in the statistics of a task can be displayed by the "uxshw STA …
FULL" command.
CPU: CPU time of an execution (in seconds). Format: 9 numeric characters.
ELAPS: ELAPS time of an execution (in seconds). Format: 9 numeric characters.
PGF: Not used on UNIX and Windows. Page faults of an execution (on OpenVMS only). Format: 9
numeric characters.
148 | Chapter 4 Operations Commands

INF: Display option. Default value for the uxshw command.


Used with the uxlst command displays the job identifier number and number of executions for
running completed and aborted statuses.
Used with the uxshw command displays job identifier number and number of executions for
event wait; pending, running, aborted, completed, overrun and refused statuses, as well as
the CPU time and page faults.
INF and FULL are mutually incompatible.
FULL: Display option. Default value for the uxlst command.
Used with the uxlst command full display with the statuses overrun, refused, the CPU time
and page faults.
Used with the uxshw command full display with time and the total number of executions.
INF and FULL are mutually incompatible.
STAUPR: filters Uproc statistics, incompatible with STATES and BOTH
STASES: filters the Sessions statistics, incompatible with STATUPR and BOTH
BOTH: Default value, extracts Uproc and Session statistics, incompatible with STATUPR and
STATSES
OUTPUT: Storage of results. If not specified output will be displayed on the screen.

4.3.4.4 Examples
uxlst STA EXP UPR=D_LOAD_FIL MU=SIEGE

Creates a new task in the list of statistics for the Uproc D_LOAD_FIL on the Management unit
SIEGE in the production area
Chapter 5 Batch Management | 149

5 Batch Management

5.1 Presentation
There are several ways of generating batch jobs under Dollar Universe:
 A scheduled task will be launched by the scheduler when its scheduled date and time
coincide with the system date and time.
 A provoked or scheduled task may be triggered by an operator intervention requesting
creation or modification of a launch.
 A provoked or scheduled task may be triggered by the command uxordre.
In all cases, triggering a task starts (provided the task's launch window is valid) with the examination
of its execution conditions during the "condition checking" phase. If these conditions are satisfied, the
task is executed.
The batch job can be monitored and interrupted if it exceeds the predefined time limit. This function is
provided via the uxsurjob command.

5.2 The Batch Trigger


Dollar Universe provides a command which enables operations to be triggered from the external
environment or another batch procedure.

5.2.1 uxordre
The command (alias uxord on OpenVMS) can be used to trigger a task already defined in the Dollar
Universe parameter base as a "provoked task" or as a "scheduled task". Default parameters may be
used or overridden by those supplied with the trigger command as described below.
Reminder: If the task is:
 Activated: the command uxordre creates an actived launch.
 Simulated: the command uxordre creates a deactivated launch.
 Disactivated: the command uxordre does not create a launch.
The uxordre command also accepts up to thirty applications parameters for transfer:
 To the procedure, if the task is a simple Uproc.
 To the session header, if the task is a session.
The command displays the launch number in the standard output. The format is "numlaunch
nnnnnnn".

5.2.1.1 Format
The command format is as follows: uxordre

Item Format Default


ESP=X | S | I | A 1c S_ESPEXE
TSK= 64c TSK(SES)(VSES)(UPR)(VUPR)
150 | Chapter 5 Batch Management

Item Format Default


SES= 64c ""
VSES= 3n
UPR= 64c
VUPR= 3n
UG= | MU= 64c
AFTER= "U_FMT_DATE-hhmm" system date and time
ELAPS= "(hhhmm)" 99959
EXCLU= "(hhmm,hhmm)" (0000,0000)
QUEUE= 31c schedul
PRINTER= 4c schedul
DTRAIT= | PDATE= U_FMT_DATE schedul
FORCE | NOFORCE NOFORCE
BYPASS
PARAM=P1,P2.… 255c
LAUNCHVAR="var=val,…" 255c

The OS/400 command UXORDRE allows the user to trigger an existing task from the command line.
The F4 key allows the user to enter each parameter individually. The F11 key displays the name of
each parameter.
Examples:
uxordre UPR=1ST_JOB MU=SATURN PARAM=34,/tmp,type:2
uxordre UPR=OK2 MU=FSOLAPTOP LAUNCHVAR="test=one,test2=two"

5.2.1.2 Description of Items


TSK: Task code. Format: 64 alphanumeric characters. Tasks from an update V5 to V6 have the
default identifier: TSK (SES) (VSES) (UPR) (VUPR).
UPR: Uproc code. Format: 64 alphanumeric characters.
Requires a Uproc code: compulsory.
VUPR: Uproc version. Format: 3 numeric characters.
Accepts a specific Uproc version number. By default, all versions of specified Uprocs are
considered (irrelevant for S and X).
SES: Session code. Format: 64 alphanumeric characters.
Accepts a session code
VSES: Version session. Format: 3 numeric characters.
Accepts a specific session version number. By default, all versions of specified sessions are
considered (irrelevant for S and X areas).
MU (or UG): Management unit code. Format: 64 alphanumeric characters.
Requires a Management unit code (generic value accepted): compulsory.
AFTER: Date and time of start of launch window. Allows jobs to be triggered for deferred processing
Default value: For a provoked task: corresponding information in the task; for a scheduled
task: immediately.
Format: U_FMT_DATE-HHMM, the date format is indicated by the value of the setting
U_FMT_DATE, the time is on four characters.
Chapter 5 Batch Management | 151

On OS/400, the date must be entered in the format used by the system. The time format is
HHMMSS.
ELAPS: Duration of launch window. Format: (HHHMM).
On Windows/UNIX/OpenVMS: default value: 99959 (999hrs 59min, or 41.6 days)
On OS/400: default value: corresponding information in the task.
EXCLU: Exclusion period (on Windows/UNIX). Format: (HHMM,HHMM). Default value: Empty.
Enables the exclusion of a given inter from the launch window.
EXLW: Exclusion period (on OS/400). Format: (HHMMSS HHMMSS).
Enables the exclusion of a given inter from the launch window.
Default value: corresponding information in the task.
QUEUE: Execution batch queue. Format: 32 alphanumeric characters.
Default value: corresponding information in the task.
Must exist at the operating-system level
PRINTER: Printer associated with task. Default value: corresponding information in the task.
Must be entered in the form of a logical name (four characters)
CENTRAL: Obsolete.
FORCE: Forced launch at end of window flag.
On Windows/UNIX/OpenVMS, default value: NOFORCE.
On OS/400, default value: corresponding information in the task.
BYPASS: Launch without condition check.
DTRAIT or PDATE: Processing date. Default value: corresponding information in the task.
On Windows/UNIX/OpenVMS, format: Indicated by the value of the setting U_FMT_DATE.
On OS/400, the date must be entered in the format used by the system.
PARAM: Applications parameters.
Enables the transfer of 1 to 30 parameters to the first Uproc of the task. These parameters
may be received:
o In the Uproc CL in the form of variables $1 to $30 or in the Dollar Universe form S_P1 to
S_P30.
o In the scripts executed by the batch envelope: U_ANTE_UPROC and U_POST_UPROC
in the Dollar Universe format S_P1 to S_P30.
The maximum number of parameters is 30. The length of each parameter is limited to 255
characters and the total length (sum of the parameter lengths + twice the number of
parameters) must be less than 2074 characters.
Format: The parameters are separated by commas; each parameter can have any format
unless it comprises a space, in which case it must be shown between quotes " ".
LAUNCHVAR: The complete list of execution variables and their values. Format: "var=val,var=val…",
255 characters maximum.
The list is enclosed within quotation marks. Each variable=value couple is separated from the
following one by a comma (with no space).
The variable’s name must be selected from the list of launch variables.
Where the value of the variable is indicated, this value replaces the value of the launch
variable. If the value is not indicated (there must be no comma present) the default value of
the launch, task or Uproc variable is taken into account.
152 | Chapter 5 Batch Management

If the value contains non-alphanumeric characters (e.g. spaces, /…) it must be enclosed
within quotation marks.
The format of the value must be compatible with the format declared upon creation of the
variable in the Uproc.
On OS/400, entering the variable name and variable value are separated.

5.2.1.3 Examples
uxordre NODE=ds5200 ESP=X UPR=IU_DTS MU=S01 PARAM=34,/tmp,type:2

This command triggers the provoked Task "IU_DTS S01", existing on node ds5200 in the
Production area, with its default parameters, and transfers the following applications
parameters to procedure: 34, /tmp, type:2.

5.3 Control Execution Time


These commands are deprecated and maintain only for compatibility.

The time required to execute a batch (elapsed time) can be controlled by the uxsurjob, uxspvjob or
uxalrjob commands.
 uxsurjob: Oversees the elapsed time of a Uproc and interrupts it if it exceeds a predefined
limit.
 uxspvjob: Oversees the elapsed time of a Uproc and executes a script if it exceeds a
predefined limit. (Precise to the minute).
 uxalrjob: Oversees the elapsed time of a Uproc and executes a script if it exceeds a
predefined limit. (Precise to the second).

5.3.1 uxsurjob
Once the time limit has been reached, Dollar Universe "kills" the batch job and all its attached sub-
processes.
The uxsurjob command can either be executed from the U_ANTE_UPROC (U_ANTE_UPROC.bat on
Windows), in the UXMGR directory, if the customer organization requires that no job should exceed
the allotted time, or alternatively from the Uproc script if the time limit is specific to each Uproc or if
control of execution time is only desired for certain jobs.

5.3.1.1 Format
The command format is as follows:
uxsurjob
Verb Item
uxsurjob NB_SEC $S_NUMPROC |
%S_NUMPROC%

It should be launched in the background by using the sign & in UNIX.

5.3.1.2 Description of Items


NB_SEC: Elapsed time limit.
Indicates (in seconds) the maximum elapsed time which the job should not exceed.
Chapter 5 Batch Management | 153

S_NUMPROC: The ID number of the Uproc currently running; this variable is automatically supplied
by Dollar Universe.
Under Windows: %S_NUMPROC%,
Under UNIX: $S_NUMPROC.
Under OpenVMS: ‘S_NUMROC’

5.3.1.3 Examples
uxsurjob 3600 %S_NUMPROC% (in Windows)
uxsurjob 3600 $S_NUMPROC & (in UNIX)
$ uxsurjob 3600 'S_NUMPROC' (in OpenVMS)

If this command is inserted in U_ANTE_UPROC, all jobs exceeding one hour's elapsed time
will be killed.
If the same command is inserted in an individual Uproc script, only that Uproc will be
interrupted if its execution exceeds one hour's elapsed time.

5.3.2 uxspvjob
Once the time limit has been reached, Dollar Universe launches the user script U_SPV_UPROC
located in the UXMGR directory of the company.
This command can be included in the U_ANTE_UPROC if every Uprocs need to be overseen with the
same time limit. If the oversee time limit is specific for each Uproc, or if only specific Uprocs need to
be overseen, the command can be specified in the script of the Uproc.
On Windows, the script %UNI_DIR_EXEC%\U_SPV_UPROC needs to have a .bat or .cmd extension
and on OpenVMS the script @UXMGR:U_SPV_UPROC needs to have a .com extension.

5.3.2.1 Format
The command format is as follows:
Verb Item
uxspvjob NB_SEC

It should be launched in the background by using the sign & in UNIX.

5.3.2.2 Description of Items


NB_SEC: Elapsed time limit.
Indicates (in seconds) the maximum elapsed time after which the script has to be executed.
The displayed time is converted into minutes and rounded up to the next minute. For
example:
o 5s: 1 minute,
o 58s: 1 minute,
o 67s: 2 minutes.

5.3.2.3 Examples
uxspvjob 550 (in Windows)
uxspvjob 550 (in UNIX)
$ SPAWN/NOWAIT uxspvjob 550 (in OpenVMS)
154 | Chapter 5 Batch Management

If the execution time is larger than 10 minutes, the U_SPV_UPROC script will be executed.

5.3.3 uxalrjob
This command can be included in the U_ANTE_UPROC if every Uproc need to be overseen with the
same time limit. If the oversee time limit is specific for each Uproc, or if only specific Uprocs need to
be overseen, the command can be specified in the script of the Uproc.
Once the time limit has been reached, Dollar Universe executes the script U_ALR_JOB (on Windows:
U_ALR_JOB.bat or U_ALR_JOB.cmd) located in the data/nodefiles (UNI_DIR_NODEFILE)
subdirectory of the company.
The definition of the U_ALR_JOB variable allows a different naming of this script.
Eight parameters are passed to the U_ALR_JOB script during the execution of the uxalrjob
command:
 Session name or " ".
 Session execution number.
 Uproc name.
 Uproc execution number.
 Management unit.
 Launch number.
 Processing date.
 Seconds number of the alarm.
These parameters can be used in the script with their usual format: $1, $2 … on UNIX; %1, %2… on
Windows, P1, P2… on OpenVMS.

5.3.3.1 Format
The command format is as follows:

Verb Item
uxalrjob NB_SEC

uxalrjob 10 on Windows
uxalrjob 10 & on UNIX
$ uxalrjob 10 on OpenVMS

5.3.3.2 Description of Items


NB_SEC: Elapsed time limit.
Indicates (in seconds) the maximum elapsed time after which the U_ALR_JOB script will be
executed.

5.3.3.3 Examples
On Windows:
Uproc internal script (after 20 seconds of execution time, the script %UXMGR%\U_ALR_JOB.bat will
be executed):
%UNI_DIR_EXEC%\uxalrjob 20
set RESEXE=0
Chapter 5 Batch Management | 155

%UXMGR%\U_ALR_JOB.bat script (displays the parameters in the %UXMGR%\alr.log file):


echo %1 >>%UXMGR%\alr.log
echo %2 >>%UXMGR%\alr.log
echo %3 >>%UXMGR%\alr.log
echo %4 >>%UXMGR%\alr.log
echo %5 >>%UXMGR%\alr.log
echo %6 >>%UXMGR%\alr.log
echo %7 >>%UXMGR%\alr.log
echo %8 >>%UXMGR%\alr.log
exit 0
Uproc history trace:
07/07/06 11:13:53 Start Condition Check
Modified directly in the Engine by
operator: eca
Processing Date 07/07/06
07/07/06 11:13:53 Submitted in BATCH Q: SYS_BATCH
under ENTRY N° : 0144
BATCH starting
Maximum allowed elapsed time reached: 00000020 seconds . U_ALR_JOB
submitted
Start Completion Instructions
07/07/06 11:14:25 *** NORMAL TASK COMPLETION ***
%UXMGR%\alr.log file:
" "
"0000000"
"UPR_ALRJOB"
"0000144"
"SATURN "
"0000120"
"20060707"
"20"
156 | Chapter 6 FTP Commands

6 FTP Commands
Not available on OS/400

The command uxstr FTP will trigger a file transfer via the Dollar Universe Manager for File Transfer
mechanism.
The commands below should be used depending on whether the file is to be pushed or pulled:
 uxstr FTP GET: to retrieve a file by FTP.
 uxstr FTP PUT: to send a file by FTP.
These commands can only be used in a Uproc script or in a CMD Uproc.

6.1 uxstr FTP GET


This command will retrieve one or more files from an FTP server using Dollar Universe Manager for
File Transfer features.

6.1.1 Commands
The arguments of the command are described below:

Item Format Default value


PARTNER= 16ch
ORIGIN_FILENAME= 256ch ""
ORIGIN_PATHNAME= 256ch
TARGET_FILENAME= 256ch
TARGET_PATHNAME= 256ch
LOGON= 32ch anonymous
PASSWORD= 32ch
MODE=ASCII | BINARY ASCII
ACTION=REPLACE | ABORT | NONE ABORT
CRLF | NOCRLF NOCRLF
DELETE NODELETE
NEWER NONEWER
RECURSIVE NORECURSIVE
BUFFER_SIZE= 2n FTP default
RETRY= 1ch
UMASK= 3ch

6.1.2 Description of Items


PARTNER: Physical name or IP address of the target machine
ORIGIN_FILENAME: Name of the remote file to be retrieved. By default all files in the directory.
Chapter 6 FTP Commands | 157

ORIGIN_PATHNAME: Remote directory. By default the FTP connection user’s home directory. *
forbidden.

Note that paths must be given like FTP paths, meaning that a path like "C:\Temp\Transfer"
should be written: "C:/Temp/Transfer".

TARGET_FILENAME: Local file name. Unchanged by default.


TARGET_PATHNAME: Local file reception directory. By default the home directory of the Uproc’s
submission user account. * forbidden.
LOGON: FTP connection user
PASSWORD: FTP connection user password. Passwords are invisible in the GUI.
MODE: Type of transfer (ASCII or BINARY)
ACTION: Behavior if the target file exists: REPLACE, ABORT or NONE.
CRLF: All CR characters are converted to LF during ASCII transfer. No conversion by default except
for submissions.
DELETE: Deletes the origin file is the transfer is successful. If not the file is kept.
NEWER: Transfers the file if its modification date is later than the target file.
RECURSIVE: Transfers whole files and subdirectories of the ORIGIN_PATHNAME (the
ORIGIN_FILENAME and the TARGET_FILENAME must not be edited). When using the recursive
option, the recursion depth limit is set to 150 directories. NORECURSIVE by default.
The RECURSIVE option uses the FTP LIST command internally to get a list of files and
directories on the remote server. The expected server answer must be formated so each line
starts with the file permissions in UNIX format. Since this answer varies from a server to
another, the feature will not work if the answer has a different format. Should this happen, a
failover option is available: it tests each single file on the specified remote server location with
a FTP CWD command to check the existence of a directory. The failover option is less
performant but it can be enabled with the U_FT_GET_DIR_FAILOVER node setting in the
"Node Settings – FTP Settings" category.
BUFFER_SIZE: Sets the communications buffer size in blocks of 512 bytes. If valorized, the format is
integer/2n with a minimum value of 1 and maximum value is 64.
RETRY: Number of retries in case of failure on one digit.
UMASK: Mask applied to local file permissions. Format: 3 numerical characters. If UMASK is not set
or set to 000, files are downloaded with 666 permissions by default (for a root user) or 640 (for a non-
root user). Otherwise, file permissions are obtained by subtracting UMASK from the default value (666
or 640).
Example
uxstr FTP GET PARTNER=”WinXP” ORIGIN_PATHNAME=”/tmp/” CRLF MODE=BINARY
UMASK=700 ACTION=CANCEL RETRY=3

6.2 uxstr FTP PUT


This command will send one or more files to an FTP server using the Dollar Universe Manager for File
Transfer features.
 Linux-like OS: files are uploaded with their original permissions.
 Windows: files are uploaded with 755 as permission (the octal permissions doesn't natively
exists for Windows)
158 | Chapter 6 FTP Commands

6.2.1 Commands
The CRLF option is not available for FTP PUT.

The arguments of the command are described below:

Item Format Default value


PARTNER= 16ch
ORIGIN_FILENAME= 256ch ""
ORIGIN_PATHNAME= 256ch
TARGET_FILENAME= 256ch
TARGET_PATHNAME= 256ch
LOGON= 32ch anonymous
PASSWORD= 32ch
MODE=ASCII | BINARY ASCII
ACTION=REPLACE | ABORT | APPEND | NONE ABORT
DELETE NODELETE
NEWER NONEWER
RECURSIVE NORECURSIVE
BUFFER_SIZE= 2n FTP default
RETRY= 1ch

6.2.2 Description of Items


PARTNER: Physical name or IP address of the target machine
ORIGIN_FILENAME: Name of local file to send to the FTP server. By default all files in the directory.
ORIGIN_PATHNAME: Name of the local folder from which files are to be sent. By default the FTP
connection user’s home directory. * forbidden.

Note that paths must be given like FTP paths, meaning that a path like "C:\Temp\Transfer"
should be written: "C:/Temp/Transfer".

TARGET_FILENAME: Name of the file on the FTP server, only when a single file is to be transferred.
Unchanged by default.
TARGET_PATHNAME: Name of the destination folder on the FTP server to which files will be sent.
By default the home directory of the Uproc’s submission user account. * forbidden.
LOGON: FTP connection user
PASSWORD: FTP connection user password. Passwords are invisible in the GUI.
MODE: Type of transfer (ASCII or BINARY)
ACTION: Behavior if the target file exists: REPLACE, APPEND, ABORT or NONE.
DELETE: Deletes the origin file is the transfer is successful. If not the file is kept.
NEWER: Transfers the file if its modification date is later than the target file.
RECURSIVE: Transfers whole files and subdirectories of the ORIGIN_PATHNAME (the
ORIGIN_FILENAME and the TARGET_FILENAME must not be edited). When using the recursive
option, the recursion depth limit is set to 150 directories. NORECURSIVE by default.
Chapter 6 FTP Commands | 159

The RECURSIVE option uses the FTP LIST command internally to get a list of files and
directories on the remote server. The expected server answer must be formated so each line
starts with the file permissions in UNIX format. Since this answer varies from a server to
another, the feature will not work if the answer has a different format. Should this happen, a
failover option is available: it tests each single file on the specified remote server location with
a FTP CWD command to check the existence of a directory. The failover option is less
performant but it can be enabled with the U_FT_GET_DIR_FAILOVER node setting in the
"Node Settings – FTP Settings" category.
BUFFER_SIZE: Sets the communications buffer size in blocks of 512 bytes. If valorized, the format is
integer/2n with a minimum value of 1 and maximum value is 64.
RETRY: Number of retries in case of failure on one digit.
Example
uxstr FTP PUT PARTNER=”hp10201” ORIGIN_FILENAME=”data.txt”
TARGET_PATHNAME=”/tmp/” ACTION=ABORT
160 | Chapter 7 DQM Commands

7 DQM Commands

7.1 Queue Management Commands

7.1.1 Create a Batch Queue


The uxaddque command defines a new physical or logical queue. The batch queue is created with a
disabled status and must therefore be started before it can be used.

When physical queues are associated with logical queues, there is no verification that the
physical queue exists because it may have been created on a remote node. It is advisable
therefore to make sure that any physical queues referred to do actually exist.

The command syntax is as follows:


Verb Items Format
uxaddque SOC= 6 characters
QUEUE= 31 characters*
GENE
LSTQUE= "node1:queue1,node2:queue2,…"
NODE= 64 characters max. Default:
S_NOEUD or S_NODENAME
JOBLIM= [0->999] default: 0
MAXSEC= n
PERSEC= n
BASPRI= [0->255] default: 0
ADDPRI= [0->255] default: 0
MAXPRI= [0->255] default: 0
EXEPRI= [0->255] default: 0
[NO]SECPRI
LSTMU= "MU1:NbJobs, MU2:NbJobs,…"

7.1.1.1 Items
SOC: The command’s execution environment. Refer to section "Environment" on page 14
QUEUE: Name of the batch queue.
GENE Indicates the creation of a logical batch queue, incompatible with NODE.
LSTQUE: List of the physical queues associated with a logical queue. Each physical queue should be
preceded by its node of residence. Format: "node1:queue1,node2:queue2,…". The order of this list is
identical to the one used by the DQM server to dispatch the jobs.
NODE: Name of the physical node on which the jobs managed by the batch queue will run. By
default, this will be the current node. Incompatible with GENE and LSTQUE.
JOBLIM: Maximum number of jobs executable concurrently in the batch queue or, in the case of a
Logical queue in all associate physical queues. Once this limit has been reached jobs will enter the
queue in a “pending” state.
Chapter 7 DQM Commands | 161

PERSEC: Physical queue only. Number of seconds determining the revision cycle of the job's
sequence priority within the queue. Every persec seconds, the job priority is increased by the value of
addpri, starting at the base sequence priority, and up to the maxpri.
BASPRI: Physical queue only. Default sequence priority of a job in a batch queue. Default=0.
ADDPRI: Physical queue only. Value of the increments to a job's priority in the dynamic sequence
priority management mode.
MAXPRI: Physical queue only. Maximum job priority in the queue. Jobs with this priority are run as
soon as the joblim permits.
EXEPRI: Physical queue only. Default execution priority of jobs in this queue.
SECPRI: turns on management of secondary priority for the queue in question. This can be turned off
with NOSECPRI. Secondary priority means that jobs with the same submission priority will be
considered not on their Entry number but on their session number. In this way jobs in the first session
will be able to finish before the second session can start processing.
LSTMU: List of the job limits imposed by Management unit for the current queue. Format: “M.U.: Nb
Jobs, M.U.: Nb Jobs….” Management units in the list will be guaranteed the specified number of
concurrent processing slots whenever there are jobs pending in the queue.

7.1.1.2 Examples
$UNI_DIR_EXEC/uxaddque QUEUE="${S_CODUG}_${S_DATRAIT}" NODE="${S_NODENAME}"
JOBLIM=1 MAXSEC=3600 PERSEC=3600 BASPRI=1 ADDPRI=1 MAXPRI=255 EXEPRI=20

When executed in a Uproc script, this command creates a physical queue with a name obtained from
the management unit code and the processing date interpreted dynamically during execution of the
Uproc. The node (local) is shown by the variable S_NODENAME, which allows this script to be
distributed without needing to be adapted.
%UNI_DIR_EXEC%\uxaddque QUEUE=LOG_QUEUE GENE
LSTQUE="saturn:SYS_BATCH,saturn:PHYS1,uranus:PHYS2"

This command creates the logical batch queue LOG_QUEUE in the current environment and
associates it with the following physical queues: SYS_BATCH and PHYS1 on the node saturn,
PHYS2 on the node uranus.
%UNI_DIR_EXEC%\uxaddque QUEUE=PHY_QUEUE LSTMU=”C_UK:2,C_FRANCE:2,C_SPAIN:2”
JOBLIM=10

This command will create a physical queue supporting 10 concurrent jobs in all. Management units
C_UK, C_FRANCE and C_SPAIN are all guaranteed at least 2 concurrent jobs when the queue is
loaded. All M.U.s (including those specified in the list) will compete for the remaining capacity (4 jobs).

7.1.2 Update Batch Queue Parameters


The uxupdque command updates the definition of a batch queue and allows physical queues to be
associated with a logical queue. For reasons of coherence, the batch queue must be empty.
The command syntax is as follows:
Verb Item Format
uxupdque SOC= 6 characters
QUEUE= 31 characters*
LSTQUE= "node1:queue1,node2:queue2,…"
ADDQUE= "node1:queue1,node2:queue2,…"
DLTQUE= "node1:queue1,node2:queue2,…"
NODE= 64 characters max
162 | Chapter 7 DQM Commands

Verb Item Format


JOBLIM= [0-999]
MAXSEC= In seconds
PERSEC= In seconds
BASPRI= [0-255]
ADDPRI= [0-255]
MAXPRI= [0-255]
EXEPRI= [0-255]
[NO]SECPRI
ADDMU= "MU1:NbJobs, MU2:NbJobs,…"
DLTMU= "MU1:NbJobs, MU2:NbJobs,…"

7.1.2.1 Items
SOC: The command’s execution environment.
QUEUE: Name of the batch queue.
LSTQUE: List of the physical queues associated with a logical queue. Each physical queue should be
preceded by its node of residence. Format: "node1:queue1,node2:queue2,…". Incompatible with
NODE. The order in this list is identical to the one used by the DQM server to dispatch the jobs.
ADDQUE: Allows physical queues to be added to the list of queues associated with the logical queue.
Format: "node1:queue1,node2:queue2,…". Incompatible with NODE
DLTQUE: Allows physical queues to be removed from the list of queues associated with the logical
queue. Format: "node1:queue1,node2:queue2,…". Incompatible with NODE
NODE: Name of the physical node on which the jobs managed by the batch queue will run. By
default, this will be the current node. Incompatible with LSTQUE, ADDQUE and DLTQUE
JOBLIM: Maximum number of jobs executable concurrently in the batch queue, or in the case of a
Logical queue in all associated physical queues.
MAXSEC: Physical queue only. Number of seconds after which the job will get the maximum
sequence priority and thus be eligible to execute. This corresponds to the maximum job retention
period. The job will run only when the joblim so allows.
PERSEC: Physical queue only. Number of seconds determining the revision cycle of the job's
sequence priority within the queue. Every persec seconds, the job priority is increased by the value of
addpri, starting at the base sequence priority, and up to the maxpri.
BASPRI: Physical queue only. Default sequence priority of a job in a batch queue. Default=0.
ADDPRI: Physical queue only. Value of the increments to a job's priority in the dynamic sequence
priority management mode
MAXPRI: Physical queue only. Maximum job priority in the queue. Jobs with this priority are run as
soon as the joblim permits.
EXEPRI: Physical queue only. Default execution priority of jobs in this queue.
SECPRI: turns on management of secondary priority for the queue in question. This can be turned off
with NOSECPRI. Secondary priority means that jobs with the same submission priority will be
considered not on their Entry number but on their session number. In this way jobs in the first session
will be able to finish before the second session can start processing.
ADDMU: Adds MU job limits to the list of MU Job Limits. Format: “MU1:NJobs1,MU2:NJobs2…”
DLTMU: Removes MU Job Limits from the MU Job Limit list. Format: “MU1:NJobs1,MU2:NJobs2…"
Chapter 7 DQM Commands | 163

7.1.2.2 Examples
$UNI_DIR_EXEC/uxupdque QUEUE="${S_CODUG}_${S_DATRAIT}" JOBLIM=5

This command modifies the maximum number of jobs that can be executed in parallel in the batch
queue created previously.
%UNI_DIR_EXEC%\uxupdque QUEUE=LOG_QUEUE ADDQUE="uranus:PHYS3"

This command adds the physical batch queue PHYS3 on the node uranus to the logical batch queue
LOG_QUEUE.

7.1.3 Delete a Batch Queue


The uxdltque command deletes batch queues. This command only operates if the batch queue is
empty.
The command syntax is as follows:
Verb Item Format
uxdltque QUEUE= 31 characters max

QUEUE: Name of batch queue.

7.1.3.1 Example
$UNI_DIR_EXEC/uxdltque QUEUE="${S_CODUG}_${S_DATRAIT}"

This command deletes the batch queue shown, provided that it is stopped and contains no jobs.

7.1.4 Reset a Batch Queue


The uxresetque command removes all jobs (pending, suspended and running) from a queue
(physical or logical). Resetting a logical queue does not impact the contents of its associated physical
queues.
The command syntax is as follows:
Verb Item Format
uxresetque QUEUE= 31 characters max

QUEUE: Name of batch queue.

7.1.4.1 Example
$UNI_DIR_EXEC/uxresetque QUEUE="${S_CODUG}_${S_DATRAIT}"

This command resets the batch queue shown. All jobs in the queue are lost.

7.1.5 Start a Batch Queue


The uxstrque command starts a batch queue. This command must be used if the batch queue status
is disabled and jobs are to be executed on it.

Starting a logical queue only allows jobs to run if at least one associated physical queue has
been started.

The command syntax is as follows:


164 | Chapter 7 DQM Commands

Verb Item Format


uxstrque QUEUE= 31 characters max

QUEUE: Name of the batch queue. The value all starts all the batch queues.

7.1.5.1 Example
$UNI_DIR_EXEC/uxstrque QUEUE=QB_PHYS_1

This command starts the batch queue shown. Its status changes from disabled to enabled, thereby
allowing jobs to be executed on this queue.

7.1.6 Stop a Batch Queue


The uxstpque command stops a batch queue. This command must be used if the batch queue status
is started and no more jobs are to be run on it. Any jobs on this batch queue that were pending or
suspended will not be run. Any jobs that were running will not be stopped. Every job that was present
in the batch queue at the time of stoppage will remain in the batch queue.
The command syntax is as follows:

Verb Items Format


uxstpque QUEUE= 31 characters max
NEXT

QUEUE: Name of the batch queue. The value all will stop all pre-defined batch queues
NEXT: (On UNIX only). Qualifier meaning that the batch queue will only be stopped once the jobs
running in the batch queue are completed. Jobs pending execution will not be run. If the 'next' option
is not used, all jobs present in the queue will be frozen until the queue is restarted.

7.1.6.1 Example
$UNI_DIR_EXEC/uxstpque QUEUE=QB_PHYS_1 NEXT

This command stops the batch queue once all jobs that were running at the time the command was
issued have terminated. Any other jobs will not be run.

7.1.7 Display Batch Queue List


The uxlstque command displays the batch queue list. For each queue, the following information is
displayed:
 QUEUE Name: Batch queue name
 Type:
o PHYS: Physical queue
o LOGI: Logical queue
 STA: batch queue status
o ON: started
o OFF: stopped
 JOBLIM: maximum number of jobs in the queue
 JOBQUE: number of jobs in the queue
 JOBEXE: number of running jobs in the queue
Chapter 7 DQM Commands | 165

 JOBHLD: number of held jobs in the queue


 JOBPEND: number of pending jobs in the queue
The command syntax is as follows:
Verb Item Format
uxlstque QUEUE= * 31 characters max

QUEUE: Name of the batch queue. The qualifier may contain wildcards.

7.1.7.1 Example
D:\UNIV56\exec>uxlstque queue=*

This command displays the following information:


QUEUE NAME TYPE STA JOBLIM JOBQUE JOBEXE JOBHLD
JOBPEND

----------------------------------------------------------------------------
----

BATCH1 PHYS OFF 5 0 0 0


0

LOG_QUEUE LOGI ON 999999 0 0 0


0

SYS_BATCH PHYS ON 99999 0 0 0


0
The SYS_BATCH queue has one running job.

7.1.8 Show Batch Queue Status


The uxshwque command displays the batch queue status, along with a list containing the name and
status of all jobs contained in the queue. The command syntax is as follows:
Verb Item Format
uxshwque QUEUE= 31 characters max

QUEUE: Name of the batch queue. The qualifier may contain wildcards. The value all will display all
pre-defined batch queues

7.1.8.1 Example
D:\UNIV56\exec>uxshwque queue=SYS_BATCH

This command displays the following information:


Queue SYS_BATCH
JobLim 10
Priorite de base 1
Priorite d'execution 10
Priorite maximale 255
JobQue 1 , JobExe 1 , JobHld 0 , JobPend 0
Jobname Entry Node User Prio SecPrio stat Date
Mu
XSATURNIU_TEST000 000002 univ56a 100 0000000 execution 20080930
11:41 SATURN
Completed successfully
The batch queue characteristics are: 10 jobs maximum in progress (JobLim), 1 job present in queue
(JobQue) which is running (JobExe); no jobs on hold (JobHld) nor pending (jobPend).
166 | Chapter 7 DQM Commands

The jobs present in the queue are listed with the name of the job (Jobname), the queue entry number
(Entry), the submission user (User), the sequence priority (Prio), the secondary priority (SecPrio), the
job status (Stat), the execution date and the Management unit (MU).

7.2 Job Management Commands


These commands operate on the local node only.

7.2.1 Hold a Job


The uxhldjob command suspends a job in the batch queue. The job will not benefit from the
sequence priority management mechanism. It can be released by the interface or by the uxrlsjob
command.
The command syntax is as follows:
Verb Item Format
uxhldjob ENTRY= [0-999999]

ENTRY: Unique sequence number attributed to a job by DQM, This number can be seen using the
uxshwque command.

7.2.1.1 Example
$UNI_DIR_EXEC/uxhldjob ENTRY=$NUMJOB

The variable NUMJOB was previously filled out by the entry number corresponding to the job to be
hold.

7.2.2 Release a Held Job


The uxrlsjob command releases a job on hold in the batch queue. It cancels the effect of the
uxhldjob command. The command syntax is as follows:

Verb Item Format


uxrlsjob ENTRY= [0-999999]

ENTRY: Unique sequence number attributed to a job by DQM, This number can be seen using the
uxshwque command.

7.2.2.1 Example
$UNI_DIR_EXEC/uxrlsjob ENTRY=$NUMJOB

The variable NUMJOB was previously filled out by the entry number corresponding to the job to be
released.
Executing the command results in execution of the job in the batch queue as soon as possible,
depending on the job priority.

7.2.3 Status of a Job


The uxshwjob command displays the status of a job in a batch queue. The command syntax is as
follows:
Chapter 7 DQM Commands | 167

Verb Item Format


uxshwjob ENTRY= [0-999999]

ENTRY: Unique sequence number attributed to a job by DQM. This number can be seen using the
uxshwque command.

7.2.3.1 Example
$UNI_DIR_EXEC/uxshwsjob ENTRY=$NUMJOB

The variable NUMJOB was previously filled out by the entry number corresponding to the job to be
displayed.
Executing the command results in display of the status of the job in the batch queue, together with its
characteristics:
Xagencebck_dev000 root 0058 0100 execution 960514 15:57
Where:
 Xagencebck_dev000 is the name of the job.
 Root is the user id responsible for submission.
 0058 is the entry number of the job.
 0100 is the priority with which the job was submitted to the batch queue.
 Execution is the status of the job.
 960514 15:57 is the date (YYMMDD) and the starting time for the job execution.

7.2.4 Stop a Job


The uxstpjob command stops a job submitted to a batch queue, irrespective of the status of this job.
The command syntax is as follows:

Verb Item Format


uxstpjob ENTRY= [0-999999]

ENTRY: Unique sequence number attributed to the job by DQM. This number can be seen using the
uxshwque command.

7.2.4.1 Example
$UNI_DIR_EXEC/uxstpjob ENTRY=$NUMJOB

The variable NUMJOB was previously filled out by the entry number corresponding to the job to be
stopped.
Executing the command results in immediate stoppage of the job running in the batch queue.

7.2.5 Update Job Priorities


The uxsetpri command modifies the sequence or execution priorities of a job in a batch queue. This
modification can only occur if the job is not already running. The command syntax is as follows:

Verb Item Format


uxsetpri ENTRY= [0-999999]
PRI= [0-999]
168 | Chapter 7 DQM Commands

Verb Item Format


EXEPRI= [0-255]

ENTRY: Unique sequence number attributed to the job by DQM. This number can be seen using the
uxshwque command.
PRI: New sequence priority of the job in the batch queue.
EXEPRI: New execution priority of the job in the batch queue.

7.2.5.1 Example
$UNI_DIR_EXEC/uxsetpri ENTRY=$NUMJOB PRI=200 EXEPRI=100

The variable NUMJOB was previously filled out by the entry number corresponding to the job to be
stopped.
Executing the command results in updating of the priorities associated with job in the batch queue.
Chapter 8 Date Management | 169

8 Date Management
Not available on OS/400

Dollar Universe uses advanced date and time management algorithms for its internal scheduling
calculations. These cover date calculation and format and integrate the type of day: calendar,
working, closing or holidays.

8.1 Format and Offset of Dates


The uxdat command will return a date format, an offset date or the type or position of a day in a
calendar.
The smallest time unit managed is the day, the largest is the year.
The seven results are supplied on standard output (UNIX, Windows) or as symbols (OpenVMS). Only
one of the seven fields will contain data according to the initial request.

8.1.1 Format
Only syntactical coherence is verified.
The default language is international (English). Choice of language is determined by the format itself:
j, a, s, for French and d, y, w, for International.
The result will be in uppercase if at least on character of the output format is in uppercase.
Dollar Universe calendars will only be consulted in the case of working day offsets or requests
concerning the status of the source date. All other operations are independent of the Dollar Universe
environment. The optional item MU=<MU name> indicates the target calendar.
Two types of syntax can be used depending in the results required.

8.1.1.1 Formatting and Offsets


Offsets are processed in sequence from left to right.
The command format is as follows:
Verb Item
uxdat Source date format Source date Target date format Offset

uxdat "dd/mm/yyyy" "01/01/1999" "dd-mmm-yy" "-1do/1m"

Result 1: U_DATE_RES: Date with the target format and the required offset.

8.1.1.2 Type of Day


The command format is as follows:

Verb Item
uxdat Source date format Source date Type

uxdat "dd/mm/yyyy" "01/01/1999" "type" [MU=<MU name>]

The result or global symbol (OpenVMS) depends on the value of “Type”. Uxdat valorizes the following
global symbols depending on the arguments.
170 | Chapter 8 Date Management

Result 2: U_TYPE_DAY: Status of the source date (Working, Closing, Holiday)


Result 3: U_RGO_BEG_MONTH: Position of a working day from the beginning of the month.
Result 4: U_RGO_END_MONTH: Position of a working day from the end of the month.
Result 5: U_RGO_BEG_YEAR: Position of a working day from the beginning of the year.
Result 6: U_RGO_END_YEAR: Position of a working day from the end of the year.
Result 7: U_NBDAYS: Number of days between two dates.

8.1.2 Item Description

8.1.2.1 Date Formats


Intern. date French date
format: format:
Position of month as 1-12 m m
Position of month as 01-12 mm mm
Month as Jan to Dec (jan to dec) mmm mmm
Month as January to December (janvier to décembre) mmmm mmmm
Position of day in month as 1-31 d j
Position of day in month as 01-31 dd jj
Position of day in week as 1 to 7 p p
Position of day in week as mon to sun (lun to dim) ddd jjj
Position of day in week as Monday to Sunday (lundi to dddd jjjj
dimanche)
Position of week in year as 1-52 w s
Position of week in year as 01-52 ww ss
Position of day in year as 1-365 q q
Position of day in year as 001-365 qqq qqq
Year as 00 to 99 yy aa
Year as 0000 to 9999 yyyy aaaa

If the input format contains a year in two characters, the year is translated like this:
 From 00 to 40, the year is located between 2000 and 2040.
 From 70 to 99, the year is located between 1970 and 1999.

The uxdat command requires dates only between 1970 and 2040.

8.1.2.2 Offsets
"n" is an integer:

Intern. French
offset offset
Separator / /
Position n n
Negative offset -n -n
Chapter 8 Date Management | 171

Intern. French
offset offset
Positive offset +n +n
Positive offset of n calendar days +nd +nj
Negative offset of n calendar days -nd -nj
Positive offset of n working days +ndo +njo
Negative offset of n working days -ndo -njo
Set to nth calendar day of the week no ns
Set to nth working day of the week nwo nso
Positive offset of n weeks +nw +ns
Negative offset of n weeks -nw -ns
Set to nth calendar day of the month nm nm
Set to nth working day of the month nmo nmo
Set to nth calendar day (type p) of the month nmp nmp
Set to nth working day (type p) of the month nmop nmop
Positive offset of n months +nm +nm
Negative offset of n months -nm -nm
Set to nth calendar day of the year ny na
Set to nth working day of the year nyo nao
Set to nth day (type p) of the year nyp nap
Set to nth working day (type p) of the year nyop naop
Set to nth month of the year nmy nma
Positive offset of n years +ny +na
Negative offset of n years -ny -na

8.1.2.3 Type
Result: Intern. type French
type
Position of a working day from the beginning of the month obm odm
Position of a working day from the end of the month oem ofm
Position of a working day from the beginning of the year oby oda
Position of a working day from the end of the year oey ofa

8.1.3 Examples

8.1.3.1 Format
Format examples for 01/02/99.

"d" 1
"dd" 01
"ddd" Mon
172 | Chapter 8 Date Management

"dddd" Monday
"dddd mmmm dd yyyy" Monday February 01 1999
"dd mmmm yyyy" 01 february 1999
"q" 32 (position in year)
"qqq" 032 (position in year)
"w" 5 (week)
"ww" 05 (week)
"dd-mmm-yyyy" 01-Feb-1999

8.1.3.2 Offsets
Offset examples for 01/02/99.

"+1m/1m/-1do" last working day of the month (offset +1 month, set to day 1, offset –1
working day)
"+1y/1y/-1w/7w" Last Sunday of the year (offset +1 year, set to day 1, offset –1 week, set to
day 7)

8.2 Format of Dates and Offset of Time


The uxtim command converts a time (with or without a date) in a specified format. Allow the
specification of a time offset.

8.2.1 Formats
For a known date, the command format is as follows:

Verb Item
uxtim Source date & time Source date & Target date & time Time
format time format offset

For example:
uxtim "hhMM ap" "0600 PM" "HH:MM" "-0h10"

For the execution date and time of the command, the command format is as follows:
Verb Item
uxtim NOW Target date & time Time offset
format

For example:
uxtim NOW "aaaa, mmmm, jj HH:MM AP" "+2h50"

On OpenVMS, uxtim valorizes the global symbol UXTIM_VALUE.

8.2.2 Item Description


Source date & time format– Target date & time format: respectively, the date format to be converted
and the target format.
Chapter 8 Date Management | 173

The time format uses the HH symbol for the hour, the MM symbol for the minutes and AP to specify
the time format (in 12h format).
For example "15012003, 1506" has for format "DDMMYYYY, HHMM".

Intern. date French date


format: format:
Position of month as 01-12 mm mm
Month as Jan to Dec (jan to dec) mmm mmm
Month as January to December (january to december) mmmm mmmm
Position of day in month as 01-31 dd jj
Position of day in week as 1 to 7 p p
Position of day in week as mon to sun (mon to sun) ddd jjj
Position of day in week as Monday to Sunday (monday to sunday) dddd jjjj
Position of week in year as 01-52 ww ss
Position of day in year as 001-365 qqq qqq
Year as 00 to 99 yy aa
Year as 0000 to 9999 yyyy aaaa

Source date & time: date and time to be converted in the specified format specified as Target date
and time format.
To be specified with Source date and time format
Time offset: offset to be applied to the specified date and time or to the actual date and time if the
parameter NOW is used.
The format of the offset is: +/-HHHhMM:
o The + sign specifies an offset in the future, the – sign specifies an offset in the past.
o HHH is the number of hours to offset (limited to 3 digits).
o “h” is a field separator, needs to specified as well.
o MM is the number of minutes to be specified (between 0 and 59).

8.2.3 Examples
% uxtim "hhMM ap" "0600 PM" "HH:MM"
18:00

"0600 PM" is converted to the (hhMM ap), format. There is no offset.


% uxtim "hhMM ap" "0600 PM"
0600 PM

"0600 PM" has not been converted (no output format and no offset).
% uxtim NOW "aaaa, mmmm, jj HH:MM AP"
2003, mars, 05 03:30 PM

The current date and time have been converted to the specified format (no offset).
% uxtim NOW "aaaa, mmmm, jj HH:MM AP" "+2h50"
2003, mars, 05 06:20 PM

The current date and time have been converted to the specified format with an offset of 2h50.
% uxtim "aaaa, mmmm, jj HH:MM AP" "2003, JANUARY, 21 06:26 PM" "jj/mm/aa"
174 | Chapter 8 Date Management

21/01/03

The "21 January 2003 6h26 PM" has been converted to the specified format, no offset.
Chapter 9 Hidden Variable Management | 175

9 Hidden Variable Management


These commands allow the definition of variables whose values will be invisible to the user in
interfaces and logs.
Hidden variables are not the same as Uproc variables; they can be used anywhere in Dollar Universe.
Variables and their values are stored in a special file. The variable name appears in ASCII, its value is
encoded.

9.1 Commands
The Company’s logical environment (unienv) should be loaded before any of these commands can be
used.
Create a variable and its hidden value in the variable definition file:
uxhideval [<AREA>] INSERT [file=<path+name>] var=<variable_name>
val=<variable_value>

List variables in the file:


uxhideval [<AREA>] LIST [file=<path+name>] var=<variable_name>

Delete a variable and its value from the file:


uxhideval [<AREA>] DELETE [file=<path+name>] var=<variable_name>

Retrieves the value of a variable from the file:


uxhideval [<AREA>] EXTRACT [file=<path+name>] var=<variable_name>

Execute a command using the value of one or more hidden variables (the command displays the
result of its execution together with the standard output of the command passed as a parameter):
uxexechidden [file=< path+name >] <command> !HIDDEN_<variable_name>!
!HIDDEN_<variable_name>!

This command must be executed within a Uproc script launched by Dollar Universe.

9.1.1 Items
<AREA>: Optional, Area for which the command has been defined. By default the value of the
environment variable S_ESPEXE will be used and will take the value of the Area where the job is run.
Enter:
 EXP for the Production Area,
 SIM for the Simulation Area,
 INT for the Integration Area,
 APP for the Application Area.
<path+filename>: Enter the address of the file which will contain the variable definitions.
This item is optional. By default the file hidevalues.dta in the company’s root directory
(UNI_DIR_DATA) will be used. There should be 256 characters maximum for the path and
256 characters maximum for the filename. The address must not contain any spaces or tab
characters.
If this item is used with the uxexechidden command, it must be in first position (see example
below).
176 | Chapter 9 Hidden Variable Management

The first time the command uxhideval … INSERT is used, the file is created with the rights of
the user who executed the command.
If a command cannot access the file, it will end in error.
<variable_name>: enter the name of the variable. Maximum 256 characters. The variable name must
not contain spaces or tab characters. The wildcard character “*” may be used with uxhideval … LIST
command.
<variable_value>: enter the value of the variable. Maximum 256 characters. This value will not be
visible to the user. The value must not contain spaces or tab characters
<command>: command to be executed. The command accepts as a parameter the value of the
hidden variable specified (!HIDDEN_<variable_name>!) in the variable definition file. The same
command may accept several hidden variables as parameters.

9.1.2 Examples
Create the variable COUNTRY with the hidden value “New Zealand” in the file
$UXMGR/HiddenValues for the Production Area.
$UNI_DIR_EXEC/uxhideval EXP INSERT var=COUNTRY val=New_Zealand
file="$UXMGR/HiddenValues"

Create the variable DURATION with the hidden value “120” in the file
$UNI_DIR_DATA/hidevalues.dta for the Production Area.
$UNI_DIR_EXEC/uxhideval EXP INSERT var=DURATION val=120

List all variables (without their values) from the file $UXDIR_ROOT/hidevalues.dta for the Production
Area.
$UNI_DIR_EXEC/uxhideval EXP LIST var=*

Display the value of the variable DURATION if it exists in the file $UXDIR_ROOT/hidevalues.dta for
the Production Area.
$UNI_DIR_EXEC/uxhideval EXP EXTRACT var=DURATION

Run the command “sleep” to accept as a parameter the value of the hidden variable DURATION from
the default file for the Production Area.
$UNI_DIR_EXEC/uxexechidden sleep !HIDDEN_DURATION!

Run the command "/tmp/script.sh" to accept as a parameter the value of the hidden variable
COUNTRY from the file $UXMGR/HiddenValues.
$UNI_DIR_EXEC/uxexechidden file=$UXMGR/HiddenValues /tmp/script.sh
!HIDDEN_COUNTRY!

Delete the variable COUNTRY from the file UXMGR/HiddenValues if it exists fro the Production Area.
$UNI_DIR_EXEC/uxhideval EXP DELETE var=COUNTRY file="$UXMGR/HiddenValues"

Display in the job output the values of the two hidden variables, defined in the default file:
$UNI_DIR_EXEC/uxexechidden echo !HIDDEN_COUNTRY! - !HIDDEN_DURATION!
New_Zealand - 120
Chapter 10 The Command Language Procedure | 177

10 The Command Language Procedure

10.1 Presentation of the CL


The term "Command Language Procedure or CL" designates a command file associated with the
Uproc (CL_INT or CL_EXT type). In the rest of this chapter, all operations procedures written in
command language (i.e. belonging to the operating system) are referred to as "procedures".
The command language provides the indispensable access to communications between the
procedures and Dollar Universe. The latter therefore supplies a set of commands aimed at acquiring
information from or transmitting information to the 'procedure'.
It is worth noting that the preliminary processing performed by Dollar Universe before actually
submitting the job ("condition check") requires no specific intervention in the procedure itself.
To facilitate manipulation and maintenance, it is recommended to keep procedures short and
homogeneous from the functional viewpoint (simplified Launch Formulas, simpler conditions).
Dollar Universe commands contribute to making procedures portable, independent of the
configuration and ensure coherent operations management, while permitting applications to benefit
fully from the logic inherent in the Dollar Universe concepts (companies, areas, Management units
and inter-MU dependencies, etc.).

10.1.1 Normalization of CL Procedures


The CL procedure can be written either in Dollar Universe or independently, using a text editor of the
user's choice.
The procedure can make use of the commands described below, or the local environment variables
generated by Dollar Universe.

10.1.2 The Return Code of CL Procedures


While Dollar Universe can recognize the technical quality of a job’s completion, the procedure may,
from an applications perspective, be deemed incorrectly completed.
Therefore, to cover all possible cases, Dollar Universe requires that procedures set a variable
indicating the desired return code.
Two procedures may issue a return code: The pre-processing routine and the CL of the Uproc.
The pre-processing routine delivers its return code in the variable unix_status. The Uproc exit is
restored in the variable RESEXE or S_RESEXE on OpenVMS. The first may be of use to the Uproc
procedure and both may be used in the batch envelope's post processing routine.
On OpenVMS only, the variable S_RESEXE can also be used in the CL to ensure a job will complete
or abort regardless of the return code:
 S_RESEXE=="V" (Job will complete regardless of the return code)
 S_RESEXE=="I" (Job will abort regardless of the return code)
If the variable S_RESEXE is set with any other value, the return code is taken into account.

On OpenVMS if the S_RESEXE variable is set to “V” or “I” and there is no specified exit code,
Uproc status management rules based on the return code value are not available.
178 | Chapter 10 The Command Language Procedure

10.1.3 Commands
The following specific commands are available:

Verb Theme Function


uxsetabort Protects the execution from interruption from the job monitor
uxset parm Passes parameters to other Uprocs within a session
uxset info Displays additional information in the job monitor
uxset msg Sends messages to the Uproc's history trace
uxset step Writes a step in a Uproc
uxset var Carry-over of a variable’s values within a session
uxset hvar Transfers variables from one Uproc to another within a session

In each of these commands the default values of the Management unit and applications parameters
are systematically those of the operating environment.

10.2 CL Commands
The commands described below leaves a trace of their execution in the execution history (History
Trace). If recording in the history file has been turned off for the Task, or generally by setting the node
setting U_HISTORIC to “No” (Advanced Settings category), the command will run normally. The
execution traces will be visible in the History Trace only for the duration of the Uproc execution.

10.2.1 Preventing the Cancellation of a Running Uproc


The purpose of the uxsetabort command is to define a zone in the script of the Uproc that cannot be
interrupted by a stop command from an operational interface of Dollar Universe:
 UniViewer Console: list of executions
 Command uxend ctl.

Operating system commands can still be used to kill a process but this is not recommended.

This command can only be executed from the script of a Uproc. Its execution is traced in the Uproc’s
job log and history trace.
If the operator requests that execution of the Uproc be cancelled while in the protected zone, a
message informs him of the parameter behavior:
 either the cancellation command is executed at the end of the protected zone,
 or the cancellation command is simply ignored.
If the operator cancels an execution outside of the protected zone, the cancellation will take
immediate effect whatever the command configuration parameters.

10.2.1.1 Format
uxsetabort allow=on|off [queue=on|off]

 allow: delimits the protected zone of the script of the Uproc. Mandatory
allow=off marks the start of the protected zone, during which the Uproc cannot be stopped
by a command from a Dollar Universe interface.
Chapter 10 The Command Language Procedure | 179

allow=on marks the end of the protected zone. If this command is not in the script, the
protected zone extends to the end of the script.
 queue: indicates whether a stop command requested by a user must be memorized or not.
Optional. Can only be used with allow=off.
queue=on the stop command must be memorized. It will then be executed once the
protected zone has ended. Default value.
queue=off the stop command must not be memorized. It will then not be executed once the
protected zone has ended.

10.2.1.2 Examples
If the protected zone is delimited by a start command (uxsetabort allow=off) and an end command
(uxsetabort allow=on), the behavior is as follows, depending on the value of the item queue:
Uproc script Uproc script
... ...
uxsetabort allow=off queue=on Stop uxsetabort allow=off queue=off
command
Protected section Protected section

uxsetabort allow=on uxsetabort allow=on


... ...

Cancellation executed at the end of Cancellation ignored


the protected zone

If queue=on, the stop command is executed after the end of the protected zone.
If the protected zone extends to the end of the script, the behavior is as follows, depending on the
value of the item queue:
Uproc script Uproc script
... ...
uxsetabort allow=off queue=on Stop uxsetabort allow=off queue=off
command
Protected section Protected section

Job Aborted Job Completed

If queue=on, the stop command is memorized and executed at the end of the Uproc script.
The execution status of the Uproc is then Aborted. If the Uproc was part of a session, the
error path of the session (if it exists) will be executed.

10.2.2 Inserting a Step


The command uxset step (UXSETSTEP on OS/400) defines recovery steps within the Uproc's
procedure. These steps may provide checkpoints from which the procedure may be restarted after an
incident, without re-executing the entire Uproc.
The step numbers are recorded in the operations events file while the Uproc is executed. Therefore
they provide a way to track the execution of a Uproc, as part of the dynamic job monitor function.
In the event of a restart, Dollar Universe prompts the user to enter the number of the step from which
to restart the run (last step passed by default). The value of the step number entered is available in
the Uproc's procedure, in the variable S_NUMJALON. This variable should be systematically tested in
the procedure, and, depending on its value, the procedure should divert the procedure to the desired
line.
180 | Chapter 10 The Command Language Procedure

10.2.2.1 Format
uxset step nn

nn is the step number (2 numeric characters). Passage through this step is time-stamped in
the Dollar Universe Uproc history trace.

10.2.2.2 Example
uxset step 2

This command inserted in the Uproc procedure will result in the line being marked as "step No 2".
When executing the Uproc, the current step number will also be displayed on the job monitor screen.
Examples of the use of recovery steps in ksh and csh procedures are included in the annexes to this
manual.

10.2.3 Information Display


The command uxset info (UXSETINFO on OS/400), executed in the Uproc script, allows user’s
information to be set in the job monitor:
 An optional text field: "Information".
 An optional number field: "Severity".
The corresponding values are displayed in the job monitor if the values are different than the previous
value (default values of the Uproc or previous command executed in the script):
 UniViewer Console and GUI: the values are shown in the columns "Information" and
"Severity" of the job monitor.
 Command Interface: to show the values, use the key word FULL INFO in the command uxlst
ctl.

10.2.3.1 Format
uxset info [value=VALUE] [severity=NUM]

value= Corresponds to the text to be displayed; enclosed within quotation marks if it contains spaces.
Has a maximum length of 50 characters.
severity= Number between 0 and 9999. The default is 0. If no severity is specified, the default is 0.

10.2.3.2 Example
Running a Uproc with a script containing the following command:
uxset info value="My job is running " severity=0004

Displays "My job is running" in the Information field and "0004" in the Severity field of the UVC Job
runs document.

10.2.4 Generating a Message


The command uxset msg (UXSETMSG on OS/400) offers the means of communicating between the
Uproc's executing procedure and its history trace visible from the job monitor. This means, for
example, that operator instructions may be inserted in the history trace depending on what happens
within the actual running procedure.
The History trace of the Uproc’s execution is available in the Dollar Universe interfaces "job monitor"
or "execution history" by selecting this Uproc and by requesting the option "History trace".
Chapter 10 The Command Language Procedure | 181

All messages generated by this command are contained in the files of the executions history.
Thus, the latter, depending on the volume processed, can become very large.

10.2.4.1 Format
uxset msg "var1" "var2" ..."var8"

var designates from 1 to 8 variables or lines of text. If var represents a local variable, its value will be
translated in the History Trace; if var represents a text string, it will be transcribed identically in Dollar
Universe history trace.
Each uxset msg command will display one message in the history trace. The maximum length for this
message is 1600 characters (including spaces). The message will be truncated in lines of 80
character.

10.2.4.2 Example
uxset msg " *** Current MU:" " ${S_CODUG}"

On UNIX, this command will generate the following entry in the Uproc history trace:
*** Current MU: B_LONDON

if B_LONDON is the management unit for which the Uproc is running.

10.2.5 Passing Parameters


The command uxset parm (UXSETPARM on OS/400) enables up to 30 parameters to be passed to
the following Uprocs within a session. The parameters positioned by a parent Uproc are available to
its children in the standard format: under the numbers 1 to 30 or in the Dollar Universe form in the
variables: S_P1 to S_P30.
The passed parameters with this command can be used:
 In the standard form: only in the Uprocs script.
 In the Dollar Universe form: In the Uproc script or in the scripts launched by the batch
envelop: pre and post processing routines.

10.2.5.1 Format
uxset parm "parm1" "parm2" ... "parm30"

parmn designates from 1 to 30 parameters. The number of parameters is limited to 30. Each
parameter has a maximum length of 255 characters; the total length of parameters (the sum
of the lengths + twice the number of parameters) must not exceed 2074 characters.

10.2.5.2 Example
In the following session:

Uproc P1
uxset parm "10" $RES

Uproc P2 Uproc P3
uxset msg "P1 : " $2 uxset msg "P1 : " $2
uxset parm $2

Uproc P4
uxset msg "P1 : " $1
182 | Chapter 10 The Command Language Procedure

If the command uxset parm "10" "Base Full" is executed by Uproc P1, Uproc P2 may use the
second parameter via S_P2, and Uproc P3 may use both parameters via S_P1 and S_P2 etc.
If this distribution is to be interrupted for P2 to transmit further parameters to P4, a new uxset parm
command must be executed in P2.

10.2.5.3 Recovering Parameters on OS/400


The parameters are not intrinsically recovered in the classic OS/400 programs. The command
UXGETPARM allows the user to recover the parameter value passed from the command
UXSETPARM or UXORDRE in a DCL variable.
Syntax:
CALL PGM(UXGETPARM) PARM('PARM=n' 'DCLVAR=var')

This command must be used in the CL. It accepts two parameters:


 PARM: positional parameter number to recover: 0 to 11
 DCLVAR: string of maximum length 256 characters. CL variable the parameter value will be
written in.

In qsh, the parameter n can be used directly in the $n shell variable.

10.2.6 Carry-over of Variables


Carry-over of the values of variables within a session is not automatic. By default, if nothing is done,
the value of the variable is not carried over and the engine applies the rules for assigning values by
default.
The carry-over of a value may be requested by executing the command uxset var (UXSETVAR on
OS/400) in the Uproc’s CL or in post-processing (U_POST_UPROC).
The command uxset var allows the value of the variables within the session to be carried over. Three
kinds of carry-over can be requested:
 By mentioning within the command uxset var those variables which should be carried over
and eventually their new value.
 In an overall way, by executing the command uxset var without any other complement or
else uxset var level ALL, in order to carry over only the values of the variables of the parent
Uproc known from the child Uproc (the values carried over are those known at the beginning
of the parent Uproc execution).
 By executing the command uxset var level INTER, in order to carry over only the values of
the received variables of the parent Uproc known from the child Uproc. This command can't
be executed in a header Uproc.
The variable transfer within a session is done by the execution of the command. If the next Uproc in
the session is not submitted (for example in case of an optional task), the variables will be transferred
to the child Uproc of the skipped Uproc.

On UNIX/Linux, a variable name cannot start with a number (operating system restriction).

10.2.6.1 Format
The syntax shown below are authorized:
uxset var
uxset var level ALL
uxset var level INTER
uxset var "VAR1=VAL1 VAR2 VAR3=VAL3"
Chapter 10 The Command Language Procedure | 183

VARn indicates the variable’s name and VALn which will be transmitted to the child Uproc.
If the value is not shown (no equals sign) the last value of the variable, or its default value, is
transmitted.
If several variables are to be transmitted they should be separated by spaces and the list enclosed
within quotation marks.
If a value contains non-alphanumeric characters they should be enclosed within quotation marks. The
latter should then be preceded by the character \ so as to distinguish this quotation mark from the one
which marks the end of the list, for example:
uxset var "VARDATE=2010/11/30 VARTXT="\"TEST TEST"\" VARNUM=555"

The " " enclosing the string "TEST TEST" is needed to carry over the space in the string "TEST
TEST" ; if you don't have a space in your string they are not needed. As the string "TEST TEST" has
non alphanumeric characters, these characters must be preceded by the "\" characters.

10.2.6.2 Examples
Exemple 1
We have three Uprocs A, B, C. All have the same default variables: Var1, Var2, Var3.
Uproc A has a script which contains: uxset var level ALL
Uproc B has a script which contains: uxset var level INTER
Uproc C has a script which displays the variables.
In this case the script will display the values for Var1, Var2, Var3 of Uproc A, which were transmitted
to Uproc B using the "uxset var level ALL" command, then carried over to Uproc C using the "uxset
var level INTER" command.
In other words "uxset var level INTER" carries over only the information transmitted from a parent
Uproc, and the carry over could be cascaded between multiple Uprocs using "uxset var level INTER"
command.
Example 2
We have three Uprocs X, Y, Z.
Uproc X variables: Var1=Val1x, Var2=Val2x, Var3=Val3x
Uproc Y variables: Var1=Val1y, Var2=Val2y, Var3=Val3y
Uproc Z variables: Var1=Val1z, Var2=Val2z, Var3=Val3z
All have the same default variables: Var1=Val1, Var2=Val2, Var3=Val3
Uproc X has a script which contains: uxset var Var1=NewValue
Uproc Y has a script which contains: uxset var level INTER
Uproc Z has a script which displays the variables.
In this case the script will display the values NewValue, Val2z, and Val3z. In this case Uproc X
transmitted NewValue to Uproc Y, and NewValue was carried over to Uproc Z using the "uxset var
level INTER" command.

10.2.6.3 Recovering Variables on OS/400


The variables are not implicitly recovered in classic OS/400 programs. The command UXGETVAR
allows the user to recover the variable value passed from a UXSETVAR or UXORDRE command in a
DCL variable.
Syntax:
CALL PGM(UXGETVAR) PARM('VAR=varname' 'DCLVAR=var')

This command must be used in the CL. It accepts two parameters:


184 | Chapter 10 The Command Language Procedure

 VAR : name of variable to recover


 DCLVAR: string of maximum length 256 characters. CL variable the variable value will be
written in.

In qsh, the var variable can be used directly in the $var shell variable.

10.2.7 Inheritance Variables


Inheritance variables are variables that can be transferred from a parent session Uproc to child
session Uprocs. As oppose to Uproc variables, inheritance variables do not have a size limit and do
not have to be declared in the Uproc settings. Once an inheritance variable is entered in the Uproc
script it is automatically transferred to the child Uproc when the session is run.
The uxset hvar command can be used to create an inheritance variable, assign a value to this
variable and specify that this variable will be transferred to the child Uprocs.
The uxset inheritance [keep|discard] command specifies whether input variables are transferred to
the child Uprocs or not.
The uxunset hvar command specifies which variables will not be transferred to the child Uprocs.
For web services REST and SOAP type Uprocs, inheritance variables can be created through UVC as
output variables. For more information, refer to the Dollar Universe Manager for Web Services User
Manual.

10.2.7.1 Restrictions
All Uproc types do not support inheritance variables. The table below shows the Uproc types for which
inheritance variables are or are not supported.

Inheritance Variables Supported Not Supported


Uproc Type WS_SOAP CMD
WS_REST EJB
ODB_JOB FTP_GET
ODB_TPL FTP_PUT
CL_INT JMS_SEND
CL_EXT OAPP_PGM
MSSQL OAPP_SET
MSSQL_REF SAP_IPACK
SAP_PCHAIN
SAP_XBP2
ZOS

10.2.7.2 Format
The syntaxes shown below are authorized:
uxset hvar VAR1=VAL1
uxset inheritance [keep]
uxset inheritance [discard]
uxunset hvar VARn

VARn indicates the variable’s name and VALn the value which will be transmitted to the child Uproc.
With the command uxset hvar the variable's value can be assigned through a text file :
Chapter 10 The Command Language Procedure | 185

text_file.txt | uxset hvar VAR1 VAR2=value VAR3

VAR2 will be assigned “value” and VAR1 and VAR3 will be assigned the content of the file
text_file.txt. There is no specifique format for entering values into a text file.
Example of content in a text file:
Paris, France
2013/09/17
Val1, Val2, Val3
If several variables are to be transmitted they should be separated by spaces.
uxset hvar VARDATE=2013/08/16 “VARTXT=TEXT VALUE" VARNUM=555

The " " enclosing the variable “VARTXT” is needed to carry over the space in the string "TEXT
VALUE"; if you don't have a space in your string they are not needed.

10.2.7.3 Constraints on the variable value


During the transmission to the next Uproc, inheritance variables are created as environment variables
into the system (by the u_batch of the next Uproc), so the value of an inheritance variable has to
contain the same characters than the ones authorized for the value of an environment variable on the
given OS (the command set is used to set an environment variable for Windows, and the command
export is used for UNIX). Otherwise, the inheritance variable cannot be created as an environment
variable by the system, and the Uproc aborts.
Example 1: The following inheritance variables set into the script of a Uproc are correct:
uxset hvar "MY_VAR1=email<who@hello.com>"
or
uxset hvar MY_VAR1="email<who@hello.com>"

This variable will be created as an environment variable on the system by DUAS. This corresponds to
the following correct system commands:
On a windows command:
C:\>set MY_VAR1="email<who@hello.com>"

On a UNIX Shell:
root@myunixmachine:/# export MY_VAR1="email<who@hello.com>"
Example 2: The following inheritance variable set into the script of a Uproc is not correct:
uxset hvar MY_VAR1=email<toto@hello.com>

This variable cannot be created as an environment variable by DUAS. This corresponds to the
following incorrect system commands:
On a windows command:
C:\>set MY_VAR1=email<who@hello.com>
The syntax of the command is incorrect
On a UNIX Shell:
root@myunixmachine:/# export MY_VAR1=email<who@hello.com>
-bash: syntax error near unexpected token `newline'

If the value contains non alphanumeric characters, these characters must be preceded by the
"\" character.

10.2.7.4 Display of Inheritance Variables


With the exception of WS_SOAP and WS_REST type Uprocs, inheritance variables are not listed in
UVC. To view the transmitted variables, open the job log of the child Uproc.
186 | Chapter 10 The Command Language Procedure

Example:

$!** INHERITANCE VARIABLES


var1: val12345
_!================================================
If the option to keep the variables is activated (by default or command uxset inheritance keep),
inheritance variables will be transmitted. If the option to keep the variables is deactivated (command
uxset inheritance discard), the variables will not be transmitted to the child Uproc.
If the user references a variable that already exists (name conflict), the variable's value set in the
category with a higher priority is selected. The categories are the following:
1. Variables created in the script
2. Standard variables (S_NODENAME, S_AREA, S_NUMLANC)
3. Uproc variables
4. Parameters
5. MU variables
6. Node variables
7. Variables defined in U_ANTE_UPROC
8. Variables defined in unienv

10.2.7.5 Examples
We have three Uprocs in a session (A, B and C). A is the parent Uproc and B and C are the child
uprocs.
Run the following command in the script of Uproc A to generate inheritance variables:
uxset hvar Var1=Val1A Var2=Val2A Var3=Val3A

Uproc A variables: Var1=Val1A, Var2=Val2A, Var3=Val3A


In this configuration, be default the variables Var1, Var2 and Var3 and their values will be transmitted
to all child Uprocs in the Session.
Example 1
Run the command “uxset inheritance [discard]” in the script of Uproc A and no input variables will be
transferred to Uproc B.
If the command ““uxset inheritance [keep]” is entered, Uproc B will receive all transferred input
variables.
Example 2
Run the command “uxunset hvar Var1 Var3” in the script of Uproc A and Uproc B will just receive the
variable Var2 with the value “Val2A”.
Chapter 11 Annexes | 187

11 Annexes

11.1 Example of Use of CL Commands

11.1.1 Recovery Steps and Messages in a KSH Script


#! /bin/ksh
STEP0 ()
# Variable S_NUMJALON =0 at normal start of uproc
{
$UNI_DIR_EXEC/uxset msg " *** Passage STEP 0 *** "
}
STEP1 ()
{
$UNI_DIR_EXEC/uxset step "1"
$UNI_DIR_EXEC/uxset msg " *** Passage STEP 1 *** "
# Use uxset msg to display normal
# comments and instructions in History Trace.
}
STEP2 ()
{
$UNI_DIR_EXEC/uxset step "2"
$UNI_DIR_EXEC/uxset msg " *** Passage STEP 2 *** "
}
STEP3 ()
{
$UNI_DIR_EXEC/uxset step "3"
$UNI_DIR_EXEC/uxset msg " *** Passage STEP 3 *** "
}
STEP4 ()
{
$UNI_DIR_EXEC/uxset step "4"
$UNI_DIR_EXEC/uxset msg " *** Passage STEP 4 *** "
}
STEP5 ()
{
$UNI_DIR_EXEC/uxset step "5"
$UNI_DIR_EXEC/uxset msg " *** Passage STEP 5 *** "
}
# During recovery the S_NUMJALON variable is loaded manually from the Job
Monitor screen, else =0
#
Iscn=$S_NUMJALON
let Iscn=Iscn
echo "Iscn =$Iscn"
while [ $Iscn -le 5 ]
do
echo "Iscn =$Iscn"
Fnct=STEP$Iscn
echo "Fnct =$Fnct"
e $Fnct
let Iscn=Iscn+1
done
exit 0
188 | Chapter 11 Annexes

11.1.2 Recovery Steps and Messages in a CSH Script


#! /bin/csh
#
goto STEP$S_NUMJALON
# normal processing starts here
STEP00:

STEP01:
$UNI_DIR_EXEC/uxset step "1"
$UNI_DIR_EXEC/uxset msg " *** Passage step N° $S_NUMJALON ***"

STEP02:
$UNI_DIR_EXEC/uxset step "2"
$UNI_DIR_EXEC/uxset msg " *** Passage step N° $S_NUMJALON ***"

STEP99:
exit 0

11.2 Appendices AS/400

11.2.1 Examples of OS/400 Programs

11.2.1.1 Development

Administration
CALL PGM(UXSHW) PARM(NODE 'TNODE=Asterix')

Displays the Asterix node definition


CALL PGM(UXLST) PARM(MU LOCAL)

Displays the list of Management Units that reside on the local node
CALL PGM(UXLST) PARM(DOM)

Displays the list of defined Domains and their labels


CALL PGM(UXSHW) PARM(MUD 'MU=SIEGE' 'APPL=*')

Displays the definition of the SIEGE Management Unit directories for all applications
CALL PGM(UXSHW) PARM(USER 'USER=ADMIN')

Displays the definition for the user ADMIN

Classes and resources


CALL PGM(UXLST) PARM(CLASS)

Displays the list of defined classes


CAL PGM(UXSHW) PARM(RES 'RES=D_*')

Displays the definition of resources

Uprocs
CALL PGM(UXADD) PARM(UPR EXP 'UPR=TEST' 'LABEL=LOAD FILE' + 'FPERIOD=D'
'APPL=BK' 'MEMO=O' 'NBPER=1')
Chapter 11 Annexes | 189

Create the Uproc TEST version 000 label “Load file” in the current environment (Company, node)
Production Area, functional period: day, internal command file, BK Application (T Domain),
memorization, 1 execution, 1 period.

Sessions
CALL PGM(UXSHW) PARM(SES EXP 'SES=D_LOAD_BCK' LNK)

Displays the previously created Session with the Uprocs it is composed of and links between them.

Calendars
CALL PGM(UXDLT) PARM(CAL EXP 'MU=SIEGE' 'SINCE=2008' 'BEFORE=2010)

Deletes the years 2008, 2009 and 2010 in the Management Unit SIEGE’s calendar in the current
environment (Company, node and Area).

Tasks
CALL PGM(UXADD) PARM(TSK EXP 'SES=D_LOAD_BCK' +
'UPR=D_LOAD_FIL' 'MU=SIEGE' TECHINF 'TYPE=S' 'USER=ADMIN')

Create a Task from the Session D_LOAD_BCK, Uproc header D_LOAD_FIL on the Management Unit
SIEGE, non-template in the Production Area. The Task is scheduled, the submission account is
ADMIN. This task cannot create a launch, as in this state, a date has not yet been defined.
CALL PMG(UXLST) PARM(TSK EXP 'UPR=D_LOAD_FIL' +
'SES=D_LOAD_BCK' 'MU=SIEGE' FULL)

Displays the list of all the task characteristics

11.2.1.2 Production

Resources
CALL PGM(UXCNR) PARM(RES 'RES=PRIO_ORDO' 'ESP=X' +
'UPR=IU_DT2' 'MU=S01')

Releases the reservation made on the resource PRIO_ORDO by the Task defined by the Uproc
IU_DT2, Management Unit S01 in the Production Area

Launches
CALL PGM(UXLST) PARM(FLA FULL)

Displays the list of launches and all associated information

Events
CALL PGM(UXLST) PARM(EVT EXP FULL)

Displays the list of events in the Production Area as well as all associated information

Job Monitor
CALL PGM(UXPUR) PARM(CTL EXP 'UPR=D_*' 'MU=SIEGE' +
'SINCE=(20130101,1200)' 'BEFORE=(20130201,1200)')

Purges the job monitor of all the jobs of the Uproc IU_TEST version 001 on the Management Unit
SIEGE between January 1st, 2013 at 12:00 and February 1st, 2013 at 12:00 for a date with the format
YYYYMMDD.

Engines
CALL PMG(UXEND) PARM(ATM EXP ALL)
190 | Chapter 11 Annexes

Stops all engines in the Production Area

Execution History
CALL PGM(UXSHW) PARM(HCX EXP 'UPR=D_LOAD_FIL' 'NUPR=*' +
'SES=D_LOAD_BCK' 'NSESS=*' 'MU=SIEGE' VAR)

Displays the Uproc D_LOAD_FIL variables that execute for the session D_LOAD_BCK in the
Management Unit SIEGE

Statistics
CALL PGM(UXDLT) PARM(STA EXP 'UPR=D_LOAD_FIL' 'MU=SIEGE')

Deletes the Uproc U_LOAD_FIL task on the Management Unit D_LOAD_FIL in the statistics list

11.2.1.3 Batch Management


CALL PGM(UXORDRE) PARM('UPR=1ST_JOB' 'MU=SATURN' +
'PARAM=34,/tmp,type:2')

Provokes the task associated with the Uproc 1ST_JOB on the Management Unit Saturn with the
indicated parameters.

11.2.2 Control Language Programming

11.2.2.1 Screen Size of an OS400 Source File


The ‘+’ sign at the end of line of an OS400 source file means that the command will continue onto the
next line.
On OS/400, the file size is based on the length of the line displayed on the screen. So, the ‘+‘ is used
to wrap the command onto the next line when the maximum number of characters of the line has
been reached.
For scripting development, you can either work directly on a source file on the server, or on a text file
on your local work station. The latter implies that the file transfer will use the iSeries navigator, which
will convert the file to a Source file with a maximum line length declared through its interface.

11.2.2.2 Program Structure


Begin
CLP programs should start with PGM
End
CLP programs should end with ENDPGM
Label
Label can be used to define a step within a CLP program. The GOTO command is used to
skip to the label and continue executing from this point. The label syntax is as follows:
STEP00:

11.2.2.3 Variable Handling


Local variables can be used within CLP programs. Although “environment variables” do not exist as
such, it is still possible to pass Dollar Universe variables to a program by declaring and obtaining
these values manually. Variables can also be passed to a program as parameters with pointer
evaluation.
Chapter 11 Annexes | 191

Local Variable Declaration:


DCL VAR(&name) TYPE(*type) LEN(n)
NAME: Name of the variable to be declared
TYPE: Type of the variable.
*CHAR
*DEC
*LGL
Example – Declare UNI_TEST variable of type *CHAR and length 1
DCL VAR(&UNI_TEST) TYPE(*CHAR) LEN(1)
Local Variable Update:
CHGVAR VAR(&name) VALUE(‘value')
- NAME: Name of the variable to be updated
- VALUE: New value of the variable.
Example – Change VNOM to value IDF
CHGVAR VAR(&VNOM) VALUE('IDF')

11.2.2.4 CL Parameter Basics


The value that a program passes to a program it has called is commonly called a program parameter.
Program parameters are specified by indicating a value or variable name for the PARM keyword in
the calling program.
The calling program's PARM parameter can also contain a list of variables. In this case, the same
number of values is passed to the called program in separate parameters.
For example, the following PGM command lists two input parameters &Cusnbr and &Cusname:
PGM PARM(&Cusnbr &Cusname)
Being passed a variable value is in general the same as assigning an initial value to a variable. Since
a variable’s initial value is set by the calling program, initial values cannot be set for variables within a
called program.
Defining Parameters in a Called Program:
CL supports only three types of variables
 character (*CHAR)
 decimal (*DEC)
 logical (*LGL)
Each input variable in the called program must correspond to one of these types.
Example:
PGM PARM(&Name &Number &Flag)
DCL &Name *CHAR 9
DCL &Number *DEC (15 5)
DCL &Flag *LGL
The Parameter sequence in the PGM command must correspond to the order in which they are
passed.
CALL MYPROGRAM + PARM('Christine' 22.5 '1')
Passing Literals to a Called Program:
Literals can also be passed in the PARM parameter of the CALL command. If you specify only one
parameter, you can code the PARM keyword positionally:
CALL MYPROGRAM 'Monday'
You can specify up to 50 parameters. When you list more than one, you must enclose the list in
brackets, as with all list-type values:
192 | Chapter 11 Annexes

CALL MYPROGRAM + PARM('Monday' 'Tuesday' + 'Wednesday')


Parameters passed from the OS/400 command line must always be literals since variables can only
exist in a program.
Passing Character Literals and Logical Constants:
If character literals are passed, the called program must declare the input variables with the type
*CHAR. The program called in the last example would contain the following commands:
PGM PARM(&Day1 &Day2 &Day3)
DCL &Day1 *CHAR 9
DCL &Day2 *CHAR 9
DCL &Day3 *CHAR 9

The variables are declared as nine-byte *CHAR variables, even though two of the literals
(Monday and Tuesday) contain fewer than nine characters. When you declare the variables
used as parameters, make them long enough to hold the longest possible value that could be
passed to them.

When a *CHAR variable is longer than the value being passed to it, the value is left-justified and
padded to the right with blanks. In the preceding example, the values of variables &Day1, &Day2, and
&Day3 would be Monday, Tuesday and Wednesday, respectively (indicates trailing blanks).
If the literal that was passed is longer than the input variable, the extra characters are truncated.
Passing Decimal Literals:
Decimal literals can be passed as parameters from an OS/400 command line or a CL program:
CALL MYPROGRAM + PARM(5 3.1416 129.95)
When decimal literals are passed, the called program must declare the corresponding input variables
as *DEC (15 5) (if it doesn't, the called program will abort with a decimal data error).
Example:
PGM PARM(&Number1 &Number2 &Number3)
DCL &Number1 *DEC (15 5)
DCL &Number2 *DEC (15 5)
DCL &Number3 *DEC (15 5)
Passing Variables to a Called Program:
Variable values can also be passed from a CL program.
For example:
CALL PROGRAM1 PARM(&Name)
CALL PROGRAM2 PARM(&Name &Address &Phone)
CALL PROGRAM3 PARM(&Radius 3.1416 &Area)
The first example passes the current value of the variable &Name to PROGRAM1.
The second example passes the current values of three variables to PROGRAM2.
The third example passes a combination of program variables and literals to PROGRAM3.
When variables are used as program parameters, they should be declared in the calling program, as
shown below:
PROGRAM1:
PGM DCL &Name *CHAR 10
DCL &Department *DEC (5 0)
CHGVAR &Name 'Mary'
CALL PROGRAM2 +
PARM(&Name &Department)
RETURN
ENDPGM
Variable names in the calling and called programs don't have to match, but data types and variable
lengths must be consistent. Note that decimal variables don’t have to be passed (e.g., &department)
Chapter 11 Annexes | 193

as (15 5), rather, define each decimal variable to match the data type and length of the corresponding
program variable to be passed.
The DCL commands in the calling and called program can be in any order and do not have to declare
the variables with the same names. The following example shows how PROGRAM2 might look:
PROGRAM2:
PGM PARM(&Alpha &Dept)
DCL &Dept *DEC (5 0)
DCL &Alpha *CHAR 10
IF (&Alpha = 'Mary') DO
CHGVAR &Dept VALUE(12600)
ENDDO
RETURN
ENDPGM
As required, the parameters appear in the same order as they do in PROGRAM1's CALL command.

11.2.2.5 Submission Commands


CALL
 Synchronous command
 Parameters can be passed to the called program
 OS400 environment cannot be set (JOBQ, OUTQ, JOBD…)
SMBJOB
 Asynchronous command
 Parameters cannot be passed to the called program
 OS400 environment can be set JOBQ, OUTQ, JOBD, DATE, JOB
Dollar Universe OS400 environment variables:
Since the SMBJOB command is asynchronous, it is necessary to use the CALL command.
Dollar Universe provides an internal mechanism to declare the OS400 environment through the use of
Uproc variables.
Available variables are UX<OS400_Name>
 UXJOBQ
 UXJOBD
 UXOUTQ
 UXJOB
 UXDATE…

11.2.2.6 IF/THEN Structure


An IF/THEN testing structure is available in CLP. ELSE keyword does not exist and should be
replaced by cascading IF tests.
Format
IF COND(statement) THEN( do something )
Statement: Testing condition that will return True or False
Do_Something: Command to execute if the test is true. Multiple lines can be added using the ‘+‘
according to the OS400 line size behavior.
Example – Testing a Step Number
IF COND(&S_NUMJALON *EQ '00') THEN(GOTO +
194 | Chapter 11 Annexes

CMDLBL(JALON00))
Example 2 – Testing the value of a string
IF COND((&PGMPARM *NE ' ') *AND (&CMD *NE ' ')) +
THEN(CALL PGM(&CMD) PARM('&PGMPARM'))

11.2.2.7 Dollar Universe Error Handling


Dollar Universe will interpret the last message sent with the 9898 ID just before the RETURN as an
error.
SNDPGMMSG MSGID(CPF9898) MSGF(QCPFMSG) MSGTYPE(*ESCAPE)
A RETURN with no preceding message is interpreted as normal successful completion of the Uproc.

11.2.2.8 Compilation
CLP is a programming language, so source codes should be compiled before being called by Dollar
Universe as external commands.
Dollar Universe cannot execute un-compiled source code, so programs are treated as external
scripts. Internal scripts cannot be used.
An exception is made for single-line commands. Single-line commands CAN be triggered from an
internal script, with no blank spaces and no carriage returns at the end of the file.
Crtclpgm pgm (‘LIBRARY\PROGRAM’ ‘LIBRARY/SOURCEFILE’… ).
Parameters are:
 Program: Output file as a result of the compilation.
o Library: Output library where the program will be located.
 Source File: Input Control Language file. Type of file must be *.SRC.
o Library: Input library where the source file is located.
 Source member: Member of the source file to compile.
Chapter 12 About Automic Software, Community and Services | 195

12 About Automic Software,


Community and Services
This topic introduces the Automic Software company and how to leverage the full potential of our
solutions to you.

You can also obtain Automic documentation online from docs.automic.com.

12.1 Automic Software Company


Automic Software is dedicated to business automation.

Automic is the world's most comprehensive platform in automating businesses. Founded 1985,
Automic pioneered the largest, independent, globally deployed automation platform which powers the
enterprise, application and infrastructure. Now, as the consumerization of IT accelerates, Automic is
re-imagining how organizations integrate next generation service models such as Cloud, DevOps and
Big Data. Today, our software automates tens of millions of operations a day for over 2,000
customers worldwide. We challenge conventional thinking, enabling our customers to be faster,
smarter, in control. Automic – the standard in business automation.
Find out more at our website www.automic.com .

12.2 Automic Community


Want to connect with other Automic users to compare notes or learn how others are tackling problems
that you’re running into?

Talk with other users from around the world to learn how they optimize their business automation with
Automic. Interact with the Automic Team to get ONE Automation Platform tips and tricks straight from
the source.
Join the Automic Community and become an Automic Insider and be among the first to get news
about new products and events, even before they are generally announced!

12.3 Download Center


Make sure that you are using our products to their fullest potential.

The Download Center is the place where you find product downloads, documentation and information
on new releases and hot-fixes about your Automic solution. It’s all in one place: from service hotfixes,
release notes, and all guides. You will also find patch descriptions, known bugs or workarounds.
196 | Chapter 12 About Automic Software, Community and Services

12.4 Technical Support


We have a support team you can trust.

Our team of professionals is ready to support you, anytime and anywhere. Three support centers
located in Europe, the United States, and Asia Pacific build the core of the Automic support
organization.
Our Technical Support Team makes sure that your closest Automic experts are never more than a
few hours flight away, no matter on which continent your subsidiaries and data centers are located.
Automic Software is designed to provide global connectivity for international companies. You are
employing Automic software on a global scale and therefore you can expect global service.

12.5 Training and Services


Do you want to learn even more about Automic solutions?

We offer a range of training options on how to get the most out of your Automic solution. Depending
on your location, either open training sessions at an Automic Software Service Center, or
personalized training sessions at your company's site suits best. Visit the training site and get detailed
information about currently offered courses.

S-ar putea să vă placă și