PREP_PROCESS_PROMPTSET

Script Function: Reads the definition of PromptSet objects and provides them for further processing as an internal list (data sequence).

Syntax

PREP_PROCESS_PROMPTSET ( PromptSet Name )

Syntax	Description/Format
PromptSet Name	The name of the PromptSet object whose definition should be retrieved. Format: script literal or script variable

Return Codes
Reference to the data sequence that includes the PromptSet definition.

Comments

This script function can be used to read the definition of PromptSet objects and it is available as a data sequence. You specify the name of the PromptSet object and the reference to the related data sequence will be returned.

The data sequence includes a line for each element of the PromptSet object. The columns of each line store the various information. You can access these columns by using the script function GET_PROCESS_LINE.

The following information is retrieved for each element:

The name of the PromptSet variable (without a leading &)
The value of the user-defined field
The value of the PromptSet element (default value)
The type of the PromptSet element (text, integer, etc.)
The object name of the reference object (variable or calendar)
The key of the Calendar object (if available)

The order of the above list complies with the order of the columns.

All the information of an element will be returned and separated by the characters "§§§" when you do not specify a specific line in GET_PROCESS_LINE.

Examples

The following example script reads the definition of the PromptSet object PRPT.JOBP and writes the lines to the activation report. All the element information is retrieved.

:SET &HND# = PREP_PROCESS_PROMPTSET(PRPT.JOBP)
:PROCESS &HND#
: SET &LINE# = GET_PROCESS_LINE(&HND#)
: P &LINE#
:ENDPROCESS

:CLOSE_PROCESS &HND#

The following information is written to the activation protocol:

2013-01-31 11:28:59 - U0020408 TEXTFIELD1§§§§§§§§§text§§§VARA.JOB§§§
2013-01-31 11:28:59 - U0020408 INTEGER1§§§§§§0§§§integer§§§UC_DATATYPE_NUMERIC§§§
2013-01-31 11:28:59 - U0020408 COMBOBOX1§§§§§§§§§combo§§§DB_WARTUNG§§§
2013-01-31 11:28:59 - U0020408 RADIOGROUP1§§§§§§§§§dynradiogroup§§§UC_OBJECT_TEMPLATE§§§
2013-01-31 11:28:59 - U0020408 CHECKGROUP1§§§§§§§§§dyncheckgroup§§§UC_SENDTO_ACT§§§
2013-01-31 11:28:59 - U0020408 CHECKLIST2§§§§§§§§§dyncheckgroup§§§UC_UTILITY_ARCHIVE§§§
2013-01-31 11:28:59 - U0020408 DATE1§§§§§§2010-09-03§§§datefield§§§UC_DATATYPE_DATE§§§0
2013-01-31 11:28:59 - U0020408 TIMESTAMP2§§§§§§2010-10-28 14:34:57§§§timestamp§§§UC_DATATYPE_TIMESTAMP§§§0

The second example only reads the name of the reference object and the PromptSet element types.

:SET &HND# = PREP_PROCESS_PROMPTSET(PRPT.JOBP)
:PROCESS &HND#
: SET &VAR# = GET_PROCESS_LINE(&HND#,1)
: SET &TYPE# = GET_PROCESS_LINE(&HND#,4)
: P &VAR# &TYPE#
:ENDPROCESS

:CLOSE_PROCESS &HND#

The output could be the following:

2013-01-31 11:59:20 - U0020408 TEXTFIELD1 text
2013-01-31 11:59:20 - U0020408 INTEGER1 integer
2013-01-31 11:59:20 - U0020408 COMBOBOX1 combo
2013-01-31 11:59:20 - U0020408 RADIOGROUP1 dynradiogroup
2013-01-31 11:59:20 - U0020408 CHECKGROUP1 dyncheckgroup
2013-01-31 11:59:20 - U0020408 CHECKLIST2 dyncheckgroup
2013-01-31 11:59:20 - U0020408 DATE1 datefield
2013-01-31 11:59:20 - U0020408 TIMESTAMP2 timestamp

Script Elements	Definition
:PROCESS... :TERM_PROCESS... :ENDPROCESS	They 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.
GET_PROCESS_LINE	Retrieves the current line's content of a data sequence.