OpenTP1 Version 7 Programming Reference COBOL Language

[Contents][Index][Back][Next]

1.1.1 Relationship between UAPs and programs

Table 1-1 gives the relationship between OpenTP1 facilities for use with OpenTP1 UAPs and programs for creating UAPs in COBOL.

Table 1-1 Relationship between OpenTP1 facilities and programs for COBOL-UAP creation

OpenTP1 facility Program called with CALL statement
System operation management Execute an operation command. CBLDCADM('COMMAND ')
Report the completion of user server start processing. CBLDCADM('COMPLETE')
Report the status of a user server. CBLDCADM('STATUS ')
DAM file service Close a logical file. CBLDCDAM('DCDAMSVC','CLOS')
Terminate using an unrecoverable DAM file. CBLDCDAM('DCDAMSVC','END ')
Shut down a logical file. CBLDCDAM('DCDAMSVC','HOLD')
Open a logical file. CBLDCDAM('DCDAMSVC','OPEN')
Input a logical file block. CBLDCDAM('DCDAMSVC','READ')
Update a logical file block. CBLDCDAM('DCDAMSVC','REWT')
Release a logical file from the shutdown state. CBLDCDAM('DCDAMSVC','RLES')
Reference the status of a logical file. CBLDCDAM('DCDAMSVC','STAT')
Start using an unrecoverable DAM file. CBLDCDAM('DCDAMSVC','STRT')
Output a logical file block. CBLDCDAM('DCDAMSVC','WRIT')
Seek a physical file block. CBLDCDMB('DCDAMINT','BSEK')
Close a physical file. CBLDCDMB('DCDAMINT','CLOS')
Allocate a physical file. CBLDCDMB('DCDAMINT','CRAT')
Input directly a physical file block. CBLDCDMB('DCDAMINT','DGET')
Output directly a physical file block. CBLDCDMB('DCDAMINT','DPUT')
Input a physical file block. CBLDCDMB('DCDAMINT','GET ')
Open a physical file. CBLDCDMB('DCDAMINT','OPEN')
Output a physical file block. CBLDCDMB('DCDAMINT','PUT ')
IST service Close an internode shared table. CBLDCIST('CLOS')
Open an internode shared table. CBLDCIST('OPEN')
Input an internode shared table record. CBLDCIST('READ')
Output an internode shared table record. CBLDCIST('WRIT')
User journal acquisition Acquire a user journal. CBLDCJNL('UJPUT ')
Journal data editing Close the jnlrput output file. CBLDCJUP('CLOSERPT')
Open the jnlrput output file. CBLDCJUP('OPENRPT ')
Input journal data of the jnlrput output file. CBLDCJUP('RDGETRPT')
Look for resources Enable locking of a resource. CBLDCLCK('GET ')
Release all the resources from lock. CBLDCLCK('RELALL ')
Release resource from lock specified by name. CBLDCLCK('RELNAME ')
Audit log output Output audit log data. CBLDCADT('PRINT ')
Output message log Output message log. CBLDCLOG('PRINT ')
Message exchange processing Report the application information. CBLDCMCF('APINFO ')
Close the MCF environment. CBLDCMCF('CLOSE ')
Commit an MHP. CBLDCMCF('COMMIT ')
Terminate continuous-inquiry- response processing. CBLDCMCF('CONTEND ')
Activate an application program. CBLDCMCF('EXECAP ')
Start an MHP service. CBLDCMCF('MAINLOOP')
Open the MCF environment. CBLDCMCF('OPEN ')
Receive a message. CBLDCMCF('RECEIVE ')
Receive a synchronous message. CBLDCMCF('RECVSYNC')
Send a response message. CBLDCMCF('REPLY ')
Resend a message. CBLDCMCF('RESEND ')
Enable MHP rollback. CBLDCMCF('ROLLBACK')
Send a message. CBLDCMCF('SEND ')
Exchange a synchronous message. CBLDCMCF('SENDRECV')
Send a synchronous message. CBLDCMCF('SENDSYNC')
Accept temporary-stored data. CBLDCMCF('TEMPGET')
Update temporary-stored data. CBLDCMCF('TEMPPUT')
Cancel user timer monitoring. CBLDCMCF('TIMERCAN')
Set user timer monitoring. CBLDCMCF('TIMERSET')
Performance verification trace Report the sequential number for an acquired performance verification trace. CBLDCPRF('PRFGETN ')
Acquire user-specific performance verification traces. CBLDCPRF('PRFPUT ')
Remote API facility Establish a connection with a RAP-processing listener. CBLDCRAP('CONNECT ')
CBLDCRAP('CONNECTX')
Release a connection with a RAP-processing listener. CBLDCRAP('DISCNCT ')
Remote procedure call Request a remote service. CBLDCRPC('CALL ')
Terminate an application program. CBLDCRPC('CLOSE ')
Report data to CUP unidirectionally. CBLDCRPC('CLTSEND ')
Reject the receiving of processing results. CBLDCRPC('DISCARDF ')
Reject acceptance of specific processing results. CBLDCRPC('DISCARDS')
Acquire the node address of a client UAP. CBLDCRPC('GETCLADR')
Acquire the descriptor of an asynchronous response-type RPC request which has encountered an error CBLDCRPC('GETERDES')
Acquire the node address of a gateway. CBLDCRPC('GETGWADR')
Reference the schedule priority of a service request. CBLDCRPC('GETSVPRI ')
Reference the service response waiting interval. CBLDCRPC('GETWATCH')
Start an application program. CBLDCRPC('OPEN ')
Receive processing results in asynchronous mode. CBLDCRPC('POLLANYR')
Set a schedule priority of a service request. CBLDCRPC('SETSVPRI ')
Update the service response waiting interval. CBLDCRPC('SETWATCH ')
Retry a service program. CBLDCRPC('SVRETRY ')
Start an SPP service. CBLDCRSV('MAINLOOP')
Real-time statistical information service Acquire real-time statistical information for arbitrary section. CBLDCRTS('RTSPUT ')
TAM file service# Delete a TAM table record. CBLDCTAM('ERS ')('ERSR')('ZRS ')('ZRSR')
Input a TAM table record. CBLDCTAM('FxxR')('FxxU')('VxxR')('VxxU')
Acquire TAM table status. CBLDCTAM('GST ')
Acquire TAM table information. CBLDCTAM('INFO')
Update/add a TAM table record. CBLDCTAM('MFY ')('MFYS')('STR ')('WFY ')('WFYS')('YTR ')
Transaction control Start a transaction. CBLDCTRN('BEGIN ')
Enable commitment in chained mode. CBLDCTRN('C-COMMIT')
Enable rollback in chained mode. CBLDCTRN('C-ROLL ')
Report the information about the current transaction. CBLDCTRN('INFO ')
Enable commitment in unchained mode. CBLDCTRN('U-COMMIT')
Enable rollback in unchained mode. CBLDCTRN('U-ROLL ')
Online tester management Report the test status of a user server. CBLDCUTO('T-STATUS')

