Uprocs

This section describes the commands on Uprocs. The default Environment can be changed.

The command uxadd UPR adds a Uproc into the Uprocs list. Only general information is defined. Additional information will be entered by updating the Uproc (uxupd command). Its syntax is as follows:

uxadd UPR UPR=uproc [VUPR=version] [LABEL=label][FPERIOD=N|D|W|T|F|M|2|3|Q|S|Y] [UPT=CL_INT|CL_EXT|CMD|FTP_GET|FTP_PUT|…] [CLFIL=filename] [CL_INT=filename] [COMMAND=command] [EXECDIR=directory] [SHELL=filename] [SHELLARG=arguments] [SHELLTYPE=POWERSHELL|PERL|CSCRIPT|DEFAULT] APPL=application [CLASS=class] [MEMO=N|O|A] [NBPER=number] [RETRY=(NNN,MM)] [DEFINFO=information] [DEFSEV=severity] [INTERACTIVE| NONINTERACTIVE]

See also GENINF Items.

The command uxupd UPR modifies the Uproc’s general information. It defines additional characteristics such as conditions, completion instructions, incompatibilities. Its syntax is as follows:

uxupd UPR UPR=uproc [VUPR=version] family...

• family

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

  • GENINF: Updates Uproc general information.
  • UPR_STATUS: Defines the Uproc completion status.
  • CTLDUR: Updates control information for the execution duration of the Uproc.
  • NOTIFY: Defines email notification on completion of the Uproc.
  • LAUNCHVAR add: Creates, assigns values and deletes Uproc variables.
  • INCCLASS add: Defines the classes with which a Uproc is incompatible. The Uprocs membership class is defined in its general information.
  • TERMINS add: Defines the events which will be purged upon completion of the Uproc.
  • DEPCON add: Defines the conditions of dependency upon other Uprocs.
  • INCCON add: Defines conditions of incompatibility with individual Uproc.
  • RESCON add: Defines resource conditions.
  • 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 add: Defines the order of consideration for the successors of the Uproc.
  • FTP_GET: Defines a FTP_GET Uproc.
  • FTP_PUT: Defines a FTP_PUT Uproc.

• GENINF

  General information.

  uxupd UPR UPR=uproc [VUPR=version] GENINF [LABEL=label][FPERIOD=N|D|W|T|F|M|2|3|Q|S|Y] [UPT=CL_INT|CL_EXT|CMD|FTP_GET|FTP_PUT|…] [CLFIL=filename] [CL_INT=filename] [COMMAND=command] [EXECDIR=directory] [SHELL=filename] [SHELLARG=arguments] [SHELLTYPE=POWERSHELL|PERL|CSCRIPT|DEFAULT] APPL=application [CLASS=class] [MEMO=N|O|A] [NBPER=number] [RETRY=(NNN,MM)] [DEFINFO=information] [DEFSEV=severity] [INTERACTIVE| NONINTERACTIVE] [DIR_FILES=directory]

  See also GENINF Items

• UPR_STATUS

  Uproc completion status.

  uxupd UPR UPR=uproc [VUPR=version] UPR_STATUS ENABLE=Y|N|y|n [SET=C|A] [RETCODE=value[,EQ|LO|GT|NE]] [EXT_RETCODE=n1;n2;[n3,n4];[n5,n6]/n7] [STRING=string] [REGEXP|NOREGEXP] [SEARCH_FILE=filename]

  See also UPR_STATUS Items

• CTLDUR

  Control the Uproc run duration.

  uxupd UPR UPR=uproc [VUPR=version] CTLDUR [MAXDUR=(HHHMMSS|nnn,K|F|C=filename)|NONE] [MINDUR=(HHHMMSS|nnn,R|C=filename)|NONE] [MAXWDUR=(HHHMMSS|nnn,F|A|C=filename)|NONE]

  See also CTLDUR Items

• NOTIFY

  Email notification on Uproc completion.

  uxupd UPR UPR=uproc [VUPR=version] NOTIFY [MAIL=Y|N] [COMPLETED=Y|N] [ABORTED=Y|N] [REFUSED=Y|N] [TIMEOVERRUN=Y|N] [JOBLOG=Y|N|value] [RECIPIENT="email1;email2…"]

  See also NOTIFY Items

• LAUNCHVAR add

  Add a variable

  uxupd UPR UPR=uproc [VUPR=version] LAUNCHVAR add VARNAME=variable [VTYPE=D|Q|P|T] VFORMAT=format [VALMIN=value] [VALMAX=value] VVALUE=value

• LAUNCHVAR dlt

  Delete a variable.

  uxupd UPR UPR=uproc [VUPR=version] LAUNCHVAR dlt VARNAME=variable

  See also Variables Items

