Parameters

14 Parameters

This section contains the following topics:

Parent topic: Object APIs

Define and Modify Parameters

This is a public interface for operations involving defined Parameter objects. For further information, see the chapter on Parameters in the Oracle Life Sciences Data Hub Application Developer's Guide.

This section contains the following topics:

Parent topic: Parameters

Create a Parameter

Use this API to create a parameter instance or definition or both the parameter instance and its definition.

Name

CDR_PUB_DF_PARAMETER.CreateParameter

Signature

PROCEDURE CREATEPARAMETER(   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_PARAMNAMING  IN OUT    CDR_NAMING_VERSION_OBJ_TYPE,   PIO_CDRPARAMOBJTYPE  IN OUT    CDR_PARAMETER_OBJ_TYPE,   PI_CREATE_OBJECT  IN    VARCHAR2,   PI_INSTANCE_SUBTYPE_ID  IN    CDR_NAMINGS.OBJECT_SUBTYPE_ID%TYPE,   PI_PARENTNAMING  IN OUT    CDR_BASE_OBJ_TYPE,   PO_DEFCLASSIFICATIONCOLL  IN    CDR_CLASSIFICATIONS_COLL );

Parameters

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

PIO_PARAMNAMING (Mandatory) If you are creating a new instance of an existing Parameter Set definition (and instances of all the Parameters in the Parameter Set definition), enter values to identify the Parameter Set definition. For OBJECT_TYPE_RC enter $OBJTYPES$PARAMSETREF.
If you are creating a single Parameter, enter values for the Parameter definition you want to create or, if you are creating an instance of an existing Parameter definition, enter values to identify the definition you want to create an instance of. For OBJECT_TYPE_RC enter $OBJTYPES$PARAMETER if you are creating a definition only; $OBJTYPES$PARAMREF if you are creating an instance of an existing definition; and NULL if you are creating a new definition and an instance of it.

The following attributes are required: COMPANY_ID, OBJECT_TYPE_RC, NAMESPACE_OBJ_ID, NAMESPACE_OBJ_VER, NAMESPACE_START_OBJ_VER, NAMESPACE_END_OBJ_VER, OWNING_LOCATION_RC, CHECKED_OUT_FLAG_RC, CHECKED_OUT_ID, OBJECT_SUBTYPE_ID, DESCRIPTION, REF_COMPANY_ID, REF_OBJ_ID, REF_OBJ_VER, OBJECT_VERSION_NUMBER, VALIDATION_STATUS_RC, VERSION_LABEL.
PIO_CDRPARAMOBJTYPE (Optional) This is a parameter of table type CDR_PARAMETER_OBJ_TYPE that contains Parameter-specific attributes. If you are creating an instance of an existing Parameter Set, do not enter any values here. If you are creating a single Parameter, enter values for the Parameter definition you want to create or, 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:

For simple parameter, no LOV: COMPANY_ID, PROMPT, INPUT_OUTPUT_RC, READ_ONLY_FLAG_RC, VISIBLE_FLAG_RC, MANDATORY_FLAG_RC, DEFAULT_VALUE, POSITION, PARAM_TYPE_RC, AUTO_SHARE_FIELD_FLAG_RC.

For static LOV type parameter: COMPANY_ID, PROMPT, INPUT_OUTPUT_RC, READ_ONLY_FLAG_RC, VISIBLE_FLAG_RC, MANDATORY_FLAG_RC, DEFAULT_VALUE, POSITION, PARAM_TYPE_RC, AUTO_SHARE_FIELD_FLAG_RC, LOV_COMPANY_ID, LOV_ID, LOV_VER, LOV_MULTI_FLAG_RC, ALLOWED_VALUES_RC, VALIDATION_RULE_RC, VAL_PRG_INST_COMPANY_ID, VAL_PRG_INST_ID, VAL_PRG_INST_VER, VAL_SC_REF_COMPANY_ID, VAL_SC_REF_ID, VAL_SC_REF_VER.

For programatic LOV type parameter: COMPANY_ID, PROMPT, INPUT_OUTPUT_RC, READ_ONLY_FLAG_RC, VISIBLE_FLAG_RC, MANDATORY_FLAG_RC, DEFAULT_VALUE, POSITION, PARAM_TYPE_RC, AUTO_SHARE_FIELD_FLAG_RC, LOV_PRG_INST_COMPANY_ID, LOV_PRG_INST_ID, LOV_PRG_INST_VER, LOV_SC_REF_COMPANY_ID, LOV_SC_REF_ID, LOV_SC_REF_VER, LOV_MULTI_FLAG_RC, ALLOWED_VALUES_RC, VALIDATION_RULE_RC, VAL_PRG_INST_COMPANY_ID, VAL_PRG_INST_ID, VAL_PRG_INST_VER, VAL_SC_REF_COMPANY_ID, VAL_SC_REF_ID, VAL_SC_REF_VER.