#: The APIs of the following TAM file services are not supported in COBOL language:
  • Open a TAM table.
  • Close a TAM table.
  • Cancel the input of a TAM table record.
Organization of this subsection
(1) Facilities and programs available with SUPs
(2) Facilities and programs available with SPPs
(3) Facilities and programs available with MHPs
(4) Facilities and programs available with UAPs that handles offline work

(1) Facilities and programs available with SUPs

Table 1-2 lists the facilities which can be used with SUPs and their request codes.

Table 1-2 Facilities available with SUPs and their request codes


Facility available with SUP

Names of facilities available with SUPs and request codes specified as data name at the beginning of COBOL-UAP creation program
SUP operating conditions
Outside Inside
System operation management Execute an operation command. 'COMMAND' Y Y
Report the completion of user server start processing. 'COMPLETE' Y N
Report the status of a user server. 'STATUS ' Y Y
DAM file service Close a logical file. 'DCDAMSVC', 'CLOS' Y Y
Terminate using an unrecoverable DAM file. 'DCDAMSVC', 'END ' Y Y
Shut down a logical file. 'DCDAMSVC', 'HOLD' Y Y
Open a logical file. 'DCDAMSVC', 'OPEN' Y Y
Input a logical file block. 'DCDAMSVC', 'READ' Y Y
Update a logical file block. 'DCDAMSVC', 'REWT' (Y) Y
Release a logical file from the shutdown state. 'DCDAMSVC', 'RLES' Y Y
Reference the status of a logical file. 'DCDAMSVC', 'STAT' Y Y
Start using an unrecoverable DAM file. 'DCDAMSVC', 'STRT' Y Y
Output a logical file block. 'DCDAMSVC', 'WRIT' (Y) Y
IST service Close an internode shared table. 'DCISTSVC', 'CLOS' Y Y
Open an internode shared table. 'DCISTSVC', 'OPEN' Y Y
Input an internode shared table record. 'DCISTSVC', 'READ' Y Y
Output an internode shared table record. 'DCISTSVC', 'WRIT' Y Y
User journal acquisition Acquire a user journal. 'UJPUT ' Y Y
Lock for resources Enable locking of a resource. 'GET ' N Y
Release all the resources from lock. 'RELALL ' N Y
Release resource from lock specified by name. 'RELNAME' N Y
Audit log output Output audit log data. 'PRINT ' Y Y
Output message log Output message log. 'PRINT ' Y Y
Performance verification trace Report the sequential number for an acquired performance verification trace. 'PRFGETN' Y Y
Acquire user-specific performance verification traces. 'PRFPUT ' Y Y
Remote API facility Establish a connection with a RAP- processing listener. 'CONNECT'
'CONNECTX'
Y N
Release a connection with a RAP- processing listener. 'DISCNCT' Y N
Remote procedure call Request a remote service. 'CALL ' Y Y
Terminate an application program. 'CLOSE ' Y N
Reject the receiving of processing results. 'DISCARDF' Y Y
Reject acceptance of specific processing results. 'DISCARDS' Y Y
Acquire the descriptor of an asynchronous response-type RPC request which has encountered an error. 'GETERDES' Y Y
Reference the schedule priority of a service request. 'GETSVPRI' Y Y
Reference the service response waiting interval. 'GETWATCH' Y Y
Start an application program. 'OPEN ' Y N
Receive processing results in asynchronous mode. 'POLLANYR' Y Y
Set a schedule priority of a service request. 'SETSVPRI' Y Y
Update the service response waiting interval. 'SETWATCH' Y Y
Real-time statistical information service Acquire real-time statistical information for arbitrary section. 'RTSPUT ' Y Y
TAM file service Delete a TAM table record. 'ERS'/'ERSR'/'ZRS '/'ZRSR' N Y
Input a TAM table record. 'FxxR'/'FxxU'/'VxxR'/'VxxU' N Y
Acquire TAM table status. 'GST' Y Y
Acquire TAM table information. 'INFO ' Y Y
Update/add a TAM table record. 'MFY'/'MFYS'/'STR '/'WFY'/'WFYS'/'YTR' N Y
Transaction control Start a transaction. 'BEGIN' Y N
Enable commitment in chained mode. 'C-COMMIT' N Y
Enable rollback in chained mode. 'C-ROLL ' N Y
Report the information about the current transaction. 'INFO ' Y Y
Enable commitment in unchained mode. 'U-COMMIT' N Y
Enable rollback in unchained mode. 'U-ROLL ' N Y
Online tester management Report the test status of a user server. 'T-STATUS' Y Y

