Synchronize Table Descriptors in a Load Set

Use this API to synchronize all the existing table descriptors in a Load Set with the Table definition at the source. When you use this API, it performs different tasks according to the situation:

• If the API finds no changes to be synchronized, it displays a message indicating that there are no changes to the table descriptors.
• If the API finds changes to be synchronized and the Load Set definition is checked out, it synchronizes the changes and displays a message indicating that changes were identified and synchronized.
• If the API finds changes to be synchronized and the Load Set definition is checked in, then it checks out the Load Set, completes synchronization and leaves the Load Set checked out.

Table descriptors (and corresponding Table definitions) are checked out only if changes are detected. After synchronization is complete, the API returns a collection of Table descriptor objIDs and obj versions that were changed.

The API does not create a new table descriptor in the Load Set but only synchronizes the existing Table Descriptors. The updated Table Descriptor generates the same outcome as when columns are uploaded for a Table Descriptor.

Name

CDR_PUB_DF_LOADSET.SychronizeTablesWithinLS

Signature

PROCEDURE SYCHRONIZETABLESWITHINLS(
P_API_VERSION IN NUMBER,
P_INIT_MSG_LIST IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,
P_COMMIT IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,
P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL,
X_RETURN_STATUS OUT NOCOPY VARCHAR2,
X_MSG_COUNT OUT NOCOPY NUMBER,
X_MSG_DATA OUT NOCOPY VARCHAR2,
PI_NLSDEFCOMPID  IN NUMBER,
PI_NLSDEFID      IN NUMBER,
PI_VFILENAME     IN VARCHAR2,
PI_BFILEBLOB     IN BLOB,
PO_TDESCLIST     OUT NOCOPY CDR_BASE_OBJ_COLL,
PO_OUTMSG        OUT NOCOPY VARCHAR2 );

Parameters

This API has standard parameters (see Standard Parameters) and the following parameter:

• PARAM P_API_VERSION (Mandatory). Enter the current version of the API you are calling. The API compares the version numbers of incoming calls to its current version number and returns an error if they are incompatible.
• PARAM P_INIT_MSG_LIST (Optional). Accept the default value (FND_API.G_FALSE) to ensure that this individual API does not initialize the message list upon completion. Pass FND_API.G_TRUE to override the default behavior.
• PARAM P_COMMIT (Optional). Accept the default value (FND_API.G_FALSE) to ensure that this individual API does not commit upon completion. Pass FND_API.G_TRUE to override the default behavior.
• PARAM P_VALIDATION_LEVEL (Optional). Accept the default value to perform full validation. No other values are currently supported.
• PARAM X_RETURN_STATUS. This output parameter returns the end status of the API: (S) Success, (E) Error or (U) Unexpected Error
• PARAM X_MSG_COUNT. This output parameter returns the count of error messages if the return status is other than Success.
• PARAM X_MSG_DATA. If the message count is 1, this output parameter returns the text of the error message. If there are more than one message, use cdr_pub_msg_pub.get to retrieve the messages.
• PARAM PI_NLSDEFCOMPID. Enter the Company Id.
• PARAM PI_NLSDEFID. Provide the Load Set Definition Id
• PARAM PI_VFILENAME (Optional). If the Load Set is a SAS or TEXT type, provide the file name.

  For SAS—cport. xport, cprt, xprt and .sas*dat files are allowed.

  For TXT—zip and mdd files are allowed. The zip should only contain mdd files. The mdd file name should be the same as the Table Descriptor it needs to update. For other types, it can be sent as null.

• PARAM PI_BFILEBLOB (Optional). Provide the BLOB that holds the file content for SAS and TEXT Load Sets.
• PARAM PO_TDESCLIST. This list contains the table descriptors that were updated.
• PARAM PO_OUTMSG. Returns the error/confirmation messages.