• INCCLASS add

  Add an incompatibility class.

  uxupd UPR UPR=uproc [VUPR=version] INCCLASS add XCLASS=class

• INCCLASS dlt

  Delete an incompatibility class.

  uxupd UPR UPR=uproc [VUPR=version] INCCLASS dlt XCLASS=class

  See also Incompatibility Classes and Successors Items

• TERMINS add

  Add a completion instruction.

  uxupd UPR UPR=uproc [VUPR=version] TERMINS add TERMNO=number TERM=uproc [PDATE=ANY|SAME|(±n,n,n)|(a, ,n)] [MU=SAME|"MU(mu)"|"MUT(type)"|"HDP({XY})"] [SESS=ANY|SAME|SAMERUN|EXPL(session)] [USER=ANY|SAME] [STATUS=TERMINATED|ABNORMAL]

• TERMINS dlt

  Delete completion instructions.

  uxupd UPR UPR=uproc [VUPR=version] TERMINS dlt TERMNO=number

  See also Completion Instructions and Conditions Items

• DEPCON add

  Add a dependency condition.

  uxupd UPR UPR=uproc [VUPR=version] DEPCON add CONDNO=number DEP=uproc [IFPLANNED] [PDATE=ANY|SAME|(±n,n,n)|(a, ,n)] [DTYPE=A|W|C|H] [MU=SAME|"MU(mu)"|"MUT(type)"|"HDP({XY})"] [SESS=ANY|SAME|SAMERUN|EXPL(session)] [USER=ANY|SAME] [STATUS=TERMINATED|ABNORMAL|ENDED|ABSENT] [EXPECTED|EXCLUDED] [NOFATAL|FATAL]

• DEPCON dlt

  Delete dependency condition. The launch formula must be updated first with the complete new launch formula.

  uxupd UPR UPR=uproc [VUPR=version] DEPCON dlt CONDNO=number

  See also Completion Instructions and Conditions Items

• INCCON add

  Add an incompatibility condition.

  uxupd UPR UPR=uproc [VUPR=version] INCCON add CONDNO=number INC=uproc [PDATE=ANY|SAME] [MU=SAME|"MU(mu)"|"MUT(type)"|"HDP({XY})"] [SESS=ANY|SAME|SAMERUN|EXPL(session)] [USER=ANY|SAME] [EXPECTED|EXCLUDED] [NOFATAL|FATAL]

• INCCON dlt

  Delete an incompatibility condition. The launch formula must be updated first with the complete new launch formula.

  uxupd UPR UPR=uproc [VUPR=version] INCCON dlt CONDNO=number

  See also Completion Instructions and Conditions Items