For classification LOV type parameter: COMPANY_ID, PROMPT, INPUT_OUTPUT_RC, READ_ONLY_FLAG_RC, VISIBLE_FLAG_RC, MANDATORY_FLAG_RC, DEFAULT_VALUE, POSITION, PARAM_TYPE_RC, AUTO_SHARE_FIELD_FLAG_RC, LOV_CLA_LEVEL_ID, LOV_DEFAULT_CLA_ID, LOV_MULTI_FLAG_RC, ALLOWED_VALUES_RC, VALIDATION_RULE_RC, VAL_PRG_INST_COMPANY_ID, VAL_PRG_INST_ID, VAL_PRG_INST_VER, VAL_SC_REF_COMPANY_ID, VAL_SC_REF_ID, VAL_SC_REF_VER.
PI_CREATE_OBJECT (Mandatory) Enter DEFN to create a Parameter definition only; INST to create a Parameter instance only; BOTH to create a Parameter definition and an instance of it; or PARAMSET if you are creating a new instance of a Parameter Set.
PI_INSTANCE_SUBTYPE_ID (Optional) If you are creating an instance of a single Parameter, enter the ID for the subtype you want to give the instance. If you are creating a Parameter Set instance, do not enter a value here.
PI_PARENTNAMING (Optional) This is a parameter of table type CDR_BASE_OBJ_TYPE. Enter values to identify the object (for example, the Program or Report Set) that contains the Parameter definition.
The following attributes are required: COMPANY_ID, OBJ_ID, OBJ_VER. If you are creating an instance of a Parameter Set, do not enter a value here.
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 Parameters. Do not enter any values for them. If you are not creating a new definition, do not enter values here.

Parent topic: Define and Modify Parameters

Check Out a Parameter

Use this API to check out a Parameter definition.

Name

CDR_PUB_DF_PARAMETER.CheckOutParameter

Signature

