Administration Guide › Programming User Exits

Programming User Exits

Batch Line Printer Exit

Enables you to control output in DQBATCH. This exit must do all output to the system line printer.

Batch Submit Exit

Enables you to inspect and modify the JCL used for batch query execution initiated through the online submit function.

DBID Exit

Provides CA Dataquery with the correct CA Datacom/DB identifier prior to execution of a DQL Language query. When query validation is complete, CA Dataquery gives control to this exit and passes the following to the exit:

• Datadictionary entity-name
• CA Dataquery user identification
• CA Datacom/DB table name
• CA Datacom/DB database ID

The exit can change the CA Datacom/DB table name causing CA Dataquery to update its processing control blocks to reflect the new information. This process occurs one time for every table for each query. In batch or online, when a query is validated, this exit is called once for each table named in the query and has the opportunity to change the CA Datacom/DB ID of any table.

Data Exit

This exit is called every time CA Dataquery is ready to include a row in the found set of a query. It can reject the row, preventing its inclusion in the set. In online and batch, passes user's name, 3-character CA Datacom/DB name for the table being accessed, DBID, and the row itself. The exit may examine the row and return an indicator as to whether the user should have access to the row.

Data Stream Input Exit

Receives control when an input data stream is received by CA Dataquery from a terminal. It can examine and modify the data stream.

Data Stream Output Exit

Inspects and modifies the data stream in place but must not change its location or length. The Data Stream Output exit receives control just before CA Dataquery writes a data stream to a terminal. It can inspect and modify the data stream.

Network Printer Exit

Enables you to inspect and modify the print lines produced by an online query whose output destination is a network printer. CA Dataquery passes the address where the exit should build the data stream, the address of the image where the data stream should be built, the address of a flag that indicates whether a page ejection should occur and the number of columns per row in the data stream image to the user-written program. This allows nonstandard control codes to be inserted into the print lines to accommodate special printers.

Output Exit

Allows you to access individual rows of output data before the output is printed.

Query Validation Exit

Enables you to make changes to a query before the query is executed. CA Dataquery passes the query and user name that has been submitted for execution to the user-written program. The program may limit the number of rows searched by a query on a particular CA Datacom/DB table. This is an effective technique for enforcing site standards on queries.

Signon/off Exit

(In batch and online) Passes the user ID, password, and time of signon to the user-written program. The program can use this data to further validate the user, to track how frequently the user is accessing CA Dataquery, to enhance security, and so on. This exit must be used if CA Dataquery is to communicate with other security packages.

User-Defined Functions Exit

Enables you to manipulate the data resulting from a query execution by performing mathematical procedures in the form of SET statements. CA Dataquery passes the retrieved data resulting from a query execution to a user-written program.