• RESCON add

  Add a resource condition.

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

  uxupd UPR UPR=uproc [VUPR=version] RESCON add CONDNO=number RES=resource [PDATE=ANY|SAME|(±n,n,n)|(a, ,n)] [DTYPE=A|W|C|H] [MU=SAME|"MU(mu)"|"MUT(type)"|"HDP({XY})"] [ONE|ALL] [VERIF|NOVERIF] [UNLOCK|LOCK] [EXPECTED|EXCLUDED] [NOFATAL|FATAL] [ATTRIB=EXIST|SIZE|DATEUNCHANGE|SIZEUNCHANGE|DATCREA|DATMOD|GROUP|PARSING] [OPER=#|=|<|>|<=|>=|~=] [VALUE=value] [QT1=value] [QT2=value]

• RESCON dlt

  Delete a resource condition. The launch formula must be updated first with the complete new launch formula.

  uxdlt UPR UPR=uproc [VUPR=version] RESCON dlt CONDNO=number

  See also Completion Instructions and Conditions Items

• FORMULA

  Set the launch formula.

  uxupd UPR UPR=uproc [VUPR=version] FORMULA LFORM=formula

  See also Launch Formula Item

• SUCCESSOR add

  Create a successor Uproc

  uxupd UPR UPR=uproc [VUPR=version] SUCCESSOR add SUCC_UPR=uproc

• SUCCESSOR dlt

  Delete a successor Uproc

  uxupd UPR UPR=uproc [VUPR=version] SUCCESSOR dlt SUCC_UPR=uproc

  See also Incompatibility Classes and Successors Items

• FTP_GET

  Retrieve files by FTP.

  uxupd UPR UPR=uproc [VUPR=version] FTP_GET [PARTNER=hostname] [ORIGIN_FILENAME=filename] [ORIGIN_PATHNAME=path] [TARGET_FILENAME=filename] [TARGET_PATHNAME=path] [LOGON=username|anonymous] [PASSWORD=password] [MODE=ASCII|BINARY] [ACTION=REPLACE|ABORT|NONE] [CRLF|NOCRLF] [DELETE|NODELETE] [NEWER|NONEWER] [RECURSIVE|NORECURSIVE] [BUFFER_SIZE=value] [RETRY=value] [UMASK=value]

• FTP_PUT

  Send files by FTP.

  uxupd UPR UPR=uproc [VUPR=version] FTP_PUT [PARTNER=hostname] [ORIGIN_FILENAME=filename] [ORIGIN_PATHNAME=path] [TARGET_FILENAME=filename] [TARGET_PATHNAME=path] [LOGON=username|anonymous] [PASSWORD=password] [MODE=ASCII|BINARY] [ACTION=REPLACE|ABORT|APPEND|NONE] [DELETE|NODELETE] [NEWER|NONEWER] [RECURSIVE|NORECURSIVE] [BUFFER_SIZE=value] [RETRY=value]

  See also FTP Items

The command uxdup UPR duplicates a Uproc with all its characteristics. If this Uproc has an internal script, it is also duplicated. Its syntax is as follows:

uxupd UPR UPR=uproc VUPR=version TUPR=uproc TVUPR=version [TLABEL=label]

The command 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 User Guide. Its syntax is as follows:

uxshw UPR UPR=uproc [VUPR=version] [DOM=domain] [APPL=application] [SCRIPT] [OUTPUT=filename]

The command uxdlt UPR deletes a Uproc. Its syntax is as follows:

uxdlt UPR UPR=uproc [VUPR=version]

The command uxlst UPR lists the Uprocs. Its syntax is as follows:

uxlst UPR [UPR=uproc] [VUPR=version] [DOM=domain] [APPL=application] [INF|FULL] [OUTPUT=filename]

The command uxtra UPR transfers the Uprocs to another area (same company and same node). Its syntax is as follows:

uxtra UPR UPR=uproc [VUPR=version] TESP=I|S|X

The command uxscv UPR defines the current version of a Uproc (in the application or integration area only). Its syntax is as follows:

uxscv UPR UPR=uproc [VUPR=version]

The command uxrls UPR unlocks a Uproc. Its syntax is as follows:

uxrls UPR UPR=uproc [VUPR=version]

The command uxext UPR extracts the complete definition of a Uproc (with its CL if this was declared internal). Its syntax is as follows:

uxext UPR UPR=uproc [VUPR=version] [REPL] [ENABLE|NOENABLE] [NOVERIF] OUTPUT=filename

The command uxins UPR inserts the complete definition of a Uproc in the corresponding Dollar Universe files (with its CL). Its syntax is as follows:

uxins UPR UPR=uproc [VUPR=version] [REPL] [ENABLE|NOENABLE] INPUT=filename

• If Uprocs were extracted from production or simulation areas (version 000), they can 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).

See Also Other Commands Items

Description of Items

GENINF Items

• UPR=

  Uproc code. Enter a Uproc code or * (wildcard accepted except for uxadd).
  Format: 64 alphanumeric characters.

• VUPR=

  Uproc version. Accepts a Uproc version (explicit value).
  Format: 3 numeric characters.

  Default:

  • uxext: (optional) all versions of the Uprocs entered are extracted (irrelevant for SIM and EXP areas).
  • Other commands: the version is mandatory in the APP and INT areas; it is not ignored in the SIM and EXP areas (systematically equal to 000).

• LABEL=

  (Optional) Label describing the Uproc.
  Format: 64 alphanumeric characters.

• FPERIOD=

  (Optional) 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).

  Default: N (none)

• UPT=

  (Optional) 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 Managers installed.

  Default: CL_INT

• CLFIL=

  (Optional) External CL file associated with the Uproc. May only be used with the Uproc type CL_EXT. Indicates the access path and name of the procedure associated with the Uproc.
  Format: 128 characters maximum.

• CL_INT=

  (Optional) Path targeting a single file whose contents will be copied as an internal script for a CL_INT type Uproc.
  Format: 256 characters maximum.

• COMMAND=

  (Optional) Command line to be executed. May only be used with the Uproc type CMD.
  The command line must include:

  • The path to the command (otherwise the directories of the PATH variable will be searched for the command).
  • The command and its arguments.

  The command path and arguments may contain variables using the syntax: !VARIABLE!. Refer to the Dollar Universe Reference Guide for how to manipulate these variables.
  Format: 256 characters maximum.

• EXECDIR=

  (Optional) Execution directory of the command line. May only be used with the Uproc type CMD.
  Format: 258 characters maximum.

  Default: The home directory of the submission account executing the Uproc.

• SHELL=

  (Optional) 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)
  

• SHELLTYPE=

  (Optional) Contains the shell type for a Uproc of type CL_INT, CL_EXT or CMD only on a node with version 6.7 minimum. The values are: POWERSHELL, CSCRIPT (except CMD type) or PERL.

  Default: DEFAULT: the shell type is specified in the script if necessary.

