General Action Property Commands

These commands might be entered in the Action property of any ROC screen, to select the information you require, or to exercise control functions. These commands give an alternative to the menu selection and activity selection methods provided by the screen formats.

Add (AD)

Use this command to add a printer backup file, System data file, or Report Extract file to the ROC Database. A screen is displayed for you to enter your file details and output requirements.

The syntax of this command is:

ADD

Browse (BR)

Use this command to initiate video browsing for a selected Report or output request.

The syntax of this command is:

BROWSE

On the Report Write screen, the file uniquely associated with the last activity of the station is assumed.

The following command selects the Report file identified by the number of the Report, report.

BROWSE RE report

The following command selects the Report file associated with the output request identified by the number of the output request, request.

BROWSE OR request

Video Browse Output

When video browsing, special commands might also be used. Refer to Browse Action Commands.

Note: The only automatic way to delete a video browse output request is to BYE from ROC while browsing the Report. Transmitting past the end of the Report or selecting another function leaves the output request undeleted until you browse the same output request again from the same station, and execute a BYE command, or manually delete the output request or the Report.

BYE (BY, QUIT, QU)

Use this command to signal that you want to exit from ROC and return to your application.

The syntax of this command is:

BYE

If you entered ROC using the Roc command (from logic), you are returned to the Ispec specified by the command, or to the originating Ispec if none was specified. If you entered ROC by using the Ispec Selection screen (Page 2), you are returned to Page 1 if ROC output was not to Page 1; otherwise to Page 2.

Refer to the Agile Business Suite Programming Reference Manual for more information on ROC command.

The following command returns you to the specified Ispec in your application:

BYE ispec

The following command disconnects you from your application:

BYE BYE

What Happens to the current Output Request

If you are currently browsing a Report when you use a BYE command, the Output Request is deleted.

To ensure correct Cleanup of a printed VD report output, always set "Delete on Bye" on the Options screen (ROCO) and always exit the video report browse (ROCT) with BYE.

Note: The only automatic way to delete a video browse output request is to BYE from ROC while browsing that Report. Transmitting past the end of the Report or selecting another function leaves the output request undeleted until you browse the same Report output again from the same station, and execute a BYE command, or manually delete the output request.

CLEAR

This is a special command only available by using the Roc Ispec CLEAR command from the logic of your application. This command resets user information for the station. The ROC screens are not presented.

CONTROL (CO)

Use this command to display control information associated with the selected report or output request.

The syntax of this command is:

CONTROL

On the Report Write screen, the file uniquely associated with the last activity of the station is assumed.

The following command displays control information for the Report identified by the number of the Report, report:

CONTROL RE report

The following command displays control information for the output request identified by the number request, and for the associated Report:

CONTROL OR request

DELETE (DE)

Use this command to mark the selected Report file or Report output request for deletion. You can enter this command from the Reports Available or Output Requests screens, or from the Browse screens.

DELETE [ OVERRIDE ] [ deletions ]

Include OVERRIDE to delete Report output that has non-deleted output requests.

The value deletions is any number of number or range values, where number is the number of a Report or output request (from the Reports Available or Output Requests screens), and range is a range of Report or output request numbers in the form:

start - end

You can replace the second number, end, with End (or E) to indicate the last Report or output request.

Examples:

1 3 5-10 16-E

What is deleted

If a Report is selected, it is marked for deletion unless it has some current output requests. (Include OVERRIDE to mark the Report for unconditional deletion.)

If an output request is selected, it is marked for deletion.

Note: If you need to browse Report output for a Report initiated from your terminal, and the Report output request has been marked for deletion, you are unable to browse the output until the output request has been physically deleted. Other stations will still have access to the Report output. Refer to STATE Control Action command.

When deletions are actioned

The actual deletion is performed as a low-priority activity by the background ROC Report. This Report also deletes Report output that satisfies both of the following conditions:

FSTATION (FS)

Use this command to request the Reference Station To Full Station Inquiry screen, which enables you to find the full station name for a reference station.

The syntax of this command is:

FSTATION

Using the Reference Station To Full Station Inquiry screen

On the Reference Station To Full Station Inquiry screen, enter the reference station name in the Enter Reference Station property. You can leave the property blank if you want to inquire on your current station name.

When you press the XMIT key, the full station name is displayed (or a warning message that the station name is not a reference station).

HOME (HO)

Use this command to return to the ROC Home menu.

This command has the following syntax:

HOME

OPTION (OP)

