# Compaq ACMS for OpenVMS
Quick Reference Guide

Previous | Contents | Index

## 2.8.3 COPY Command (UDU>)

Authorizes and assigns sign-in characteristics to ACMS users by creating new UDU definitions from existing UDU definitions. With qualifiers, you can assign different sign-in characteristics to the new definitions.
COPY source-user-name new-user-name

Command Qualifiers | Defaults
--- | ---
/[NO]AGENT | From source definition
/[NO]DISPLAY_MENU | From source definition
/[NO]FINAL=(keyword[,...]) | From source definition
/[NO]INITIAL=(keyword[,...]) | From source definition
/LANGUAGE[=language-name] | From source definition
/MDB=menu-database-file | From source definition
/MENU[=menu-path-name] | From source definition
/PRINTFILE [ = print-file-spec | spooled-device-name ] | From source definition
/[NO]SKIPMENULANGUAGE | From source definition

## 2.8.4 CREATE/PROXY Command (UDU>)

Creates an empty ACMS proxy file (ACMSPROXY.DAT).
CREATE /PROXY

## 2.8.5 DEFAULT Command (UDU>)

Changes information in the UDU DEFAULT definition. If you omit one or more qualifiers from an ADD command, the resulting new definition receives information from the existing DEFAULT definition.
DEFAULT

Command Qualifiers | Defaults
--- | ---
/[NO]AGENT | From existing DEFAULT definition
/[NO]DISPLAY_MENU | From existing DEFAULT definition
/[NO]FINAL=(keyword[,...]) | From existing DEFAULT definition
/[NO]INITIAL=(keyword[,...]) | From existing DEFAULT definition
/LANGUAGE[=language-name] | From existing DEFAULT definition
/MDB=menu-database-file | From existing DEFAULT definition
/MENU[=menu-path-name] | From existing DEFAULT definition
/PRINTFILE [ = print-file-spec | spooled-device-name ] | From existing DEFAULT definition
/[NO]SKIPMENULANGUAGE | From existing DEFAULT definition

## 2.8.6 EXIT Command (UDU>)

Ends the UDU session and returns to DCL level.
EXIT

## 2.8.7 HELP Command (UDU>)

Displays information about UDU commands and qualifiers.
HELP [ topic [...] ]

Command Qualifiers | Defaults
--- | ---
/[NO]PROMPT | /PROMPT

## 2.8.8 LIST Command (UDU>)

Writes UDU definitions to ACMSUDU.LIS in your default directory or to a specified output file.
LIST user-name

Command Qualifiers | Defaults
--- | ---
/BRIEF | Full definition
/OUTPUT[=file-spec] | /OUTPUT=ACMSUDU.LIS

## 2.8.9 LIST/PROXY Command (UDU>)

Writes all the proxies in the ACMS proxy file to the output file ACMSPROXY.LIS. You can use the /OUTPUT qualifier to specify a different output file name.
LIST /PROXY

Command Qualifier | Default
--- | ---
/OUTPUT=file-spec | ACMSPROXY.LIS

## 2.8.10 MODIFY Command (UDU>)

Changes the user information by allowing you to change information in UDU definitions.
MODIFY user-name

Command Qualifiers | Defaults
--- | ---
/[NO]AGENT | From existing definition
/[NO]DISPLAY_MENU | From existing definition
/[NO]FINAL=(keyword[,...]) | From existing definition
/[NO]INITIAL=(keyword[,...]) | From existing definition
/LANGUAGE[=language-name] | From existing definition
/MDB=menu-database-file | From existing definition
/MENU[=menu-path-name] | From existing definition
/PRINTFILE [ = print-file-spec | spooled-device-name ] | From existing definition
/[NO]SKIPMENULANGUAGE | From existing definition

## 2.8.11 REMOVE Command (UDU>)

Removes a UDU definition from the user authorization file.
REMOVE user-name

## 2.8.12 REMOVE/PROXY Command (UDU>)

Removes the specified proxy from the ACMS proxy file (ACMSPROXY.DAT).
REMOVE /PROXY remote-node::remote-user

## 2.8.13 RENAME Command (UDU>)

