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