11 Report Sets

This section contains the following topics:

• Create and Modify Report Set Entries
  
• Create and Modify Report Sets
  
• Create and Modify Overlay Template Definitions
  
• Report Set Overlay Template
  

Create and Modify Report Set Entries

This section contains the following topics:

• Create a Report Set Entry
  
• Add and Modify an Entry
  
• Copy a Report Set Entry into Another
  
• Modify a Report Set Entry
  
• Move a Report Set Entry into Another
  
• Reorder Report Set Entries in a Parent Report Set
  
• Find if a Report Set is Checked Out
  
• Check Unique and Strict Numbering in a Report Set
  
• Identify if a Report Set Contains Child Entries
  
• Find if a User has Modify Permission
  
• Remove an Object from a Report Set Entry
  
• Remove a Report Set Entry
  
• Get a Report Set Name
  
• Get a Title
  
• Get a Chapter Number
  
• Get a Parent Number
  
• Get a List of Report Set Entry Titles
  
• Get All RSE Titles in a Report Set
  
• Get Attribute Values Derived from a Parent
  
• Get the Lowest Entry Number
  
• Get the Total Number of Report Set Entries
  
• Create a Narrative
  
• Update a Narrative
  
• Delete a Narrative
  
• Check if Copying Retains Valid Numbering in a Target Report Set
  
• Check if a Move Retains Valid Numbering in a Target Report Set
  
• Check if a Move Retains Valid Numbering in the Parent Report Set
  
• Check if Removal Retains Valid Numbering in a Parent Report Set
  
• Check if Reordering Retains Valid Numbering in a Parent Report Set
  
• Unassign a Planned Output
  

Create a Report Set Entry

Use this API to create a Report Set Entry within a Report Set or another Report Set Entry.

Name

CDR_PUB_RS_REPORT_SET_ENTRY.CreateReportSetEntry

Signature

PROCEDURE CREATEREPORTSETENTRY( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PIO_SOURCECDRNAMING  IN OUT    CDR_NAMING_VERSION_OBJ_TYPE, 
  PI_CDRRSENTRY  IN OUT    CDR_RS_ENTRY_OBJ_TYPE 
); 

Parameters

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

• PIO_SOURCECDRNAMING (Mandatory) This is a parameter of table type CDR_NAMING_VERSION_OBJ_TYPE. Enter values for the new Report Set Entry. Use the NAMESPACE attributes to identify the Report Set or Report Set Entry in which you want to create the new Report Set Entry. For OBJECT_TYPE_RC enter $OBJTYPES$REPORTSETENTRY.

  The following attributes are required: COMPANY_ID,NAME,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.

• PI_CDRRSENTRY (Mandatory) This is a parameter of table type CDR_RS_ENTRY_OBJ_TYPE that contains attributes specific to Report Set Entries. Enter values for the new Report Set Entry.

  The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,ENTRY_NUMBER,POSITION,UNIQUE_NUMBERING_FLAG_RC,STRICT_NUMBERING_FLAG_RC,PRE_NARRATIVE_ID,POST_NARRATIVE_ID, OMIT_FROM_INSTALL_FLAG_RC,TITLE,DELIMITTER,PREFIX,POSTFIX, PLACEHOLDER_FLAG_RC, VOLUME_BREAK_FLAG_RC,PI_OBJ_ID,PO_COMPANY_ID,PO_OBJ_ID,ENTRY_NUMBER_FLAG_RC,PARENT_FLAG_RC,PREFIX_FLAG_RC,POSTFIX_FLAG_RC,DELIMITER_FLAG_RC.

Add and Modify an Entry

Use this API to add and/or modify one or more Report Set Entries within the same parent Report Set Entry or Report Set definition. For a new RSE to be added, the user can use any number for the OBJ_ID and OBJ_VER like 0 and a positive number.

Name

CDR_PUB_RS_REPORT_SET_ENTRY.AddNewAndModifyEntries

Signature

PROCEDURE ADDNEWANDMODIFYENTRIES( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PI_CDRRSENAMEENTRYCOLL  IN OUT    CDR_RS_ENTRY_NAME_COLL, 
  PIO_CDRRSECOLL  IN OUT    CDR_RS_ENTRY_COLL, 
  COMPANYID  IN    CDR_NAMING_VERSIONS.COMPANY_ID%TYPE, 
  NSOBJID  IN    CDR_NAMINGS.NAMESPACE_OBJ_ID%TYPE, 
  NSOBJVER  IN    CDR_NAMING_VERSIONS.OBJ_VER%TYPE, 
  OBJSUBTYPEID  IN    CDR_NAMINGS.OBJECT_SUBTYPE_ID%TYPE 
);

Parameters

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

• PI_CDRRSENAMEENTRYCOLL (Mandatory) This is a collection of CDR_RS_ENTRY_NAME_OBJs. For each Report Set Entry that you want to modify or add, initialize a CDR_RS_ENTRY_NAME_OBJ and then extend the collection.

  If you are modifying an RSE, enter its existing values.

  If you are creating a new RSE, enter 1 for OBJ_VER and enter a number for the OBJ_ID (it must be unique within the collection). The following attributes are required: NAME,ENTRY_NUMBER,OBJ_ID,OBJ_VER.

• PIO_CDRRSECOLL (Mandatory) This is a collection of CDR_RS_ENTRY_OBJ_TYPEs. For each Report Set Entry that you want to modify or add, initialize a CDR_RS_ENTRY_OBJ_TYPE (with new values for the attributes you want to change, if you are modifying existing Entries) and then extend the collection.

  The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,ENTRY_NUMBER,POSITION,UNIQUE_NUMBERING_FLAG_RC,STRICT_NUMBERING_FLAG_RC,PRE_NARRATIVE_ID,POST_NARRATIVE_ID, OMIT_FROM_INSTALL_FLAG_RC, TITLE, DELIMITTER, PREFIX, POSTFIX, PLACEHOLDER_FLAG_RC, VOLUME_BREAK_FLAG_RC,PI_OBJ_ID,PO_COMPANY_ID,PO_OBJ_ID,ENTRY_NUMBER_FLAG_RC,PARENT_FLAG_RC,PREFIX_FLAG_RC,POSTFIX_FLAG_RC,DELIMITER_FLAG_RC.

  Note:

  You must enter an single integer Entry Number for each Report Set Entry. The API does not create entry numbers for you, but it does enforce the unique and strict numbering settings for the Report Set or Report Set Entry
• COMPANYID (Mandatory) Enter your COMPANY_ID.
• NSOBJID (Mandatory) Enter the OBJ_ID of the Report Set or Report Set Entry within which you want to add or modify Report Set Entries.
• NSOBJVER (Mandatory) Enter the OBJ_VER of the Report Set or Report Set Entry within which you want to add or modify Report Set Entries.
• OBJSUBTYPEID (Optional) If you are adding or modifying top-level Report Set Entries, enter the subtype ID of the Report Set.

  If you are adding or modifying Report Set Entries contained in another Report Set Entry, leave this parameter null.

Copy a Report Set Entry into Another

Use this procedure to copy one or more Report Set Entries into another Report Set Entry. The target Report Set Entry may or may not belong to the same Report Set hierarchy.

Name

CDR_PUB_RS_REPORT_SET_ENTRY.CopyObjectsIntoReportSetEntry

Signature

PROCEDURE COPYOBJECTSINTOREPORTSETENTRY( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PIO_CDRBASEOBJCOLL  IN OUT    CDR_BASE_OBJ_COLL, 
  PIO_TARGETBASEOBJ  IN OUT    CDR_BASE_OBJ_TYPE, 
  RENUMBER  IN    VARCHAR2, 
  PI_COPYPRGASSGNMT  IN    VARCHAR2 
); 

Parameters

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

• PIO_CDRBASEOBJCOLL (Mandatory) This is a collection of CDR_BASE_OBJ_TYPEs.

  For each Report Set Entry that you want to copy into another Report Set Entry, initialize a CDR_BASE_OBJ_TYPE and then extend the collection.

  The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.

• PIO_TARGETBASEOBJ (Mandatory) This is a parameter of table type CDR_BASE_OBJ_TYPE. Enter values to identify the Report Set Entry into which you want to copy other Report Set Entries.

  The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER

• RENUMBER (Mandatory) Enter 'Y' for copied Report Set Entries to appropriately numbered in their new location.
• PI_COPYPRGASSGNMT (Mandatory) When copying Report Set Entries, enter 'Y' to copy Program instances currently assigned to the Report Set Entries, their Planned Output assignments and mappings. Enter 'N' to avoid copying these Program instances in which case, all Planned Output assignments are lost.

Modify a Report Set Entry

Use this API to modify a Report Set Entry.

Name

CDR_PUB_RS_REPORT_SET_ENTRY.ModifyReportSetEntry

Signature

PROCEDURE MODIFYREPORTSETENTRY( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PIO_SOURCECDRNAMING  IN OUT    CDR_NAMING_VERSION_OBJ_TYPE, 
  PI_CDRRSENTRY  IN OUT    CDR_RS_ENTRY_OBJ_TYPE 
); 

Parameters

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

• PIO_SOURCECDRNAMING (Mandatory) This is a parameter of table type CDR_NAMING_VERSIONS_OBJ_TYPE that contains CDR Naming Version attributes. Enter values to identify the Report Set Entry that you want modify and enter new values for the attributes you want to modify. You can change the name and description. All attributes are required.
• PI_CDRRSENTRY (Mandatory) This is a parameter of table type CDR_RS_ENTRY_OBJ_TYPE. Enter values to identify the Report Set Entry that you want to modify and enter new values for the attributes you want to modify. You can change the Entry and Position numbers, the Strict and Unique Numbering flags, the Omit from Install flag, the Title, Delimiter, Prefix, Postfix, Placeholder flag and Volume Break flag values. All attributes are required.

Move a Report Set Entry into Another

Use this API to move one or more Report Set Entries into another Report Set Entry.

Name

CDR_PUB_RS_REPORT_SET_ENTRY.MoveObjectsIntoReportSetEntry

Signature

PROCEDURE MOVEOBJECTSINTOREPORTSETENTRY( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PIO_CDRBASEOBJCOLL  IN OUT    CDR_BASE_OBJ_COLL, 
  PIO_TARGETBASEOBJ  IN OUT    CDR_BASE_OBJ_TYPE, 
  RENUMBER  IN    VARCHAR2 
);

Parameters

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

• PIO_CDRBASEOBJCOLL (Mandatory) This is a collection of CDR_BASE_OBJ_TYPEs. For each Report Set Entry that you want to move, initialize a CDR_BASE_OBJ_TYPE and then extend the collection.

  The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.

• PIO_TARGETBASEOBJ (Mandatory) This is a parameter of table type CDR_BASE_OBJ_TYPE. Enter values to identify the Report Set or Report Set Entry into which you want to move Report Set Entries.

  The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.

• RENUMBER Enter either TRUE or FALSE. When you move a Report Set Entry, the API determines whether or not the numbering of the target Report Set or Report Set Entry is still valid.

  If you enter TRUE, the API automatically renumbers the target to make its numbering valid.

  If you enter FALSE, the copy operation fails if it creates invalid numbering.

Reorder Report Set Entries in a Parent Report Set

Use this API to change the order of Report Set Entries within a parent Report Set or Report Set Entry.

Name

CDR_PUB_RS_REPORT_SET_ENTRY.ReorderReportSetEntry

Signature

PROCEDURE REORDERREPORTSETENTRY( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PI_REORDERCOLL  IN OUT    CDR_REORDER_OBJ_COLL 
);

Parameters

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

PI_REORDERCOLL (Mandatory) Initialize a CDR_REORDER_OBJ_TYPE for each child Report Set Entry in the same parent Report Set or Report Set Entry, including the correct new Position and Entry Number, in the correct new order, and then extend the collection.

The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER,POSITION,ENTRY_NUMBER,OBJECT_VERSION_NUMBER.

Find if a Report Set is Checked Out

Use this API to determine whether or not the Report Set is currently checked out. The API returns $YESNO$YES if it is checked out and $YESNO$NO if it is not checked out.

Name

CDR_PUB_RS_REPORT_SET_ENTRY.GetRSCheckOutFlagRC

Signature

FUNCTION GETRSCHECKOUTFLAGRC( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  PI_COMPANYID  IN    CDR_NAMINGS.COMPANY_ID%TYPE, 
  PI_OBJID  IN    CDR_NAMINGS.OBJ_ID%TYPE 
) RETURN CDR_NAMINGS.CHECKED_OUT_FLAG_RC%TYPE; 

Return

CDR_NAMINGS.CHECKED_OUT_FLAG_RC%TYPE Description varchar, returns '$YESNO$YES' or '$YESNO$NO'

Parameters

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

• PI_COMPANYID (Mandatory) Enter the COMPANY_ID of the Report Set Entry.
• PI_OBJID (Mandatory) Enter the OBJ_ID of the Report Set Entry.

Check Unique and Strict Numbering in a Report Set

Use this API to check whether a Report Set's Entries conform to the rules you specify for unique and strict numbering.

Name

CDR_PUB_RS_REPORT_SET_ENTRY.IsValidChildrenRSEntries

Signature

FUNCTION ISVALIDCHILDRENRSENTRIES( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  COMPANYID  IN    CDR_NAMINGS.COMPANY_ID%TYPE, 
  OBJID  IN    CDR_NAMINGS.OBJ_ID%TYPE, 
  OBJVER  IN    CDR_NAMING_VERSIONS.OBJ_VER%TYPE, 
  UNIQUEFLAG  IN    CDR_RS_ENTRIES.UNIQUE_NUMBERING_FLAG_RC%TYPE, 
  STRICTFLAG  IN    CDR_RS_ENTRIES.STRICT_NUMBERING_FLAG_RC%TYPE 
) RETURN VARCHAR2; 

Return

Type VARCHAR2

Description varchar2 true or false

Parameters

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

• COMPANYID Enter the Company ID of the Report Set.
• OBJID Enter the object ID of the Report Set.
• OBJVER Enter the object version of the Report Set.
• UNIQUEFLAG Enter Y to validate the Report Set's numbering for uniqueness. Enter N to allow non-unique Report Set Entry numbers within the Report Set.
• STRICTFLAG Enter Y to validate the Report Set for strictly sequential numbering, with no gaps allowed. Enter N to allow gaps in numbering between sibling Report Set Entries within the Report Set.

Identify if a Report Set Contains Child Entries

Use this API to determine whether or not a Report Set or Report Set Entry contains child Report Set Entries.

Name

CDR_PUB_RS_REPORT_SET_ENTRY.HasChildren

Signature

FUNCTION HASCHILDREN( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  PI_COMPANYID  IN    CDR_NAMINGS.COMPANY_ID%TYPE, 
  PI_NS_OBJID  IN    CDR_NAMINGS.OBJ_ID%TYPE, 
  PI_NS_OBJVER  IN    CDR_NAMING_VERSIONS.OBJ_VER%TYPE 
) RETURN VARCHAR2; 

Return

Type VARCHAR2

Description varchar Y or N depending on if the RS has children or not.

Parameters

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

• PI_COMPANYID (Mandatory) Enter the COMPANY_ID of the Report Set or Report Set Entry.
• PI_NS_OBJID (Mandatory) Enter the OBJ_ID of the Report Set or Report Set Entry.
• PI_NS_OBJVER (Mandatory) Enter the OBJ_VER of the Report Set or Report Set Entry.

Find if a User has Modify Permission

Use this API to determine whether or not you (the current user) have permission to modify a particular Report Set Entry. This API takes into consideration the validation status of the Report Set or RSE and whether you have the RS Modify privilege, the RS Modify QC privilege, the RS Modify Production privilege, or none of these privileges.

Name

CDR_PUB_RS_REPORT_SET_ENTRY.HasReportModPermission

Signature

FUNCTION HASREPORTMODPERMISSION( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  PI_COMPANYID  IN    CDR_NAMINGS.COMPANY_ID%TYPE, 
  PI_OBJID  IN    CDR_NAMINGS.OBJ_ID%TYPE, 
  PI_OBJVER  IN    CDR_NAMING_VERSIONS.OBJ_VER%TYPE, 
  RAISEEXECPTION  IN    VARCHAR2 := 'N' 
) RETURN VARCHAR2; 

Return

Type VARCHAR2

Description varchar2

Parameters

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