• APPL=

  Application code. Used with uxadd and uxupd: Indicates the application with which the Uproc is associated.
  Optional with uxupd.
  Format: 64 alphanumeric characters.

• CLASS=

  (Optional) Uproc membership class.
  Format: 64 alphanumeric characters.

• MEMO=

  (Optional) Indicates how the Uproc is memorized in the job events file. Three values are possible:

  • N: not memorized
  • O: one execution.
  • A: all executions.

  Whenever the Uproc is memorized (O or A selection), the item NBPER must also be supplied.

  Default : N

• NBPER=

  (Optional) Number of Uproc periods memorized. Indicates the number of functional periods for which events will be kept in the operations events file.
  Format: 2 numeric characters.

  Default : 0 (without limit)

• RETRY=

  (Optional) If the Launcher sets the “aborted” status to the job, the Launcher will re-run the job until it completes with the Completed status..
  Format (NNN,MM), where:

  • NNN: is the maximum number of retries. Maximum 999.
  • 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=

  (Optional) Default value of the Uproc’s Information parameter, which is shown in the job monitor.
  Format: Free text truncated to 50 characters if longer.

• DEFSEV=

  (Optional) Default value of the Uproc’s Severity parameter, which is shown in the job monitor.
  Format: Integer from 0000 to 9999 on 4 digits.

• INTERACTIVE | NOINTERACTIVE

  (Optional) On Windows only, submission mode

  • INTERACTIVE : 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.

  Default: NOINTERACTIVE

• DIR_FILES=

  (Optional) Path targeting a directory in which the content will be copied as Uproc files.

UPR_STATUS Items

• ENABLE=

  Enables or disables management of the Uproc’s completion status. Can only be used with the STATUS family.
  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=

  (Optional) 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
  • A: status Aborted

  Default : C

• RETCODE=

  (Optional, incompatible with EXT_RETCODE, STRING and SEARCH_FILE) Test the Uproc’s script return code (on UNIX / OpenVMS) or the variable RESEXE (on Windows). Can only be used with the STATUS family.
  Format: 4n[,2c]:

  • 4n: numerical value on 4 digits: expected return code. Positive or negative integer.
  • (Optional) 2c: value test operator on 2 characters. The possible values are: EQ (equal), GT (greater than), LO (less than) or NE (not equal).
    Default: EQ (equal).

  Example:

  uxupd UPR EXP UPR=STATUS_UPR UPR_STATUS ENABLE=Y SET=A RETCODE=0.LO

• EXT_RETCODE=

  (Optional, incompatible with RETCODE, STRING and SEARCH_FILE) Test the Uproc’s script return code (on UNIX / OpenVMS) or the variable RESEXE (on Windows). Can only be used with the STATUS family.
  Format: n1;n2;[n3,n4];[n5,n6]/n7 up to 64 characters maximum. The list of values can contain:

  • A simple value. Format: * or a positive or negative integer (from -32767 to 32768).
    Example: -2
  • A range of positive or negative integers (from -32767 to 32768). format: [min,max],
    Example: [-10,10]: from -10 to 10 inclusive.
  • Values calculated from a multiple: Format N/m (N positive or negative, m only positive)
    Example: */3: all multiples of 3.
  • Values calculated within a range (from -32767 to 32768) using a specific multiple (m only positive): format [min.max]/m.
    Example: [1,10]/4: 4 and 8. Each of the values or ranges must be separated by a colon.
    

  Example: -2;[-10,10];*/3;[1,10]/4

• STRING=

  (Optional, incompatible with RETCODE and EXT_RETCODE) 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.
  Format: 128 characters. If the string includes spaces, it must be enclosed in quotes.

  Used with the keyword REGEXP, this field corresponds to a regular expression (Tcl/Tk library version 8.1 with option "ERE" meaning that only the syntax of 8.0 is supported; follow this URL https://tcl.tk/doc/howto/regexp81.html#part1_2 for more details).
  The following characters are supported for regular expressions:

  • A wildcard: any character “.”
  • Repeat: zero or more occurrences of previous character or class “*”
  • Line positions: beginning of line “^”
  • Line position: end of line “$”
  • Character class: any one character in set. Example: [clas]
  • Inverse class: any one character not in set. Example: [^clas]
  • Range: any characters within the specified range. Example: [0-9]
  • Escape: literal use of metacharacter “x”. Example: \x
  • Word position: beginning of word. Example: \<xyz
  • Word position: end of word. Example: xyz\>

  Example:

  uxupd UPR EXP UPR=STATUS_UPR UPR_STATUS ENABLE=Y SET=C STRING=Execution_OK SEARCH_FILE=/data/result_file.txt

• REGEXP | NOREGEXP

  (Optional) Regular expression

  • REGEXP: Indicates that STRING contains a regular expression.
  • NOREGEXP: Indicates that STRING does not contain a regular expression.

  Default: NOREGEXP.

• SEARCH_FILE=

  (Optional, incompatible with RETCODE and EXT_RETCODE) File to be searched for the character string STRING. Can only be used with the STATUS family.
  Format: 256 characters. If the string includes spaces, it must be enclosed in quotes.

  Default: the Uproc’s job log

CTLDUR Items

• MAXDUR=

  (Optional) Controls run time that lasts too long.
  Format: (HHHMMSS|nnn,K|F|C=filename) or NONE to reset the value. If the specified time (HHHMMSS or nnn%) 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).

  Examples:
  

  uxupd upr upr=MY_UPROC ctldur maxdur="(119,C=hello)"

  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