Use this command to request the Options screen.

This command has the following syntax:

OPTION

Using the Options screen

On the Options screen, you can:

The following properties appear on the Options screen.

Usercode/Password

Enter the usercode (and password) for the files you want to view. The value you enter in the usercode property is used, in conjunction with the value of Glb.User, to determine the Reports that are visible to you. All Reports with a Glb.User value of spaces are visible to all users.

The usercode (and password) you enter must be a valid usercode with a current password. Refer to Usercode Security in ROC Security for more information on usercodes.

Note: Your terminal defaults to the previous usercode providing it is signed onto the same COMS usercode. If this behavior is not required, clear these details by using a Roc CLEAR logic command from your application.

Terminal Output Page

ET1100, MT900, and TD830 style terminals might have multiple display pages. Normally, output is displayed on Page 1. Use this property to choose another page to receive the output from ROC, which in turn enables you to use ROC without interfering with the display on your page. If you enter an invalid page, ROC output is displayed on the current page.

Terminal Model

If necessary, enter the model of your terminal to ensure that the correct set of Output Control codes is used for displaying the Reports on your terminal. If the terminal model is not correctly set, Output Control codes are ignored.

Resume with

Use this property to return to a previous activity indicated in the history details. Use the Rotate and Delete History properties to modify this history order. The default for this property is zero, which selects the final entry on the list.

Rotate History

Enter Y to rotate the history entries so that the reference number in the Resume with property is the last on the list.

Delete History

Enter Y to delete all history entries below the reference number in the Resume with property.

History

Each line in the history display indicates a previous (incomplete) activity. For a Report being browsed, the history shows the Report number, the block number, the index for the Report, the offset, and whether the TRUNCATE or SQUASH ROC command has been used.

For a menu, the type of menu (Home, Report, or Output Requests) and the selection criteria are displayed.

OR (for OUTPUT REQUEST)

Use this command to display Output Requests that you might access. You can include parameters to narrow your selection. If you do not narrow your selection, all Output Requests visible to you are selected (possibly over several screen pages).

The syntax of this command is:

OR [ state ]
OR [ state ] RE report
OR [ state ] ST station
OR [ state ] US user

Include…

To Select…

state

One or more state values (as shown on ROC Home screen, and in the following table). Only output requests of the specified types are selected. If none are specified, all are selected.

RE report

Output requests associated with output produced from Report programs with name (or number) report.

ST station

Output requests with a destination Glb.Stn value of station. By default, it is the current user station.

US user

Output requests associated with Report files having a Glb.User value of user. By default, it is the current user usercode.

The following table contains possible values for state.

State

Output Request

C

Output completed

D

Waiting to be deleted

E

Queued; error attempting to write

G

Report being generated

Q

Waiting to be started

W

Being written or browsed

Note: If a user with a non-space usercode attempts to examine information for a different user value, no information is visible.

PRIOR (PR)

Use this command to return to your previous ROC activity.

The syntax of this command is:

PRIOR

QUIT

This command is a synonym for the BYE command, and signals that you are leaving ROC and returning to your application. Refer to BYE command for more information.

REPORT (RE)

REPORT (RE)

Use this command to display Reports that you can access. You can include parameters to narrow your selection. If you do not narrow your selection, all Reports visible to you are selected (possibly over several screen pages).

The syntax of this command is:

REPORT [ state ]
REPORT [ state ] RE report
REPORT [ state ] ST station
REPORT [ state ] US user

Include…

To Select…

state

Available Reports with the listed values. If none are specified, all are selected. Valid values are as listed in the following table.

RE report

Available Reports that are produced from Reports named report.

ST station

Select available Reports that originate from the station station. By default, it is the current user station.

US user

Available Reports having a Glb.User value of user. By default, it is the current usercode.

The following table contains possible values for state.

State

Output Request

C

Output completed

D

Waiting to be deleted

G

Report being generated

Q

Waiting to be started

W

Waiting recovery

Note: If a user with a non-space usercode attempts to examine information for a different user value, no information is visible.

WRITE (WR)

WRITE (WR)

Use this command to display the Write Request screen, on which you can specify or accept default options for the printing of the Report on LP, RP, EX, or TP output devices.

The syntax of this command is:

WRITE

On the Browse screen, the file uniquely associated with the last activity of the station is assumed.

The following command selects the Report identified by the number of the Report, report.

WRITE RE report

The following command selects control information for the Report associated with the output request identified by the number request.

WRITE OR request