$RWCALL OPT=INFO
12-1
This function returns report definition information. Optionally, the function presents a list of reports from which a selection can be made.
This function has the following format:
&CONTROL SHRVARS=($RW) -EXEC $RWCALL OPT=INFO [ INFO=REPORT ] [ APPL={repapplid|prefix? | ? } ] [ TYPE={ PUBLIC | PRIVATE } ] [ USERID={userid|prefix? | ? } ] [ NAME={name|prefix? | ? } ] [ GROUP={group|prefix? | ? } ] [ SINGLE={ YES | NO } ] [ ORDER={ ID | DESC } ] [ STATUS={ ACTIVE | INACTIVE} ] [ AUTOSEL={ YES | NO } ]
Use
To validate report details entered by a user on a panel defined by your installation and provide help on a panel defined by your installation by presenting a Report List from which a selection can be made.
Operands
OPT=INFO
Specifies definition information is to be returned.
INFO=REPORT
Specifies report definition information is to be returned.
APPL={
repapplid
| prefix
? | ? }Specifies the ID of the report application to which the report belongs. If a prefix followed by a question mark (?)is specified, a Report List is presented from which a selection can be made. The list will contain all reports that belong to report applications with IDs starting with the prefix specified, and which match the other criteria specified. If a question mark is specified without a prefix, all reports which match the other criteria specified are listed on the Report List.
TYPE={ PUBLIC | PRIVATE }
Specifies the type of report. PUBLIC indicates that the report is a public report and PRIVATE indicates that the report is a private report.
USERID={
userid
| prefix
? | ? }Specifies the user ID of the user who owns the report if it is a private report. If a prefix followed by a question mark (?) is specified, a Report List is presented from which a selection can be made. The list will contain all private reports owned by users whose user ID starts with the prefix specified, and which match the other criteria specified. If a question mark is specified without a prefix, all reports that match the other criteria specified are listed on the Report List.
NAME={
name
| prefix
? | ? }Specifies the name of the report. If a prefix followed by a question mark (?) is specified, a Report List is presented from which a selection can be made. The list will contain all reports with names starting with the prefix specified, and which match the other criteria specified. If a question mark is specified without a prefix, all reports that match the other criteria specified are listed on the Report List.
GROUP={
group
| prefix
? | ? }Specifies the group to which the reports belong that are to be presented in the Report List. A Report List is presented from which a selection can be made. If a prefix followed by a question mark (?) is specified, the list will contain all reports that belong to groups with names starting with the prefix specified. If a question mark is specified without a prefix, all reports that match the other criteria specified are listed on the Report List.
SINGLE={ YES | NO }
Specifies the setting of the Suit Single Record field for reports that are to be included in the Report List. If not specified, reports with a Suit Single Record setting of YES or NO are included in the list.
ORDER={ ID | DESC }
Specifies the order in which the Report List will be presented.
- ID
- Reports will be listed in user ID order.
- DESC
- Reports will be listed in description order.
- STATUS={ ACTIVE | INACTIVE }
- Specifies the status of reports to be included on the Report List. If not specified, both active and inactive reports are included in the list.
AUTOSEL={ YES | NO }
Allows the automatic selection of a report, when set to YES, instead of displaying a selection list containing only one report.
Return Codes
&RETCODE = 0
$RWCALL completed successfully. The variables returned are as follows:
- &$RWREPAPPL
- Report Application
- &$RWREPTYPE
- Report type, PUBLIC or PRIVATE
- &$RWREPUSERID
- User ID of owner if it is a private report
- &$RWREPNAME
- Report name
- &$RWREPDESC
- Brief description of report
- &$RWREPGROUP
- Group
&RETCODE = 4
Request denied. &SYSMSG is set to an error message and &$RWFDBK is set to one of the following:
- 1
- User not authorized for the request
- 8
- Report not defined
- 10
- No reports defined within the specified range
- 11
- Report not selected from Report List
&RETCODE = 8
An error occurred. &SYSMSG is set to an error message.
Examples
&CONTROL SHRVARS=($RW) -EXEC $RWCALL OPT=INFO INFO=REPORT NAME=? &CONTROL SHRVARS=($RW) -EXEC $RWCALL OPT=INFO INFO=REPORT TYPE=PUBLIC + NAME=SUMMARY? &CONTROL SHRVARS=($RW) -EXEC $RWCALL OPT=INFO INFO=REPORT APPL=$SAIMPB + TYPE=PUBLIC NAME=OPENPROBLEMS
Notes
Either the APPL, USERID, NAME, GROUP, SINGLE or STATUS operand must be specified.