PROCEDURE CHECKOUTPARAMETER(   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_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_CDRNAMING (Mandatory) This is a parameter of table type CDR_BASE_OBJ_TYPE that contains CDR Naming attributes. Enter values to identify the Parameter you want to check out. The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.
PI_COMMENT (Optional) Enter an explanation of why you are checking out the Parameter.
PI_ISINSTONLY (Mandatory) Enter $YESNO$NO.

Parent topic: Define and Modify Parameters

Check In a Parameter

Use this API to explicitly check in a Parameter definition.

Name

CDR_PUB_DF_PARAMETER.CheckInParameter

Signature

PROCEDURE CHECKINPARAMETER(   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_BASE_OBJ_TYPE,   PI_COMMENT  IN    VARCHAR2 );

Parameters

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

PIO_CDRNAMING (Mandatory) This is a parameter of table type CDR_BASE_OBJ_TYPE that contains CDR Naming attributes. Enter values to identify the Parameter you want to check out. The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.
PI_COMMENT (Optional) Enter a checkin comment.

Parent topic: Define and Modify Parameters

Get Displayed Parameter Values

Use this API to get the Parameter value(s) that must be displayed in the submission Execution Setup in cases where the displayed value differs from the value used internally: for a Parameter with a classification list of values, this API returns a comma-separated list of the terms in the appropriate classification level (instead of the term_id used internally); for a Report Set Entry Title Parameter, the API returns the title (instead of the RSE obj_id); and for a Parameter with a look-up value, the API returns a display value; for example, 'Yes' instead of $YESNO$YES. You can also use this API to populate a default value for a Parameter in an Execution Setup.

Name

CDR_PUB_DF_PARAMETER.GetDefaultCLAVvalue

Signature

FUNCTION GETDEFAULTCLAVALUE(   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,   PALLOWEDVALUE  IN    CDR_PARAMETERS.ALLOWED_VALUES_RC%TYPE,   PDEFAULTVALUE  IN    VARCHAR2 ) RETURN VARCHAR2;

Parameters

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

P_COMMIT (Optional) Accept the default value (FND_API.G_FALSE) to ensure that this individual API does not commit upon completion. Pass FND_API.G_TRUE to override the default behavior.
P_VALIDATION_LEVEL (Optional) Accept the default value to perform full validation. No other values are currently supported.
PALLOWEDVALUE (Optional) To get the allowed values for a Parameter with a classification LOV, enter $PARAMALLOWVALS$CLALOV. To get the title for a Report Set Entry, enter $PARAMALLOWVALS$ENTRYLOV. To get a look-up value or enter a default value, do not enter a value here.
PDEFAULTVALUE (Optional) To get the allowed values for a Parameter with a classification LOV, enter the level ID of the Parameter's LOV. To get a look-up value, enter $PARAMALLOWVALS$LOV. To get the title for a Report Set Entry, enter the RSE object ID. To set a default value for a Parameter in the Execution Setup, enter the string you want to serve as the default value. The API returns the string.

Parent topic: Define and Modify Parameters

Define Parameter Relations

This is a public interface for operations related to passing values from one Parameter to another within a Report Set or Workflow. For further information, see the chapter on Parameters in the Oracle Life Sciences Data Hub Application Developer's Guide.

This chapter contains the following procedures and functions:

Parent topic: Parameters

Create a Parameter Relation Collection

Program instance contained in the Workflow and an input Parameter of another Program instance that is executed later in the Workflow.

Name

CDR_PUB_DF_PARAM_RELATION.CreateParrelColl

Signature

PROCEDURE CREATEPARRELCOLL( 
  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_PARCOLL  IN OUT    CDR_PARAM_RELATION_COLL, 
  PI_VALIDATERELATIONS  IN    VARCHAR := 'T' 
);

Parameters

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

PIO_PARCOLL (Mandatory) This is a collection of CDR_PARAM_RELATION_OBJ_TYPEs.
For each Parameter relation that you want to create, initialize a CDR_PARAM_RELATION_OBJ_TYPE and then extend the collection. For the SRC attributes enter information about the Parameter whose value will be passed to another Parameter. For the TGT attributes, enter information about the target Parameter that will receive its value from the source Parameter. For RELATION_TYPE enter either LINK or SHARE.
PI_VALIDATERELATIONS (Mandatory) Accept the default value of 'T' to validate the parameter relations in the collection. Enter 'F' to skip validation.

Parent topic: Define Parameter Relations

Get Parameter Instances for Value Passing

Use this API to get a list of Parameters that would be valid for either receiving a value from, or passing a value to, the Parameter you specify in the Report Set or Workflow you specify.

Name

CDR_PUB_DF_PARAM_RELATION.GetParameterRefs

Signature

PROCEDURE GETPARAMETERREFS(   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_PSNSCOMPANYID  IN    CDR_NAMINGS.COMPANY_ID%TYPE,   PI_PSNSOBJID  IN    CDR_NAMINGS.OBJ_ID%TYPE,   PI_PSNSOBJVER  IN    CDR_NAMING_VERSIONS.OBJ_VER%TYPE,   PI_PAROBJID  IN    CDR_NAMINGS.OBJ_ID%TYPE,   PI_PAROBJVER  IN    CDR_NAMING_VERSIONS.OBJ_VER%TYPE,   PO_PARCOLL  OUT    CDR_PARAM_RELATION_COLL,   PI_SHARE  IN    VARCHAR2 );

Parameters

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

PI_PSNSCOMPANYID (Mandatory) Enter the company ID of the Report Set or Workflow.
PI_PSNSOBJID (Mandatory) Enter the object ID of the Report Set or Workflow.
PI_PSNSOBJVER (Mandatory) Enter the version number of the Report Set or Workflow.
PI_PAROBJID (Mandatory) Enter the object ID of the Parameter.
PI_PAROBJVER (Mandatory) Enter the version number of the Parameter.
PO_PARCOLL This output parameter is a collection of CDR_PARAM_RELATION_OBJ_TYPEs containing Parameter instances in the Report Set or Workflow.
PI_SHARE Enter SHAREDFROM to get a list of potential source Parameters that could pass their value to the Parameter you specified. Enter SHAREDTO to get a list of potential target Parameters that could receive their value from the Parameter you specified.

Parent topic: Define Parameter Relations

Remove Parameter Relations

Use this API to delete one or more Parameter relations from a Report Set or Workflow.

Name

CDR_PUB_DF_PARAM_RELATION.RemoveParrelColl

Signature

PROCEDURE REMOVEPARRELCOLL(   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_PARCOLL  IN OUT    CDR_PARAM_RELATION_COLL );

Parameters

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

PIO_PARCOLL (Mandatory) This is a collection of CDR_PARAM_RELATION_OBJ_TYPEs. For each Parameter relation that you want to delete, initialize a CDR_PARAM_RELATION_OBJ_TYPE and then extend the collection.

The following attributes are required: COMPANY_ID, SRC_PARENT_OBJ_ID, SRC_PARENT_OBJ_VER, SRC_PAR_REF_OBJ_ID, SRC_PAR_REF_OBJ_VER, TGT_PARENT_OBJ_ID, TGT_PARENT_OBJ_VER, TGT_PAR_REF_OBJ_ID, TGT_PAR_REF_OBJ_VER.

Parent topic: Define Parameter Relations