Changes the user names and, with qualifiers, other information in UDU definitions.
RENAME old-user-name new-user-name

Command Qualifiers | Defaults
--- | ---
/[NO]AGENT | From old definition
/[NO]DISPLAY_MENU | From old definition
/[NO]FINAL=(keyword[,...]) | From old definition
/[NO]INITIAL=(keyword[,...]) | From old definition
/LANGUAGE[=language-name] | From old definition
/MDB=menu-database-file | From old definition
/MENU[=menu-path-name] | From old definition
/PRINTFILE [ = print-file-spec | spooled-device-name ] | From old definition
/[NO]SKIPMENULANGUAGE | From old definition

## 2.8.14 SHOW Command (UDU>)

Displays UDU definitions.
SHOW user-name

Command Qualifiers | Defaults
--- | ---
/BRIEF | Full definition

## 2.8.15 SHOW/PROXY Command (UDU>)

Displays one or more proxies in the ACMS proxy file (ACMSPROXY.DAT).
SHOW /PROXY remote-node::remote-user

# Chapter 3
ACMS Application Programming Services and Task Debugger Commands

This chapter contains reference material for the programming services supplied by ACMS, and for the ACMS Task Debugger commands.

# 3.1 ACMS Application Programming Services

This section provides reference material for the ACMS application programming services, ACMS$GET_TID, ACMS$RAISE_NONREC_EXCEPTION, ACMS$RAISE_STEP_EXCEPTION, ACMS$RAISE_TRANS_EXCEPTION, and ACMSAD$REQ_CANCEL, and the ACMS queuing services, ACMS$DEQUEUE_TASK and ACMS$QUEUE_TASK.

## 3.1.1 ACMS$GET_TID

Is used by a server procedure to obtain the transaction ID (TID) currently associated with an executing task.
ACMS$GET_TID (tid.wo.r)

## 3.1.2 ACMS$RAISE_NONREC_EXCEPTION

Used by a server procedure to raise a nonrecoverable exception and cancel the task.
ACMS$RAISE_NONREC_EXCEPTION ([exception_code.rl.r])

## 3.1.3 ACMS$RAISE_STEP_EXCEPTION

Raises a step exception if a step procedure detects an error from which it cannot recover, but which the task definition is able to handle.
ACMS$RAISE_STEP_EXCEPTION ([exception_code.rl.r])

## 3.1.4 ACMS$RAISE_TRANS_EXCEPTION

Raises a transaction exception if a step procedure detects an error from which it cannot recover, but which the task definition is able to handle.
ACMS$RAISE_TRANS_EXCEPTION ([exception_code.rl.r])

## 3.1.5 ACMSAD$REQ_CANCEL

Cancels a task. ACMS writes the task cancellation to the Audit Trail Log. When you include a reason parameter, the call also writes the reason for the cancel to the Audit Trail Log.

This service is considered to be a declining feature. It is recommended that you use ACMS$RAISE_NONREC_EXCEPTION instead.
ACMSAD$REQ_CANCEL ([reason.rl.r])

## 3.1.6 ACMS$DEQUEUE_TASK

Removes or reads a queued task element from the queued task repository and returns information about the task.
ACMS$DEQUEUE_TASK (queue_name.rt.dx,
[element_id.rr.r],
[flags.rlu.r],
[ret_task.wt.dx],
[ret_application.wt.dx],
[ret_workspace_list.wz.r],
[ret_workspace_count.wl.r],
[ret_element_priority.wl.r],
[ret_username.wt.dx],
[ret_element_id.wr.r],
[ret_error_count.wlu.r],
[ret_last_error.wlu.r],
[ret_last_error_adt.wadt.r])

## 3.1.7 ACMS$QUEUE_TASK

Stores the queued task element in an on-disk queued task repository.
ACMS$QUEUE_TASK (queue_name.rt.dx,
task.rt.dx,
application.rt.dx,
[workspace_list.rz.r],
[flags.rlu.r],
[element_priority.rl.r],
[username.rt.dx],
[element_id.wr.r])

# 3.2 ACMS Task Debugger Commands