• PI_COMPANYID (Mandatory) Enter the COMPANY_ID of the Report Set Entry.
• PI_OBJID (Mandatory) Enter the OBJ_ID of the Report Set Entry.
• PI_OBJVER (Mandatory) Enter the OBJ_VER of the Report Set Entry.
• RAISEEXECPTION If you enter Y here and you do not have the required privileges to modify the Report Set Entry, the API raises an exception.

  If you enter N, the API tests for different conditions.

  If you do not have the required privileges to modify the RSE, the API returns N irrespective of the RSE's validation status.

  If the RSE's validation status is Development, the API returns Y if you have modify privileges on the RSE and N if you do not.

  If the RSE's validation status is QC or Production, the API checks if you have Modify QC or Modify Production, respectively.

  If you do not have the privilege required to modify an RSE of the current validation status, the API returns VIRTUAL_LOCK.

  However, you may be able to modify other RSEs in the same Report Set.

Remove an Object from a Report Set Entry

Use this API to remove one or more Report Set Entries from a Report Set or parent Report Set Entry.

Name

CDR_PUB_RS_REPORT_SET_ENTRY.RemoveObjectsFromRSEntries

Signature

PROCEDURE REMOVEOBJECTSFROMRSENTRIES( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PIO_CDRBASEOBJCOLL  IN OUT    CDR_BASE_OBJ_COLL, 
  RENUMBER  IN    VARCHAR2 
); 

Parameters

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

• PIO_CDRBASEOBJCOLL (Mandatory) This is a collection of CDR_BASE_OBJ_TYPEs. For each Report Set Entry that you want to copy, initialize a CDR_BASE_OBJ_TYPE and then extend the collection.

  The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.

• RENUMBER Enter either TRUE or FALSE. When you remove a Report Set Entry, the API determines whether or not the numbering of the parent Report Set or Report Set Entry is still valid. If you enter TRUE, the API automatically renumbers the target to make its numbering valid. If you enter FALSE, the Remove operation fails if it creates invalid numbering.

Remove a Report Set Entry

Use this API to remove a Report Set Entry from a Report Set. If the removal of the RSE causes invalid numbering in the remaining RSEs, the API generates an error.

Name

CDR_PUB_RS_REPORT_SET_ENTRY.RemoveReportSetEntry

Signature

PROCEDURE REMOVEREPORTSETENTRY( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PIO_CDRBASEOBJ  IN OUT    CDR_BASE_OBJ_TYPE 
);

Parameters

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

PI_CDRBASEOBJ (Mandatory) This is a parameter of table type CDR_BASE_OBJ_TYPE. Enter values to identify the Report Set Entry from which you want to unassign the Planned Output.

The following attributes are required: COMPANY_ID, OBJ_ID AND OBJ_VER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER, OBJECT_VERSION_NUMBER.

Get a Report Set Name

Use this API to get the name of the Report Set you specify.

Name

CDR_PUB_RS_REPORT_SET_ENTRY.GetReportSetName

Signature

FUNCTION GETREPORTSETNAME( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  PI_COMPANYID  IN    CDR_NAMINGS.COMPANY_ID%TYPE, 
  PI_OBJID  IN    CDR_NAMINGS.OBJ_ID%TYPE 
) RETURN CDR_NAMINGS.NAME%TYPE; 

Return

Type CDR_NAMINGS.NAME%TYPE

Description varchar Name of the RS

Parameters

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

• PI_COMPANYID (Mandatory) Enter the Company ID of the Report Set.
• PI_OBJID (Mandatory) Enter the Object ID of the Report Set.

Get a Title

Use this API to get the full title of a Report Set or Report Set Entry. If you do not specify a version, the API returns the value for the most recent version.

Name

CDR_PUB_RS_REPORT_SET_ENTRY.GetTitle

Signature

FUNCTION GETTITLE( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  PI_COMPANYID  IN    CDR_NAMINGS.COMPANY_ID%TYPE, 
  PI_OBJID  IN    CDR_NAMINGS.OBJ_ID%TYPE, 
  PI_OBJVER  IN    CDR_NAMING_VERSIONS.OBJ_VER%TYPE 
) RETURN VARCHAR2; 

Return

Type VARCHAR2

Parameters

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

• PI_COMPANYID (Mandatory) Enter the COMPANY_ID of the Report Set Entry.
• PI_OBJID (Mandatory) Enter the OBJ_ID of the Report Set Entry.
• PI_OBJVER (Mandatory) Enter the OBJ_VER of the Report Set Entry.

Get a Chapter Number

Use this API to get the chapter number of a Report Set Entry.

Name

CDR_PUB_RS_REPORT_SET_ENTRY.GetChapterNumber

Signature

FUNCTION GETCHAPTERNUMBER( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  PI_COMPANYID  IN    CDR_NAMINGS.COMPANY_ID%TYPE, 
  PI_OBJID  IN    CDR_NAMINGS.OBJ_ID%TYPE, 
  PI_OBJVER  IN    CDR_NAMING_VERSIONS.OBJ_VER%TYPE 
) RETURN VARCHAR2; 

Return

Type VARCHAR2

Description varchar returns the chapter number of the reportset entry

Parameters

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

• PI_COMPANYID (Mandatory) Enter the COMPANY_ID of the Report Set Entry.
• PI_OBJID (Mandatory) Enter the OBJ_ID of the Report Set Entry.
• PI_OBJVER (Mandatory) Enter the OBJ_VER of the Report Set Entry.

Get a Parent Number

Use this API to get the chapter number of the parent Report Set Entry of the RSE you specify. If the parent is the Report Set itself, the API returns Null.

Name

CDR_PUB_RS_REPORT_SET_ENTRY.GetParentNumber

Signature

FUNCTION GETPARENTNUMBER( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  PI_COMPANYID  IN    CDR_NAMINGS.COMPANY_ID%TYPE, 
  PI_OBJID  IN    CDR_NAMINGS.OBJ_ID%TYPE, 
  PI_OBJVER  IN    CDR_NAMING_VERSIONS.OBJ_VER%TYPE 
) RETURN VARCHAR2; 

Return

Type VARCHAR2

Description varchar returns the parent number of the object

Parameters

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

• PI_COMPANYID (Mandatory) Enter the COMPANY_ID of the Report Set Entry.
• PI_OBJID (Mandatory) Enter the OBJ_ID of the Report Set Entry.
• PI_OBJVER (Mandatory) Enter the OBJ_VER of the Report Set Entry.

Get a List of Report Set Entry Titles

Use this API to get a list of the full titles and version numbers of all the RSEs in a direct path to a particular Report Set Entry, from the top of the Report Set down to the Report Set Entry you specify.

Name

CDR_PUB_RS_REPORT_SET_ENTRY.TopDownListOfRSetitles

Signature

FUNCTION TOPDOWNLISTOFRSETITLES( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  PI_NCOMPANYID  IN    CDR_NAMINGS.COMPANY_ID%TYPE, 
  PI_NRSEOBJID  IN    CDR_NAMINGS.OBJ_ID%TYPE, 
  PI_NRSEOBJVER  IN    CDR_NAMING_VERSIONS.OBJ_VER%TYPE, 
  PI_NRSOBJID  IN    CDR_NAMINGS.OBJ_ID%TYPE, 
  PI_NRSOBJVER  IN    CDR_NAMING_VERSIONS.OBJ_VER%TYPE 
) RETURN CDR_VALS_COLL; 

Return

Type CDR_VALS_COLL

Description CDR_VALS_COLL returns the list of RSE titles top down

Parameters

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

• PI_NCOMPANYID (Mandatory) Enter the COMPANY_ID of the Report Set Entry.
• PI_NCOMPANYID (Mandatory) Enter the OBJ_ID of the Report Set Entry.
• PI_NRSEOBJID (Mandatory) Enter the OBJ_ID of the Report Set Entry.
• PI_NRSOBJID (Mandatory) Enter the OBJ_ID of the parent Report Set.
• PI_NRSOBJVER (Mandatory) Enter the OBJ_VER of the Report Set Entry.

Get All RSE Titles in a Report Set

Use this API to get a list of the full titles of all the RSEs in a Report Set from the top down.

Name

CDR_PUB_RS_REPORT_SET_ENTRY.TopDownListOfRSeTitles

Signature

