6 Checking In Objects and Setting Their Validation Status

This section contains the following topics:

• Running the Validation API

• Explicitly Checking In an Object

Checking in all objects is required.

Setting objects' validation status is optional. It does not change any behavior and the status is not visible in the user interface or to end users in any way. However, it may be useful for your internal testing and validation purposes to use this tool. In addition, the API that upgrades objects' validation status first checks in all objects and can be used to simplify that task.

The validation API checks in the object you specify in the input parameter PI_VALOBJ, and all the objects it contains (if any), and upgrades its validation status. If you specify the Adapter Domain in PI_VALOBJ, the API attempts to check in and upgrade all the objects in your adapter.

Note:

The following conditions prevent a successful validation:

• The validation of a particular object fails if the object is checked out by a user different from the person running the validation API. In this case, the person who has the object checked out must either explicitly check in the object or run the validation API.

• The validation process fails if the Work Area is included in the process (which it is if you have specified either the Adapter Domain, the Adapter Area, or the Work Area itself) and does not have a validation status of Production. Use the API CDR_PUB_DF_WORKAREA.UPDATEUSAGEINTENT to change it to Production.

Running the Validation API

To set the validation status of all the objects in your Adapter Domain to Development, Quality Control, or Production, run the API CDR_PUB_VL_VALIDATION.UPDATEVALSTATUS and provide values relating to the Adapter Domain.

Enter mandatory values or parameter PI_VALOBJ to specify your Adapter Domain:

• company_id = Enter_your_company_ID

• obj_id = Enter_your_Adapter_Domain_ID

• obj_ver = 1

• obj_type_rc = '$OBJTYPES$ADAPTERDOMAIN'

• validation_status_rc = Enter one of the following values: $SYSVALDNSTEPS$RETIRED, $SYSVALDNSTEPS$DEVELOPMENT, $SYSVALDNSTEPS$QUALITYCONTROL, $SYSVALDNSTEPS$PRODUCTION

• object)_version_number = 1

Two output parameters indicate which objects were and were not successfully upgraded:

• PO_CASCADEDOBJCOL lists the objects that were successfully upgraded

• PO_ERRORNAMINGCOLL lists the objects that could not be upgraded because they are checked out by another user

Explicitly Checking In an Object

There is a different API for checking in each type of object. You have already explicitly checked in Variables and Parameter definitions (see "Check in the Variable" and "Check in the Parameter".

You may need the following APIs:

• CDR_PUB_DF_PROGRAM.CHECKINPROGRAMDEFINITION

• CDR_PUB_DF_PARAMETER_SET.CHECKINPARAMETERSETDEFINITION

• CDR_PUB_DF_TABLE.CHECKIN

Each of these APIs has the same type of parameters:

• PIO_BASEOBJECT. Enter CDR_BASE_OBJ_TYPE values to identify the object.

  • company_id Enter your company ID; see "Getting Your Company ID".

  • obj_id Enter the object's Object ID.

  • obj_ver = 1

  • object_version_number = 1

  • namespace_obj_id Enter your Adapter Area's Object ID.

  • namespace_obj_ver = 1

• PI_COMMENT(Optional) Enter the reason you are checking in the Program.