The item catalog category (ICC) Web Service includes the getICCDetails method, which returns the details of the ICC according to the parameters requested in the output. Users can invoke the method on both ICC versions and non-version ICCs. It can also be used to publish an ICC and its associated entities to other Oracle Product Hub systems.
Attention: Before using Publication Web Services, you must complete some manual post-installation steps. Complete the steps documented in My Oracle Support ID 1336146.1. This My Oracle Support ID also includes troubleshooting tips.
This Web Service method provides an interface to extract the information about the ICC and/or its hierarchy based on input. It can also be used to publish this data to other Oracle Product Hub systems.
You can invoke the getICCDetails method using two modes:
Batch Mode
Retrieves the details of the ICC(s) published as part of a batch from the PIM Publication user interface.
Use this mode when you can directly provide the batch ID to use the ICC services. The parameters provided while creating the batch take precedence over the values provided for the parameters below while invoking the service.
List Mode
Passes a list of ICC identifiers directly as input to the getICCDetails method.
Optionally provides any number of ICC IDs for invoking the services.
While invoking the ICC services in either mode, provide the following WS-Security and Parameter inputs:
WS-Security
| Parameter Name | Type | Optional | Description |
|---|---|---|---|
| User Name | String | NO | EBS "Applications User name" |
| Password | String | NO | Password for EBS "Applications User" |
Parameters
| Parameter Name | Type | Optional | Description |
|---|---|---|---|
| BatchId | Integer | No (batch mode) Yes (non-batch mode) | The identifier of the Batch that was published from the PIM UI. |
| ICCId | Integer | Yes (batch mode) No (non-batch mode) | The identifier of the ICC to be extracted/published.
Note: In Batch Mode, the ICCId is derived from the selected ICC. In List Mode:
|
| ICCName | String | Yes
Note: This parameter is not considered while publishing to external systems. | The name of the ICC to be published to other Oracle Product Hub systems. In Batch Mode, the ICCName is derived from the selected ICC. In List Mode, provide either the ICCId or the ICCName. |
| VersionSequence | Integer | Yes (batch mode) No (non-batch mode) | Version for which the service is needed. If left blank, the default is the current effective version. |
| UserDefAttrGrps | Boolean | Yes | Flag to control whether to include the user defined attribute groups associated with the ICC(s) in the output payload or when publishing to Oracle Product Hub systems. Default Value : True |
| Valuesets | String | Yes
Note: This parameter is not considered when publishing to external systems. | Flag to control whether to publish value sets associated with user defined attributes when publishing to Oracle Product Hub systems. Default Value : True |
| ICCVersions | String | Yes
Note: This parameter is not considered when publishing to other Oracle Product Hub systems. | Flag that controls whether the version information for the ICC(s) is included in the output payload. Default Value: True |
| TransAttrs | String | Yes
Note: This parameter is not considered when publishing to other Oracle Product Hub systems. | Flag to control whether the transaction attributes for the ICC(s) are included in the output payload. Default Value: True |
| ICCPages | String | Yes
Note: This parameter is not considered when publishing to external systems. | Flag that controls whether to publish pages associated with ICCs to Oracle Product Hub systems. Default Value: True |
| ICCFunctions | String | Yes
Note: This parameter is not considered when publishing to external systems. | Flag that controls whether to publish functions associated with ICCs to Oracle Product Hub systems. Default Value: True |
| ICCStructure | String | Yes
Note: This parameter is not considered when publishing to other Oracle Product Hub systems. | Flag to control whether the structures for ICC(s) are included in the output payload. Default Value: True |
| ParentICCs | String | Yes | Flag to control whether the parent hierarchy for the ICC(s) is included in the output payload or published to Oracle Product Hub systems. Default Value: True Note: This parameter is honored only during "List" mode calls to the getICCDetails method. |
| ChildICCs | String | Yes | Flag to control whether the child hierarchy for ICC(s) is included in the output payload or published to Oracle Product Hub systems. Default Value: True Note: This parameter is honored only during a "List" mode call to the getICCDetails method. |
| Sync
Note: This appears as the "Publish to PIM Systems Only" checkbox in the batch publishing flow. | String | No (batch mode) No (non-batch mode) | Flag to indicate whether to publish to external systems or other Oracle Product Hub systems. A value of Y indicates publishing to Oracle Product Hub systems. a value of N indicates publishing to external systems. |
| Auto Import | String | Yes
Note: This parameter is not considered when publishing to external systems. | Flag to control whether to launch the 'EGO Import Metadata' concurrent program in the target Oracle Product Hub system or not. If it is set to 'N', the metadata interface tables in the target OPH systems are loaded with the data from the source OPH system. Users must manually launch this concurrent program to import the data in the interface tables into the production tables. If it is set to 'Y', this concurrent program is automatically launched in the target OPH system, which then imports the data from the interface tables into the production tables. Default Value: N |
| ReturnPayload | String | Yes
Note: This parameter is honored only in List mode. | Publishing to external systems: Flag to control whether the output payload includes the ICC(s) details. Publishing to other Oracle Product Hub systems: Flag to control whether to display concurrent program errors and warnings occurring in the target OPH systems as well as any additional ICC information provided for publishing. Default Value: True |
Multi Selection Parameters
| Parameter Name | Type | Optional | Description |
|---|---|---|---|
| LanguageCode | String | Yes (batch mode) Yes (non-batch mode) Note: This parameter is not considered when publishing to Oracle Product Hub systems. | When publishing to exteral systems: The language code in which to return the output, for example, US (for American English). Default: Return output in all installed languages. Note: Repeat this parameter multiple times to return output in more than one language. When publishing to Oracle Product Hub systems: When publishing to OPH systems, the attribute group translatable column values are published in all of the installed languages common between the source and target OPH systems. |
| LanguageName | String | Yes (batch mode), Yes (non-batch mode) Note: This parameter is not considered when publishing to Oracle Product Hub systems. | When publishing to external systems: The language name in which to return the output, for example, English. When publishing to Oracle Product Hub systems: When publishing to OPH systems, attribute group translatable column values are published in all of the installed languages common between the source and target OPH systems. |
| SystemCode | String | Yes (batch mode) No (non-batch mode) Note: This parameter is not considered when publishing to external systems. | The system code for a target OPH system to which you plan to publish the ICC(s) . Default behavior: at least one target OPH system must be selected/provided. Note: Repeat this parameter multiple times when publishing to multiple systems. |
| SystemName | String | Yes (batch mode) No (non-batch mode) Note: This parameter is not considered when publishing to external systems. | The system name for the target OPH system to which you plan to publish the ICC(s) . Default behavior: at least one target OPH system must be selected/provided. Note: Repeat this parameter multiple times when publishing to multiple systems. |
FND Security Parameters
| Parameter Name | Type | Optional | Description |
|---|---|---|---|
| RESPONSIBILITY_NAME | String | No (batch mode) No (non-batch mode) | Provide the Responsibility name for the user. For example: EGO_DEVELOPMENT_MANAGER Note: In batch mode (using the UI flow), it is derived from the EBS Login. |
| RESPONSIBILITY_APPL_NAME | String | No (batch mode) No (non-batch mode) | Application name for the above responsibility. For example: EGO Note: In batch mode (using the UI flow), it is derived from the EBS Login. |
| SECURITY_GROUP_NAME | String | Yes (batch mode) No (non-batch mode) | Security group name. |
| NLS_LANGUAGE | String | Yes (batch mode) No (non-batch mode) | The current session language to use for the Web Service invocation. |
The output payload includes details based on the configurable parameters selected by the user.
Payload when publishing to external systems:
ListOfICCs
ItemCatalogCategory
ItemCatalogGroupId - The ICC ID for which the details have been produced.
EnabledFlag - Flag indicating whether ICC is enabled.
InactiveDate - Inactive Date
ItemCreationAllowedFlag - Flag indicating ICC is available for item creation.
ParentCatalogGroupId - Parent ICC ID for the given ICC ID.
ParentCatalogGroupName - Parent ICC name for the given ICC ID.
CategoryName - The concatenated name of the category formed from all segments.
Segment1..20 - Segments containing the ICC Name.
TranslatableAttributes
Language
Description
ICCVersion
TransactionAttribute - Transaction attributes list and metadata for the ICC version.
ICCStructure - Structure associated with the ICC version and its metadata.
UserDefAttrGrpAssociation - List of user defined attribute groups and their metadata associated to the ICC.
UserDefinedAttrGroup
TranslatableAttributes
UserDefAttrGrpBusEntity
UserDefinedAttribute - List of user defined attributes and their metadata.
TranslatableAttributes
Valueset
Status - Status information
Error - Error information
Code
Message
AdditionalInfo - Additional Info Section
SessionId
EntityCount
Payload when publishing to Oracle Product Hub systems:
Status - Status information
Error - Error information
Code
Message
Language Code
System Code
Warning - Warning information
Code
Message
Language Code
System Code
AdditionalInfo - Additional Info Section
SessionId
EntityCount