FUNCTION TOPDOWNLISTOFRSETITLES( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  PI_COMPANYID  IN    CDR_NAMINGS.COMPANY_ID%TYPE, 
  PI_OBJID  IN    CDR_NAMINGS.OBJ_ID%TYPE, 
  PI_OBJVER  IN    CDR_NAMING_VERSIONS.OBJ_VER%TYPE 
) RETURN CDR_VALS_COLL; 

Return

Type CDR_VALS_COLL

Parameters

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

• PI_COMPANYID (Mandatory) Enter the COMPANY_ID of the Report Set Entry.
• PI_OBJID (Mandatory) Enter the OBJ_ID of the Report Set Entry.
• PI_OBJVER (Mandatory) Enter the OBJ_VER of the Report Set Entry.

Get Attribute Values Derived from a Parent

Use this API to retrieve attribute values for a Report Set Entry that are derived from its parent Report Set or Report Set Entry, including those that are dynamically derived and those that are derived only when the child Report Set Entry is initially created.

Name

CDR_PUB_RS_REPORT_SET_ENTRY.GetDerivedAttrValuesFromParent

Signature

PROCEDURE GETDERIVEDATTRVALUESFROMPARENT( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PI_COMPANY_ID  IN    CDR_NAMINGS.COMPANY_ID%TYPE, 
  PI_NAMESPACE_OBJ_ID  IN    CDR_NAMINGS.NAMESPACE_OBJ_ID%TYPE, 
  PI_NAMESPACE_OBJ_VER  IN    CDR_NAMING_VERSIONS.NAMESPACE_START_OBJ_VER%TYPE, 
  PI_CDRRSENTRY  IN OUT    CDR_RS_ENTRY_OBJ_TYPE, 
  PI_PARENT_NUMBER  OUT    VARCHAR2 
); 

Parameters

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

• PI_COMPANY_ID (Mandatory) Enter the COMPANY_ID of the parent Report Set or Report Set Entry.
• PI_NAMESPACE_OBJ_ID (Mandatory) Enter the OBJ_ID of the Report Set or Report Set Entry.
• PI_NAMESPACE_OBJ_VER (Mandatory) Enter the OBJ_VER of the parent Report Set or Report Set Entry.
• PI_CDRRSENTRY (Mandatory) This is a parameter of table type CDR_RS_ENTRY_OBJ_TYPE that contains attributes specific to Report Set Entries. Enter values to identify the Report Set Entry for which you want to retrieve inherited attributes.
• PI_PARENT_NUMBER This output parameter returns the chapter number of the parent Report Set Entry.

  If the parent is the Report Set itself, the parameter returns NULL.

Get the Lowest Entry Number

Use this API to get the number of the lowest numbered child Report Set Entry in the Report Set or RSE you specify.

Name

CDR_PUB_RS_REPORT_SET_ENTRY.GetMinEntryNumber

Signature

FUNCTION GETMINENTRYNUMBER( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  PI_COMPANY_ID  IN    CDR_NAMINGS.COMPANY_ID%TYPE, 
  PI_NAMESPACE_OBJ_ID  IN    CDR_NAMINGS.NAMESPACE_OBJ_ID%TYPE, 
  PI_NAMESPACE_OBJ_VER  IN    CDR_NAMING_VERSIONS.NAMESPACE_START_OBJ_VER%TYPE 
) RETURN CDR_RS_ENTRIES.ENTRY_NUMBER%TYPE; 

Return

Type CDR_RS_ENTRIES.ENTRY_NUMBER%TYPE

Parameters

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

• PI_COMPANY_ID (Mandatory) Enter the COMPANY_ID of the Report Set or Report Set Entry.
• PI_NAMESPACE_OBJ_ID (Mandatory) Enter the OBJ_ID of the Report Set.
• PI_NAMESPACE_OBJ_VER (Mandatory) Enter the OBJ_VER of the Report Set.

Get the Total Number of Report Set Entries

Use this API to get the number of the highest numbered child Report Set Entry in the Report Set or RSE you specify.

Name

CDR_PUB_RS_REPORT_SET_ENTRY.GetMaxEntryNumber

Signature

FUNCTION GETMAXENTRYNUMBER( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  PI_COMPANY_ID  IN    CDR_NAMINGS.COMPANY_ID%TYPE, 
  PI_NAMESPACE_OBJ_ID  IN    CDR_NAMINGS.NAMESPACE_OBJ_ID%TYPE, 
  PI_NAMESPACE_OBJ_VER  IN    CDR_NAMING_VERSIONS.NAMESPACE_START_OBJ_VER%TYPE 
) RETURN CDR_RS_ENTRIES.ENTRY_NUMBER%TYPE; 

Return

Type CDR_RS_ENTRIES.ENTRY_NUMBER%TYPE

Parameters

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

• PI_COMPANY_ID (Mandatory) Enter the COMPANY_ID of the Report Set.
• PI_NAMESPACE_OBJ_ID (Mandatory) Enter the OBJ_ID of the Report Set.
• PI_NAMESPACE_OBJ_VER (Mandatory) Enter the OBJ_VER of the Report Set.

Create a Narrative

Use this API to create a narrative for an existing Report Set Entry.

Name

CDR_PUB_RS_REPORT_SET_ENTRY.CreateNarrative

Signature

PROCEDURE CREATENARRATIVE( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PI_CDRRSENARRATIVE  IN OUT    CDR_RSE_NARRATIVE_OBJ_TYPE, 
  PIO_BASEOBJECT  IN OUT    CDR_BASE_OBJ_TYPE 
); 

Parameters

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

• PI_CDRRSENARRATIVE (Mandatory) This is a parameter of type CDR_RSE_NARRATIVE_OBJ_TYPE that contains details of the narrative to be added.

  The following attributes are required: COMPANY_ID, NARRATIVE_MODE(PRE/POST),NARRATIVE_TEXT,NARRATIVE_TYPE(TEXT or TEXT/PLAIN),FILE_NAME.

• PIO_BASEOBJECT (Mandatory) This is a parameter of table type CDR_BASE_OBJ_TYPE. Enter values to identify the Report Set Entry to which you want to create a Narrative.

  The following attributes are required: COMPANY_ID, OBJ_ID AND OBJ_VER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER, OBJECT_VERSION_NUMBER.

Update a Narrative

Use this API to update a narrative for an existing Report Set Entry.

Name

CDR_PUB_RS_REPORT_SET_ENTRY.UpdateNarrative

Signature

PROCEDURE UPDATENARRATIVE( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PI_CDRRSENARRATIVE  IN OUT    CDR_RSE_NARRATIVE_OBJ_TYPE, 
  PIO_BASEOBJECT  IN OUT    CDR_BASE_OBJ_TYPE 
); 

Parameters

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

• PI_CDRRSENARRATIVE (Mandatory) This is a parameter of type CDR_RSE_NARRATIVE_OBJ_TYPE that contains details of the narrative to be updated.

  The following attributes are required: COMPANY_ID, NARRATIVE_MODE(PRE/POST),NARRATIVE_TEXT,NARRATIVE_TYPE(TEXT or TEXT/PLAIN),FILE_NAME.

• PIO_BASEOBJECT (Mandatory) This is a parameter of table type CDR_BASE_OBJ_TYPE. Enter values to identify the Report Set Entry from which you want to update a narrative.

  The following attributes are required: COMPANY_ID, OBJ_ID AND OBJ_VER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER, OBJECT_VERSION_NUMBER.

Delete a Narrative

Use this API to delete a narrative for an existing Report Set Entry.

Name

CDR_PUB_RS_REPORT_SET_ENTRY.DeleteNarrative

Signature

PROCEDURE DELETENARRATIVE( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PI_CDRRSENARRATIVE  IN OUT    CDR_RSE_NARRATIVE_OBJ_TYPE, 
  PIO_BASEOBJECT  IN OUT    CDR_BASE_OBJ_TYPE 
); 

Parameters

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

• PI_CDRRSENARRATIVE (Mandatory) This is a parameter of type CDR_RSE_NARRATIVE_OBJ_TYPE that contains details of the narrative to be deleted.

  The following attributes are required: COMPANY_ID, NARRATIVE_MODE(PRE/POST).

• PIO_BASEOBJECT (Mandatory) This is a parameter of table type CDR_BASE_OBJ_TYPE. Enter values to identify the Report Set Entry from which you want to delete a narrative.

  The following attributes are required: COMPANY_ID, OBJ_ID AND OBJ_VER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER, OBJECT_VERSION_NUMBER.

