Runbooks

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

The command uxadd BOOK creates a new run book. Its syntax is as follows:

uxadd BOOK BOOK=book AREA=A|I|S|X [DOM=domain] [APPL=application] [TSK=task] [MU=mu] [UPR=uproc] [SES=session] [USER=user] [QUEUE=queue] [INFO=information] [SEV=severity] TYPE=BK_INT|BK_URL|BK_FILE_TXT|BK_FILE_BIN FILE=fichier URL=url TEXT=texte

The command uxupd BOOK updates a run book. Its syntax is as follows:

uxupd BOOK BOOK=book [AREA=A|I|S|X] [DOM=domain] [APPL=application] [TSK=task] [MU=mu] [UPR=uproc] [SES=session] [USER=user] [QUEUE=queue] [INFO=information] [SEV=severity] [TYPE=BK_INT|BK_URL|BK_FILE_TXT|BK_FILE_BIN] [FILE=fichier] [URL=url] [TEXT=texte]

The command uxshw BOOK displays the characteristics of a run book. Its syntax is as follows:

uxshw BOOK BOOK=book [AREA=A|I|S|X] [DOM=domain] [APPL=application] [TSK=task] [MU=mu] [UPR=uproc] [SES=session] [USER=user] [QUEUE=queue] [INFO=information] [SEV=severity] [TYPE=BK_INT|BK_URL|BK_FILE_TXT|BK_FILE_BIN] [OUTPUT=filename]

The command uxlst BOOK lists the run books. Its syntax is as follows:

uxlst BOOK [BOOK=book] [AREA=A|I|S|X] [DOM=domain] [APPL=application] [TSK=task] [MU=mu] [UPR=uproc] [SES=session] [USER=user] [QUEUE=queue] [INFO=information] [SEV=severity] [TYPE=BK_INT|BK_URL|BK_FILE_TXT|BK_FILE_BIN] [FULL|INF][OUTPUT=filename]

The command uxdlt BOOKdeletes a run book. Its syntax is as follows:

uxdlt BOOK BOOK=book

The command uxext BOOK extracts the complete definition of a run book. Its syntax is as follows:

uxext BOOK BOOK=book [REPL] OUTPUT=filename

The command uxins BOOK inserts the complete definition of a run book in the corresponding Dollar Universe files. Its syntax is as follows:

uxins BOOK BOOK=book [REPL] INPUT=filename

Description of Items

• BOOK=

  Enter the run book’s name or * (wildcard accepted except for uxadd).
  Format 64 alphanumeric characters.

• TYPE=

  (Optional for all commands except uxadd) Type of run book.
  Format: 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 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 with the FILE item below.

  • BK_FILE_BIN: External executable file. Complete this information with the FILE item below.

    FILE=: Enter the name of this file to open or execute. This file must exists. 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 sub-directory.

The information below selects the executions that the runbook displays.

• AREA=

  (Optional for all commands except uxadd) Area(s) in which the run book should be used.
  Format: Enter 1 to 4 characters from A, I, S, X:

  • A: Application Area
  • I: Integration Area
  • S: Simulation Area
  • X: Production Area

  Default: X

• DOM=

  (Optional) Enter the application execution code for which the runbook must be used or*.
  Format: 1 alphanumeric character

• APPL=

  (Optional) Enter the job application code for which the runbook must be used or *.
  Format: 64 alphanumeric character

• TSK=

  (Optional) Enter the Task code for which the runbook must be used or *.
  Format: 64 alphanumeric character

• MU=

  (Optional) Enter the Management unit code for which the runbook must be used or *.
  Format: 64 alphanumeric character

• SES=

  (Optional) Enter the session code for which the runbook must be used or *.
  Format: 64 alphanumeric character

• UPR=

  (Optional) Enter the Uproc code for which the runbook must be used or *.
  Format: 64 alphanumeric character

• USER=

  (Optional) Enter the job’s user account code for which the runbook must be used or *.
  Format: 64 alphanumeric character

• QUEUE=

  (Optional) Enter the DQM job queue code for which the runbook must be used or *.
  Format: 31 alphanumeric character

• INFO=

  (Optional) Enter the job Information field code for which the runbook must be used or *.
  Format: 50 alphanumeric character

• SEV=

  (Optional) Enter the code for the job serverity value for which the runbook must be used or *.
  Format: 4 alphanumeric character

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

• 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).

• INPUT=

  Input file for the uxins command.

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

Examples

• Creates a run book (all areas by default) named TEST for all the COMPTA application jobs in the production area (by default). This run book will be available in an external file: c: \ temp \ text.txt.

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

• Updates the runbook to open CA URL:

  uxupd book book=TEST type=BK_URL URL="https://www.ca.com/"

• Displays to the screen all runbooks starting with RUN:

  uxshw BOOK BOOK=RUN*

• Lists all runbooks to the file c:\temp\LstBook.txt :

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

• Deletes the runbook RUNBOOK1 :

  uxdlt BOOK BOOK=RUNBOOK1

• Extracts all runbooks starting with D to the file c:\temp\Book.ext:

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

• Inserts all runbooks from the file c:\temp\Book.ext to the current environment:

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