Legend:
Outside: Outside the transaction processing range
Inside: Inside the transaction processing range
Y: Can be used with SUPs.
(Y): Can be used only when accessing an unrecoverable DAM file.
N: Cannot be used with SUPs.

(2) Facilities and programs available with SPPs

Table 1-3 lists the facilities which can be used with SPPs and their request codes.

Table 1-3 Facilities available with SPPs and their request codes


Facility available with SPP

Names of facilities available with SUPs and request codes specified as data name at the beginning of COBOL-UAP creation program
SPP operating conditions
Outside Inside
Root Not root
System operation management Execute an operation command. 'COMMAND ' Y Y Y
Report the status of a user server. 'STATUS ' Y Y Y
DAM file service Close a logical file. 'DCDAMSVC','CLOS' Y Y Y
Terminate using an unrecoverable DAM file. 'DCDAMSVC','END ' Y Y Y
Shut down a logical file. 'DCDAMSVC','HOLD' Y Y Y
Open a logical file. 'DCDAMSVC','OPEN' Y Y Y
Input a logical file block. 'DCDAMSVC','READ' Y Y Y
Update a logical file block. 'DCDAMSVC','REWT' (Y) Y Y
Release a logical file from the shutdown state. 'DCDAMSVC','RLES' Y Y Y
Reference the status of a logical file. 'DCDAMSVC','STAT' Y Y Y
Start using an unrecoverable DAM file. 'DCDAMSVC','STRT' Y Y Y
Output a logical file block. 'DCDAMSVC','WRIT' (Y) Y Y
IST service Close an internode shared table. 'DCISTSVC','CLOS' Y Y Y
Open an internode shared table. 'DCISTSVC','OPEN' Y Y Y
Input an internode shared table record. 'DCISTSVC','READ' Y Y Y
Output an internode shared table record. 'DCISTSVC','WRIT' Y Y Y
User journal acquisition Acquire a user journal. 'UJPUT ' Y Y Y
Lock for resources Enable locking of a resource. 'GET ' N Y Y
Release all the resources from lock. 'RELALL ' N Y Y
Release resource from lock specified by name. 'RELNAME ' N Y Y
Audit log output Output audit log data. 'PRINT ' Y Y Y
Output message log Output message log. 'PRINT ' Y Y Y
Message exchange processing Close the MCF environment. 'CLOSE ' O N N
Activate an application program. 'EXECAP ' N Y Y
Open the MCF environment. 'OPEN ' O N N
Receive a synchronous message. 'RECVSYNC' Y Y Y
Resend a message. 'RESEND ' N Y Y
Send a message. 'SEND ' N Y Y
Exchange a synchronous message. 'SENDRECV' Y Y Y
Send a synchronous message. 'SENDSYNC' Y Y Y
Cancel user timer monitoring. 'TIMERCAN' Y Y Y
Set user timer monitoring. 'TIMERSET' Y Y Y
Performance verification trace Report the sequential number for an acquired performance verification trace. 'PRFGETN ' Y Y Y
Acquire user-specific performance verification traces. 'PRFPUT ' Y Y Y
Remote API facility Establish a connection with a RAP- processing listener. 'CONNECT '
'CONNECTX'
Y N N
Release a connection with a RAP-processing listener. 'DISCNCT ' Y N N
Remote procedure call Request a remote service. 'CALL ' Y Y Y
Terminate an application program. 'CLOSE ' O N N
Report data to CUP unidirectionally. 'CLTSEND ' Y Y Y
Reject the receiving of processing results. 'DISCARDF' Y Y Y
Reject acceptance of specific processing results. 'DISCARDS' Y Y Y
Acquire the node address of a client UAP. 'GETCLADR' Y Y Y
Acquire the descriptor of an asynchronous response-type RPC request which has encountered an error. 'GETERDES' Y Y Y
Acquire the node address of a gateway. 'GETGWADR' Y Y Y
Reference the schedule priority of a service request. 'GETSVPRI' Y Y Y
Reference the service response waiting interval. 'GETWATCH' Y Y Y
Start an application program. 'OPEN ' O N N
Receive processing results in asynchronous mode. 'POLLANYR' Y Y Y
Set a schedule priority of a service request. 'SETSVPRI' Y Y Y
Update the service response waiting interval. 'SETWATCH' Y Y Y
Retry a service program. 'SVRETRY ' Y N N
Start an SPP service. 'MAINLOOP' O N N
Real time statistical information service Acquire real-time statistical information for arbitrary section. 'RTSPUT ' Y Y Y
TAM file service Delete a TAM table record. 'ERS '/'ERSR'/'ZRS '/'ZRSR' N Y Y
Input a TAM table record. 'FxxR'/'FxxU'/'VxxR'/'VxxU' N Y Y
Acquire TAM table status. 'GST ' Y Y Y
Acquire TAM table information. 'INFO ' Y Y Y
Update/add a TAM table record. 'MFY '/'MFYS'/'STR '/'WFY'/'WFYS'/'YTR ' N Y Y
Transaction control Start a transaction. 'BEGIN ' Y N N
Enable commitment in chained mode. 'C-COMMIT' N Y N
Enable rollback in chained mode. 'C-ROLL ' N Y N
Report the information about the current transaction. 'INFO ' Y Y Y
Enable commitment in unchained mode. 'U-COMMIT' N Y N
Enable rollback in unchained mode. 'U-ROLL ' N Y Y
Online tester management Report the test status of a user server. 'T-STATUS' Y Y Y