Check if Copying Retains Valid Numbering in a Target Report Set

Use this API to determine whether copying a given set of Report Set Entries into another Report Set or Report Set Entry would result in invalid numbering in the target RS or RSE.

Name

CDR_PUB_RS_REPORT_SET_ENTRY.ValidateCopyRSEList

Signature

FUNCTION VALIDATECOPYRSELIST( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  PIO_CDRBASEOBJCOLL  IN    CDR_BASE_OBJ_COLL, 
  PIO_TARGETBASEOBJ  IN    CDR_BASE_OBJ_TYPE 
) RETURN VARCHAR2; 

Return

Type VARCHAR2

Description varchar2 success or failure

Parameters

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

• PIO_CDRBASEOBJCOLL (Mandatory) This is a collection of CDR_BASE_OBJ_TYPEs. For each Report Set Entry that you want to copy, initialize a CDR_BASE_OBJ_TYPE and then extend the collection.

  The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.

• PIO_TARGETBASEOBJ (Mandatory) This is a parameter of table type CDR_BASE_OBJ_TYPE. Enter values to identify the Report Set or Report Set Entry into which you want to copy Report Set Entries.

  The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.

Check if a Move Retains Valid Numbering in a Target Report Set

Use this API to determine whether moving a given set of Report Set Entries into another Report Set or Report Set Entry would result in invalid numbering in the target RS or RSE. The API returns TRUE if the numbering will remain valid or FALSE if the numbering will become invalid.

Name

CDR_PUB_RS_REPORT_SET_ENTRY.ValidateMoveIntoRSEList

Signature

FUNCTION VALIDATEMOVEINTORSELIST( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  PIO_CDRBASEOBJCOLL  IN    CDR_BASE_OBJ_COLL, 
  PIO_TARGETBASEOBJ  IN    CDR_BASE_OBJ_TYPE 
) RETURN VARCHAR2; 

Return

Type VARCHAR2

Description varchar2 success or failure

Parameters

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

• PIO_CDRBASEOBJCOLL (Mandatory) This is a collection of CDR_BASE_OBJ_TYPEs. For each Report Set Entry that you want to copy, initialize a CDR_BASE_OBJ_TYPE and then extend the collection.

  The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.

• PIO_TARGETBASEOBJ (Mandatory) This is a parameter of table type CDR_BASE_OBJ_TYPE. Enter values to identify the Report Set or Report Set Entry into which you want to copy Report Set Entries.

  The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.

Check if a Move Retains Valid Numbering in the Parent Report Set

Use this API to determine whether moving a given set of Report Set Entries out of its parent Report Set or RSE would result in invalid numbering in the parent RS or RSE.

Name

CDR_PUB_RS_REPORT_SET_ENTRY.ValidateMoveFromRSEList

Signature

FUNCTION VALIDATEMOVEFROMRSELIST( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  PIO_CDRBASEOBJCOLL  IN    CDR_BASE_OBJ_COLL 
) RETURN VARCHAR2; 

Return

Type VARCHAR2

Description varchar2 success or failure

Parameters

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

PIO_CDRBASEOBJCOLL (Mandatory) This is a collection of CDR_BASE_OBJ_TYPEs. For each Report Set Entry that you want to copy, initialize a CDR_BASE_OBJ_TYPE and then extend the collection.

The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.

Check if Removal Retains Valid Numbering in a Parent Report Set

Use this API to determine whether removing a given set of Report Set Entries would result in invalid numbering in the parent RS or RSE.

Name

CDR_PUB_RS_REPORT_SET_ENTRYCDR_PUB_RS_REPORT_SET_ENTRY.ValidateRemoveRSEList

Signature

FUNCTION VALIDATEREMOVERSELIST( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  PIO_CDRBASEOBJCOLL  IN    CDR_BASE_OBJ_COLL 
) RETURN VARCHAR2; 

Return

Type VARCHAR2

Description varchar2 success or failure

Parameters

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

PIO_CDRBASEOBJCOLL (Mandatory) This is a collection of CDR_BASE_OBJ_TYPEs. For each Report Set Entry that you want to copy, initialize a CDR_BASE_OBJ_TYPE and then extend the collection.

The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.

Check if Reordering Retains Valid Numbering in a Parent Report Set

Use this API to determine whether reordering a collection of Report Set Entries would result in invalid numbering in the parent RS or RSE. To actually reorder the RSEs use ReorderReportSetEntry.

Name

CDR_PUB_RS_REPORT_SET_ENTRY.ValidateReorderList

Signature

FUNCTION VALIDATEREORDERLIST( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  REORDERCOLL  IN    CDR_REORDER_OBJ_COLL 
) RETURN VARCHAR2 

Return

Type VARCHAR2

Description varchar2 success or failure

Parameters

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

REORDERCOLL Initialize a CDR_REORDER_OBJ_TYPE for each child Report Set Entry in the same parent Report Set or Report Set Entry, including the correct new position and Entry Number, in the correct new order, and then extend the collection. All the attributes are mandatory.

Unassign a Planned Output

Use this API to unassign a Planned Output from a Report Set Entry.

Name

CDR_PUB_RS_REPORT_SET_ENTRY.RemovePOAssignment

Signature

PROCEDURE REMOVEPOASSIGNMENT( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PI_CDRBASEOBJ  IN    CDR_BASE_OBJ_TYPE 
); 

Parameters

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

PI_CDRBASEOBJ (Mandatory) This is a parameter of table type CDR_BASE_OBJ_TYPE. Enter values to identify the Report Set Entry from which you want to unassign the Planned Output.

The following attributes are required: COMPANY_ID, OBJ_ID AND OBJ_VER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER, OBJECT_VERSION_NUMBER.

Create and Modify Report Sets

This is a public interface for all functions related to Report Sets.

This section contains the following topics:

• Create a Report Set
  
• Check Out a Report Set
  
• Undo a Report Set Checkout
  
• Copy Objects Into a Report Set
  
• Get a Summary Output Validation Status
  
• Modify a Report Set
  
• Move Objects into a Report Set
  
• Remove Objects from a Report Set
  
• Check In a Report Set
  
• Remove a Report Set Definition
  
• Remove a Report Set
  

Create a Report Set

Use this API to create a new Report Set definition only, a new instance of an existing Report Set definition, or a new definition and an instance of it.

Name

CDR_PUB_RS_REPORT_SET.CreateReportSet

Signature

PROCEDURE CREATEREPORTSET( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PIO_SOURCECDRNAMING  IN OUT    CDR_NAMING_VERSION_OBJ_TYPE, 
  PI_REPORTSET  IN    CDR_REPORT_SET_OBJ_TYPE,
  PI_CREATEOBJECT  IN    VARCHAR2, 
  PI_INSTANCE_SUBTYPE_ID  IN    CDR_NAMINGS.OBJECT_SUBTYPE_ID%TYPE, 
  PI_DEFCLASSIFICATIONCOLL  IN    CDR_CLASSIFICATIONS_COLL, 
  PI_INSTCLASSIFICATIONCOLL  IN    CDR_CLASSIFICATIONS_COLL 
);

Parameters

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

• PIO_SOURCECDRNAMING (Mandatory) This is a parameter of table type CDR_NAMING_VERSION_OBJ_TYPE. Enter values for the new Report Set Entry. Use the NAMESPACE attributes to identify the Report Set or Report Set Entry in which you want to create the new Report Set Entry. For OBJECT_TYPE_RC enter $OBJTYPES$REPORTSETENTRY.

  The following attributes are required: COMPANY_ID,NAME,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.

• PI_REPORTSET (Mandatory) This is a parameter of table type CDR_REPORT_SET_OBJ_TYPE.

  Enter values for the Report Set definition you want to create.

  If you are creating an instance of an existing definition, enter values to identify the definition you want to create an instance of. The following attributes are required: UNIQUE_NUMBERING_FLAG_RC,STRICT_NUMBERING_FLAG_RC.

• PI_CREATEOBJECT (Mandatory) Enter DEFN to create a definition only; INST to create a instance of an existing definition; or BOTH to create a new definition and an instance of it.
• PI_INSTANCE_SUBTYPE_ID (Optional) If you are creating a new instance, enter the ID for the subtype you want to give the instance.

  If you are creating a definition only, do not enter a value for this parameter.

