This API lets the user retrieve and purge a change control log. It also allows the user to purge an open change control log.
APINCCLG can be invoked with:
CALLNAT 'APINCCLG' API-PARM #API-CCLG-PARM
| D | to retrieve a change control log. |
| P | to purge an open change control log. |
Important:
Reset the field SEL-DATE programmatically before the call is
made to APINCCLG.
This document covers the following topics:
A definition of #API-CCLG-PARM is provided in LDA UCCLCCLG.
| Field Name | Format | I/O |
|---|---|---|
| #API-CCLG-PARM | ||
| #API-CCLG-PARM-1 | A250 | |
| #API-CCLG-PARM-1 | ||
| APPLICATION | A32 | in |
| OBJECT | A8 | in |
| LIBRARY | A8 | in |
| DBID | N5 | in |
| FNR | N5 | in |
| VERSION | N4 | in |
| SEL-DATE | T | in |
| REQUEST-ID | A20 | out |
| STATUS | A32 | out |
| OUT-VERSION | N4 | out |
| OUT-LIBRARY | A8 | out |
| OUT-DBID | N5 | out |
| OUT-FNR | N5 | out |
| OUT-USERID | A8 | out |
| OUT-TIME | T | out |
| OUT-TID | A8 | out |
| IN-VERSION | N4 | out |
| IN-LIBRARY | A8 | out |
| IN-DBID | N5 | out |
| IN-FNR | N5 | out |
| IN-USERID | A8 | out |
| IN-TIME | T | out |
| IN-TID | A8 | out |
When APINCCLG is called:
#API-CCLG-PARM.APPLICATION should carry the name of the change control log's application.
#API-CCLG-PARM.OBJECT should carry the name of the object.
#API-CCLG-PARM.LIBRARY should carry the library name of the NATURAL location of the maintenance deployment.
#API-CCLG-PARM.DBID should carry the database number of the NATURAL location of the maintenance deployment.
#API-CCLG-PARM.FNR should carry the file number of the NATURAL location of the maintenance deployment.
#API-CCLG-PARM.VERSION should carry the object's version number.
If [API-PARM.API-MAIN-FUNC] = 'D' and the change control log is found then APINCCLG returns in the remaining parameter fields the change control log data including the name of the maintenance status and the name of the maintenance request (if one is associated with the log).
If [API-PARM.API-MAIN-FUNC] = 'P' and the change control log is found then APINCCLG purges it even if it is open.
APINCCLG returns the following [API-PARM.API-MSG-NO]:
| 1011 | if an [API-PARM.API-MAIN-FUNC] distinct from both 'D' and 'P' has been specified, |
| 7251 | if the application is unknown or the change control log has not been found, |
| 7255 | if the change control log has been retrieved, |
| 7256 | if the change control log has been purged. |
Other values of API-PARM.API-MSG-NO may be received in more unusual situations.