| Oracle® Health Sciences Life Sciences Warehouse Application Programming Interface Guide Release 2.4 E53659-01 |
|
|
PDF · Mobi · ePub |
| Oracle® Health Sciences Life Sciences Warehouse Application Programming Interface Guide Release 2.4 E53659-01 |
|
|
PDF · Mobi · ePub |
This section contains the following topics:
This is a public interface for Business Area-related APIs, including creating, modifying, and removing Business Areas. It also includes APIs for checking Business Areas in and out, and undoing a Business Area checkout.
This section contains the following topics:
Use this API to create a new Business definition, a new instance of an existing Business Area definition, or a new definition and an instance of it.
Name CDR_PUB_DF_BUSINESSAREA.CreateBusiArea
PROCEDURE CREATEBUSIAREA( 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_CDRPRGOBJTYPE IN CDR_BUSAREA_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_VERSIONS_OBJ_TYPE that contains CDR Naming Version attributes.
If you are creating a new definition only or a new definition and an instance of it, enter values for the new definition.
If you are creating an instance of an existing definition, enter values to identify the definition. For OBJECT_TYPE_RC enter $OBJTYPES$BUSAREA if you are creating a definition only; $OBJTYPES$BUSAREAREF if you are creating an instance of an existing definition; and NULL if you are creating a new definition and an instance of it.
PI_CDRPRGOBJTYPE (Optional) This is a parameter of table type CDR_BUSAREA_OBJ_TYPE specific to Business Areas.
If you are creating a new definition, enter values for the new Business Area.
The following attributes are required: ADAPTER_COMPANY_ID,ADAPTER_OBJ_ID,ADAPTER_OBJ_VER.
If you are creating an instance of an existing Business Area, do not enter any values here.
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 Business Areas. Do not enter any values for them.
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 Business Areas. Do not enter any values for them.
Use this API to modify a Business Area definition or instance.
Note:
If you are modifying a definition, you must first check it out.Name CDR_PUB_DF_BUSINESSAREA.ModifyBusiAreaDetails
PROCEDURE MODIFYBUSIAREADETAILS( 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 );
Parameters This API has standard parameters (see "Standard Parameters") and the following parameter:
PIO_CDRNAMING (Mandatory) This is a parameter of table type CDR_NAMING_VERSION_OBJ_TYPE. Enter values to identify the Business Area and enter new values for the attributes you want to modify.
You can change the name, description, or version label 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.
Use this API to check out a Business Area definition either directly or through an instance of it.
Name CDR_PUB_DF_BUSINESSAREA.CheckOutBusiArea
PROCEDURE CHECKOUTBUSIAREA( 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 Business Area that you want to do check out.
If you are checking out the Business Area definition directly, enter values to identify the definition.
If you are checking out a Business Area definition through an instance of it, enter values to identify the instance.
The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.
PI_COMMENT Enter the reason you are checking out the Business Area.
PI_ISINSTONLY (Mandatory) Enter $YESNO$NO.
Use this API to undo the checkout of a Business Area definition, discarding any changes that have been made.
Name CDR_PUB_DF_BUSINESSAREA.UncheckOutBusiArea
PROCEDURE UNCHECKOUTBUSIAREA( 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 Business Area 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.
Use this API to check in a Business Area definition.
Name CDR_PUB_DF_BUSINESSAREA.CheckInBusiAreaDefinition
PROCEDURE CHECKINBUSIAREADEFINITION( 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 Business Area 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 Business Area.
Use this API to remove one or more Business Area definitions or instances.
Name CDR_PUB_DF_BUSINESSAREA.RemoveBusiArea
PROCEDURE REMOVEBUSIAREA( 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 Business Area 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.
This is a public interface for all Business Area hierarchy-related operations, including creating, modifying, and removing Business Area hierarchies and hierarchy columns.
This section contains the following topics:
Use this API to create a hierarchy in a Business Area. To define the hierarchy's columns, use ModifyBusAreaHierAndHierCol.
Name CDR_PUB_DF_BUSINESSAREA_HIER.CreateBusinessAreaHier
PROCEDURE CREATEBUSINESSAREAHIER( 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 );
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 hierarchy. Use the NAMESPACE attributes to identify the Business Area in which you want to create the hierarchy.
The following attributes are required: OBJECT_TYPE_RC,NAME,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER,OBJECT_SUBTYPE_ID. For OBJECT_TYPE_RC enter $OBJTYPES$BUSAREAHIER.
Use this API to modify Business Area Hierarchies and Hierarchy Columns. You can change name and description, add Columns, and change their Group With Previous setting. Use the Remove Columns API to remove Columns.
Name CDR_PUB_DF_BUSINESSAREA_HIER.ModifyBusAreaHierAndHierCol
PROCEDURE MODIFYBUSAREAHIERANDHIERCOL( 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_NAMING IN OUT CDR_NAMING_VERSION_OBJ_TYPE, PI_BUS_HIERCOLUMNS_COLL IN OUT CDR_BUSAREA_HIER_COLS_COLL );
Parameters This API has standard parameters (see "Standard Parameters") and the following parameters:
PIO_NAMING (Mandatory) This is a parameter of table type CDR_NAMING_VERSION_OBJ_TYPE.
Enter values to identify the Business Area Hierarchy that you want to modify and enter new values for the attributes you want to modify. You can modify only the Name and Description. All attributes are required.
PI_BUS_HIERCOLUMNS_COLL (Mandatory) This is a collection of CDR_BUSAREA_HIER_COLS_OBJ_TYPEs.
Initialize a CDR_BUSAREA_HIER_COLS_OBJ_TYPE for each Column in their position order with the values you want to change, and then extend the collection. All attributes are required.
Use this API to reorder the Columns of a Business Area Hierarchy.
Note:
The API enforces validation rules for Column sequence.Name CDR_PUB_DF_BUSINESSAREA_HIER.ReorderHierCols
PROCEDURE REORDERHIERCOLS( 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_BUS_HIERCOLUMNS_COLL IN OUT CDR_BUSAREA_HIER_COLS_COLL );
Parameters This API has standard parameters (see "Standard Parameters") and the following parameters:
PIO_BUS_HIERCOLUMNS_COLL (Mandatory) This is a collection of CDR_BUSAREA_HIER_COLS_OBJ_TYPEs. For each Column, initialize a CDR_BUSAREA_HIER_COLS_OBJ_TYPE, providing the new value for POSITION NUMBER relative to the other Columns, and then extend the collection. You must initialize all existing Columns.
The following attributes are required: COMPANY_ID,HIER_OBJ_ID,HIER_OBJ_VER,TD_COMPANY_ID,TD_OBJ_ID,TD_COL_COMPANY_ID,TD_COL_OBJ_ID,POSITION,GROUP_WITH_PREVIOUS_RC.
Use this API to remove Business Area Hierarchy Columns.
Note:
You cannot remove a Column that is currently part of a Join. If you remove a Column, and if the next Column's Group By Previous setting is Yes, then that setting is changed to No.Name CDR_PUB_DF_BUSINESSAREA_HIER.RemoveHierColumns
PROCEDURE REMOVEHIERCOLUMNS( 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_BUS_HIERCOLUMNS_COLL IN OUT CDR_BUSAREA_HIER_COLS_COLL );
Parameters This API has standard parameters (see "Standard Parameters") and the following parameter:
PIO_BUS_HIERCOLUMNS_COLL (Mandatory) This is a collection of CDR_BUSAREA_HIER_COLS_OBJ_TYPEs. For each Column that you want to remove, initialize a CDR_BUSAREA_HIER_COLS_OBJ_TYPE and then extend the collection.
The following attributes are required: COMPANY_ID,HIER_OBJ_ID,HIER_OBJ_VER,TD_COMPANY_ID,TD_OBJ_ID,TD_COL_COMPANY_ID,TD_COL_OBJ_ID,POSITION,GROUP_WITH_PREVIOUS_RC.
Use this API to remove one or more Business Area Hierarchies, including all their Columns.
Name CDR_PUB_DF_BUSINESSAREA_HIER.RemoveHiers
PROCEDURE REMOVEHIERS( 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_BASEOBJCOLL IN OUT CDR_BASE_OBJ_COLL );
Parameters This API has standard parameters (see "Standard Parameters") and the following parameter:
PI_BASEOBJCOLL (Mandatory) This is a collection of CDR_BASE_OBJ_TYPEs. For each Hierarchy 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.
This is a public interface for Business Area Join-related operations, including creating, modifying, and removing Business Area Joins and Join Columns.
This section contains the following topics:
Use this API to create a Business Area Join.
Name CDR_PUB_DF_BUSINESSAREA_JOIN.CreateBusinessAreaJoin
PROCEDURE CREATEBUSINESSAREAJOIN( 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_BUSAREAJOINSOBJTYPE IN CDR_BUSAREA_JOINS_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 Join that you want to create. Use the NAMESPACE attributes to identify the Business Area in which you want to create the Join.
The following attributes are required: OBJECT_TYPE_RC,NAME,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER,OBJECT_SUBTYPE_ID. For OBJECT_TYPE_RC enter $OBJTYPES$JOIN.
PI_BUSAREAJOINSOBJTYPE (Mandatory) This is a parameter of table type CDR_BUSAREA_JOINS_OBJ_TYPE specific to Joins. Enter values for the Join that you want to create.
The following attributes are required: TD_COMPANY_ID,TD_OBJ_ID,FK_TD_COMPANY_ID,FK_TD_OBJ_ID,TD_OUTERJOIN_RC,FK_TD_OUTERJOIN_RC. For TD_OUTERJOIN_RC and FK_TD_OUTERJOIN_RC enter $YESNO$NO to define an inner join on the side of the corresponding Table Descriptor, or $YESNO$YES to define an outer join. Be sure to define an outer join on only one side, if any.
Use this API to modify Business Area Joins and Join Columns. You can change the name and description of the Join and change either side to an inner or outer join (but be careful not to make both sides into outer joins). You can add Join Columns and pair them with a different Column from the other Table Descriptor.
Note:
Do not change the operator. EQUAL TO is the only operator currently supported.Name CDR_PUB_DF_BUSINESSAREA_JOIN.ModifyBusAreaJoinAndJoinCol
PROCEDURE MODIFYBUSAREAJOINANDJOINCOL( 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_NAMING IN OUT CDR_NAMING_VERSION_OBJ_TYPE, PI_BUSINESS_JOIN IN OUT CDR_BUSAREA_JOINS_OBJ_TYPE, PI_BUS_JOINCOLUMNS_COLL IN OUT CDR_BUSAREA_JOIN_COLS_COLL );
Parameters This API has standard parameters (see "Standard Parameters") and the following parameters:
PIO_NAMING (Mandatory) This is a parameter of table type CDR_NAMING_VERSION_OBJ_TYPE. Enter values to identify the Join that you want to modify and for the attributes you want to change.
The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.
PI_BUSINESS_JOIN (Mandatory) This is a parameter of table type CDR_BUSAREA_JOINS_OBJ_TYPE specific to Joins. Enter values to identify the Join that you want to modify and the values you want to modify. All attributes are required.
PI_BUS_JOINCOLUMNS_COLL (Mandatory) This is a collection of CDR_BUSAREA_JOIN_COLS_TYPEs. For each Join Column that you want to modify, initialize a CDR_BUSAREA_JOIN_COLS_TYPE and then extend the collection.
The following attributes are required: COMPANY_ID,JOIN_OBJ_ID,JOIN_OBJ_VER,TD_COL_COMPANY_ID,TD_COL_OBJ_ID,FK_TD_COL_COMPANY_ID,FK_TD_COL_OBJ_ID,POSITION. You can change the joined columns but you cannot modify the operator, which is always Equal To.
Use this API to remove one or more Columns from a Join.
Name CDR_PUB_DF_BUSINESSAREA_JOIN.RemoveJoinColumns
PROCEDURE REMOVEJOINCOLUMNS( 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_BUS_JOINCOLUMNS_COLL IN OUT CDR_BUSAREA_JOIN_COLS_COLL );
Parameters This API has standard parameters (see "Standard Parameters") and the following parameter:
PIO_BUS_JOINCOLUMNS_COLL (Mandatory) This is a collection of CDR_BUSAREA_JOIN_COLS_TYPEs. For each Join Column that you want to remove, initialize a CDR_BUSAREA_JOIN_COLS_TYPE and then extend the collection.
The following attributes are required: COMPANY_ID,JOIN_OBJ_ID,JOIN_OBJ_VER,TD_COL_COMPANY_ID,TD_COL_OBJ_ID,FK_TD_COL_COMPANY_ID,FK_TD_COL_OBJ_ID,POSITION.
Use this API to remove one or more Joins, with all their Columns, from a Business Area.
Name CDR_PUB_DF_BUSINESSAREA_JOIN.RemoveJoins
PROCEDURE REMOVEJOINS( 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_BASEOBJCOLL IN OUT CDR_BASE_OBJ_COLL );
Parameters This API has standard parameters (see "Standard Parameters") and the following parameter:
PI_BASEOBJCOLL (Mandatory) This is a collection of CDR_BASE_OBJ_TYPEs.
For each Join that you want to remove from the Business Area, 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.
This is a public interface for operations related to Generic Visualization Business Areas including initializing and resetting them.
This section contains the following topics:
Section 4.4.2, "Reset a Generic Visualization Business Area"
Section 4.4.3, "Get Possible Blinding Types of a Business Area Instance"
Use this API to initialize a particular Generic Visualization Business Area Instance of a given currency and blinding access type. If the currency and the blinding access type values are null, the default types of the BA instance are used.
You can invoke this API multiple times in the same instance in a single user session to change the type of access to the data. You can also invoke it multiple times to read data from more than one Business Area Schema as long as all the data across all the Business Areas is uniformly either real or dummy.
If you initialize a new Business Area schema changes blinding access, the API errors out, directing you to reset access to all Business Areas using the RESETBAACCESS API.
Name CDR_PUB_API_GVA.SetInitializeBA
PROCEDURE SETINITIALIZEBA( 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, PI_VCURRENCY IN VARCHAR2, PI_VBLINDINGACCESSTYPE IN VARCHAR2, X_RETURN_STATUS OUT NOCOPY VARCHAR2, X_MSG_COUNT OUT NOCOPY NUMBER, X_MSG_DATA OUT NOCOPY VARCHAR2 );
Parameters This API has the following parameters:
PI_COMPANYID. Enter the Business Area Instance Company ID.
PI_OBJID. Enter the Business Area Instance Object ID.
PI_OBJVER. Enter the Business Area Instance Object Version.
PI_VCURRENCY. Enter the Currency status.
PI_VBLINDINGACCESSTYPE. Enter the Blinding Access Type.
X_RETURN_STATUS.
X_MSG_COUNT.
X_MSG_DATA.
Note:
You can also invoke this API with the same results, using CDR_PUB_API_GVA.SETINITILIZEBA.Use this API to clear all the initializations of Buiness Area schemas. It is equivalent to logging out and logging back in to the system. Use this API when you want to change blinding access type from blinded to unblinded or vice-versa.
Use this API to get the possible Blinding Access Types of a Business Area Instance, which is in turn based on the blinding statuses of underlying Business Area Table instances and the user's privileges.
Name CDR_PUB_API_GVA.GetBAValidBlindingAccessTypes
FUNCTION GETBAVALIDBLINDINGACCESSTYPES(
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 BLINDINGACCESSTYPESCOLL PIPELINED;
Return A collection of the possible blinding access types. BLINDINGACCESSTYPESCOLL is TABLE TYPE OF VARCHAR2(30);
Parameters This API has the following parameters:
PI_COMPANYID. Enter the Business Area Instance Company ID.
PI_OBJID. Enter the Business Area Instance Object ID.
PI_OBJVER. Enter the Business Area Instance Object Version.
BLINDINGACCESSTYPESCOLL. This is the list of possible blinding access types.
Use this API to get the snapshot labels common to all Tables within a Business Area Instance for a given blinding access type.
Name CDR_PUB_API_GVA.GetSnapshotLabels
FUNCTION GETSNAPSHOTLABELS(
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,
PI_VBLINDINGACCESSTYPE IN VARCHAR2) RETURN CURRENCYCOLL PIPELINED;
Return A collection of the snapshot labels for a particular blinding access type in the Business Area instance common to all Tables within a Business Area Instance. CURRENCYCOLL is TABLE TYPE OF VARCHAR2(200);
Parameters This API has the following parameters.
PI_COMPANYID. Enter the Business Area Instance Company ID.
PI_OBJID. Enter the Business Area Instance Object ID.
PI_OBJVER. Enter the Business Area Instance Object Version.
PI_VBLINDINGACCESSTYPE . Enter the Blinding Access Type.
CDR_PUB_GENERIC_BA_V
Use this naming view to retrieve all the Generic Visualization Business Area Instances on which a user has privileges to read data.
CDR_PUB_GENERIC_BA_TABLES_V Use this view to retrieve the Table instance details for a given GV BAI.
|
 Copyright © 2013, 2014, Oracle and/or its affiliates. All rights reserved. Legal Notices |
|