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 facilityProgram called with CALL statement
System operation managementExecute 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 serviceClose 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 serviceClose 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 acquisitionAcquire a user journal.CBLDCJNL('UJPUT ')
Journal data editingClose 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 resourcesEnable 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 outputOutput audit log data.CBLDCADT('PRINT ')
Output message logOutput message log.CBLDCLOG('PRINT ')
Message exchange processingReport 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 traceReport the sequential number for an acquired performance verification trace.CBLDCPRF('PRFGETN ')
Acquire user-specific performance verification traces.CBLDCPRF('PRFPUT ')
Remote API facilityEstablish a connection with a RAP-processing listener.CBLDCRAP('CONNECT ')
CBLDCRAP('CONNECTX')
Release a connection with a RAP-processing listener.CBLDCRAP('DISCNCT ')
Remote procedure callRequest 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 errorCBLDCRPC('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 serviceAcquire 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 controlStart 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 managementReport 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
OutsideInside
System operation managementExecute an operation command.'COMMAND'YY
Report the completion of user server start processing.'COMPLETE'YN
Report the status of a user server.'STATUS 'YY
DAM file serviceClose a logical file.'DCDAMSVC', 'CLOS'YY
Terminate using an unrecoverable DAM file.'DCDAMSVC', 'END 'YY
Shut down a logical file.'DCDAMSVC', 'HOLD'YY
Open a logical file.'DCDAMSVC', 'OPEN'YY
Input a logical file block.'DCDAMSVC', 'READ'YY
Update a logical file block.'DCDAMSVC', 'REWT'(Y)Y
Release a logical file from the shutdown state.'DCDAMSVC', 'RLES'YY
Reference the status of a logical file.'DCDAMSVC', 'STAT'YY
Start using an unrecoverable DAM file.'DCDAMSVC', 'STRT'YY
Output a logical file block.'DCDAMSVC', 'WRIT'(Y)Y
IST serviceClose an internode shared table.'DCISTSVC', 'CLOS'YY
Open an internode shared table.'DCISTSVC', 'OPEN'YY
Input an internode shared table record.'DCISTSVC', 'READ'YY
Output an internode shared table record.'DCISTSVC', 'WRIT'YY
User journal acquisitionAcquire a user journal.'UJPUT 'YY
Lock for resourcesEnable locking of a resource.'GET 'NY
Release all the resources from lock.'RELALL 'NY
Release resource from lock specified by name.'RELNAME'NY
Audit log outputOutput audit log data.'PRINT 'YY
Output message logOutput message log.'PRINT 'YY
Performance verification traceReport the sequential number for an acquired performance verification trace.'PRFGETN'YY
Acquire user-specific performance verification traces.'PRFPUT 'YY
Remote API facilityEstablish a connection with a RAP- processing listener.'CONNECT'
'CONNECTX'
YN
Release a connection with a RAP- processing listener.'DISCNCT'YN
Remote procedure callRequest a remote service.'CALL 'YY
Terminate an application program.'CLOSE 'YN
Reject the receiving of processing results.'DISCARDF'YY
Reject acceptance of specific processing results.'DISCARDS'YY
Acquire the descriptor of an asynchronous response-type RPC request which has encountered an error.'GETERDES'YY
Reference the schedule priority of a service request.'GETSVPRI'YY
Reference the service response waiting interval.'GETWATCH'YY
Start an application program.'OPEN 'YN
Receive processing results in asynchronous mode.'POLLANYR'YY
Set a schedule priority of a service request.'SETSVPRI'YY
Update the service response waiting interval.'SETWATCH'YY
Real-time statistical information serviceAcquire real-time statistical information for arbitrary section.'RTSPUT 'YY
TAM file serviceDelete a TAM table record.'ERS'/'ERSR'/'ZRS '/'ZRSR'NY
Input a TAM table record.'FxxR'/'FxxU'/'VxxR'/'VxxU'NY
Acquire TAM table status.'GST'YY
Acquire TAM table information.'INFO 'YY
Update/add a TAM table record.'MFY'/'MFYS'/'STR '/'WFY'/'WFYS'/'YTR'NY
Transaction controlStart a transaction.'BEGIN'YN
Enable commitment in chained mode.'C-COMMIT'NY
Enable rollback in chained mode.'C-ROLL 'NY
Report the information about the current transaction.'INFO 'YY
Enable commitment in unchained mode.'U-COMMIT'NY
Enable rollback in unchained mode.'U-ROLL 'NY
Online tester managementReport the test status of a user server.'T-STATUS'YY
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
OutsideInside
RootNot root
System operation managementExecute an operation command.'COMMAND 'YYY
Report the status of a user server.'STATUS 'YYY
DAM file serviceClose a logical file.'DCDAMSVC','CLOS'YYY
Terminate using an unrecoverable DAM file.'DCDAMSVC','END 'YYY
Shut down a logical file.'DCDAMSVC','HOLD'YYY
Open a logical file.'DCDAMSVC','OPEN'YYY
Input a logical file block.'DCDAMSVC','READ'YYY
Update a logical file block.'DCDAMSVC','REWT'(Y)YY
Release a logical file from the shutdown state.'DCDAMSVC','RLES'YYY
Reference the status of a logical file.'DCDAMSVC','STAT'YYY
Start using an unrecoverable DAM file.'DCDAMSVC','STRT'YYY
Output a logical file block.'DCDAMSVC','WRIT'(Y)YY
IST serviceClose an internode shared table.'DCISTSVC','CLOS'YYY
Open an internode shared table.'DCISTSVC','OPEN'YYY
Input an internode shared table record.'DCISTSVC','READ'YYY
Output an internode shared table record.'DCISTSVC','WRIT'YYY
User journal acquisitionAcquire a user journal.'UJPUT 'YYY
Lock for resourcesEnable locking of a resource.'GET 'NYY
Release all the resources from lock.'RELALL 'NYY
Release resource from lock specified by name.'RELNAME 'NYY
Audit log outputOutput audit log data.'PRINT 'YYY
Output message logOutput message log.'PRINT 'YYY
Message exchange processingClose the MCF environment.'CLOSE 'ONN
Activate an application program.'EXECAP 'NYY
Open the MCF environment.'OPEN 'ONN
Receive a synchronous message.'RECVSYNC'YYY
Resend a message.'RESEND 'NYY
Send a message.'SEND 'NYY
Exchange a synchronous message.'SENDRECV'YYY
Send a synchronous message.'SENDSYNC'YYY
Cancel user timer monitoring.'TIMERCAN'YYY
Set user timer monitoring.'TIMERSET'YYY
Performance verification traceReport the sequential number for an acquired performance verification trace.'PRFGETN 'YYY
Acquire user-specific performance verification traces.'PRFPUT 'YYY
Remote API facilityEstablish a connection with a RAP- processing listener.'CONNECT '
'CONNECTX'
YNN
Release a connection with a RAP-processing listener.'DISCNCT 'YNN
Remote procedure callRequest a remote service.'CALL 'YYY
Terminate an application program.'CLOSE 'ONN
Report data to CUP unidirectionally.'CLTSEND 'YYY
Reject the receiving of processing results.'DISCARDF'YYY
Reject acceptance of specific processing results.'DISCARDS'YYY
Acquire the node address of a client UAP.'GETCLADR'YYY
Acquire the descriptor of an asynchronous response-type RPC request which has encountered an error.'GETERDES'YYY
Acquire the node address of a gateway.'GETGWADR'YYY
Reference the schedule priority of a service request.'GETSVPRI'YYY
Reference the service response waiting interval.'GETWATCH'YYY
Start an application program.'OPEN 'ONN
Receive processing results in asynchronous mode.'POLLANYR'YYY
Set a schedule priority of a service request.'SETSVPRI'YYY
Update the service response waiting interval.'SETWATCH'YYY
Retry a service program.'SVRETRY 'YNN
Start an SPP service.'MAINLOOP'ONN
Real time statistical information serviceAcquire real-time statistical information for arbitrary section.'RTSPUT 'YYY
TAM file serviceDelete a TAM table record.'ERS '/'ERSR'/'ZRS '/'ZRSR'NYY
Input a TAM table record.'FxxR'/'FxxU'/'VxxR'/'VxxU'NYY
Acquire TAM table status.'GST 'YYY
Acquire TAM table information.'INFO 'YYY
Update/add a TAM table record.'MFY '/'MFYS'/'STR '/'WFY'/'WFYS'/'YTR 'NYY
Transaction controlStart a transaction.'BEGIN 'YNN
Enable commitment in chained mode.'C-COMMIT'NYN
Enable rollback in chained mode.'C-ROLL 'NYN
Report the information about the current transaction.'INFO 'YYY
Enable commitment in unchained mode.'U-COMMIT'NYN
Enable rollback in unchained mode.'U-ROLL 'NYY
Online tester managementReport the test status of a user server.'T-STATUS'YYY
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
OutsideInside
System operation managementExecute an operation command.'COMMAND 'YY
Report the status of a user server.'STATUS 'YY
DAM file serviceClose a logical file.'DCDAMSVC','CLOS'YY
Terminate using an unrecoverable DAM file.'DCDAMSVC','END 'YY
Shut down a logical file.'DCDAMSVC','HOLD'YY
Open a logical file.'DCDAMSVC','OPEN'YY
Input a logical file block.'DCDAMSVC','READ'YY
Update a logical file block.'DCDAMSVC','REWT'(Y)Y
Release a logical file from the shutdown state.'DCDAMSVC','RLES'YY
Reference the status of a logical file.'DCDAMSVC','STAT'YY
Start using an unrecoverable DAM file.'DCDAMSVC','STRT'YY
Output a logical file block.'DCDAMSVC','WRIT'(Y)Y
IST serviceClose an internode shared table.'DCISTSVC','CLOS'YY
Open an internode shared table.'DCISTSVC','OPEN'YY
Input an internode shared table record.'DCISTSVC','READ'YY
Output an internode shared table record.'DCISTSVC','WRIT'YY
User journal acquisitionAcquire a user journal.'UJPUT 'YY
Look for resourcesEnable locking of a resource.'GET 'NY
Release all the resources from lock.'RELALL 'NY
Release resource from lock specified by name.'RELNAME 'NY
Audit log outputOutput audit log data.'PRINT 'YY
Output message logOutput message log.'PRINT 'YY
Message exchange processingReport the application information.'APINFO 'NOY
Close the MCF environment.'CLOSE 'OO
Commit an MHP.'COMMIT 'NY
Terminate continuous-inquiry-response processing.'CONTEND 'NOY
Activate an application program.'EXECAP 'NOY
Start an MHP service.'MAINLOOP'ON
Open the MCF environment.'OPEN 'OO
Receive a message.'RECEIVE 'NOY
Receive a synchronous message.'RECVSYNC'YY
Send a response message.'REPLY 'NOY
Resend a message.'RESEND 'NY
Enable MHP rollback.'ROLLBACK'NY
Send a message.'SEND 'NOY
Exchange a synchronous message.'SENDRECV'YY
Send a synchronous message.'SENDSYNC'YY
Accept temporary-stored data.'TEMPGET 'NOY
Update temporary-stored data.'TEMPPUT 'NOY
Cancel user timer monitoring.'TIMERCAN'YY
Set user timer monitoring.'TIMERSET'YY
Performance verification traceReport the sequential number for an acquired performance verification trace.'PRFGETN 'YY
Acquire user-specific performance verification traces.'PRFPUT 'YY
Remote API facilityEstablish a connection with a RAP- processing listener.'CONNECT '
'CONNECTX'
YN
Release a connection with a RAP-processing listener.'DISCNCT 'YN
Remote procedure callRequest a remote'CALL 'OY
Terminate an application program'CLOSE 'ON
Report data to CUP unidirectionally.'CLTSEND 'YY
Reject the receiving of processing results.'DISCARDF'YY
Reject acceptance of specific processing results.'DISCARDS'YY
Acquire the descriptor of an asynchronous-response type RPC request which has encountered an error.'GETERDES'YY
Reference the schedule priority of a service request.'GETSVPRI'YY
Reference the service response waiting interval.'GETWATCH'YY
Start an application program.'OPEN 'ON
Receive processing results in asynchronous mode.'POLLANYR'OY
Set a schedule priority of a service request.'SETSVPRI'YY
Update the service response waiting interval.'SETWATCH'YY
Real time statistical information serviceAcquire real-time statistical information for arbitrary section.'RTSPUT 'YY
TAM file serviceDelete a TAM table record.'ERS '/'ERSR'/'ZRS '/'ZRSR'NY
Input a TAM table record.'FxxR'/'FxxU'/'VxxR'/'VxxU'NY
Acquire TAM table status.'GST 'YY
Acquire TAM table information.'INFO'YY
Update/add a TAM table record.'MFY '/'MFYS'/'STR '/'WFY'/'WFYS'/'YTR 'NY
Transaction controlStart a transaction.'BEGIN 'ON
Enable commitment in unchained mode.'U-COMMIT'NO
Report the information about the current transaction'INFO 'YY
Enable rollback in unchained mode.'U-ROLL 'NO
Online tester managementReport the test status of a user server.'T-STATUS'YY
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 workNames 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 serviceSeek 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 editingClose the jnlrput output file.'CLOSERPT'
Open the jnlrput output file.'OPENRPT '
Input journal data of the jnlrput output file.'RDGETRPT'
Performance verification traceReport the sequential number for an acquired performance verification trace.'PRFGETN '
Acquire user-specific performance verification traces.'PRFPUT '