• MINDUR=

  (Optional) Controls run time that’s too short.
  Format: (HHHMMSS|nnn,R|C=filename) or NONE to reset the value. If the Uproc finishes before the specified time (HHHMMSS or nnn%), the chosen action is executed:

  • R: reruns the Uproc
  • C: executes the script specified: Enter the path and name of the script to run (maximum 256 characters)

• MAXWDUR=

  (Optional) Controls a wait period before the execution.
  Format: (HHHMMSS|nnn,F|A|C=filename) or NONE to reset the value. If the allowed wait time (HHHMMSS or nnn%) 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).

NOTIFY Items

• MAIL=

  (Optional) Enables email notification for this Uproc.
  Format: Y or N.

  • Y (yes): enables email notification when a selected status (see below) occurs.
  • N (no): disables email notification. Default value.

  Example:
  

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

• COMPLETED=

  (Optional) Indicates whether the Completed status is to trigger email notification (value Y: yes).
  Format: Y or N.

  Default: N

• ABORTED=

  (Optional) Indicates whether the Aborted status is to trigger email notification (value Y: yes).
  Format: Y or N

  Default: N
  

• REFUSED=

  (Optional) Indicates whether the Refused status is to trigger email notification (value Y: yes).
  Format: Y or N.

  Default: N

• TIMEOVERRUN=

  (Optional) Indicates whether the Time overrun status is to trigger email notification (value Y: yes).
  Format: Y or N.

  Default: N

• JOBLOG=

  (Optional) Indicates whether the log of the Uproc is to be attached to the email.
  Format:

  • N: the log of the Uproc is not attached to the email sent.
  • Y: the log of the Uproc is not attached to the email sent, whatever its size.
  • 4 numerical characters: the log of the Uproc is not attached to the email provided that its size does not exceed the value indicated in kilobytes.

  Default: N

• RECIPIENT=

  (Optional) List of recipient email 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;…".

Variables Items

• VARNAME=

  Variable’s name. Requires the name of a Uproc variable to be entered.
  Format: 20 alphanumeric characters.

• VTYPE=

  (Optional) Variable’s type. The variable may be of one of following types: Text, password, quantity or date. The type determines a variable’s format.
  Format:

  • Q: quantity
  • T: text
  • P: password
  • D: date

  Default: T

• VFORMAT=

  Variable’s format. Optional for quantity-type variables, where this information has no significance.

  • 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): maximum 255 characters.
    Default: 255 characters

  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=VARTXT VVALUE=\"Last var\"

  uxupd UPR EXP UPR=D_LOAD_FIL LAUNCHVAR add VARNAME=PASSWD VTYPE=P VVALUE=MyPassword

• VALMIN=, VALMAX=

  (Optional) Range of values exclusively for quantity type variables. 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 or 11 numerical characters plus the sign.

  Default: 0 and 999999999999.

  Note: for a negative numerical value, VALMIN is mandatory, else it is defined to 0 by default and the consistency check will display the error "Incorrect value".

  Examples:

  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=VARNUMNEG VTYPE=Q VAMIN=-9999 VVALUE=-123

• VVALUE=

  Variable’s value. 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. The value of a password variable must be entered in clear but is not displayed in the output of the command.

  • Date variable: 10 characters
  • Quantity variable: 12 numerical characters or 11 numerical characters plus the sign.
  • Password and Text variables: 255 characters

Incompatibility Classes and Successors Items

• 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. 255 characters.

  Example: The Uproc is declared incompatible with classes CLASS1 and CLASS2:

  uxupd UPR UPR=UPROC1 INCCLASS add XCLASS=(CLASS1,CLASS2)

• SUCC_UPR=

  Uproc successor. 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.
  Format: 64 characters.

  Example:

  uxupd UPR UPR=UPROC1 SUCCESSOR add UPROC1_SUCCESSOR_1

Completion Instructions and Conditions Items

• TERMNO=

  The completion instruction's identification number. A number is associated with each instruction; two different instructions may not have the same number.
  Format: 2 numeric characters.

