The attribute group Web Service includes the getAGDetails method, which publishes the details of an attribute group and its associated entities to target Oracle Product Hub (OPH) systems based on input to these 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.
The getAGDetails method provides an interface to extract information about attribute groups and their associated entities ( which include business entities, attributes, and value sets/child value sets associated to the attributes) based on input and then publish them to target OPH systems.
You can invoke the getAGDetails method using two modes:
Batch Mode
Retrieves the details of the attribute group(s) published as part of a batch from the PIM Publication user interface and publishes them to target OPH systems.
Use this mode when you can directly provide the batch ID to use the attribute group 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 attribute group identifiers directly as input to the getAGDetails method.
Optionally provides any number of attribute group IDs for invoking the services.
While invoking the attribute group 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. |
| AGId | Integer | Yes (batch mode) No (non-batch mode) | Attribute Group ID for which the details need to be published.
Note: In Batch Mode, there is no need to provide the AGId. It is derived for the selected attribute group(s) in the batch. In List Mode, you must provide either the AGId or the AGName. |
| Agname | String | Yes (batch mode), No (non-batch mode) | The name of the attribute group to be published.
Note: In Batch Mode, there is no need to provide the AGname. It is derived for the selected attribute group(s) in the batch. In List Mode, you must provide either the AGId or the AGName. |
| Valuesets | String | Yes (batch mode), No (non-batch mode) Default Value: Y | Flag to control whether to publish the value sets associated with the user defined attributes to target OPH systems. |
| ChildValuesets | String | Yes (batch mode), No (non-batch mode) Default Value: Y | Flag to control whether to publish the child value sets associated with the user defined attributes to target OPH systems. |
| Sync (In Batch flow - Publish to PIM Systems Only checkbox) | String | Yes (batch mode), No (non-batch mode) Default Value: Y | Flag to indicate whether to publish to external systems or OPH systems. Value Y indicates publishing to OPH systems. The attribute group Webservice supports publishing to OPH systems only. |
| Auto Import | String | Yes (batch mode), No (non-batch mode) Default Value: N | Flag to control whether to launch the 'EGO Import Metadata' concurrent program in the target OPH 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. The program imports the data from the interface tables into the production tables. |
| Return Payload | String | No (non-batch mode) Default Value: N Note: This parameter is honored only in List mode. | Flag to control whether user wants to display the concurrent program errors and warnings that occur in the target OPH systems, as well as any additional information provided about the attribute groups. |
Multi Selection Parameters
| Parameter Name | Type | Optional | Description |
|---|---|---|---|
| LanguageCode | String | Yes (batch mode), Yes (non-batch mode) This parameter is not considered when publishing to OPH systems. | When publishing to OPH systems, attribute group translatable column values are published in all the installed languages common between the source and target OPH systems. |
| LanguageName | String | Yes (batch mode), Yes (non-batch mode) This parameter is not considered when publishing to OPH 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) Default behavior: You must select at least one target OPH system. Note: Repeat this parameter multiple times to publish to multiple systems. | The system code for a target OPH system. |
| SystemName | String | Yes (batch mode), No (non-batch mode) Default behavior: Select at least one target OPH system. Note: Repeat this parameter multiple times to publish to multiple systems. | The system name for a target OPH system. |
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 (UI flow), the responsibility name 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 (UI flow), the application name 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 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