Script Function: Provides the content of a Documentation tab as an internal listShows entities in a grid view (data sequenceAn internal listing of Console outputs or lines of Variable objects, etc. The lines of a data sequence can be accessed by using a PROCESS loop or the script element GET_PROCESS_LINE. The script elements PREP_PROCESS* generate data sequences.) for further processing.
PREP_PROCESS_DOCU( Object name, [Documentation tab])
Syntax |
Description/Format |
---|---|
Object name |
The name of any objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task whose Documentation tab should be read. Format: scriptA particular Automation Engine object type. literal or script variableA placeholder for a value within a script. |
Documentation tab |
The name of the Documentation tab. When you do not specify a name, the system will search for the Documentation tab "Docu". |
Return Codes |
---|
A reference to the data sequence that includes the content of the required Documentation tab. |
This script element reads the content of a specific Documentation tab of an object (Documentation tabs are available in all object types) and provides it as a data sequence for further processing. Note that you must specify the name of the object and the Documentation tab in the same way as it is defined in the variableIt stores or retrieves values dynamically at runtime. An individual Automation Engine object type. UC_OBJECT_DOCU.
You can specify a structured or a simple (it includes only text) Documentation tab.
Structured Documentation tabs store all elements that are defined in the left tab area to the data sequence line by line. The content (text) of a simple Documentation tab is redirected to the data sequence line by line.
Uppercase letters and lowercase letters are ignored in Documentation-tab names. A search for "docu" will also find "Docu".
This script functionPre-defined run book template in the Automation Engine. One single step only, e.g. Start Windows Service, Copy file,… will not abort when the system cannot find a Documentation tab that has the specified name. The only effect is that the data sequence will not be filled with contents in this case. The script function will only abort when the object name is not valid
The following example reads the Documentation tab "Docu" of the object SCRI.TEST and prints its content in the activation reportA report provides more detailed information about a task's execution or a component..
:SET &HND# = PREP_PROCESS_DOCU(SCRI.TEST,Docu)
:PROCESS &HND#
: SET &LINE# = GET_PROCESS_LINE(&HND#)
: PRINT &LINE#
:ENDPROCESS
:CLOSE_PROCESS &HND#
See also:
Script Elements | Definition |
---|---|
These script statements are used to define a loop for the line by line processing of a data sequence such as the content of a sequential file or the text result of a command. |
|
Retrieves the current line content of a data sequence. |
Script Elements - Data Sequences
Sample Collection
Setting End Status depending on Report Content
About Scripts
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support |
Copyright © 2016 Automic Software GmbH |