• TERM=

  Completion instruction. Specifies the Uproc code corresponding to the event that must be purged by the completion instruction.
  Format: 64 alphanumeric characters.

  Example:

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

• CONDNO=

  Condition's identification number. A number is associated with each condition (irrespective of the type); two different conditions cannot have the same number.
  Format: 2 numeric characters.

• DEP=

  Dependency condition. Specifies the Uproc code concerned by the dependency condition.
  Format: 64 alphanumeric characters.

  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})"

• INC=

  Incompatibility condition. Specifies the Uproc code concerned by the incompatibility condition.
  Format: 64 alphanumeric characters.

  Example:

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

• RES=

  Resource condition. Specifies the resource code concerned by the resource condition.
  Format: 64 alphanumeric characters.

  Example:

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

• IFPLANNED

  (Optional) Flag for the condition to be checked by the launcher only if the conditional Uproc is scheduled / executed, taking into account the submission account / session / MU and processing date elements. If the event is not present and if this launch is not scheduled, the condition is completely ignored (avoids waiting for a job that will not take place). Refer to the Reference Guide for full description.

• PDATE=

  (Optional) Processing date control. Specifies the required offset between the conditioned Uproc processing date and that of the conditioning Uproc or resource.
  Format:

  • (±n,n,n): Depending on the functional period of the conditioning Uproc, it is expressed as "+ or -" a number of calendar units in brackets, separated by commas:
    For example PDATE=(+1,-1,) for a functional period of DAY may be translated by: day +1, month –1, same year.
  • SAME: The same processing date (globally) is required; if the control is required on the same calendar unit, a white character may be used in the triplet.
  • ANY: The control should not take account of the processing date; 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.

  The following table summarizes the calendar units proposed, according to the functional period of the Uproc:

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

  Default: SAME

• DTYPE=

  (Optional) Control by processing date. Indicates the type of day to consider for the conditioning Uprocs with a day functional period.
  Format:

  • A: Any: Whatever the type of day: worked, closed or holiday, the indicated shifting is counted in calendar days.
  • W: Worked: The indicated shifting is counted in worked days (in relation with the reference calendar of the considered management units).
  • C: Closed: The indicated shifting is counted in closed days.
  • H: Holiday: The indicated shifting is counted in holiday days.

• MU=

  (Optional) Control by Management units. Indicates on which series of management units the condition must be sought.

  • SAME: the check applies to the same Management unit.
  • MU(mu): the check applies to a specific Management unit, where mu represents the management unit code in question (64 alphanumeric characters).
  • MUT(type): the check applies to a management unit type, where type represents the management unit type (1 alphanumeric character).
  • HDP({XY}): the check applies to the hierarchical dependencies between Management units, the checking expression will be 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).

  Default: SAME

• ONE | ALL

  (Optional) 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.
  • ALL implies that the condition is expected on all of the Management units targeted.

  Default: ALL

• SESS=

  (Optional) Control by session. Indicates for which session the condition must be sought.

  • ANY: the check does not consider the notion of session.
  • SAME: the check applies to any execution of the same session.
  • SAMERUN: the check applies to the same run of the same session.
  • EXPL(session): the check applies to an explicit session, where session is the code of the session in question.

  Default: ANY

• STATUS=

  (Optional) Required state. Indicates the expected Uproc status. For dependency conditions or completion instructions:

  • TERMINATED: If the expected status is "COMPLETED".
  • ABNORMAL: If the expected status is "ABORTED".

  For dependency conditions only:

  • ENDED: If the expected status is "COMPLETED" or "ABORTED".
  • ABSENT: If the expected condition is "ABSENT".

  Default: TERMINATED

• USER=

  (Optional) Submission account. Indicates the type of submission account for which the condition must be sought.

  • SAME: the check applies to the same submission account.
  • ANY: the check does not consider the notion of submission account.

  Default: ANY

• EXPECTED | EXCLUDED

  (Optional) Boolean logic.

  • EXPECTED: Indicates that the condition expressed is sought as "true".
  • EXCLUDED: Indicates that the condition sought should be the opposite of that expressed.

  Default: EXPECTED

• FATAL | NOFATAL

  (Optional) Launcher behavior if condition is not satisfied.

  • FATAL: If the condition expressed is not satisfied at the Uproc's first condition check, the launcher abandon this launch and set its status to "LAUNCH REFUSED".
  • NOFATAL: If the condition expressed is not satisfied at the Uproc's first condition check, the launcher will declare the launch in an "EVENT_WAIT" status. The Uproc's conditions will be checked again upon appearance of the expected event.

  Default: NOFATAL