• PI_DEFCLASSIFICATIONCOLL (Optional) By default the new definition is classified according to the subtype you assigned it in the CDR_NAMING_VERSION_OBJ_TYPE.

  If you want to override the default classifications for one or more classification levels, use this parameter. This is a collection of CDR_CLA_OBJ_TYPEs, which have 5 attributes, including CLA_LEVEL_ID and CLASSIFICATION_ID.

  If you want the definition to inherit its classifications for a particular level from its parent, enter the classification level ID and, for the CLASSIFICATION_ID, enter 0 (zero).

  If you want to explicitly assign one or more terms for a particular level, initialize a CDR_CLA_OBJ_TYPE for each term, entering the classification level ID and, for the CLASSIFICATION_ID, the term ID. The PAR_ attributes are not relevant to Report Sets. Do not enter any values for them. If you are not creating a new definition, do not enter values here.

• PI_INSTCLASSIFICATIONCOLL (Optional) By default the new instance is classified according to the subtype you assigned it in the PI_INSTANCE_SUBTYPE_ID.

  If you want to override the default classifications for one or more classification levels, use this parameter. This is a collection of CDR_CLA_OBJ_TYPEs, which have 5 attributes, including CLA_LEVEL_ID and CLASSIFICATION_ID.

  If you want the instance to inherit its classifications for a particular level from its parent Work Area, enter the classification level ID and, for the CLASSIFICATION_ID, enter 0 (zero).

  If you want to explicitly assign one or more terms for a particular level, initialize a CDR_CLA_OBJ_TYPE for each term, entering the classification level ID and, for the CLASSIFICATION_ID, the term ID. The PAR_ attributes are not relevant to Report Sets. Do not enter any values for them. If you are not creating a new instance, do not enter values here.

Check Out a Report Set

Use this API to check out a Report Set definition.

Name

CDR_PUB_RS_REPORT_SET.CheckOutReportSet

Signature

PROCEDURE CHECKOUTREPORTSET( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PIO_CDRREPORTSET  IN OUT    CDR_BASE_OBJ_TYPE, 
  PI_COMMENT  IN    VARCHAR2, 
  PI_ISINSTONLY  IN    VARCHAR2, 
  PI_OPTYPE  IN    VARCHAR2 
); 

Parameters

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

• PI_CDRREPORTSET (Mandatory) This is a parameter of table type CDR_BASE_OBJ_TYPE. Enter values to identify the Report Set definition that you want to check in.

  The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.

• PI_COMMENT (Optional) Enter the reason you are checking in the Report Set definition.
• PI_ISINSTONLY (Mandatory) Enter $YESNO$NO
• PI_OPTYPE (Mandatory) Set to NULL.

Undo a Report Set Checkout

Use this API to undo the checkout of a Report Set definition, discarding any changes that have been made.

Name

CDR_PUB_RS_REPORT_SET.UncheckOutReportSetDef

Signature

PROCEDURE UNCHECKOUTREPORTSETDEF( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PIO_CDRREPORTSET  IN OUT    CDR_BASE_OBJ_TYPE 
);

Parameters

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

PIO_CDRREPORTSET (Mandatory) This is a collection of CDR_BASE_OBJ_TYPEs. For each Report Set that you want to remove, initialize a CDR_BASE_OBJ_TYPE and then extend the collection.

The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.

Copy Objects Into a Report Set

Use this API to copy one or more Report Set Entries and Program instances into a Report Set definition. You may specify a Report Set instance into which you want to copy the Report Set Entries. In that case, the system copies the Report Set Entries into the Report Set definition that the Report Set instance references and the Report Set instance you specify is upgraded to point to the new version of the Report Set definition.

Name

CDR_PUB_RS_REPORT_SET.CopyObjectsIntoReportSet

Signature

PROCEDURE COPYOBJECTSINTOREPORTSET( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PI_CDRBASEOBJECTCOLL  IN OUT    CDR_BASE_OBJ_COLL, 
  PI_CDRTARGETCONTAINEROBJECT  IN OUT    CDR_BASE_OBJ_TYPE, 
  PI_CHECKINFLAG  IN    VARCHAR2, 
  PI_COPYPRGASSGNMT  IN    VARCHAR2 
);

Parameters

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

• PI_CDRBASEOBJECTCOLL (Mandatory) This is a collection of cdr_base_obj_type that is used to describe the Report Set Entries you want to copy.

  Enter values for attributes COMPANY_ID, OBJ_ID, OBJ_VER, NAMESPACE_OBJ_ID, NAMESPACE_OBJ_VER, AND OBJECT_VERSION_NUMBER for each RSE you want to copy. All children, grandchildren, etc. RSEs of the RSEs you specify are included in the Copy operation.

  Enter COMPANY_ID, OBJ_ID AND OBJ_VER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER, OBJECT_VERSION_NUMBER for each RSE

• PI_CDRTARGETCONTAINEROBJECT (Mandatory) This is a parameter of table type CDR_BASE_OBJ_TYPE. Enter values to identify the Report Set into which you want to copy the specified Report Set Entries.

  The following attributes are required: COMPANY_ID, OBJ_ID AND OBJ_VER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER, OBJECT_VERSION_NUMBER of target Report Set Definition.

• PI_CHECKINFLAG (Mandatory) Enter 'Y' so that the copied Report Set Entries are appropriately numbered in their new location.
• PI_COPYPRGASSGNMT (Mandatory) Enter 'Y' to copy any Program instances currently assigned to the Report Set Entries to be copied, with their Planned Output assignments and mappings.

  Enter 'N' to avoid copying these Program instances. In this case, all Planned Output assignments are lost.

Get a Summary Output Validation Status

Use this API to calculate the summary output validation status for the entire Report Set hierarchy in the context of a Report Set instance.

Name

CDR_PUB_RS_REPORT_SET.GetSOVSforRSHierarchy

Signature

FUNCTION GETSOVSFORRSHIERARCHY( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PI_COMPID  IN    CDR_NAMINGS.COMPANY_ID%TYPE, 
  PI_OBJID  IN    CDR_NAMINGS.OBJ_ID%TYPE, 
  PI_OBJVER  IN    CDR_NAMING_VERSIONS.OBJ_VER%TYPE, 
  PI_RSIOBJID  IN    CDR_NAMINGS.OBJ_ID%TYPE, 
  PI_RSIOBJVER  IN    CDR_NAMING_VERSIONS.OBJ_VER%TYPE 
) RETURN CDR_SOVS_OBJ_COLL; 

Return

Type CDR_SOVS_OBJ_COLL

Parameters

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

• PI_COMPID (Mandatory) Enter the COMPANY_ID of the Column or Table Descriptor.
• PI_OBJID (Mandatory) Enter the OBJ_ID of the Column or Table Descriptor.
• PI_OBJVER (Mandatory) Enter the OBJ_VER of the Column or Table Descriptor.
• PI_RSIOBJID (Mandatory) Enter the object ID of the Report Set instance.
• PI_RSIOBJVER (Mandatory) Enter the object version of the Report Set instance.

Modify a Report Set

Use this API to modify a Report Set definition or instance. You can modify the name and description. If you are modifying an instance object, you can also change the 3 REF attribute values to select a different source definition.

Note:

To modify a definition, you must first check it out.

Name

CDR_PUB_RS_REPORT_SET.ModifyReportSetDetails

Signature

PROCEDURE MODIFYREPORTSETDETAILS( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PIO_CDRNAMING  IN OUT    CDR_NAMING_VERSION_OBJ_TYPE, 
  PI_REPORTSET  IN    CDR_REPORT_SET_OBJ_TYPE 
); 

Parameters

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

• PIO_CDRNAMING (Mandatory) This is a parameter of table type CDR_NAMING_VERSION_OBJ_TYPE.

  Enter values to identify the Report Set and enter new values for the attributes you want to modify. You can change the name or description for either a definition or instance.

  For an instance, you can also change to a different underlying source definition by entering values for the new definition in the three REF attributes. All attributes are required.

  Note:

  Use separate APIs for modifying the validation status and the version label: CDR_PUB_VL_VALIDATION.UPDATE VAL STATUS and CDR_PUB_DF_NAMING.UPDATEVERSIONLABEL.