Legend:
Outside: Outside the transaction processing range
Inside: Inside the transaction processing range
Y: Can be used with SPPs.
(Y): Can be used only when accessing an unrecoverable DAM file.
O: Can be used only from the main program.
N: Cannot be used with SPPs.

Note
Root in the table indicates a root transaction branch. Not root indicates a transaction branch other than the root transaction branch.

(3) Facilities and programs available with MHPs

Table 1-4 lists the facilities which can be used with MHPs and their request codes.

Table 1-4 Facilities available with MHPs and their request codes


Facility available with MHP

Names of facilities available with MHPs and request codes specified as data name at the beginning of COBOL-UAP creation program
MHP operating conditions
Outside Inside
System operation management Execute an operation command. 'COMMAND ' Y Y
Report the status of a user server. 'STATUS ' Y Y
DAM file service Close a logical file. 'DCDAMSVC','CLOS' Y Y
Terminate using an unrecoverable DAM file. 'DCDAMSVC','END ' Y Y
Shut down a logical file. 'DCDAMSVC','HOLD' Y Y
Open a logical file. 'DCDAMSVC','OPEN' Y Y
Input a logical file block. 'DCDAMSVC','READ' Y Y
Update a logical file block. 'DCDAMSVC','REWT' (Y) Y
Release a logical file from the shutdown state. 'DCDAMSVC','RLES' Y Y
Reference the status of a logical file. 'DCDAMSVC','STAT' Y Y
Start using an unrecoverable DAM file. 'DCDAMSVC','STRT' Y Y
Output a logical file block. 'DCDAMSVC','WRIT' (Y) Y
IST service Close an internode shared table. 'DCISTSVC','CLOS' Y Y
Open an internode shared table. 'DCISTSVC','OPEN' Y Y
Input an internode shared table record. 'DCISTSVC','READ' Y Y
Output an internode shared table record. 'DCISTSVC','WRIT' Y Y
User journal acquisition Acquire a user journal. 'UJPUT ' Y Y
Look for resources Enable locking of a resource. 'GET ' N Y
Release all the resources from lock. 'RELALL ' N Y
Release resource from lock specified by name. 'RELNAME ' N Y
Audit log output Output audit log data. 'PRINT ' Y Y
Output message log Output message log. 'PRINT ' Y Y
Message exchange processing Report the application information. 'APINFO ' NO Y
Close the MCF environment. 'CLOSE ' O O
Commit an MHP. 'COMMIT ' N Y
Terminate continuous-inquiry-response processing. 'CONTEND ' NO Y
Activate an application program. 'EXECAP ' NO Y
Start an MHP service. 'MAINLOOP' O N
Open the MCF environment. 'OPEN ' O O
Receive a message. 'RECEIVE ' NO Y
Receive a synchronous message. 'RECVSYNC' Y Y
Send a response message. 'REPLY ' NO Y
Resend a message. 'RESEND ' N Y
Enable MHP rollback. 'ROLLBACK' N Y
Send a message. 'SEND ' NO Y
Exchange a synchronous message. 'SENDRECV' Y Y
Send a synchronous message. 'SENDSYNC' Y Y
Accept temporary-stored data. 'TEMPGET ' NO Y
Update temporary-stored data. 'TEMPPUT ' NO Y
Cancel user timer monitoring. 'TIMERCAN' Y Y
Set user timer monitoring. 'TIMERSET' Y Y
Performance verification trace Report the sequential number for an acquired performance verification trace. 'PRFGETN ' Y Y
Acquire user-specific performance verification traces. 'PRFPUT ' Y Y
Remote API facility Establish a connection with a RAP- processing listener. 'CONNECT '
'CONNECTX'
Y N
Release a connection with a RAP-processing listener. 'DISCNCT ' Y N
Remote procedure call Request a remote 'CALL ' O Y
Terminate an application program 'CLOSE ' O N
Report data to CUP unidirectionally. 'CLTSEND ' Y Y
Reject the receiving of processing results. 'DISCARDF' Y Y
Reject acceptance of specific processing results. 'DISCARDS' Y Y
Acquire the descriptor of an asynchronous-response type RPC request which has encountered an error. 'GETERDES' Y Y
Reference the schedule priority of a service request. 'GETSVPRI' Y Y
Reference the service response waiting interval. 'GETWATCH' Y Y
Start an application program. 'OPEN ' O N
Receive processing results in asynchronous mode. 'POLLANYR' O Y
Set a schedule priority of a service request. 'SETSVPRI' Y Y
Update the service response waiting interval. 'SETWATCH' Y Y
Real time statistical information service Acquire real-time statistical information for arbitrary section. 'RTSPUT ' Y Y
TAM file service Delete a TAM table record. 'ERS '/'ERSR'/'ZRS '/'ZRSR' N Y
Input a TAM table record. 'FxxR'/'FxxU'/'VxxR'/'VxxU' N Y
Acquire TAM table status. 'GST ' Y Y
Acquire TAM table information. 'INFO' Y Y
Update/add a TAM table record. 'MFY '/'MFYS'/'STR '/'WFY'/'WFYS'/'YTR ' N Y
Transaction control Start a transaction. 'BEGIN ' O N
Enable commitment in unchained mode. 'U-COMMIT' N O
Report the information about the current transaction 'INFO ' Y Y
Enable rollback in unchained mode. 'U-ROLL ' N O
Online tester management Report the test status of a user server. 'T-STATUS' Y Y