• VERIF | NOVERIF

  (Optional) File verification for a resource condition.

  • VERIF: Indicates that the launcher must verify the physical presence of the resource during the Uproc's condition check (default).
  • NOVERIF: Indicates verification is not required, in which case it will be seen as a logical resource

  Default: VERIF.

• LOCK | UNLOCK

  (Optional) Resource allocation.

  • UNLOCK: 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.
  • LOCK: 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.

  Default: UNLOCK

• ATTRIB=

  (Optional) Used for FIL type resources. The file attribute to verify is one of the following:
  EXIST, SIZE, DATEUNCHANGE, SIZEUNCHANGE, DATCREA, DATMOD, GROUP, PARSING.
  Refer to the Reference Guide for the meaning of each attribute.

  If ATTRIB OPER VALUE is checked, the condition is valid.

• OPER=

  (Optional) Used for FIL type resources. Operator used to check the value of the file attribute. Can be one of the following:
  #, =, <, >, <=, >=

• VALUE=

  (Optional) Used for FIL type resources. ATTRIB Attribute value sought.

• QT1= and QT2=

  (Optional) Quotas required. 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.
  Format: Numeric value between 0 and 9999.

  Default: 0

Launch Formula Item

• LFORM=

  (Optional) Launch formula. Boolean logic that express the entire launch formula for the Uproc in question, and the current action. 
  Format: Maximum length 400 characters

  • Cnn: condition number nn.
  • =: the condition is sought true.
  • #: the condition is sought false.
  • AND: both conditions must be checked.
  • OR: one or other of the two conditions must be checked.

  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)"

  Example:

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

FTP Items

• PARTNER=

  (Optional) Physical name or IP address of the target machine.
  Format: 255 alphanumeric characters max.

  Example: host name

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

  Example: IP address

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

• ORIGIN_FILENAME=

  (Optional) Name of the file to be transferred.

  Default: all files in the directory.

• ORIGIN_PATHNAME=

  (Optional) Name of the directory that contains the files to be transferred. * forbidden.

  Default: the FTP connection user’s home directory.

• TARGET_FILENAME=

  (Optional) Target file name.

  Default: Unchanged.

• TARGET_PATHNAME=

  (Optional) File reception directory. * forbidden

  Default: the home directory of the Uproc submission user account.

• LOGON=

  (Optional) FTP connection user

  Default: anonymous

• PASSWORD=

  (Optional) FTP connection user password. Passwords are not displayed in the GUI.

• MODE=

  (Optional) Type of transfer: ASCII or BINARY.

  Default: ASCII

• ACTION=

  (Optional) Behavior if the target file exists: REPLACE, APPEND (FTP_PUT only), ABORT or NONE.

  Default: ABORT

• CRLF | NOCRLF

  (Optional) CR characters conversion. Not available for FTP_PUT.

  • CRLF: Converts all CR characters to LF during ASCII transfer.
  • NOCRLF: No conversion by default except for submissions.

  Default: NOCRLF

• DELETE | NODELETE

  (Optional) Origin file deletion

  • DELETE: Deletes the origin file if the transfer is successful.
  • NODELETE: Keep the origin file if the transfer is successful.

  Default: NODELETE:

• NEWER | NONEWER

  (Optional) Check on the file date

  • NEWER: Transfers the file if its modification date is later than the target file.
  • NONEWER: Transfer the file whatever its date.

  Default: NONEWER

  Warning! This option is not supported by SFTP by default. To see if SFTP has been configured, see the node setting U_FT_SFTP U_FT_SFTP value.

• RECURSIVE | NORECURSIVE

  (Optional) Transferred files

  • RECURSIVE: Transfers whole files and sub directories of the ORIGIN_PATHNAME (the ORIGIN_FILENAME and the TARGET_FILENAME must not be edited). The recursion depth limit is set to 150 directories.
  • NORECURSIVE: Transfers files from the current directory.

  Default: NORECURSIVE.

  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 formatted 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 fail-over 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 fail-over option is less performing but it can be enabled with the U_FT_GET_DIR_FAILOVER node setting in the "Node Settings – FTP Settings" category.

• BUFFER_SIZE=

  (Optional) Sets the communications buffer size in blocks of 512 bytes.
  Format: integer on 2 digits between 01 and 64.

• RETRY=

  (Optional) Number of retries in case of failure.

• UMASK=

  (Optional) 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).

Other Commands Items

• TUPR=

  Enter a Uproc code, result of the duplication.
  Format: 64 alphanumeric characters.

• TVUPR=

  Uproc version, result of the duplication.
  Format:  3 numeric characters.

• TLABEL=

  (Optional) Uproc label, result of the duplication.
  Format: 64 alphanumeric characters.

• APPL=

  (Optional) Application code. Used with uxlst and uxshw: enables the selection of Uprocs associated with an Application (wildcard accepted).
  Format: 64 alphanumeric characters.

