| 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 includes the following topics:
This section contains the following procedures related to flags in the package DME_PUB_FLAG_DATA:
Use this API to set the state of a single flag for a given record.
Name DME_PUB_FLAG_DATA.SetFlag
PROCEDURE SETFLAG, ( P_API_VERSION IN VARCHAR2, P_INIT_MSG_LIST IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE, P_COMMIT IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE, P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, X_RETURN_STATUS OUT NOCOPY VARCHAR2, X_MSG_COUNT OUT NOCOPY NUMBER, X_MSG_DATA OUT NOCOPY VARCHAR2, PI_COMPANY_ID IN NUMBER, PI_TAB_OBJ_ID IN NUMBER, PI_SKEY_VALUE IN VARCHAR2, PI_FLAG_ID IN NUMBER, PI_FLAG_STATE IN VARCHAR2, );
Parameters This API has standard parameters (see "Standard Parameters") as well as the following parameters:
PI_COMPANY_ID (Mandatory). Enter the company ID.
PI_TAB_OBJ_ID (Mandatory). Enter the obj_id of the table instance which contains the data record.
PI_SKEY_VALUE (Mandatory). Enter the surrogate key of the record.
PI_FLAG_ID (Mandatory). Enter the unique ID of the flag (from dme_flag_names)
PI_FLAG_STATE (Mandatory). The state that the flag may take on, to be set for the data record.
Use this API to retrieve information about an Oracle DMW flag setting.
Name DME_PUB_FLAG_DATA.GetFlag
PROCEDURE GETFLAG ( P_API_VERSION IN VARCHAR2, P_INIT_MSG_LIST IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE, P_COMMIT IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE, P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, X_RETURN_STATUS OUT NOCOPY VARCHAR2, X_MSG_COUNT OUT NOCOPY NUMBER, X_MSG_DATA OUT NOCOPY VARCHAR2, PI_COMPANY_ID IN NUMBER, PI_TAB_OBJ_ID IN NUMBER, PI_SKEY_VALUE IN VARCHAR2, PI_FLAG_ID IN NUMBER, PO_FLAG_STATE OUT NOCOPY VARCHAR2, );
Parameters This API has standard parameters (see "Standard Parameters") as well as the following parameters:
PI_COMPANY_ID (Mandatory). Enter the company ID.
PI_TAB_OBJ_ID (Mandatory). Enter the obj_id of the table instance that contains the data record.
PI_SKEY_VALUE (Mandatory).The surrogate key of the record
PI_FLAG_ID (Mandatory). The unique ID of the flag (from dme_flag_names)
PO_FLAG_STATE (Mandatory). This output parameter inherits the flag state for this record.
Use this API to retrieve information about all the flags and their values, assigned to a particular data record.
Name DME_PUB_FLAG_DATA.GetFlagsOnData
PROCEDURE GETFLAGSONDATA (P_API_VERSION IN VARCHAR2, P_INIT_MSG_LIST IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE, P_COMMIT IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE, P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, X_RETURN_STATUS OUT NOCOPY VARCHAR2, X_MSG_COUNT OUT NOCOPY NUMBER, X_MSG_DATA OUT NOCOPY VARCHAR2, PI_COMPANY_ID IN NUMBER, PI_TAB_OBJ_ID IN NUMBER, PI_SKEY_VALUE IN VARCHAR2, PI_INCLUDE_NULLS IN NUMBER, PO_FLAGS OUT NOCOPY CDR_NAME_VALUE_PAIR_COLL );
Parameters This API has standard parameters (see "Standard Parameters") as well as the following parameters:
PI_COMPANY_ID (Mandatory). Enter the company ID.
PI_TAB_OBJ_ID (Mandatory). This input parameter is an object ID for a namings object of type $OBJTYPES$TABLEREF (table instance).
PI_SKEY_VALUE (Mandatory). Enter the surrogate key of the record whose flags you want to retrieve.
PI_INCLUDE_NULLS (Mandatory). Set this input parameter to 1 to include information for flags with NULL state, else 0.
PO_FLAGS (Mandatory). This is a parameter of type CDR_NAME_VALUE_PAIR_COLL for the returned values (names and states).
Use this API to delete an existing DMW Flag state.
Name DME_PUB_FLAG_DATA.DeleteFlag
PROCEDURE DELETEFLAG (P_API_VERSION IN VARCHAR2, P_INIT_MSG_LIST IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE, P_COMMIT IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE, P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, X_RETURN_STATUS OUT NOCOPY VARCHAR2, X_MSG_COUNT OUT NOCOPY NUMBER, X_MSG_DATA OUT NOCOPY VARCHAR2, PI_COMPANY_ID IN NUMBER, PI_TAB_OBJ_ID IN NUMBER, PI_SKEY_VALUE IN VARCHAR2, PI_FLAG_ID IN NUMBER,
Parameters This API has standard parameters (see "Standard Parameters") as well as the following parameters:
PI_COMPANY_ID (Mandatory). Enter the company ID.
PI_TAB_OBJ_ID (Mandatory). This input parameter is an object id for a namings object of type $OBJTYPES$TABLEREF (table instance).
PI_SKEY_VALUE (Mandatory). The surrogate key of the record.
PI_FLAG_ID (Mandatory). This input parameter is the ID of the flag whose state you want to remove.
Use the following APIs in the package DME_PUB_FLAG_NAME to retrieve DMW flag names definitions and states. Use the first version of these APIs if you know the flag ID; use the second one if you know its name.
This section includes the following:
Use this API to retrieve information about an Oracle DMW flag name definition. Use this API if you know the Flag Name ID.
Name DME_PUB_FLAG_NAME.GetFlagName
PROCEDURE GETFLAGNAME (P_API_VERSION IN VARCHAR2, P_INIT_MSG_LIST IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE, P_COMMIT IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE, P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, X_RETURN_STATUS OUT NOCOPY VARCHAR2, X_MSG_COUNT OUT NOCOPY NUMBER, X_MSG_DATA OUT NOCOPY VARCHAR2, PI_COMPANY_ID IN NUMBER, PI_FLAG_NAME_ID IN NUMBER, PIO_DME_FLAG_NAME IN OUT NOCOPY DME_FLAG_NAME_TYPE, );
Parameters This API has standard parameters (see "Standard Parameters") as well as the following parameters:
PI_COMPANY_ID (Mandatory). Enter the company ID.
PI_FLAG_NAME_ID (Mandatory). Enter the ID of the flag name definition to be retrieved.
PIO_DME_FLAG_NAME (Mandatory). This is a parameter of type DME_FLAG_DEF_NAME for the returned values.
Use this API to retrieve information about an Oracle DMW flag name definition. Use this API if you know the Flag Name.
Name DME_PUB_FLAG_NAME.GetFlagName
PROCEDURE GETFLAGNAME (P_API_VERSION IN VARCHAR2, P_INIT_MSG_LIST IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE, P_COMMIT IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE, P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, X_RETURN_STATUS OUT NOCOPY VARCHAR2, X_MSG_COUNT OUT NOCOPY NUMBER, X_MSG_DATA OUT NOCOPY VARCHAR2, PI_COMPANY_ID IN NUMBER, PI_FLAG_NAMESTR IN VARCHAR2, PIO_DME_FLAG_NAME IN OUT NOCOPY DME_FLAG_NAME_TYPE, );
Parameters This API has standard parameters (see "Standard Parameters") as well as the following parameters:
PI_COMPANY_ID (Mandatory). Enter the company ID.
PI_FLAG_NAMESTR (Mandatory). Enter the name of the flag name definition to be retrieved.
PIO_DME_FLAG_NAME (Mandatory). This is a parameter of type DME_FLAG_DEF_NAME for the returned values.
Use this API to retrieve information about DMW flag name definitions.
Name DME_PUB_FLAG_NAME.GetFlagNames
PROCEDURE GETFLAGNAMES ( P_API_VERSION IN VARCHAR2, P_INIT_MSG_LIST IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE, P_COMMIT IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE, P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, X_RETURN_STATUS OUT NOCOPY VARCHAR2, X_MSG_COUNT OUT NOCOPY NUMBER, X_MSG_DATA OUT NOCOPY VARCHAR2, PI_CATEGORY_ID IN NUMBER DEFAULT NULL, PI_SUBJECT_VISIT IN VARCHAR2 DEFAULT NULL, PI_USER_SETTABLE IN VARCHAR2 DEFAULT NULL, PO_FLAG_NAMES OUT NOCOPY DME_FLAG_NAME_COLL, );
Parameters This API has standard parameters (see "Standard Parameters") as well as the following parameters:
PI_CATEGORY_ID (Optional). This input parameter is set to null to retrieve flags in any category. To get matching flags from a given category, you must provide a valid category ID.
PI_SUBJECT_VISIT (Optional). This input parameter is set to null to match flags irrespective of their being marked as subject_visit flags or not. To retreive matching subject_visit flags, enter either $YESNO$YES or $YESNO$NO as appropriate.
PI_USER_SETTABLE (Optional). This input parameter is set to null to match flags whether or not they are settable by the user. To match user-settable options, provide either $YESNO$YES or $YESNO$NO as appropriate.
PO_FLAG_NAMES (Mandatory). This is a parameter of type DME_FLAG_NAME_COLL for the returned values.
Use this API to retrieve information about all the DMW flag states for a single flag.
Name DME_PUB_FLAG_STATE.GetFlagStates
PROCEDURE GETFLAGSTATES (P_API_VERSION IN VARCHAR2, P_INIT_MSG_LIST IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE, P_COMMIT IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE, P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, X_RETURN_STATUS OUT NOCOPY VARCHAR2, X_MSG_COUNT OUT NOCOPY NUMBER, X_MSG_DATA OUT NOCOPY VARCHAR2, PI_COMPANY_ID IN NUMBER, PI_FLAG_NAME_ID IN NUMBER, PO_DME_FLAG_STATES OUT NOCOPY DME_FLAG_STATE_COLL, );
Parameters This API has standard parameters (see "Standard Parameters") as well as the following parameters:
PI_COMPANY_ID (Mandatory). Enter the company ID.
PI_FLAG_NAME_ID (Mandatory). This input parameter is the ID of the flag name definition that contains the flag value.
PO_DME_FLAG_STATES (Mandatory). This is a parameter of type DME_FLAG_STATE_COLL for the returned information.
This section includes the following:
Use this API to create a map between a model type and subtype and a flag category.
Name DME_PUB_MODEL_FLAGCAT.CreateModelFlagcatMap
PROCEDURE CREATEMODELFLAGCATMAP, (P_API_VERSION IN VARCHAR2, P_INIT_MSG_LIST IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE, P_COMMIT IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE, P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, X_RETURN_STATUS OUT NOCOPY VARCHAR2, X_MSG_COUNT OUT NOCOPY NUMBER, X_MSG_DATA OUT NOCOPY VARCHAR2, PI_COMPANY_ID IN NUMBER, PI_MODEL_TYPE_RC IN VARCHAR2, PI_MODEL_SUBTYPE_RC IN VARCHAR2, PI_CATEGORY_ID IN NUMBER, );
Parameters This API has standard parameters (see "Standard Parameters") as well as the following parameters:
PI_COMPANY_ID (Mandatory). Enter the company ID.
PI_MODEL_TYPE_RC (Mandatory). Enter a model type from the lookup CDR_MODELTYPES such as $MODELTYPE$INPUT.
If you want to map a flag category to input models that come from files, pass these two arguments as '$MODELTYPE$INPUT' and '$INPUTMODTYPE$FILE'.
If you want to map a flag category to input models from InForm, pass these two arguments as '$MODELTYPE$INPUT' and '$INPUTMODTYPE$INFORM'.
If you want to map a flag category to target models, pass these arguments as '$MODELTYPE$TARGET' and NULL.
PI_MODEL_SUBTYPE_RC (Mandatory). Enter a model subtype; for example, $MODELTYPE$INPUT or $MODELTYPE$TARGET
PI_CATEGORY_ID (Mandatory). Enter the unique ID of the category (from dme_categories in the Administration Area of the DMW User Interface).
Use this API to get all categories that are valid for a model type and subtype.
Name DME_PUB_MODEL_FLAGCAT.GetCategoriesForModel
PROCEDURE GETCATEGORIESFORMODEL, P_API_VERSION IN VARCHAR2, P_INIT_MSG_LIST IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE, P_COMMIT IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE, P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, X_RETURN_STATUS OUT NOCOPY VARCHAR2, X_MSG_COUNT OUT NOCOPY NUMBER, X_MSG_DATA OUT NOCOPY VARCHAR2, PI_COMPANY_ID IN NUMBER, PI_MODEL_TYPE_RC IN VARCHAR2, PI_MODEL_SUBTYPE_RC IN VARCHAR2, PO_CATEGORIES OUT NOCOPY DME_NUMBER_COLL, );
Parameters This API has standard parameters (see "Standard Parameters") as well as the following parameters:
PI_COMPANY_ID (Mandatory). Enter the company ID.
PI_MODEL_TYPE_RC (Mandatory). Enter a model type such as $MODELTYPE$INPUT, from the lookup CDR_MODELTYPES.
PI_MODEL_SUBTYPE_RC (Mandatory). Enter a model subtype; for example, $INPUTMODTYPE$FILE.
PO_CATEGORIES Output parameter returns an array of category IDs.
Use the following APIs to perform tasks related to discrepancy actions:
Use this API to create a new discrepancy action.
Name DME_PUB_DISC_ACTION.CreateDiscAction
PROCEDURE CREATEDISCACTION (P_API_VERSION IN VARCHAR2, P_INIT_MSG_LIST IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE, P_COMMIT IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE, P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, X_RETURN_STATUS OUT NOCOPY VARCHAR2, X_MSG_COUNT OUT NOCOPY NUMBER, X_MSG_DATA OUT NOCOPY VARCHAR2, PIO_DME_DISC_ACTION IN OUT NOCOPY DME_DISC_ACTION_TYPE,) ;
Parameters This API has standard parameters (see "Standard Parameters") as well as the following parameter:
PIO_DME_DISC_ACTION (Mandatory). This is a parameter of type DME_DISC_ACTION_TYPE that contains action attributes.
Enter the Start State, one of Candidate, Open, Answered, Cancelled, Closed. (In the API those are specified as $DISC_STATES$CANDIDATE, $DISC_STATES$OPEN. $DISC_STATES$ANSWERED, $DISC_STATES$CANCELLED, and $DISC_STATES$CLOSED).
Use this API to retrieve information about an Oracle DMW Discrepancy Action.
Name DME_PUB_DISC_ACTION.GetDiscAction
PROCEDURE GETDISCACTION( P_API_VERSION IN VARCHAR2, P_INIT_MSG_LIST IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE, P_COMMIT IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE, P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, X_RETURN_STATUS OUT NOCOPY VARCHAR2, X_MSG_COUNT OUT NOCOPY NUMBER, X_MSG_DATA OUT NOCOPY VARCHAR2, PI_ACTION_ID IN NUMBER, PIO_DME_DISC_ACTION IN OUT NOCOPY DME_DISC_ACTION_TYPE, );
Parameters This API has standard parameters (see "Standard Parameters") as well as the following parameters:
PI_ACTION_ID (Mandatory). Enter the ID of the discrepancy action to retrieve information for.
PIO_DME_DISC_ACTION (Mandatory). This is a parameter of type DME_DISC_ACTION_TYPE for the returned values.
Use this API to retrieve information about an Oracle DMW Discrepancy Action.
Name DME_PUB_DISC_ACTION.GetDiscAction
PROCEDURE GETDISCACTION, ( P_API_VERSION IN VARCHAR2, P_INIT_MSG_LIST IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE, P_COMMIT IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE, P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, X_RETURN_STATUS OUT NOCOPY VARCHAR2, X_MSG_COUNT OUT NOCOPY NUMBER, X_MSG_DATA OUT NOCOPY VARCHAR2, PI_ACTION_NAME IN VARCHAR2, PIO_DME_DISC_ACTION IN OUT NOCOPY DME_DISC_ACTION_TYPE, );
Parameters This API has standard parameters (see "Standard Parameters") as well as the following parameters:
PI_ACTION_NAME (Mandatory). Provide the name of the discrepancy action to retrieve information for.
PIO_DME_DISC_ACTION (Mandatory). This is a parameter of type DME_DISC_ACTION_TYPE for the returned values.
Use this API to modify an existing DMW Discrepancy Action.
Name DME_PUB_DISC_ACTION.UpdateDiscAction
PROCEDURE UPDATEDISCACTION, ( P_API_VERSION IN VARCHAR2, P_INIT_MSG_LIST IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE, P_COMMIT IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE, P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, X_RETURN_STATUS OUT NOCOPY VARCHAR2, X_MSG_COUNT OUT NOCOPY NUMBER, X_MSG_DATA OUT NOCOPY VARCHAR2, PIO_DME_DISC_ACTION IN OUT NOCOPY DME_DISC_ACTION_TYPE, );
Parameters This API has standard parameters (see "Standard Parameters") as well as the following parameter:
PIO_DME_DISC_ACTION (Mandatory). This is a parameter of type DME_DISC_ACTION_TYPE that contains the discrepancy action attributes to be updated.
Use this API to delete an existing DMW Discrepancy Action.
Name DME_PUB_DISC_ACTION.DeleteDiscAction
PROCEDURE DELETEDISCACTION, (P_API_VERSION IN VARCHAR2, P_INIT_MSG_LIST IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE, P_COMMIT IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE, P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, X_RETURN_STATUS OUT NOCOPY VARCHAR2, X_MSG_COUNT OUT NOCOPY NUMBER, X_MSG_DATA OUT NOCOPY VARCHAR2, PI_DME_DISC_ACTION_ID IN NUMBER, );
Parameters: This API has standard parameters (see "Standard Parameters")as well as the following parameters:
PI_DME_DISC_ACTION_ID (Mandatory). This is a parameter of type NUMBER, that contains the unique ID of the category to be disabled.
|
 Copyright © 2013, 2014, Oracle and/or its affiliates. All rights reserved. Legal Notices |
|