This section lists the commands available with the ACMS Task Debugger. Use these commands to run an ACMS task without starting an application, to control the task, and to examine and change the contents of the workspaces the task uses as it runs.

## 3.2.1 @ (At sign) Command

Runs the ACMS Task Debugger commands contained in the named file. The file can contain any ACMS Task Debugger command, including another @ command.
@ file-spec

## 3.2.2 ACCEPT Command

The ACCEPT command allows the Task Debugger to accept calls from an agent program.
ACCEPT [/qualifier]

Command Qualifiers | Defaults
--- | ---
/CONTINUOUS | None

## 3.2.3 ASSIGN Command

Assigns a process logical name for a server.
ASSIGN [/qualifier] equivalence-name logical-name

Command Qualifiers | Defaults
--- | ---
/SERVER=server-name | /SERVER=current-server

## 3.2.4 CANCEL BREAK Command

Removes one or more breakpoints from a task or from all tasks.
CANCEL BREAK [/qualifiers] [breakpoint]

Command Qualifiers | Defaults
--- | ---
/ALL[=task-name] | None

## 3.2.5 CANCEL TASK Command

Cancels the current task.
CANCEL TASK

## 3.2.6 CANCEL TRANSACTION_TIMEOUT Command

Cancels any transaction timeout period previously set.
CANCEL TRANSACTION_TIMEOUT

## 3.2.7 DEPOSIT Command

Puts a value into a workspace field.
DEPOSIT [/qualifiers] workspace-field-name=value

Command Qualifiers | Defaults
--- | ---
Same as for OpenVMS Debugger |

## 3.2.8 EXAMINE Command

Displays the contents of a workspace field.
EXAMINE [/qualifiers] workspace-field-name [OF workspace-record-name]

Command Qualifiers | Defaults
--- | ---
Same as for OpenVMS Debugger |

## 3.2.9 EXIT Command

Ends the debugging session or ends the execution of commands in a command procedure. If typed after the ACMSDBG> prompt, the EXIT command stops all subprocesses started by the Task Debugger and returns to DCL command level. If included in a command procedure, the EXIT command returns control to the command stream that started the command procedure.
EXIT

## 3.2.10 GO Command

Continues a task after a breakpoint. Also returns to a server process that you left from with `[Ctrl/G]` and continues any command after an INTERRUPT command.
GO

## 3.2.11 HELP Command

Displays information about Task Debugger commands, step points, control characters, and symbols.
HELP [topic] [...]

## 3.2.12 INTERRUPT Command

Interrupts a server and gives control to the OpenVMS Debugger in that server process. Use this command to get to the DBG> prompt so you can set breakpoints, examine addresses, or change values in a server that has already been started.
INTERRUPT server-name [/qualifiers]

Command Qualifier | Default
--- | ---
/[TASK=task-name] | None

## 3.2.13 SELECT Command

Selects and starts a task.
SELECT task-name [selection-string]

## 3.2.14 SET BREAK Command

Sets a breakpoint in the task.
SET BREAK task-name \ step-name \ location
SET BREAK task-name \ event

## 3.2.15 SET SERVER Command

Names the server used as the default for the ASSIGN command.
SET SERVER server-name

## 3.2.16 SET TRANSACTION_TIMEOUT

Sets the current transaction timeout period.
SET TRANSACTION_TIMEOUT seconds

## 3.2.17 SHOW BREAK Command

Displays task-level breakpoints you have set.
SHOW BREAK

## 3.2.18 SHOW SERVERS Command

Displays all servers you have started (and not stopped) in the current Task Debugger session.
SHOW SERVERS

## 3.2.19 SHOW TRANSACTION_TIMEOUT

Displays the value of the current transaction timeout.
SHOW TRANSACTION_TIMEOUT

## 3.2.20 SHOW VERSION Command

Displays the version number of the Task Debugger.
SHOW VERSION

## 3.2.21 START Command

Starts one or more reusable servers.
START [/qualifier] [server-name] [,...]

Command Qualifier | Default
--- | ---
/ALL | None

## 3.2.22 STEP Command