• DOM=

  (Optional) Domain code. Used with uxlst and uxshw. Enables the selection of Uprocs associated with a domain.
  Format: 1 alphanumeric character.

• SCRIPT

  (Optional) Can only be used with the command uxshw upr. This parameter enables the display of the Uproc script in the output when the node setting U_UPR_SCRIPT_NODISP (Advanced Settings category) is set to Yes. Refer to the Univiewer User Guide.

  Default: this variable is not defined and the Uproc script is displayed even if the SCRIPT parameter is absent in the command.

• TESP=

  Area code, target of the transfer: X for Production, S for Simulation or I for Integration.

• ENABLE

  (Optional) Unlock option. Indicates whether the object will be inserted in a locked or unlocked state. Unlocking will be necessary before any modification if the object is inserted with the qualifier NOENABLE.

  Default: ENABLE

• INF | FULL

  (Optional) Display option.

  • INF: Confines display to the names of the objects.
  • FULL: Displays all available information on the list of objects.

  Default: FULL

• OUTPUT=

  • Output file for the uxext command.
  • (Optional) Output file for display storage of uxshw or uxlst commands.

  Default: The output is sent to screen.

• INPUT=

  Input file for the uxins command.

• NOVERIF

  (Optional) only to be used with the uxext command. Force the command to skip the checking of the output data file before insertion of new records. This enhances performance and can only be used for the creation of a new output data file.

• REPL

  (Optional) Replacement flag. Indicates whether the extracted (or inserted) records delete and replace the records that already exist in the destination file.

  Default: Extraction (or insertion) is refused for each record that already exists (indicated by a message for each occurrence).

Examples

• Create a command type Uproc:

  uxadd UPR EXP UPR=CMD_UPR LABEL=\”My Command Uproc\” UPT=CMD COMMAND=netstat EXECDIR=/temp FPERIOD=D APPL=EJ MEMO=O NBPER=1

• Create the Uproc D_LOAD_FIL, version 000, with the label "Loading of file" in the current environment (company, node) in the production area, external script: c:\temp\ D_LOAD_FIL.bat, application BK (domain T):

  uxadd UPR EXP UPR=D_LOAD_FIL LABEL=\"Loading of file\" UPT=CL_EXT CLFIL=c:\temp\D_LOAD_FIL.bat APPL="BK"

• Duplicate a Uproc:

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

• Update Uproc functional period to day, memorized for one execution, one period:

  uxupd UPR EXP UPR=D_LOAD_FIL GENINF FPERIOD=D memo="O" NBPER=1

• Create 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:

  uxadd UPR EXP UPR=DEF_UPR APPL=U_ UPT=CL_EXT CLFIL=C:\script.bat DEFINFO=\"Default information for this Uproc\" DEFSEV=0001

• Modify 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:

  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\"

• Create 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):

  uxadd UPR EXP UPR=D_BACKUP LABEL=Backup FPERIOD=d UPT=CL_EXT CLFIL=c:\temp\D_BACKUP.bat APPL=BK

• Modify 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 script will release the resource D_BASE allocated in total by Uproc D_LOAD_FIL:

  uxupd UPR EXP UPR=D_BACKUP DEPCON add CONDNO=01 DEP=D_LOAD_FIL

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

• Create a text-type variable VARTXT for Uproc D_LOAD_FIL, with a maximum length of 30 characters and a default value of " XY_VARTXT ":

  uxupd UPR UPR=D_LOAD_FIL LAUNCHVAR add VARNAME=VARTXT VTYPE=T VVALUE="XY_VARTXT" VFORMAT="30"

• Create a date-type variable VARDATE for Uproc D_LOAD_FIL in the year/month/day format with a default value of 1999/12/31:

  uxupd UPR UPR=D_LOAD_FIL LAUNCHVAR add VARNAME=VARDATE VTYPE=D VVALUE="1999/12/31" VFORMAT="YYYY/MM/DD"

• Display Uproc details on the screen:

  uxshw UPR EXP UPR=D_LOAD_FIL

• List all Uprocs into the file c:\temp\lstUpr.txt:

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

• Delete all Uprocs beginning by "TEST":

  uxdlt UPR UPR=TEST*

• Transfer from The Application area to the Production area all Uproc beginning by "D_":

  uxtra UPR app UPR=D_* TESP=X

• Set version 002 of Uprocs "D_" as the current version:

  uxscv UPR APP UPR=D_* VUPR=002

• Release all Uprocs in the current environment:

  uxrls UPR UPR=*

• Extract all Uprocs beginning with D_ from the Production area and archives the data in the file c:\temp\DOC.ext:

  uxext UPR EXP UPR=D* output=c:\temp\DOC.ext

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

  uxins UPR EXP UPR=* input=c:\temp\DOC.ext