This chapter describes a set of programmatic tools (PL/SQL procedures and functions) that may be useful in developing a configuration model and deploying a runtime Oracle Configurator.
This chapter covers the following topics:
This chapter describes programmatic tools that you can use primarily to develop a configuration model and deploy a runtime Oracle Configurator. This includes:
Reference for the CZ_CF_API and the CZ_CONFIG_API_PUB Packages
Important: For the latest reference information on these APIs, see the Oracle Integration Repository, which is installed with your patched instance of the Oracle E-Business Suite, as described in the Preface of this guide. In the Integration Repository, the package described in this chapter can be located by using the Search function on the Internal Name CZ_CF_API.
Important: This chapter includes references to DHTML user interfaces, but these are temporarily retained for historical informational purposes only. As of this release, DHTML UIs are no longer supported.
For information on tools for maintaining a deployed runtime Oracle Configurator, see Programmatic Tools for Maintenance.
The programmatic tools that you use while developing or deploying a runtime Oracle Configurator are provided in the PL/SQL packages CZ_CF_API and CZ_CONFIG_API_PUB.
The CZ_CF_API package contains a set of APIs that enable you to perform various tasks such as the following:
Copying and deleting configurations that are not networked configurations
Determining default dates used by the runtime Oracle Configurator
Establishing session identity
Identifying publications
Validating configurations
Verifying configurations
The CZ_CONFIG_API_PUB package contains a set of APIs that enable you to copy configurations including networked configurations and view an existing configuration in the CZ schema.
The table Overview of Procedures and Functions in the Package CZ_CF_API summarizes and categorizes the procedures and functions available in the packages CZ_CF_API and CZ_CONFIG_API_PUB. The column labeled P/F indicates whether an API is a procedure or a function.
These procedures and functions are described in individual detail in Reference for the CZ_CF_API and the CZ_CONFIG_API_PUB Packages.
These packages are installed in the Oracle Applications database as part of Oracle Configurator.
If you installed a new instance of Oracle Applications, then these packages were installed by using Oracle Rapid Install.
If you installed Oracle Configurator in an existing instance of Oracle Applications, then these packages were installed by applying the appropriate Oracle Configurator patch.
See the Oracle Configurator Installation Guide for details about installing Oracle Configurator.
For background information and details on basic aspects of working with the PL/SQL procedures and functions in this package, refer to the table below, References for Working with PL/SQL Procedures and Functions.This table lists relevant topics in the Oracle documentation library.
| For this topic ... | See this reference document area ... |
|---|---|
|
Oracle database concepts |
|
Oracle Applications developer's guide fundamentals |
|
PL/SQL user's guide and reference |
|
SQL*Plus user's guide and reference |
|
Oracle supplied PL/SQL packages reference |
These procedures and functions are described in detail in Procedures and Functions in the CZ_CF_API and CZ_CONFIG_API_PUB Packages.
Use the following function to establish the identity of a Oracle Applications database session:
Use these procedures to determine the dates used for configurations:
Use this procedure to validate a configuration:
Use this procedure to verify that the configuration exists and that it is both valid and complete:
Use these procedures to copy and delete configurations:
COPY_CONFIGURATION - not to be used with networked configurations
COPY_CONFIGURATION_AUTO - not to be used with networked configurations
CZ_CONFIG_API_PUB.COPY_CONFIGURATION - used with networked configurations
CZ_CONFIG_API_PUB.COPY_CONFIGURATION_AUTO - used with networked configurations
Use this procedure to retrieve a common bill:
After publishing Models, you can verify whether a publication lookup will succeed for a given set of applicability parameters. See Applicability Parameters for details about specifying applicability parameters.
Use these functions to look up publications for a given set of applicability parameters:
Applicability parameters control the availability of a publication in your development or production environment
You can use applicability parameters in Oracle Configurator Developer (OCD) to determine which Model and UI to display when you publish a Model. See the Oracle Configurator Developer User’s Guide for more information about applicability parameters and publishing.
You can also use applicability parameters in the initialization message that a host application sends to the Oracle Configurator Servlet. See Session Initialization for more information.
The table Applicability Parameters for Publication Searches lists the applicability parameters in the CZ_CF_API package that many of the functions and procedures in this package use to search for Models, UIs, and publications.
This table lists each parameter's data type, the corresponding field in the Model Publishing window in Oracle Configurator Developer, and a describes each parameter.
In order to reduce the number of function calls when an application must find Models for multiple products or items, some functions in this package take parameters that are lists of values, and return a list of values (as identified in the syntax for the function). To pass a list of values, this package defines several custom data types that are collections.
Parameters in this package that are of one of these list types do not default to NULL.
See Custom Data Types for the definition of these types.
Use these procedures and functions to register and unregister Models in the pool mapping table. See Routing Models to Specified JVMs for background.
This section provides descriptions of each of the procedures and functions in the CZ_CF_API and CZ_CONFIG_API_PUB packages. These procedures and functions are listed alphabetically in Procedures and Functions in the Packages CZ_CF_API and CZ_CONFIG_API_PUB
Descriptions of the custom data types defined in the package are provided in Custom Data Types.
For a basic example of how to call one of the functions in the CZ_CF_API package, see Using the UI_FOR_PUBLICATION_ID Function.
See Overview of the CZ_CF_API and CZ_CONFIG_API_PUB Packages.
Custom Data Types in the Package CZ_CF_API describes the custom data types that are defined in this package.
For background on the record data type, see the references for collections and records.
For background on the table data type, see the references for collections.
For background on subtypes, see the references for user-defined subtypes.
For background on the UTL_HTTP package, see the references for UTL_HTTP.
For background on these custom data types, see the references under References for Working with PL/SQL Procedures and Functions:
The following table includes the custom data types and provides a description of each.
| Custom Type | Description |
|---|---|
| INPUT_SELECTION | Record consisting of: COMPONENT_CODE VARCHAR2(1200) QUANTITY NUMBER INPUT_SEQ NUMBER CONFIG_ITEM_ID DEFAULT NULL |
| CFG_INPUT_LIST | Table of INPUT_SELECTION indexed by BINARY_INTEGER |
| CFG_OUTPUT_PIECES | This is a result of the batch validation message. Subtype of UTL_HTTP.HTML_PIECES. It is a table of VARCHAR2(2000). |
| NUMBER_TBL_TYPE | Table of NUMBER |
| DATE_TBL_TYPE | Table of DATE |
| VARCHAR2_TBL_TYPE | Table of VARCHAR2(255) |
This section provides descriptions of each of the procedures and functions in the CZ_CF_API and CZ_CONFIG_API_PUB packages, arranged alphabetically. These procedures and functions are listed alphabetically in Procedures and Functions in the Packages CZ_CF_API and CZ_CONFIG_API_PUB.
The following table lists the API procedures and functions in the CZ_CF_API package. The column labeled P/F indicates whether an API is a procedure or a function.
| API Name | P/F |
|---|---|
| COMMON_BILL_FOR_ITEM | P |
| CONFIG_MODEL_FOR_ITEM | F |
| CONFIG_MODEL_FOR_PRODUCT | F |
| CONFIG_MODELS_FOR_ITEMS | F |
| CONFIG_MODELS_FOR_PRODUCTS | F |
| CONFIG_UI_FOR_ITEM | F |
| CONFIG_UI_FOR_ITEM_LF | F |
| CONFIG_UI_FOR_PRODUCT | F |
| CONFIG_UIS_FOR_ITEMS | F |
| CONFIG_UIS_FOR_PRODUCTS | F |
| COPY_CONFIGURATION | P |
| COPY_CONFIGURATION_AUTO | P |
| CZ_CONFIG_API_PUB.COPY_CONFIGURATION | P |
| CZ_CONFIG_API_PUB.COPY_CONFIGURATION_AUTO | P |
| DEFAULT_NEW_CFG_DATES | P |
| DEFAULT_RESTORED_CFG_DATES | P |
| DELETE_CONFIGURATION | P |
| ICX_SESSION_TICKET | F |
| MODEL_FOR_ITEM | F |
| MODEL_FOR_PUBLICATION_ID | F |
| POOL_TOKEN_FOR_PRODUCT_KEY | F |
| PUBLICATION_FOR_ITEM | F |
| PUBLICATION_FOR_PRODUCT | F |
| PUBLICATION_FOR_SAVED_CONFIG | F |
| REGISTER_MODEL_TO_POOL | P |
| UNREGISTER_MODEL_FROM_POOL | P |
| UNREGISTER_POOL | P |
| UI_FOR_ITEM | F |
| UI_FOR_PUBLICATION_ID | F |
| VALIDATE | P |
| CZ_CONFIG_API_PUB.VERIFY_CONFIGURATION | P |
This procedure retrieves the common bill item, if any, for the organization ID and inventory item ID that are passed in as parameters.
This procedure is used by the PUBLICATION_FOR_ITEM function to retrieve the common bill's details if the Model has not been published.
The syntax for this procedure is:
PROCEDURE common_bill_for_item ( in_inventory_item_id IN NUMBER,
in_organization_id IN NUMBER,
common_inventory_item_id OUT NOCOPY NUMBER,
common_organization_id OUT NOCOPY NUMBER);
The table Parameters for the COMMON_BILL_FOR_ITEM Procedure lists the parameters for the COMMON_BILL_FOR_ITEM procedure. The description includes the data type, the mode (in or out), and a brief note about the parameter.
| Parameter | Data Type | Mode | Note |
|---|---|---|---|
| in_inventory_item_id | number | in | Inventory Item ID of item for which common bill may be defined. |
| in_organization_id | number | in | Organization ID of Item for which common bill may be defined. |
| common_inventory_item_id | number | out | Inventory Item ID of the common bill item. NULL if no common bill defined. |
| common_organization_id | number | out | Organization ID of the common bill Item. NULL if no common bill defined. |
This function finds a published configuration model for an item, and other applicability parameters. Returns NULL if the Model cannot be found.
None
This function should be used after publishing Models, to verify if publication lookup will succeed for a given set of applicability parameters.
Publications must exist for a Model to be returned. This function must be run on the instance that the Model is published to.
If usage_name and/or publication_mode are NULL or not provided, profile option values will be checked. However, Oracle Applications session parameters are not defined by default within a SQL*Plus session. If profile option values are not defined for this or any other reason, the defaults for usage_name and/or publication_mode will be "Any Usage" and "P" (Production) respectively.
The syntax for this function is:
FUNCTION config_model_for_item (inventory_item_id IN NUMBER,
organization_id IN NUMBER,
config_lookup_date IN DATE,
calling_application_id IN NUMBER,
usage_name IN VARCHAR2,
publication_mode IN VARCHAR2 DEFAULT NULL,
language IN VARCHAR2 DEFAULT NULL)
RETURN NUMBER;
The table Parameters for the CONFIG_MODEL_FOR_ITEM Function describes the parameters for the CONFIG_MODEL_FOR_ITEM function. The table includes the data type, the mode (in or out), and a brief note about the parameter.
| Parameter | Data Type | Mode | Note |
|---|---|---|---|
| inventory_item_id | number | in | If the Model was imported from Oracle BOM, this is the Inventory Item ID for the published Model, from the MTL_SYSTEM_ITEMS table, on which configuration models are based. |
| organization_id | number | in | If the Model was imported from Oracle BOM, this is the organization ID for the published Model, from the MTL_SYSTEM_ITEMS table, on which configuration models are based. |
| config_lookup_date | date | in | Date to search for inside the applicable range for the publication. See Applicability Parameters. |
| calling_application_id | number | in | The registered ID of an application for which the Model is published. See Applicability Parameters. |
| usage_name | varchar2 | in | Usage name to search for in the publication. See Applicability Parameters. |
| publication_mode | varchar2 | in | Publication mode to search for in the publication. See Applicability Parameters. |
| language | varchar2 | in | Language code to search for in the publication. See Applicability Parameters. |
None
This function returns the devl_project_id of the configuration model published for this combination of inputs. NULL is returned if there is no matching publication.
This function finds the Models that are associated with each entry in a list of Inventory Items that are published with the matching applicability parameters. The function returns the list of Model IDs (devl_project_id values) that meet the specified parameters.
None
This function should be used after publishing Models, to verify if publication lookup will succeed for a given set of applicability parameters.
Publications must exist for a Model to be returned. This function must be run on the instance that the Model is published to.
If usage_name and/or publication_mode are NULL or not provided, the CZ: Publication Usage and/or CZ: Publication Lookup Mode profile option values will be checked. However, Oracle Applications session parameters are not defined by default within a SQL*Plus session. If profile option values are not defined for this or any other reason, the defaults for usage_name and/or publication_mode will be "Any Usage" and "P" (Production) respectively.
The syntax for this function is:
FUNCTION config_models_for_items (inventory_item_id IN NUMBER_TBL_TYPE,
organization_id IN NUMBER_TBL_TYPE,
config_lookup_date IN DATE_TBL_TYPE,
calling_application_id IN NUMBER_TBL_TYPE,
usage_name IN VARCHAR2_TBL_TYPE,
publication_mode IN VARCHAR2_TBL_TYPE,
language IN VARCHAR2_TBL_TYPE)
RETURN NUMBER_TBL_TYPE;
The following table describes the parameters for the CONFIG_MODELS_FOR_ITEMS function. This includes the data type, the mode (in or out), and a brief note about the parameter.
| Parameter | Data Type | Mode | Note |
|---|---|---|---|
| inventory_item_id | number_tbl_type | in | If the Model was imported from Oracle BOM, this is a list of Inventory Item IDs for the published Model from the MTL_SYSTEM_ITEMS table, on which configuration models are based. |
| organization_id | number_tbl_type | in | If the Model was imported from Oracle BOM, this is a list of organization IDs for the published Model from the MTL_SYSTEM_ITEMS table, on which configuration models are based. |
| config_lookup_date | date_tbl_type | in | List of dates to search for inside the applicable range for the publication. See Applicability Parameters. |
| calling_application_id | number_tbl_type | in | List of registered IDs of applications for which the Model is published. See Applicability Parameters. |
| usage_name | varchar2_tbl_type | in | List of Usage names to search for in the publication. See Applicability Parameters. |
| publication_mode | varchar2_tbl_type | in | List of publication modes to search for in the publication. See Applicability Parameters. |
| language | varchar2_tbl_type | in | List of language codes to search for in the publication. See Applicability Parameters. |
None
This function returns an array in which each element is a devl_project_id value for the associated item. NULL is returned if there is no matching publication.
This function finds a published configuration model for a product key and other applicability parameters. Returns NULL if the Model cannot be found.
None
This function should be used after publishing Models, to verify if publication lookup will succeed for a given set of applicability parameters.
Publications must exist for a Model to be returned. This function must be run on the instance that the Model is published to.
If usage_name and/or publication_mode are NULL or not provided, the CZ: Publication Usage and/or CZ: Publication Lookup Mode profile option values will be checked. However, Oracle Applications session parameters are not defined by default within a SQL*Plus session. If profile option values are not defined for this or any other reason, the defaults for usage_name and/or publication_mode will be "Any Usage" and "P" (Production) respectively.
The syntax for this function is:
FUNCTION config_model_for_product (product_key IN VARCHAR2,
config_lookup_date IN DATE,
calling_application_id IN NUMBER,
usage_name IN VARCHAR2,
publication_mode IN VARCHAR2 DEFAULT NULL,
language IN VARCHAR2 DEFAULT NULL)
RETURN NUMBER;
The following table describes the parameters for the CONFIG_MODEL_FOR_PRODUCT function. This includes the data type, the mode (in or out), and a brief note about the parameter.
| Parameter | Data Type | Mode | Note |
|---|---|---|---|
| product_key | varchar2 | in | Product key to search for in the publication. See Applicability Parameters. |
| config_lookup_date | date | in | Date to search for inside the applicable range for the publication. See Applicability Parameters. |
| calling_application_id | number | in | The registered ID of an application for which the Model is published. See Applicability Parameters. |
| usage_name | varchar2 | in | Usage name to search for in the publication. See Applicability Parameters. |
| publication_mode | varchar2 | in | Publication mode to search for in the publication. See Applicability Parameters. |
| language | varchar2 | in | Language code to search for in the publication. See Applicability Parameters. |
None
This function returns the devl_project_id of the configuration model published for this combination of inputs. NULL is returned if there is no matching publication.
This function returns a list of Model IDs (devl_project_id values) associated with each entry in a list of product keys that are published with matching applicability parameters.
None
This function should be used after publishing Models, to verify if publication lookup will succeed for a given set of applicability parameters.
Publications must exist for a Model to be returned. This function must be run on the instance that the Model is published to.
If usage_name and/or publication_mode are NULL or not provided, the CZ: Publication Usage and/or CZ: Publication Lookup Mode profile option values will be checked. However, Oracle Applications session parameters are not defined by default within a SQL*Plus session. If profile option values are not defined for this or any other reason, the defaults for usage_name and/or publication_mode will be "Any Usage" and "P" (Production) respectively.
The syntax for this function is:
FUNCTION config_models_for_products ( product_key IN VARCHAR2_TBL_TYPE,
config_lookup_date IN DATE_TBL_TYPE,
calling_application_id IN NUMBER_TBL_TYPE,
usage_name IN VARCHAR2_TBL_TYPE,
publication_mode IN VARCHAR2_TBL_TYPE,
language IN VARCHAR2_TBL_TYPE)
RETURN NUMBER_TBL_TYPE;
The following table describes the parameters for the CONFIG_MODELS_FOR_PRODUCTS function. This includes the data type, the mode (in or out), and a brief note about the parameter.
| Parameter | Data Type | Mode | Note |
|---|---|---|---|
| product_key | varchar2_tbl_type | in | List of product keys to search for in the publication. See Applicability Parameters. |
| config_lookup_date | date_tbl_type | in | List of dates to search for inside the applicable range for the publication. See Applicability Parameters. |
| calling_application_id | number_tbl_type | in | List of registered IDs of applications for which the Model is published. See Applicability Parameters. |
| usage_name | varchar2_tbl_type | in | List of Usage names to search for in the publication. See Applicability Parameters. |
| publication_mode | varchar2_tbl_type | in | List of publication modes to search for in the publication. See Applicability Parameters. |
| language | varchar2_tbl_type | in | List of language codes to search for in the publication. See Applicability Parameters. |
None
This function returns a list of Model IDs (devl_project_id values) associated with each entry in a list of product keys that are published with matching applicability parameters.
This function returns the user interface ID associated with the publication found for the input item, organization ID, and applicability.
None
This function should be used after publishing Models, to verify if publication lookup will succeed for a given set of applicability parameters.
Publications must exist for a Model to be returned. This function must be run on the instance that the Model is published to.
If usage_name and/or publication_mode are NULL or not provided, the CZ: Publication Usage and/or CZ: Publication Lookup Mode profile option values will be checked. However, Oracle Applications session parameters are not defined by default within a SQL*Plus session. If profile option values are not defined for this or any other reason, the defaults for usage_name and/or publication_mode will be "Any Usage" and "P" (Production) respectively.
The syntax for this function is:
FUNCTION config_ui_for_item (inventory_item_id IN NUMBER,
organization_id IN NUMBER,
config_lookup_date IN DATE,
ui_type IN OUT NOCOPY VARCHAR2,
calling_application_id IN NUMBER,
usage_name IN VARCHAR2,
publication_mode IN VARCHAR2 DEFAULT NULL,
language IN VARCHAR2 DEFAULT NULL)
RETURN NUMBER;
The following table describes the parameters for the CONFIG_UI_FOR_ITEM function. This includes the data type, the mode (in or out), and a brief note about the parameter.
| Parameter | Data Type | Mode | Note |
|---|---|---|---|
| inventory_item_id | number | in | If the Model was imported from Oracle BOM, this is the Inventory Item ID for the published Model, from the MTL_SYSTEM_ITEMS table, on which configuration models are based. |
| organization_id | number | in | If the Model was imported from Oracle BOM, this is the organization ID for the published Model, from the MTL_SYSTEM_ITEMS table, on which configuration models are based. |
| config_lookup_date | date | in | Date to search for inside the applicable range for the publication. See Applicability Parameters. |
| ui_type | varchar2 | in/out | This is the type of published UI sought and found for each product. Values are ’APPLET’, ’DHTML’, or ’JRAD’. If either DHTML or JRAD is passed, then the publication UI type must be either DHTML or JRAD. Otherwise NULL is returned. If APPLET is passed, then the publication UI type can be either APPLET, DHTML, or JRAD. If DHTML or JRAD is passed and there is no publication available for the item, then the API returns the user interface ID of the BOM JRAD UI. |
| calling_application_id | number | in | The registered ID of an application for which the Model is published. See Applicability Parameters. |
| usage_name | varchar2 | in | Usage name to search for in the publication. See Applicability Parameters. |
| publication_mode | varchar2 | in | Publication mode to search for in the publication. See Applicability Parameters. |
| language | varchar2 | in | Language code to search for in the publication. See Applicability Parameters. |
None
This function returns the user interface ID associated with the selected publication.
If the ui_type is APPLET, then the publication UI type can be either APPLET, DHTML, or JRAD.
If the ui_type is either DHTML or JRAD, then the publication UI type must be either DHTML or JRAD. Otherwise NULL is returned. If there is no publication available for the item, then the API returns the user interface ID of the BOM JRAD UI.
This function does the same work as CONFIG_UI_FOR_ITEM, but also returns the look_and_feel of the UI (’APPLET’, ’BLAF’, or ’FORMS’).
None
This function should be used after publishing Models, to verify if publication lookup will succeed for a given set of applicability parameters.
Publications must exist for a Model to be returned. This function must be run on the instance that the Model is published to.
If usage_name and/or publication_mode are NULL or not provided, CZ: Publication Usage and/or CZ: Publication Lookup Mode profile option values will be checked. However, Oracle Applications session parameters are not defined by default within a SQL*Plus session. If profile option values are not defined for this or any other reason, the defaults for usage_name and/or publication_mode will be "Any Usage" and "P" (Production) respectively.
The syntax for this function is:
FUNCTION config_ui_for_item_lf ( inventory_item_id IN NUMBER,
organization_id IN NUMBER,
config_lookup_date IN DATE,
ui_type IN OUT NOCOPY VARCHAR2,
calling_application_id IN NUMBER,
usage_name IN VARCHAR2,
look_and_feel OUT NOCOPY VARCHAR2,
publication_mode IN VARCHAR2 DEFAULT NULL,
language IN VARCHAR2 DEFAULT NULL)
RETURN NUMBER;
The following table describes the parameters for the CONFIG_UI_FOR_ITEM_LF function. This includes the data type, the mode (in or out), and a brief note about the parameter.
| Parameter | Data Type | Mode | Note |
|---|---|---|---|
| inventory_item_id | number | in | If the Model was imported from Oracle BOM, this is the Inventory Item ID for the published Model, from the MTL_SYSTEM_ITEMS table, on which configuration models are based. |
| organization_id | number | in | If the Model was imported from Oracle BOM, this is the organization ID for the published Model, from the MTL_SYSTEM_ITEMS table, on which configuration models are based. |
| config_lookup_date | date | in | Date to search for inside the applicable range for the publication. See Applicability Parameters. |
| ui_type | varchar2 | in/out | This is the type of published UI sought and found for each product. Values are ’APPLET’, ’DHTML’, or ’JRAD’. If either DHTML or JRAD is passed, then the publication UI type must be either DHTML or JRAD. Otherwise NULL is returned. If APPLET is passed, then the publication UI type can be either APPLET, DHTML, or JRAD. If DHTML or JRAD is passed and there is no publication available for the item, then the API returns the user interface ID of the BOM JRAD UI. |
| calling_application_id | number | in | The registered ID of an application for which the Model is published. See Applicability Parameters. |
| usage_name | varchar2 | in | Usage name to search for in the publication. See Applicability Parameters. |
| look_and_feel | varchar2 | out | This is a tag that overrides the default look and feel for component-style UIs (when UI_STYLE=0) in the CZ_UI_DEFS table. |
| publication_mode | varchar2 | in | Publication mode to search for in the publication. See Applicability Parameters. |
| language | varchar2 | in | Language code to search for in the publication. See Applicability Parameters. |
None
This function returns the user interface ID associated with the selected publication.
If the ui_type is APPLET, then the publication UI type can be either APPLET, DHTML, or JRAD.
If the ui_type is either DHTML or JRAD, then the publication UI type must be either DHTML or JRAD. Otherwise NULL is returned. If there is no publication available for the item, then the API returns the user interface ID of the BOM JRAD UI.
This function finds a UI for a product, and returns NULL if no UI can be found. If ui_type is passed in, the function will validate the UI it finds against this type. If the types do not match, no UI will be returned. If no ui_type is passed, the type of the UI will be returned in ui_type.
None
This function should be used after publishing Models, to verify if publication lookup will succeed for a given set of applicability parameters.
Publications must exist for a Model to be returned. This function must be run on the instance that the Model is published to.
If usage_name and/or publication_mode are NULL or not provided, the CZ: Publication Usage and/or CZ: Publication Lookup Mode profile option values will be checked. However, Oracle Applications session parameters are not defined by default within a SQL*Plus session. If profile option values are not defined for this or any other reason, the defaults for usage_name and/or publication_mode will be "Any Usage" and "P" (Production) respectively.
The syntax for this function is:
FUNCTION config_ui_for_product ( product_key IN VARCHAR2,
config_lookup_date IN DATE,
ui_type IN OUT NOCOPY VARCHAR2,
calling_application_id IN NUMBER,
usage_name IN VARCHAR2,
publication_mode IN VARCHAR2 DEFAULT NULL,
language IN VARCHAR2 DEFAULT NULL)
RETURN NUMBER;
The following table describes the parameters for the CONFIG_UI_FOR_PRODUCT function. This includes the data type, the mode (in or out), and a brief note about the parameter.
| Parameter | Data Type | Mode | Note |
|---|---|---|---|
| product_key | varchar2 | in | Product key to search for in the publication. See Applicability Parameters. |
| config_lookup_date | date | in | Date to search for inside the applicable range for the publication. See Applicability Parameters. |
| ui_type | varchar2 | in/out | This is the type of published UI sought and found for each product. Values are ’APPLET’, ’DHTML’, or ’JRAD’. If either DHTML or JRAD is passed, then the publication UI type must be either DHTML or JRAD. Otherwise NULL is returned. If APPLET is passed, then the publication UI type can be either APPLET, DHTML, or JRAD. If DHTML or JRAD is passed and there is no publication available for the item, and if the product_key corresponds to the inventory item, then the user interface ID of the BOM UI is returned |
| calling_application_id | number | in | The registered ID of an application for which the Model is published. See Applicability Parameters. |
| usage_name | varchar2 | in | Usage name to search for in the publication. See Applicability Parameters. |
| publication_mode | varchar2 | in | Publication mode to search for in the publication. See Applicability Parameters. |
| language | varchar2 | in | Language code to search for in the publication. See Applicability Parameters. |
None
If ui_type is passed in, then the function will validate the UI it finds against this type. This is the type of published UI sought and found for each product. Values are ’APPLET’, ’DHTML’, or ’JRAD’.
If either DHTML or JRAD is passed, then the publication UI type must be either DHTML or JRAD. Otherwise NULL is returned. If DHTML or JRAD is passed and the item does not have a publication available, and if the product_key corresponds to the inventory item, then the user interface ID of the BOM UI is returned.
If APPLET is passed, then the publication UI type can be either APPLET, DHTML, or JRAD.
This function returns a list of user interfaces that are associated with each entry in the list of Inventory Items that are published with matching applicability parameters.
None
This function should be used after publishing Models to verify if publication lookup will succeed for a given set of applicability parameters.
Publications must exist for a Model to be returned. This function must be run on the instance that the Model is published to.
If usage_name and/or publication_mode are NULL or not provided, the CZ: Publication Usage and/or CZ: Publication Lookup Mode profile option values will be checked. However, Oracle Applications session parameters are not defined by default within a SQL*Plus session. If profile option values are not defined for this or any other reason, the defaults for usage_name and/or publication_mode will be "Any Usage" and "P" (Production) respectively.
The syntax for this function is:
FUNCTION config_uis_for_items ( inventory_item_id IN NUMBER_TBL_TYPE,
organization_id IN NUMBER_TBL_TYPE,
config_lookup_date IN DATE_TBL_TYPE,
ui_type IN OUT NOCOPY VARCHAR2_TBL_TYPE,
calling_application_id IN NUMBER_TBL_TYPE,
usage_name IN VARCHAR2_TBL_TYPE,
publication_mode IN VARCHAR2_TBL_TYPE,
language IN VARCHAR2_TBL_TYPE )
RETURN NUMBER_TBL_TYPE;
The following table describes the parameters for the CONFIG_UIS_FOR_ITEMS function. This includes the data type, the mode (in or out), and a brief note about the parameter.
| Parameter | Data Type | Mode | Note |
|---|---|---|---|
| inventory_item_id | number_tbl_type | in | If the Model was imported from Oracle BOM, this is a list of Inventory Item IDs for the published Model from the MTL_SYSTEM_ITEMS table, on which configuration models are based. |
| organization_id | number_tbl_type | in | If the Model was imported from Oracle BOM, this is a list of organization IDs for the published Model from the MTL_SYSTEM_ITEMS table, on which configuration models are based. |
| config_lookup_date | date_tbl_type | in | List of dates to search for inside the applicable range for the publication. See Applicability Parameters. |
| ui_type | varchar2_tbl_type | in/ out | This is the type of published UI sought and found for each product. Values are ’APPLET’, ’DHTML’, or ’JRAD’. If either DHTML or JRAD is passed, then the publication UI type must be either DHTML or JRAD. Otherwise NULL is returned. If APPLET is passed, then the publication UI type can be either APPLET, DHTML, or JRAD. If DHTML or JRAD is passed and there is no publication available for the item, then the API returns the user interface ID of the BOM JRAD UI. |
| calling_application_id | number_tbl_type | in | List of registered IDs of applications for which the Model is published. See Applicability Parameters. |
| usage_name | varchar2_tbl_type | in | List of Usage names to search for in the publication. See Applicability Parameters. |
| publication_mode | varchar2_tbl_type | in | List of publication modes to search for in the publication. See Applicability Parameters. |
| language | varchar2_tbl_type | in | Language code to search for in the publication. See Applicability Parameters. |
None
This function returns the user interface ID associated with the selected publication.
If the ui_type is APPLET, then the publication UI type can be either APPLET, DHTML, or JRAD.
If the ui_type is either DHTML or JRAD, then the publication UI type must be either DHTML or JRAD. Otherwise NULL is returned. If there is no publication available for the item, then the API returns the user interface ID of the BOM JRAD UI.
This function returns a list of user interfaces that are associated with each entry in the list of product keys that are published with matching applicability parameters.
None
This function should be used after publishing Models, to verify if publication lookup will succeed for a given set of applicability parameters.
Publications must exist for a Model to be returned. This function must be run on the instance that the Model is published to.
If usage_name and/or publication_mode are NULL or not provided, the CZ: Publication Usage and/or CZ: Publication Lookup Mode profile option values will be checked. However, Oracle Applications session parameters are not defined by default within a SQL*Plus session. If profile option values are not defined for this or any other reason, the defaults for usage_name and/or publication_mode will be "Any Usage" and "P" (Production) respectively.
The syntax for this function is:
FUNCTION config_uis_for_products ( product_key IN VARCHAR2_TBL_TYPE,
config_lookup_date IN DATE_TBL_TYPE,
ui_type IN OUT NOCOPY VARCHAR2_TBL_TYPE,
calling_application_id IN NUMBER_TBL_TYPE,
usage_name IN VARCHAR2_TBL_TYPE,
publication_mode IN VARCHAR2_TBL_TYPE,
language IN VARCHAR2_TBL_TYPE )
RETURN NUMBER_TBL_TYPE;
The following table describes the parameters for the CONFIG_UIS_FOR_PRODUCTS function. This includes the data type, the mode (in or out), and a brief note about the parameter.
| Parameter | Data Type | Mode | Note |
|---|---|---|---|
| product_key | varchar2_tbl_type, | in | List of product keys to search for in the publication. See Applicability Parameters. |
| config_lookup_date | date_tbl_type, | in | List of dates to search for inside the applicable range for the publication. See Applicability Parameters. |
| ui_type | varchar2_tbl_type, | in/out | This is the type of published UI sought and found for each product. Values are ’APPLET’, ’DHTML’, or ’JRAD’. If either DHTML or JRAD is passed, then the publication UI type must be either DHTML or JRAD. Otherwise NULL is returned. If APPLET is passed, then the publication UI type can be either APPLET, DHTML, or JRAD. If DHTML or JRAD is passed and there is no publication available for the item, and if the product_key corresponds to the inventory item, then the user interface ID of the BOM UI is returned |
| calling_application_id | number_tbl_type, | in | List of registered IDs of applications for which the Model is published. See Applicability Parameters. |
| usage_name | varchar2_tbl_type, | in | List of Usage names to search for in the publication. See Applicability Parameters. |
| publication_mode | varchar2_tbl_type, | in | List of publication modes to search for in the publication. See Applicability Parameters. |
| language | varchar2_tbl_type | in | List of language codes to search for in the publication. See Applicability Parameters. |
None
If ui_type is passed in, then the function will validate the UI it finds against this type. This is the type of published UI sought and found for each product. Values are ’APPLET’, ’DHTML’, or ’JRAD’.
If either DHTML or JRAD is passed, then the publication UI type must be either DHTML or JRAD. Otherwise NULL is returned. If DHTML or JRAD is passed and the item does not have a publication available, and if the product_key corresponds to the inventory item, then the user interface ID of the BOM UI is returned.
If APPLET is passed, then the publication UI type can be either APPLET, DHTML, or JRAD.
This procedure in the CZ_CF_API package is used to copy configurations models. It is not to be used to copy networked configuration models.
This procedure copies a configuration in the database. If the NEW_CONFIG_FLAG is 1, then a new CONFIG_HDR_ID value is generated for the new configuration and it is REV_NBR 1. If NEW_CONFIG_FLAG is 0, the copy keeps the CONFIG_HDR_ID and has a REV_NBR incremented to be greater than the original.
None
The configuration to be copied must exist. This procedure must not be used with networked Models.
Note: If you want to copy a networked configuration model, then you must use the copy_configuration procedure in the CZ_CONFIG_API_PUB package. For more information see CZ_CONFIG_API_PUB.COPY_CONFIGURATION.
This procedure should be used every time a configuration is copied. The procedure will ensure that all inputs, outputs, attributes, and messages are copied.
If the configuration does not exist, or if the copy fails, return_value will be zero, and error_message will contain error information.
Note: COPY_CONFIGURATION procedure does not commit the copy data. It is your responsibility to commit the copied configuration.
The syntax for this procedure is:
PROCEDURE copy_configuration( config_hdr_id IN NUMBER,
config_rev_nbr IN NUMBER,
new_config_flag IN VARCHAR2,
out_config_hdr_id IN OUT NOCOPY NUMBER,
out_config_rev_nbr IN OUT NOCOPY NUMBER,
error_message IN OUT NOCOPY VARCHAR2,
return_value IN OUT NOCOPY NUMBER,
handle_deleted_flag IN VARCHAR2 DEFAULT NULL,
new_name IN VARCHAR2 DEFAULT NULL);
The following table describes the parameters for the COPY_CONFIGURATION procedure. This includes the data type, the mode (in or out), and a brief note about the parameter.
| Parameter | Data Type | Mode | Note |
|---|---|---|---|
| config_hdr_id | number | in | Specifies which configuration to copy. Uses CZ_CONFIG_HDRS, CZ_CONFIG_INPUTS, CZ_CONFIG_ITEMS, CZ_CONFIG_MESSAGES, and CZ_CONFIG_ATTRIBUTES. |
| config_rev_nbr | number | in | Specifies which configuration to copy. Uses CZ_CONFIG_HDRS, CZ_CONFIG_INPUTS, CZ_CONFIG_ITEMS, CZ_CONFIG_MESSAGESl, and CZ_CONFIG_ATTRIBUTES. |
| new_config_flag | varchar2 | in | A ’1' indicates that the copied configuration should have a new CONFIG_HDR_ID. A '0' indicates that the copied configuration should have the same CONFIG_HDR_ID and a unique CONFIG_REV_NBR. For example it is a revision of the existing configuration. |
| out_config_hdr_id | number | in/out | Identifies the new copy of the configuration. |
| out_config_rev_nbr | number | in/out | Identifies the new copy of the configuration. |
| error_message | varchar2 | in/out | Contains an error message if an error occurs. |
| return_value | number | in/out | Indicates the success (1) or failure (0) of the copy. |
| handle_deleted_flag | varchar2 | in | When ’0’, it will undelete the copied configuration if the original configuration is deleted. |
| new_name | varchar2 | in | Applies a new name for the configuration |
None
This procedure copies all database records associated with a configuration to a new config_hdr_id and config_rev_nbr.
Examine return_value and error_message to determine what the next step should be
This API procedure in the CZ_CONFIG_API_PUB package is used to copy configurations as well as configurations that contain connectors and support connectivity.
This procedure creates a new configuration by copying the original configuration’s CONFIG_HDR_ID and CONFIG_REV_NBR
This procedure copies a configuration in the database. If the NEW_CONFIG_FLAG is 1, then a new CONFIG_HDR_ID value is generated for the new configuration and it is REV_NBR 1. If NEW_CONFIG_FLAG is 0, the copy keeps the CONFIG_HDR_ID and has a REV_NBR incremented to be greater than the original.
None
The configuration to be copied must exist.
This procedure should be used every time a configuration is copied. The procedure will ensure that all inputs, outputs, attributes, and messages are copied.
If the configuration does not exist, or if the copy fails, return_status will be FND_API.G_RET_STS_ERROR or FND_API.G_RET_STS_UNEXP_ERROR if an error occurs within the procedure, and msg_data will contain error information.
Note: CZ_CONFIG_API_PUB.COPY_CONFIGURATION procedure does not commit the copy data. It is your responsibility to commit the copied configuration.
The syntax for this procedure is:
PROCEDURE copy_configuration(p_api_version IN NUMBER,
p_config_hdr_id IN NUMBER,
p_config_rev_nbr IN NUMBER,
p_copy_mode IN VARCHAR2,
x_config_hdr_id OUT NOCOPY NUMBER,
x_config_rev_nbr OUT NOCOPY NUMBER,
x_orig_item_id_tbl OUT NOCOPY CZ_API_PUB.number_tbl_type,
x_new_item_id_tbl OUT NOCOPY CZ_API_PUB.number_tbl_type,
x_return_status OUT NOCOPY VARCHAR2,
x_msg_count OUT NOCOPY NUMBER,
x_msg_data OUT NOCOPY VARCHAR2,
p_handle_deleted_flag IN VARCHAR2 := NULL,
p_new_name IN VARCHAR2 := NULL);
The following table describes the parameters for the CZ_CONFIG_API_PUB.COPY_CONFIGURATION procedure. This includes the data type, the mode (in or out), and a brief note about the parameter.
| Parameter | Data Type | Mode | Note |
|---|---|---|---|
| p_api_version | number | in | Required. See API Version Numbers |
| p_config_hdr_id | number | in | Required. Specifies which configuration to copy. Uses CZ_CONFIG_HDRS, CZ_CONFIG_INPUTS, CZ_CONFIG_ITEMS, CZ_CONFIG_MESSAGES, and CZ_CONFIG_ATTRIBUTES. |
| p_config_rev_nbr | number | in | Required. Specifies which configuration to copy. Uses CZ_CONFIG_HDRS, CZ_CONFIG_INPUTS, CZ_CONFIG_ITEMS, CZ_CONFIG_MESSAGESl, and CZ_CONFIG_ATTRIBUTES. |
| x_config_hdr_id | number | out | Identifies the new copy of the configuration. |
| x_config_rev_nbr | number | out | Identifies the new copy of the configuration. |
| p_copy_mode | varchar2 | in | Required. Specifies whether the new configuration has a new header ID or a new revision number. |
| x_orig_item_id_tbl | number | out | A table of the item IDs for the items in the original configuration. |
| x_new_item_id_tbl | number | out | A table of the item IDS for the items in the new configuration. |
| x_return_status | varchar2 | out | Must return FND_API.G_RET_STS_SUCCESS if procedure completed successfully; otherwise return FND_API.G_RET_STS_ERROR or FND_API.G_RET_STS_UNEXP_ERROR if an error occurs within the procedure |
| x_msg_count | number | out | Required. The number of error messages returned in the x_msg_data parameter. |
| x_msg_data | varchar2 | out | Contains an error message if the procedure is returning an x_return_status value of FND_API.G_RET_STS_ERROR or FND_API.G_RET_STS_UNEXP_ERROR |
| p_handle_deleted_flag | varchar2 | in | When ’0’, it will undelete the copied configuration if the original configuration is deleted. |
| p_new_name | varchar2 | in | Applies a new name for the configuration |
This procedure runs COPY_CONFIGURATION within an autonomous transaction. If the copy is successful, new data will be committed to the database without affecting the caller’s transaction.
See other information for COPY_CONFIGURATION.
None
The configuration to be copied must exist. This procedure must not be used with networked Models.
Note: If you want to copy a networked configuration model autonomously, then you must use the copy_configuration procedure in the CZ_CONFIG_API_PUB package. For more information see CZ_CONFIG_API_PUB.COPY_CONFIGURATION_AUTO.
This procedure should be used every time a configuration is copied. The procedure will ensure that all inputs, outputs, attributes, and messages are copied.
If the configuration does not exist, or if the copy fails, return_value will be zero, and error_message will contain error information.
Note: COPY_CONFIGURATION_AUTO procedure does not commit the copy data. It is your responsibility to commit the copied configuration.
The syntax for this procedure is:
PROCEDURE copy_configuration_auto(config_hdr_id IN NUMBER,
config_rev_nbr IN NUMBER,
new_config_flag IN VARCHAR2,
out_config_hdr_id IN OUT NOCOPY NUMBER,
out_config_rev_nbr IN OUT NOCOPY NUMBER,
Error_message IN OUT NOCOPY VARCHAR2,
Return_value IN OUT NOCOPY NUMBER,
handle_deleted_flag IN VARCHAR2 DEFAULT NULL,
new_name IN VARCHAR2 DEFAULT NULL);
The following table describes the parameters for the COPY_CONFIGURATION_AUTO procedure. This includes the data type, the mode (in or out), and a brief note about the parameter.
| Parameter | Data Type | Mode | Note |
|---|---|---|---|
| config_hdr_id | number | in | See corresponding parameter in Parameters for the COPY_CONFIGURATION Procedure. |
| config_rev_nbr | number | in | See corresponding parameter in Parameters for the COPY_CONFIGURATION Procedure. |
| new_config_flag | varchar2 | in | See corresponding parameter in Parameters for the COPY_CONFIGURATION Procedure. |
| out_config_hdr_id | number | in/out | See corresponding parameter in Parameters for the COPY_CONFIGURATION Procedure. |
| out_config_rev_nbr | number | in/out | See corresponding parameter in Parameters for the COPY_CONFIGURATION Procedure. |
| error_message | varchar2 | in/out | See corresponding parameter in Parameters for the COPY_CONFIGURATION Procedure. |
| return_value | number | in/out | See corresponding parameter in Parameters for the COPY_CONFIGURATION Procedure. |
| handle_deleted_flag | varchar2 default null | in | See corresponding parameter in Parameters for the COPY_CONFIGURATION Procedure. |
| new_name | varchar2 default null | in | See corresponding parameter in Parameters for the COPY_CONFIGURATION Procedure. |
None
This procedure copies all database records associated with a configuration to a new config_hdr_id and config_rev_nbr.
Examine return_value and error_message to determine what the next step should be.
This procedure runs COPY_CONFIGURATION within an autonomous transaction. If the copy is successful, new data will be committed to the database without affecting the caller’s transaction. This procedure can be used with networked configurations.
See other information for COPY_CONFIGURATION.
None
The configuration to be copied must exist.
This procedure should be used every time a configuration is copied. The procedure will ensure that all inputs, outputs, attributes, and messages are copied.
If the configuration does not exist, or if the copy fails, return_status will be FND_API.G_RET_STS_ERROR or FND_API.G_RET_STS_UNEXP_ERROR if an error occurs within the procedure, and msg_data will contain error information.
Note: CZ_AUTO_API_PUB.COPY_CONFIGURATION_AUTO procedure does not commit the copy data. It is your responsibility to commit the copied configuration.
The syntax for this procedure is:
PROCEDURE copy_configuration_auto ( p_api_version IN NUMBER,
p_config_hdr_id IN NUMBER,
p_config_rev_nbr IN NUMBER,
p_copy_mode IN VARCHAR2,
x_config_hdr_id OUT NOCOPY NUMBER,
x_config_rev_nbr OUT NOCOPY NUMBER,
x_orig_item_id_tbl OUT NOCOPY CZ_API_PUB.number_tbl_type,
x_new_item_id_tbl OUT NOCOPY CZ_API_PUB.number_tbl_type,
x_return_status OUT NOCOPY VARCHAR2,
x_msg_count OUT NOCOPY NUMBER,
x_msg_data OUT NOCOPY VARCHAR2,
p_handle_deleted_flag IN VARCHAR2 := NULL,
p_new_name IN VARCHAR2 := NULL);
The following table describes the parameters for the CZ_CONFIG_API_PUB.COPY_CONFIGURATION_AUTO procedure. This includes the data type, the mode (in or out), and a brief note about the parameter.
| Parameter | Data Type | Mode | Note |
|---|---|---|---|
| p_api_version | number | in | See API Version Numbers. |
| p_config_hdr_id | number | in | See corresponding parameter in Parameters for the COPY_CONFIGURATION Procedure. |
| p_config_rev_nbr | number | in | See corresponding parameter in Parameters for the COPY_CONFIGURATION Procedure. |
| p_copy_mode | varchar2 | in | Required. Specifies whether the new configuration has a new header ID or a new revision number. |
| x_config_hdr_id | number | out | See corresponding parameter in Parameters for the COPY_CONFIGURATION Procedure. |
| x_config_rev_nbr | number | out | See corresponding parameter in Parameters for the COPY_CONFIGURATION Procedure. |
| x_orig_item_id_tbl | number | out | A table of the item IDs for the items in the original configuration. |
| x_new_item_id_tbl | number | out | A table of the item IDS for the items in the new configuration. |
| x_msg_count | number | out | Required. The number of error messages returned in the x_msg_data parameter. |
| x_msg_data | varchar2 | out | See corresponding parameter in Parameters for the COPY_CONFIGURATION Procedure. |
| x_return_status | number | out | See corresponding parameter in Parameters for the COPY_CONFIGURATION Procedure. |
| p_handle_deleted_flag | varchar2 default null | in | See corresponding parameter in Parameters for the COPY_CONFIGURATION Procedure. |
| p_new_name | varchar2 default null | in | See corresponding parameter in Parameters for the COPY_CONFIGURATION Procedure. |
None
This procedure copies all database records associated with a configuration to a new config_hdr_id and config_rev_nbr.
Examine return_value and error_message to determine what the next step should be.
This utility procedure provides default date values used by Oracle Configurator for a new configuration. The caller should pass in dates that will be included in the initialization message for the runtime Oracle Configurator. The procedure will return the value that will be used by the runtime Oracle Configurator for any dates not passed in.
None
None.
This procedure should be used to find out the default dates used by the runtime Oracle Configurator for publication lookup, effectivity, and configuration creation.
None.
None.
The syntax for this procedure is:
PROCEDURE DEFAULT_NEW_CFG_DATES( p_creation_date IN OUT NOCOPY DATE,
p_lookup_date IN OUT NOCOPY DATE,
p_effective_date IN OUT NOCOPY DATE);
The following table describes the parameters for the DEFAULT_NEW_CFG_DATES procedure. This includes the data type, the mode (in or out), and a brief note about the parameter.
| Parameter | Data Type | Mode | Note |
|---|---|---|---|
| p_creation_date | date | in/out | This specifies the creation date for the new configuration. |
| p_lookup_date | date | in/out | This specifies the lookup date for the new configuration. |
| p_effective_date | date | in/out | This specifies the effective date for the new configuration. |
None
Any of the parameters (p_creation_date, p_lookup_date, p_effective_date) that were not passed in are populated with the date that the runtime Oracle Configurator would use for that parameter.
This utility procedure provides default date values used by Oracle Configurator for a restored configuration. The caller should pass in dates that will be included in the initialization message for the runtime Oracle Configurator. The procedure will return the value that will be used by the runtime Oracle Configurator for any dates not passed in. The CONFIG_HEADER_ID and a configuration revision (CONFIG_REV_NBR) must be supplied. .
None
Configuration must exist.
This procedure should be used to find out the default dates used by the runtime Oracle Configurator for publication lookup, effectivity, and configuration creation.
None.
None.
The syntax for this procedure is:
PROCEDURE DEFAULT_RESTORED_CFG_DATES( p_config_hdr_id IN NUMBER,
p_config_rev_nbr IN NUMBER,
p_creation_date IN OUT NOCOPY DATE,
p_lookup_date IN OUT NOCOPY DATE,
p_effective_date IN OUT NOCOPY DATE );
The following table describes the parameters for the DEFAULT_RESTORED_CFG_DATES procedure. This includes the data type, the mode (in or out), and a brief note about the parameter.
| Parameter | Data Type | Mode | Note |
|---|---|---|---|
| p_config_hdr_id | number | in | Specifies which configuration to use. |
| p_config_rev_nbr | number | in | Specifies which configuration to use |
| p_creation_date | date | in/out | If this is not null, then it will be returned as is. If this is null and if p_lookup_date is null and RestoredConfigDefaultModelLookupDate in CZ_DB_SETTINGS is set to config_creation_date, then sysdate is returned. See RestoredConfigDefaultModelLookupDate for more information |
| p_lookup_date | date | in/out | If this is not null, then it will be returned as is. If this is null, and if RestoredConfigDefaultModelLookupDate in CZ_DB_SETTINGS is set to config_creation_date, then p_lookup_date is set to the order line creation date. If RestoredConfigDefaultModelLookupDate in CZ_DB_SETTINGS is not set to config_creation_date, then sysdate is returned. See RestoredConfigDefaultModelLookupDate for more information. |
| p_effective_date | date | in/out | If this is not null, then it will be returned as is. Otherwise, the existing setting for this configuration is returned. |
None
Any of the parameters (p_creation_date, p_lookup_date, p_effective_date) that were not passed in are populated with the date that the runtime Oracle Configurator would use for that parameter.
This procedure removes a configuration from the database.
None
The configuration to be deleted must exist. If the specified configuration does not exist, then the procedure runs but it does not delete anything and no issues are reported.
This procedure should be used when a configuration is obsolete.
Do not delete configurations that are referred to by any host applications.
The syntax for this procedure is:
PROCEDURE delete_configuration( config_hdr_id IN NUMBER,
config_rev_nbr IN NUMBER,
usage_exists IN OUT NOCOPY NUMBER,
Error_message IN OUT NOCOPY VARCHAR2,
Return_value IN OUT NOCOPY NUMBER);
The following table describes the parameters for the DELETE_CONFIGURATION procedure. This includes the data type, the mode (in or out), and a brief note about the parameter.
| Parameter | Data Type | Mode | Note |
|---|---|---|---|
| config_hdr_id | number | in | Specifies the header ID of the configuration to be deleted |
| config_rev_nbr | number | in | Specifies the revision number of the configuration to be deleted |
| usage_exists | number | in/out | This returns 1 if a configuration usage record exists and the configuration is not deleted. (Requires custom code to populate the CZ_CONFIG_USAGES table.) |
| error_message | varchar2 | in/out | If there is an error, then this field contains a message describing the error. |
| return_value | number | in/out | If 1, then the configuration was successfully deleted. If 0, then deletion of the configuration failed. |
None
Examine the output in the error_message parameter.
This function returns a value for the ICX session ticket that Oracle Applications should pass in the icx_session_ticket parameter of the initialization message when calling Oracle Configurator. See icx_session_ticket in Session Initialization for information about that parameter.
The session ticket allows the runtime Oracle Configurator to maintain the Oracle Applications session identity. A null value is returned if user_id, resp_id, or appl_id are not defined within the Oracle Applications session or if the ICX calls fail.
For more information about the ICX session ticket, including the profile option ICX: Session Timeout, see the Oracle E-Business Suite System Administrator’s Guide - Maintenance.
None
In order to use this function, the database session must have been initialized with Oracle Applications parameters in order for the icx_session_ticket to return a value.
This function should be used before launching a configuration session from PL/SQL.
The syntax for this function is:
FUNCTION icx_session_ticket RETURN VARCHAR2;
There are no parameters for this function. It derives its inputs from the environment of the database session.
None
This function returns the ICX ticket that represents the Oracle Applications session.
If this function returns NULL, the database session is not an Oracle Applications session.
This function returns a published Model passed on the inventory item ID, organization id, and applicability.
This function is used for backward compatibility. It calls CONFIG_MODEL_FOR_ITEM with usage_name equal to "Any Usage" and publication_mode equal to ’P’.
None
This function should be used after publishing Models, to verify if publication lookup will succeed for a given set of applicability parameters.
Publications must exist for a Model to be returned. This function must be run on the instance that the Model is published to.
If usage_name and/or publication_mode are NULL or not provided, the CZ: Publication Usage and/or CZ: Publication Lookup Mode profile option values will be checked. However, Oracle Applications session parameters are not defined by default within a SQL*Plus session. If profile option values are not defined for this or any other reason, the defaults for usage_name and/or publication_mode will be "Any Usage" and "P" (Production) respectively.
The syntax for this function is:
FUNCTION model_for_item( inventory_item_id NUMBER,
organization_id NUMBER,
config_creation_date DATE,
user_id NUMBER,
responsibility_id NUMBER,
calling_application_id NUMBER )
RETURN NUMBER;
The following table lists of the parameters for the MODEL_FOR_ITEM function, including the data type, the mode (in or out), and a brief note about the parameter.
| Parameter | Data Type | Mode | Note |
|---|---|---|---|
| inventory_item_id | number | in | If the Model was imported from Oracle BOM, then this is the inventory item ID for the published Model, from the MTL_SYSTEM_ITEMS table, on which configuration models are based. |
| organization_id | number | in | If the Model was imported from Oracle BOM, then this is the organization ID for the published Model, from the MTL_SYSTEM_ITEMS table, on which configuration models are based. |
| config_creation_date | date | in | This is the lookup date for the configuration |
| user_id | number | in | This is the ID for the Oracle Applications user that is logged into from FND_USER. |
| responsibility_id | number | in | This is the responsibility that the Oracle Applications user had in the host application. |
| calling_application_id | number | in | The registered ID of an application for which the Model is published. See Applicability Parameters. |
None
This function returns the devl_project_id of the configuration model published for this combination of inputs. NULL is returned if there is no matching publication.
This function returns the Model ID for a specified publication.
None
This function should be used after publishing Models, to verify if publication lookup will succeed for a given set of applicability parameters.
Publications must exist for a Model to be returned. This function must be run on the instance that the Model is published to.
The syntax for this function is:
FUNCTION model_for_publication_id (publication_id NUMBER) RETURN NUMBER;
The following table describes the parameters for the MODEL_FOR_PUBLICATION_ID function. This includes the data type, the mode (in or out), and a brief note about the parameter.
| Parameter | Data Type | Mode | Note |
|---|---|---|---|
| publication_id | number | in | This is the specified publication id in the CZ_MODEL_PUBLICATIONS table. |
This function returns the name of the JVM pool registered for a given Product Key, by looking up the JVM pool registered to the specified Model in the mapping table (CZ_MODEL_POOL_MAPPINGS).
Use of this function assumes that you are routing Models to JVM pools, as described in Routing Models to Specified JVMs.
This function should be used when you need to obtain the name of the JVM pool to which a specific Model is registered. The Model is identified by the Product Key.
The profile option CZ: Add Model Routing Cookie must be set to True for Model routing to occur at runtime.
The syntax for this procedure is:
FUNCTION pool_token_for_product_key (p_product_key IN VARCHAR2) RETURN VARCHAR2;
The following table describes the parameters for the POOL_TOKEN_FOR_PRODUCT_KEY function. This includes the data type, the mode (in or out), and a brief note about the parameter.
| Parameter | Data Type | Mode | Note |
|---|---|---|---|
| p_product_key | varchar2 | in | Product Key of the Model for which the registered pool name is desired. For details on Product Key, see Applicability Parameters. |
This function returns the publication ID for a specified inventory item.
None
This function should be used after publishing Models to verify that publication lookup will succeed for a given set of applicability parameters.
Publications must exist for a Model to be returned. This function must be run on the instance that the Model is published to.
If usage_name and/or publication_mode are NULL or not provided, the CZ: Publication Usage and/or CZ: Publication Lookup Mode profile option values will be checked. However, Oracle Applications session parameters are not defined by default within a SQL*Plus session. If profile option values are not defined for this or any other reason, the defaults for usage_name and/or publication_mode will be "Any Usage" and "P" (Production) respectively.
The syntax for this function is:
FUNCTION publication_for_item ( inventory_item_id IN NUMBER,
organization_id IN NUMBER,
config_lookup_date IN DATE,
calling_application_id IN NUMBER,
usage_name IN VARCHAR2,
publication_mode IN VARCHAR2 DEFAULT NULL,
language IN VARCHAR2 DEFAULT NULL)
RETURN NUMBER;
The following table describes the parameters for the PUBLICATION_FOR_ITEM function. This includes the data type, the mode (in or out), and a brief note about the parameter.
| Parameter | Data Type | Mode | Note |
|---|---|---|---|
| inventory_item_id | number | in | If the Model was imported from Oracle BOM, then this is the Inventory Item ID for the published Model, from the MTL_SYSTEM_ITEMS table, on which configuration models are based. |
| organization_id | number | in | If the Model was imported from Oracle BOM, then this is the organization ID for the published Model, from the MTL_SYSTEM_ITEMS table, on which configuration models are based. |
| config_lookup_date | date | in | Date to search for inside the applicable range for the publication. See Applicability Parameters. |
| calling_application_id | number | in | The registered ID of an application for which the Model is published. See Applicability Parameters. |
| usage_name | varchar2 | in | Usage name to search for in the publication. See Applicability Parameters. |
| publication_mode | varchar2 | in | Publication mode to search for in the publication. See Applicability Parameters. |
| language | varchar2 | in | Language code to search for in the publication. See Applicability Parameters. |
This function returns the publication ID for a product key.
None
This function should be used after publishing Models, to verify if publication lookup will succeed for a given set of applicability parameters.
Publications must exist for a Model to be returned. This function must be run on the instance that the Model is published to.
If usage_name and/or publication_mode are NULL or not provided, profile option values will be checked. However, Oracle Applications session parameters are not defined by default within a SQL*Plus session. If profile option values are not defined for this or any other reason, the defaults for usage_name and/or publication_mode will be "Any Usage" and "P" (Production) respectively.
The syntax for this function is:
FUNCTION publication_for_product( product_key IN VARCHAR2,
config_lookup_date IN DATE,
calling_application_id IN NUMBER,
usage_name IN VARCHAR2,
publication_mode IN VARCHAR2 DEFAULT NULL,
language IN VARCHAR2 DEFAULT NULL)
RETURN NUMBER;
The following table describes the parameters for the PUBLICATION_FOR_PRODUCT function. This includes the data type, the mode (in or out), and a brief note about the parameter.
| Parameter | Data Type | Mode | Note |
|---|---|---|---|
| product_key | varchar2 | in | Product key to search for in the publication. See Applicability Parameters. |
| config_lookup_date | date | in | Date to search for inside the applicable range for the publication. See Applicability Parameters. |
| calling_application_id | number | in | The registered ID of an application for which the Model is published. See Applicability Parameters. |
| publication_mode | varchar2 | in | Publication mode to search for in the publication. See Applicability Parameters. |
| language | varchar2 | in | Language code to search for in the publication. See Applicability Parameters. |
This function is used to determine the publication that should be used to reopen a saved configuration. The function returns a publication ID for an existing configuration based on its model information and applicability parameters.
None
This function should be used after publishing Models, to verify if publication lookup will succeed for a given set of applicability parameters.
Publications must exist for a model to be returned. This function must be run on the instance that the model is published to.
If usage_name and/or publication_mode are NULL or not provided, the CZ: Publication Usage and/or CZ: Publication Lookup Mode profile option values will be checked. However, Oracle Applications session parameters are not defined by default within a SQL*Plus session. If profile option values are not defined for this or any other reason, the defaults for usage_name and/or publication_mode will be "Any Usage" and "P" (Production) respectively.
The syntax for this function is:
FUNCTION publication_for_saved_config ( config_hdr_id IN NUMBER,
config_rev_nbr IN NUMBER,
config_lookup_date IN DATE,
calling_application_id IN NUMBER,
usage_name IN VARCHAR2,
publication_mode IN VARCHAR2 DEFAULT NULL,
language IN VARCHAR2 DEFAULT NULL)
RETURN NUMBER;
The following table describes the parameters for the PUBLICATION_FOR_SAVED_CONFIG function. This includes the data type, the mode (in or out), and a brief note about the parameter.
| Parameter | Data Type | Mode | Note |
|---|---|---|---|
| config_hdr_id | number | in | Identifies the saved configuration to use. |
| config_rev_nbr | number | in | Identifies the saved configuration. |
| config_lookup_date | date | in | Date to search for inside the applicable range for the publication. See Applicability Parameters. |
| calling_application_id | number | in | The registered ID of an application for which the model is published. See Applicability Parameters. |
| usage_name | varchar2 | in | Usage name to search for in the publication. See Applicability Parameters. |
| publication_mode | varchar2 | in | Publication mode to search for in the publication. See Applicability Parameters. |
| language | varchar2 | in | Language code to search for in the publication. See Applicability Parameters. |
This procedure registers a Model to a JVM pool, by creating a mapping in the mapping table (CZ_MODEL_POOL_MAPPINGS) that registers the specified Model to the specified JVM pool.
If references to the specified pool do not exist in the mapping table, this procedure creates rows that implicitly register that pool, with an autonomous transaction.
Use of this procedure assumes that you are routing Models to JVM pools, as described in Routing Models to Specified JVMs.
This procedure should be used when you need to register a Model to a JVM to reduce the Model's memory footprint and improve performance.
The profile option CZ: Add Model Routing Cookie must be set to True for Model routing to occur at runtime.
The syntax for this procedure is:
PROCEDURE register_model_to_pool (p_pool_identifier IN VARCHAR2,
p_model_product_key IN VARCHAR2);
The following table describes the parameters for the REGISTER_MODEL_TO_POOL function. This includes the data type, the mode (in or out), and a brief note about the parameter.
| Parameter | Data Type | Mode | Note |
|---|---|---|---|
| p_pool_identifier | varchar2 | in | The JVM pool to which the specified Model is to be registered. |
| p_model_product_key | varchar2 | in | Product Key of the Model to be registered. For details on Product Key, see Applicability Parameters. |
This procedure unregisters a Model from a JVM pool, by deleting the mapping in the mapping table (CZ_MODEL_POOL_MAPPINGS) that registered the specified Model to the specified JVM pool. Uses an autonomous transaction.
Use of this procedure assumes that you are routing Models to JVM pools, as described in Routing Models to Specified JVMs.
This procedure should be used when you need to unregister a Model from a JVM.
The profile option CZ: Add Model Routing Cookie must be set to True for Model routing to occur at runtime.
The syntax for this procedure is:
PROCEDURE unregister_model_from_pool (p_pool_identifier IN VARCHAR2,
p_model_product_key IN VARCHAR2);
The following table describes the parameters for the UNREGISTER_MODEL_FROM_POOL function. This includes the data type, the mode (in or out), and a brief note about the parameter.
| Parameter | Data Type | Mode | Note |
|---|---|---|---|
| p_pool_identifier | varchar2 | in | The JVM pool to which the specified Model was registered. |
| p_model_product_key | varchar2 | in | Product Key of the Model that was registered. For details on Product Key, see Applicability Parameters. |
This procedure unregisters a JVM pool, by deleting all the mappings in the mapping table (CZ_MODEL_POOL_MAPPINGS) that refer to the specified JVM pool. Uses an autonomous transaction.
Use of this procedure assumes that you are routing Models to JVM pools, as described in Routing Models to Specified JVMs.
This procedure should be used when you need to unregister a JVM pool.
The profile option CZ: Add Model Routing Cookie must be set to True for Model routing to occur at runtime.
The syntax for this procedure is:
PROCEDURE unregister_pool (p_pool_identifier IN VARCHAR2);
The following table describes the parameters for the UNREGISTER_POOL function. This includes the data type, the mode (in or out), and a brief note about the parameter.
| Parameter | Data Type | Mode | Note |
|---|---|---|---|
| p_pool_identifier | varchar2 | in | The JVM pool to be unregistered. |
This function returns a UI definition (ui_def_id) for a given inventory item (inventory_item_id) and organization item (organization_id) based on publication applicability parameters.
This function is used for backward compatibility. It calls CONFIG_UI_FOR_ITEM with usage_name equal to "Any Usage" and publication_mode equal to ’P’.
None
This function should be used after publishing Models, to verify if publication lookup will succeed for a given set of applicability parameters.
Publications must exist for a model to be returned. This function must be run on the instance that the model is published to.
The syntax for this function is:
FUNCTION ui_for_item( inventory_item_id NUMBER,
organization_id NUMBER,
config_creation_date DATE,
ui_type VARCHAR2,
user_id NUMBER,
responsibility_id NUMBER,
calling_application_id NUMBER )
RETURN NUMBER;
The following table describes the parameters for the UI_FOR_ITEM function. This includes the data type, the mode (in or out), and a brief note about the parameter.
| Parameter | Data Type | Mode | Note |
|---|---|---|---|
| inventory_item_id | number | in | If the model was imported from Oracle BOM, then this is the Inventory Item ID for the published model, from the MTL_SYSTEM_ITEMS table, on which configuration models are based. |
| organization_id | number | in | If the model was imported from Oracle BOM, then this is the organization ID for the published model, from the MTL_SYSTEM_ITEMS table, on which configuration models are based. |
| config_creation_date | date | in | This is the date the configuration was created. |
| ui_type | varchar2 | in | This is the type of published UI sought and found for each product. Values are ’APPLET’, ’DHTML’, or ’JRAD’. If either DHTML or JRAD is passed, then the publication UI type must be either DHTML or JRAD. Otherwise NULL is returned. If APPLET is passed, then the publication UI type can be either APPLET, DHTML, or JRAD. If DHTML or JRAD is passed and there is no publication available for the item, then the API returns the user interface ID of the BOM JRAD UI. |
| user_id | number | in | This is the ID for the Oracle Applications user that is logged into from FND_USER. |
| responsibility_id | number | in | This is the responsibility that the Oracle Applications user had in the host application. |
| calling_application_id | number | in | The registered ID of an application for which the model is published. See Applicability Parameters. |
None
This function returns the user interface ID associated with the selected publication.
If the ui_type is APPLET, then the publication UI type can be either APPLET, DHTML, or JRAD.
If the ui_type is either DHTML or JRAD, then the publication UI type must be either DHTML or JRAD. Otherwise NULL is returned. If there is no publication available for the item, then the API returns the user interface ID of the BOM JRAD UI.
This function returns a UI definition (ui_def_id) for a specified publication ID.
None
This function should be used after publishing Models, to verify if publication lookup will succeed for a given set of applicability parameters.
Publications must exist for a model to be returned. This function must be run on the instance that the model is published to.
The syntax for this function is:
FUNCTION ui_for_publication_id ( publication_id NUMBER ) RETURN NUMBER;
The following table describes the parameters for the UI_FOR_PUBLICATION_ID function. See Using the UI_FOR_PUBLICATION_ID Function for an example of how these parameters are used. This includes the data type, the mode (in or out), and a brief note about the parameter.
| Parameter | Data Type | Mode | Note |
|---|---|---|---|
| publication_id | number | in | This is the specified publication id in the CZ_MODEL_PUBLICATIONS table. |
When called in SQL*Plus, this example prints out the ID of the UI definition associated with the publication identified by the publication_id parameter. If the publication has no associated UI, then a message is printed.
Using the UI_FOR_PUBLICATION_ID Function
set serveroutput on
DECLARE
v_ui_def_id number;
BEGIN
-- The publication must have status of 'OK' ("Complete").
v_ui_def_id := cz_cf_api.ui_for_publication_id(12345);
IF v_ui_def_id IS NULL THEN
dbms_output.put_line('UI Def ID: '||'NOT FOUND');
ELSE
dbms_output.put_line('UI Def ID: '||v_ui_def_id);
END IF;
END;
This procedure validates a configuration. You can use this procedure to check whether a configuration is still valid after an event that may cause it to become invalid. Such events might include the following:
A change in the configuration rules
The importing of the configuration from another system
A change to the configuration inputs by another program
The ordered configured BOM Items (input_list) do not match the batch validation BOM Items (from a previously processed configuration)
This procedure is a single call validation procedure that uses tables to exchange multi-valued data. A validation_status and a table of XML messages are returned.
None
The syntax for this procedure is:
PROCEDURE VALIDATE ( config_input_list IN CFG_INPUT_LIST,
init_message IN VARCHAR2,
config_messages IN OUT NOCOPY CFG_OUTPUT_PIECES,
validation_status IN OUT NOCOPY NUMBER,
URL IN VARCHAR2 DEFAULT FND_PROFILE.Value('CZ_UIMGR_URL'),
p_validation_type IN VARCHAR2 DEFAULT CZ_API_PUB.VALIDATE_ORDER));
The following table describes the parameters for the VALIDATE procedure. This includes the data type, the mode (in or out), and a brief note about the parameter.
| Parameter | Data Type | Mode | Note |
|---|---|---|---|
| config_input_list | CFG_INPUT_LIST. See Custom Data Types for a definition of this type. | in | This is a list of input selections. |
| init_message | varchar2 | in | Initialization message |
| config_messages | CFG_OUTPUT_PIECES. See Custom Data Types for a definition of this type. | out | This is a table of the output XML messages produced by validating the configuration. |
| validation_status | varchar2 | out | The status code returned by validating the configuration: 0 - CONFIG_PROCESSED 1 - CONFIG_PROCESSED_NO_TERMINATE 2 - INIT_TOO_LONG 3 - INVALID_OPTION_REQUEST 4 - CONFIG_EXCEPTION 5 - DATABASE_ERROR 6 - UTL_HTTP_INIT_FAILED 7 - UTL_HTTP_REQUEST_FAILED |
| url | varchar2 | in | The URL for the Oracle Configurator Servlet. Default will interrogate the current profile for this URL, using FND_PROFILE.Value('CZ_UIMGR_URL'). |
| p_validation_type | varchar2 | in | The possible values are CZ_API_PUB.VALIDATE_ORDER, CZ_API_PUB.VALIDATE_FULFILLMENT, and CZ_API_PUB.INTERACTIVE. The default is CZ_API_PUB.VALIDATE_ORDER. |
For an example of how these parameters are used, see Calling the CZ_CF_API.VALIDATE Procedure.
None
This procedure returns the values listed in the tableValues Returned by the VALIDATE Procedure.
This procedure verifies that the specified configuration exists and returns whether it is valid or complete. This procedure functions like a view. The procedure queries the configuration data checking that the configuration exists in the CZ schema. This query provides essential information to downstream applications without directly querying the database.
None
This procedure validates that the configuration header is a session header and not an instance header.
None
The syntax for this procedure is:
PROCEDURE verify_configuration( p_api_version IN NUMBER,
p_config_hdr_id IN NUMBER,
p_config_rev_nbr IN NUMBER,
x_exists_flag OUT NOCOPY VARCHAR2,
x_valid_flag OUT NOCOPY VARCHAR2,
x_complete_flag OUT NOCOPY VARCHAR2,
x_return_status OUT NOCOPY VARCHAR2,
x_msg_count OUT NOCOPY NUMBER,
x_msg_data OUT NOCOPY VARCHAR2);
The following table describes the parameters for the CZ_CONFIG_API_PUB.VERIFY_CONFIGURATION procedure.
| Parameter | Data Type | Mode | Note |
|---|---|---|---|
| p_api_version | number | in | Required. See API Version Numbers. |
| p_config_hdr_id | number | in | Required. Header ID of the configuration to be verified. |
| p_config_rev_nbr | number | in | Required. Revision number of the configuration to be verified. |
| x_exists_flag | varchar2 | out | If config_hdr_id and config_rev_nbr describe a saved configuration, then FND_API.G_TRUE is returned. If there is no saved configuration, then FND_API.G_FALSE is returned. |
| x_valid_flag | varchar2 | out | If the configuration exists and is valid, then FND_API.G_TRUE is returned. If the configuration exists but is invalid, then FND_API.G_FALSE is returned. If the configuration does not exist then NULL. |
| x_complete_flag | varchar2 | out | If the configuration exists and is complete, then FND_API.G_TRUE is returned. If the configuration exists but is incomplete, then FND_API.G_FALSE is returned. If the configuration does not exist, then NULL. |
| x_return_status | varchar2 | out | Must return FND_API.G_RET_STS_SUCCESS if procedure completed successfully; otherwise return FND_API.G_RET_STS_ERROR or FND_API.G_RET_STS_UNEXP_ERROR if an error occurs within the procedure |
| x_msg_count | number | out | The number of error messages returned in the x_msg_data parameter. |
| x_msg_data | varchar2 | out | See corresponding parameter in Parameters for the CZ_CONFIG_API_PUB.COPY_CONFIGURATION Procedure. |