Runs the task from the current step point to the next task-level step point. When stepping through a task that was called by another task, the Task Debugger proceeds through all the steps in the called task until the task completes. Control then returns to the parent task where you can continue typing the STEP command to cause the Task Debugger to step through the parent task.
STEP

## 3.2.23 STOP Command

Stops one or more servers.
STOP [/qualifier] [server-name][,...]

Command Qualifier | Default
--- | ---
/ALL | None

# Chapter 4
Systems Interface (SI) Services

This chapter provides reference material for calling the SI initialization, exchange I/O, submitter, and stream services in agent programs.

# 4.1 Initialization and Exchange I/O Services

This section provides reference material for calling the SI initialization and exchange I/O services in agent programs.

## 4.1.1 ACMS$INIT_EXCHANGE_IO

When the agent is prepared to perform any necessary exchange I/O, ACMS$INIT_EXCHANGE_IO specifies the type of I/O to perform. It returns an exchange I/O ID. For tasks that use DECforms, call ACMS$INIT_EXCHANGE_IO to open a DECforms session.
ACMS$INIT_EXCHANGE_IO (submitter_id.rq.r,
exchange_io_id.wq.r,
[io_enable_flag.rl.r],
[item_list.rx.r],
[io_capabilities_flag.wl.r])
ACMS$INIT_EXCHANGE_IO_A (submitter_id.rq.r,
exchange _io_id.wq.r,
[io_enable_flag.rl.r],
[item_list.rx.r],
[io_capabilities_flag.wl.r],
[comp_status.wq.r],
[efn.rbu.r],
[astadr.szem.r],
[astprm.rz.v])

## 4.1.2 ACMS$SIGN_IN

Lets an agent sign in a task submitter to ACMS.
ACMS$SIGN_IN (submitter_id.wq.r,
[username.rt.dx],
[device.rt.dx],
[cancel_routine.rem.r],
[cancel_param.rz.v])
ACMS$SIGN_IN_A (submitter_id.wq.r,
[username.rt.dx],
[device.rt.dx],
[cancel_routine.rem.r],
[cancel_param.rz.v],
[comp_status.wq.r],
[efn.rbu.r],
[astadr.szem.r],
[astprm.rz.v])

## 4.1.3 ACMS$SIGN_OUT

Lets an agent remove a task submitter from ACMS.
ACMS$SIGN_OUT (submitter_id.rq.r,
[cancel_flag.rlu.r])
ACMS$SIGN_OUT_A (submitter_id.rq.r,
[cancel_flag.rlu.r],
[comp_status.wq.r],
[efn.rbu.r],
[astadr.szem.r],
[astprm.rz.v])

## 4.1.4 ACMS$TERM_EXCHANGE_IO

This service allows an agent to finish using any I/O initialized during the ACMS$INIT_EXCHANGE_IO services. ACMS$TERM_EXCHANGE_IO frees any resources being used by the submitter, for example, DECforms sessions or TDMS channels. Any active call on the channel is canceled.
ACMS$TERM_EXCHANGE_IO (exchange_io_id.rq.r)
ACMS$TERM_EXCHANGE_IO_A (exchange_io_id.rq.r,
[comp_status.wq.r],
[efn.rbu.r],
[astadr.szem.r],
[astprm.rz.v])

# 4.2 Submitter Services

This section provides reference material for the submitter services.

## 4.2.1 ACMS$CALL

Submits an ACMS task. This service completes when the task ends. If you use the asynchronous ACMS$CALL_A service, you also must call the ACMS$WAIT service.
ACMS$CALL ([submitter_id.rq.r],
procedure_id.rq.r,
arguments.rz.r,
[tid.ro.r])
ACMS$CALL_A ([submitter_id.rq.r],
procedure _id.rq.r,
arguments.rz.r,
[tid.ro.r],
[comp_status.wq.r],
[efn.rbu.r],
[astadr.szem.r],
[astprm.rz.v])

## 4.2.2 ACMS$CANCEL_CALL