Legend:
Outside: Outside the transaction processing range
Inside: Inside the transaction processing range
Y: Can be used with an MHP.
(Y): Can be used only when accessing an unrecoverable DAM file.
O: Can be used only from the main program.
NO: The function can be used only in the service-program range of nontransaction attribute MHPs.
N: Cannot be used with an MHP.

Note
Outside the transaction processing range means the range of nontransaction attribute MHPs or MHP main programs.

(4) Facilities and programs available with UAPs that handles offline work

Table 1-5 lists the facilities which can be used with UAPs that handle offline work and their request codes.

Table 1-5 Facilities available with UAPs that handle offline work and their request codes

Facility available with UAP That handles offline work Names of facilities available with UAP that handles offline work and request codes specified as data name at the beginning of COBOL-UAP creation program
DAM file service Seek a physical file block. 'DCDAMINT','BSEK'
Close a physical file. 'DCDAMINT','CLOS'
Allocate a physical file. 'DCDAMINT','CRAT'
Input directly a physical file block. 'DCDAMINT','DGET'
Output directly a physical file block. 'DCDAMINT','DPUT'
Input a physical file block. 'DCDAMINT','GET '
Open a physical file. 'DCDAMINT','OPEN'
Output a physical file block. 'DCDAMINT','PUT '
Journal data editing Close the jnlrput output file. 'CLOSERPT'
Open the jnlrput output file. 'OPENRPT '
Input journal data of the jnlrput output file. 'RDGETRPT'
Performance verification trace Report the sequential number for an acquired performance verification trace. 'PRFGETN '
Acquire user-specific performance verification traces. 'PRFPUT '