• PI_REPORTSET (Mandatory) This is a parameter of table type CDR_REPORT_SET_OBJ_TYPE that contains Report Set attributes.

  Enter values to identify the Report Set definition or instance that you want to modify and enter new values for the attributes you want to modify. You can change the TITLE, the UNIQUE_NUMBERING_FLAG_RC, and the STRICT_NUMBERING_FLAG_RC. All attributes are required.

Move Objects into a Report Set

Use this API to move Program instances and Report Set Entries into a Report Set definition.

Name

CDR_PUB_RS_REPORT_SET.MoveObjectsIntoReportSet

Signature

PROCEDURE MOVEOBJECTSINTOREPORTSET( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PI_CDRBASEOBJECTCOLL  IN OUT    CDR_BASE_OBJ_COLL, 
  PI_CDRTARGETCONTAINEROBJECT  IN OUT    CDR_BASE_OBJ_TYPE 
); 

Parameters

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

• PI_CDRBASEOBJECTCOLL (Mandatory) This is a collection of cdr_base_obj_type that is used to describe the Report Set Entries you want to copy.

  Enter values for attributes COMPANY_ID, OBJ_ID, OBJ_VER, NAMESPACE_OBJ_ID, NAMESPACE_OBJ_VER, AND OBJECT_VERSION_NUMBER for each RSE you want to copy. All children, grandchildren, etc. RSEs of the RSEs you specify are included in the Copy operation.

  Enter COMPANY_ID, OBJ_ID AND OBJ_VER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER, OBJECT_VERSION_NUMBER for each RSE

• PI_CDRTARGETCONTAINEROBJECT (Mandatory) This is a parameter of table type CDR_BASE_OBJ_TYPE. Enter values to identify the Report Set into which you want to copy the specified Report Set Entries.

  The following attributes are required: COMPANY_ID, OBJ_ID AND OBJ_VER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER, OBJECT_VERSION_NUMBER of target Report Set Definition

Remove Objects from a Report Set

Use this API to remove one or more objects from a Report Set.

Name

CDR_PUB_RS_REPORT_SET.RemoveObjectsFromReportSet

Signature

PROCEDURE REMOVEOBJECTSFROMREPORTSET( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PI_CDRBASEOBJECTCOLL  IN OUT    CDR_BASE_OBJ_COLL 
); 

Parameters

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

PI_CDRBASEOBJECTCOLL (Mandatory) This is a collection of cdr_base_obj_type that is used to describe the Report Set Entries you want to copy.

Enter values for attributes COMPANY_ID, OBJ_ID, OBJ_VER, NAMESPACE_OBJ_ID, NAMESPACE_OBJ_VER, AND OBJECT_VERSION_NUMBER for each RSE you want to copy. All children, grandchildren, etc. RSEs of the RSEs you specify are included in the Copy operation.

Check In a Report Set

Use this API to check in a Report Set definition.

Name

CDR_PUB_RS_REPORT_SET.CheckInReportSetDef

Signature

PROCEDURE CHECKINREPORTSETDEF( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PI_CDRREPORTSET  IN OUT    CDR_BASE_OBJ_TYPE, 
  PI_COMMENT  IN    VARCHAR2 
);

Parameters

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

• PI_CDRREPORTSET (Mandatory) This is a parameter of table type CDR_BASE_OBJ_TYPE. Enter values to identify the Report Set definition that you want to check in.

  The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.

• PI_COMMENT (Optional) Enter the reason you are checking in the Report Set definition.

Remove a Report Set Definition

Use this API to remove a Report Set definition or instance.

Name

CDR_PUB_RS_REPORT_SET.RemoveReportSet

Signature

PROCEDURE REMOVEREPORTSET( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PIO_CDRREPORTSET  IN OUT    CDR_BASE_OBJ_TYPE 
); 

Parameters

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

PIO_CDRREPORTSET (Mandatory) This is a collection of CDR_BASE_OBJ_TYPEs. For each Report Set that you want to remove, initialize a CDR_BASE_OBJ_TYPE and then extend the collection.

The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.

Remove a Report Set

Use this API to remove one or more objects from a Report Set.

Name

CDR_PUB_RS_REPORT_SET.RemoveReportSets

Signature

PROCEDURE REMOVEREPORTSETS( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PIO_CDRBASEOBJCOLL  IN OUT    CDR_BASE_OBJ_COLL 
); 

Parameters

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

PI_CDRBASEOBJECTCOLL (Mandatory) This is a collection of cdr_base_obj_type that is used to describe the Report Set Entries you want to copy.

Enter values for attributes COMPANY_ID, OBJ_ID, OBJ_VER, NAMESPACE_OBJ_ID, NAMESPACE_OBJ_VER, AND OBJECT_VERSION_NUMBER for each RSE you want to copy. All children, grandchildren, etc. RSEs of the RSEs you specify are included in the Copy operation.

Create and Modify Overlay Template Definitions

This is a public interface used to create, modify and remove OTD files, which are contained by Overlay Template Definitions (OTDs) and used in Report Sets.

This section contains the following topics:

• Create an Overlay Template Definition
  
• Modify an Overlay Template Definition File Definition
  
• Get an Overlay Template Definition File as a BLOB
  
• Remove an Overlay Template Definition File Definition
  

Create an Overlay Template Definition

Use this API to create an OTD File definition after you have created an Overlay Template Definition (OTD). Use CDR_PUB_RS_OVERLAY_TEMPLATE.CopyObjectsIntoOTD to assign this OTD File definition to an OTD.

Name

CDR_PUB_RS_OTD_FILE.CreateOTDFile

Signature

PROCEDURE CREATEOTDFILE( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PIO_OTDF_SOURCECDRNAMING  IN OUT    CDR_NAMING_VERSION_OBJ_TYPE, 
  PI_CDROTDFILEOBJTYPE  IN OUT    CDR_OTDF_OBJ_TYPE, 
  PI_LOBMODE  IN    VARCHAR := NULL 
);

Parameters

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

• PIO_OTDF_SOURCECDRNAMING (Mandatory) This is a parameter of table type CDR_NAMING_VERSION_OBJ_TYPE. Enter values for the OTD File that you are creating, using the Namespace attributes to identify the parent Overlay Template Definition.

  For OBJECT_TYPE_RC enter $OBJTYPES$OVERLAYTEMPLATEFILE. The following attributes are required: COMPANY_ID,NAME,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.

• PI_CDROTDFILEOBJTYPE (Mandatory) This is a parameter of table type CDR_OTDF_OBJ_TYPE that contains object attributes specific to Overlay Template Definition Files. Enter values for the OTD File that you are creating.

  The following attributes are required: OTDF_TYPE_RC,OTDF_PGNO_FLAG,OTDF_ORIENTATION_RC,OTDF_PAPERSIZE,OTDF_LANGUAGE_RC,OTDF_ROTATION,OTDF_FILENAME,OTDF_BLOB.

• PI_LOBMODE (Optional) Enter 'IN_DIRECT'. No other value is supported except Null.

Modify an Overlay Template Definition File Definition

Use this API to modify an OTD File definition.

Name

CDR_PUB_RS_OTD_FILE.ModifyOTDFile

Signature

PROCEDURE MODIFYOTDFILE( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PIO_OTDF_SOURCECDRNAMING  IN OUT    CDR_NAMING_VERSION_OBJ_TYPE, 
  PI_CDROTDFILEOBJTYPE  IN OUT    CDR_OTDF_OBJ_TYPE, 
  PI_LOBMODE  IN    VARCHAR := NULL 
);

Parameters

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

• PIO_OTDF_SOURCECDRNAMING (Mandatory) This is a parameter of table type CDR_NAMING_VERSION_OBJ_TYPE. Enter values to identify the OTD File that you are modifying and enter new values for attributes you want to change. You can change the name and description. All attributes are required.
• PI_CDROTDFILEOBJTYPE (Mandatory) This is a parameter of table type CDR_OTDF_OBJ_TYPE that contains object attributes specific to Overlay Template Definition Files. Enter values to identify the OTD File that you are modifying and enter new values for attributes you want to change. You can change values for Page Number, Orientation, Paper Size, Rotation, or File Name. All attributes are required.
• PI_LOBMODE (Optional) Enter 'IN_DIRECT'. No other value is supported except Null.

Get an Overlay Template Definition File as a BLOB

Use this API to upload the RTF file.

Name

CDR_PUB_RS_OTD_FILE.GetOTDBlob

Signature