Cancels a task started by the task submitting agent. This service only cancels tasks started with ACMS$START_CALL. The agent must also use the ACMS$WAIT_FOR_CALL_END service with this service to get notification of the call canceling.
ACMS$CANCEL_CALL ([submitter_id.rq.r],
call_id.rq.r,
[reason_code.rlu.r])
ACMS$CANCEL_CALL_A ([submitter_id.rq.r],
call _id.rq.r,
[reason_code.rlu.r],
[comp_status.wq.r],
[efn.rbu.r],
[astadr.szem.r],
[astprm.rz.v])

## 4.2.3 ACMS$GET_PROCEDURE_INFO

Finds and returns the I/O method (terminal, request, stream, or none), the procedure ID for the task, and the number of workspace arguments the agent can pass to a task in an ACMS application.
ACMS$GET_PROCEDURE_INFO ([submitter_id.rq.r],
procedure.rt.dx,
package.rt.dx,
item_list.rx.r)
ACMS$GET_PROCEDURE_INFO_A ([submitter_id.rq.r],
procedure.rt.dx,
package.rt.dx,
item _list.rx.r,
[comp_status.wq.r],
[efn.rbu.r],
[astadr.szem.r],
[astprm.rz.v])

## 4.2.4 ACMS$START_CALL

Submits an ACMS task. This service completes when the task has been submitted. It returns a call ID to the agent.
ACMS$START_CALL ([submitter_id.rq.r],
procedure_id.rq.r,
call_id.wq.r,
arguments.rz.r,
[tid.ro.r])
ACMS$START_CALL_A ([submitter_id.rq.r],
procedure _id.rq.r,
call _id.wq.r,
arguments.rz.r,
[tid.ro.r],
[comp_status.wq.r],
[efn.rbu.r],
[astadr.szem.r],
[astprm.rz.v])

## 4.2.5 ACMS$WAIT_FOR_CALL_END

Waits for a task to complete. This service only waits for tasks started with ACMS$START_CALL. This service also reports access errors that occurred after the task was submitted.
ACMS$WAIT_FOR_CALL_END ([submitter_id.rq.r],
call_id.rq.r)
ACMS$WAIT_FOR_CALL_END_A ([submitter_id.rq.r],
call _id.rq.r,
[comp_status.wq.r],
[efn.rbu.r],
[astadr.szem.r],
[astprm.rz.v])

# 4.3 Stream Services

This section provides reference material for calling the SI stream services in agent programs.

## 4.3.1 ACMS$REPLY_TO_STREAM_IO

Reacts to I/O requests on the stream. The agent must gather information for the ACMS$WAIT_FOR_STREAM_IO input string and fill the string before calling this service.
ACMS$REPLY_TO_STREAM_IO (connect_id.rq.r,
io_id.wq.r,
[io_status.rl.r])
ACMS$REPLY_TO_STREAM_IO_A (connect_id.rq.r,
io _id.wq.r,
[io_status.rl.r],
[comp_status.wq.r],
[efn.rbu.r],
[astadr.szem.r],
[astprm.rz.v])

## 4.3.2 ACMS$WAIT_FOR_STREAM_IO

Waits for I/O messages. This service completes when the application execution controller (EXC) executes a READ or WRITE clause in the task definition.
ACMS$WAIT_FOR_STREAM_IO (connect_id.rq.r,
output_object.wz.r,
input_object.wz.r,
io_id.wq.r,
[cancel_routine.rem.r],
[cancel_param.rz.v])
ACMS$WAIT_FOR_STREAM_IO_A (connect_id.rq.r,
output _object.wz.r,
input _object.wz.r,
io _id.wq.r,
[comp_status.wq.r],
[efn.rbu.r],
[astadr.szem.r],
[astprm.rz.v],
[cancel_routine.rem.r],
[cancel_param.rz.v])

# 4.4 Superseded Services

This section provides reference material for six services used in earlier versions of ACMS.

## 4.4.1 ACMS$CLOSE_RR

Closes a TDMS channel to a terminal and disassociates it from a submitter ID. Any active TDMS call on the channel is canceled.
ACMS$CLOSE_RR ([channel.rlu.r],
[nullarg])
ACMS$CLOSE_RR_A ([channel.rlu.r],
[nullarg],
[comp_status.wq.r],
[efn.rbu.r],
[astadr.szem.r],
[astprm.rz.v])

Previous | Next | Contents | Index