FUNCTION GETOTDBLOB( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  COMPANYID  IN    CDR_NAMINGS.COMPANY_ID%TYPE, 
  OBJID  IN    CDR_NAMINGS.OBJ_ID%TYPE, 
  OBJVER  IN    CDR_NAMING_VERSIONS.OBJ_VER%TYPE 
) RETURN BLOB; 

Return

Type BLOB

Parameters

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

• COMPANYID (Mandatory) Enter the Company ID of the OTD File definition.
• OBJID (Mandatory) Enter the Object ID of the OTD File definition.
• OBJVER (Mandatory) Enter the Object version of the OTD File definition.

Remove an Overlay Template Definition File Definition

Use this API to remove one or more OTD File definitions from an OTD.

Name

CDR_PUB_RS_OTD_FILE.RemoveOTDFile

Signature

PROCEDURE REMOVEOTDFILE( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PIO_CDRBASEOBJCOLL  IN OUT    CDR_BASE_OBJ_COLL 
);

Parameters

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

PIO_CDRBASEOBJCOLL (Mandatory) This is a collection of CDR_BASE_OBJ_TYPEs. For each OTD File definition that you want to remove, initialize a CDR_BASE_OBJ_TYPE and then extend the collection.

The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.

Report Set Overlay Template

This package is used to create, check in, check out, and modify the Report Set Entry. templates.

This section contains the following topics:

• Create an Overlay Template
  
• Check Out an Overlay Template
  
• Undo an Overlay Template Checkout
  
• Copy Objects Into an Overlay Template
  
• Modify an Overlay Template
  
• Check In an Overlay Template
  
• Remove an Overlay Template
  

Create an Overlay Template

Use this API to create an Overlay Template definition (OTD).

Name

CDR_PUB_RS_OVERLAY_TEMPLATE.CreateOverlayTemplate

Signature

PROCEDURE CREATEOVERLAYTEMPLATE( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PIO_OTD_SOURCECDRNAMING  IN OUT    CDR_NAMING_VERSION_OBJ_TYPE, 
  PI_CDROTDOBJTYPE  IN OUT    CDR_OTD_OBJ_TYPE, 
  PO_DEFCLASSIFICATIONCOLL  IN    CDR_CLASSIFICATIONS_COLL 
); 

Parameters

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

• PIO_OTD_SOURCECDRNAMING (Mandatory) This is a parameter of table type CDR_NAMING_VERSION_OBJ_TYPE. Enter values for the Overlay Template Definition (OTD) that you are creating.

  For OBJECT_TYPE_RC enter $OBJTYPES$OVERLAYTEMPLATE. The following attributes are required: COMPANY_ID,NAME,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.

• PI_CDROTDOBJTYPE (Mandatory) This is a parameter of table type CDR_OTD_OBJ_TYPE that contains object attributes specific to Overlay Templates. Enter values for the Overlay Template that you are creating.

  The following attributes are required: OTD_DEFAULT_PAPERSIZE,OTD_DEFAULT_LANGUAGE_RC.

• PO_DEFCLASSIFICATIONCOLL (Optional) By default the new definition is classified according to the subtype you assigned it in the CDR_NAMING_VERSION_OBJ_TYPE.

  If you want to override the default classifications for one or more classification levels, use this parameter. This is a collection of CDR_CLA_OBJ_TYPEs, which have 5 attributes, including CLA_LEVEL_ID and CLASSIFICATION_ID.

  If you want the definition to inherit its classifications for a particular level from its parent, enter the classification level ID and, for the CLASSIFICATION_ID, enter 0 (zero).

  If you want to explicitly assign one or more terms for a particular level, initialize a CDR_CLA_OBJ_TYPE for each term, entering the classification level ID and, for the CLASSIFICATION_ID, the term ID. The PAR_ attributes are not relevant to OTDs. Do not enter any values for them.

Check Out an Overlay Template

Use this API to check out an Overlay Template Definition (OTD).

Name

CDR_PUB_RS_OVERLAY_TEMPLATE.CheckOutOverlayTemplate

Signature

PROCEDURE CHECKOUTOVERLAYTEMPLATE( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PIO_BASEOBJECT  IN OUT    CDR_BASE_OBJ_TYPE, 
  PI_COMMENT  IN    VARCHAR2, 
  PI_ISINSTONLY  IN    VARCHAR2 
); 

Parameters

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

• PIO_BASEOBJECT (Mandatory) This is a parameter of table type CDR_BASE_OBJ_TYPE. Enter values to identify the OTD that you want to check in.

  The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.

• PI_COMMENT (Optional) Enter the reason you are checking in the OTD.
• PI_ISINSTONLY (Mandatory) Enter $YESNO$NO.

Undo an Overlay Template Checkout

Use this API to undo the checkout of an Overlay Template Definition (OTD).

Name

CDR_PUB_RS_OVERLAY_TEMPLATE.UndoCheckOutOverlayTemplate

Signature

PROCEDURE UNDOCHECKOUTOVERLAYTEMPLATE( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PIO_BASEOBJECT  IN OUT    CDR_BASE_OBJ_TYPE 
); 

Parameters

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

PIO_BASEOBJECT (Mandatory) This is a parameter of table type CDR_BASE_OBJ_TYPE. Enter values to identify the OTD whose checkout you want to undo.

The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.

Copy Objects Into an Overlay Template

Use this API to copy OTD File definitions into an Overlay Template Definition.

Name

CDR_PUB_RS_OVERLAY_TEMPLATE.CopyObjectsIntoOTD

Signature

PROCEDURE COPYOBJECTSINTOOTD( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PI_CDRBASEOBJCOLL  IN    CDR_BASE_OBJ_COLL, 
  PI_CDRTARGETCONTAINEROBJECT  IN    CDR_BASE_OBJ_TYPE 
);

Parameters

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

• PI_CDRBASEOBJCOLL (Mandatory) This is a collection of CDR_BASE_OBJ_TYPEs. For each OTD file definition that you want to copy into an OTD, initialize a CDR_BASE_OBJ_TYPE and then extend the collection.

  The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.

• PI_CDRTARGETCONTAINEROBJECT (Mandatory) This is a parameter of table type CDR_BASE_OBJ_TYPE. Enter values to identify the OTD into which you want to copy OTD File definitions. The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.

Modify an Overlay Template

Use this API to modify an Overlay Template Definition (OTD).

Name

CDR_PUB_RS_OVERLAY_TEMPLATE.ModifyOverlayTemplate

Signature

PROCEDURE MODIFYOVERLAYTEMPLATE( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PIO_OTD_SOURCECDRNAMING  IN OUT    CDR_NAMING_VERSION_OBJ_TYPE, 
  PI_CDROTDOBJTYPE  IN OUT    CDR_OTD_OBJ_TYPE 
); 

Parameters

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

• PIO_OTD_SOURCECDRNAMING (Mandatory) This is a parameter of table type CDR_NAMING_VERSION_OBJ_TYPE. Enter values to identify the Overlay Template Definition (OTD) that you are modifying, and enter new values for the attributes you want to modify. You can change the name and description. All attributes are required.

• PI_CDROTDOBJTYPE Object Type of Overlay Template Definition

Check In an Overlay Template

Use this API to check in an Overlay Template Definition.

Name

CDR_PUB_RS_OVERLAY_TEMPLATE.CheckInOverlayTemplate

Signature

PROCEDURE CHECKINOVERLAYTEMPLATE( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PIO_BASEOBJECT  IN OUT    CDR_BASE_OBJ_TYPE, 
  PI_COMMENT  IN    VARCHAR2 
);

Parameters

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

• PIO_BASEOBJECT (Mandatory) This is a parameter of table type CDR_BASE_OBJ_TYPE. Enter values to identify the OTD that you want to check in.

  The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.

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

Remove an Overlay Template

Use this API to remove one or more Overlay Template Definitions (OTDs).

Name

CDR_PUB_RS_OVERLAY_TEMPLATE.RemoveOverlayTemplate

Signature

PROCEDURE REMOVEOVERLAYTEMPLATE( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PIO_CDRBASEOBJCOLL  IN OUT    CDR_BASE_OBJ_COLL 
); 

Parameters

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

PIO_CDRBASEOBJCOLL (Mandatory) This is a collection of CDR_BASE_OBJ_TYPEs. For each OTD that you want to remove, initialize a CDR_BASE_OBJ_TYPE and then extend the collection.

The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.