GDPR_Get_Detail_Data service

Edit online

The GDPR_Get_Detail_Data service returns the customer order or opportunity details as well as the individual's personal data that is stored in the IBM® Sterling Order Management database.

Prerequisite: Make sure that you enable GDPR support in IBM Sterling Order Management. For more information, see Enabling GDPR support in IBM Sterling Order Management.

The service accepts the unique identifier of customer and/or Person info data records and gathers data that contains personal information or customer contact fields and returns the relevant data in the output. The input to the GDPR_Get_Detail_Data service must contain the PersonInfoKey and/or customer identifiers such as CustomerKey or CustomerID along with the OrganizationCode. For example, 
<GDPRData PersonInfoKey="" CustomerID="" CustomerKey="" OrganizationCode=""/>
Note: If both PersonInfoKey and customer identifier are passed in the input, the GDPR_Get_Detail_Data service considers only the PersonInfoKey attribute.

The GDPR_Get_Detail_Data service invokes the PUBLISH_DATA event. This event can be activated to implement a service to notify the user regarding the availability of the data. The GDPR_Get_Detail_Data is called asynchronously through the GDPR_Execute_Request service to minimize the performance impact on the business processes.

The GDPR_Get_Detail_Data service accepts the following data in the input:
Table 1. GDPR_Get_Detail_Data service input template
Input Data Description
@PersonInfoKey Primary key attribute of YFS_PERSON_INFO table that stores contact information of a person or a business.
@CustomerKey The primary key for the YFS_CUSTOMER table.
@CustomerID The identifier for the customer. If this attribute is passed, the OrganizationCode must also be passed.
@OrganizationCode The organization code of the organization to which the customer belongs. This attribute is required, if @CustomerID is passed in the input.

The output of the GDPR_Get_Detail_Data service helps in personal data portability for an authorized individual and can be shared with the individual. The service uses a template that can be used to control the information that can be shared with the authorized individual.

The service also returns the count of associated order records for the identified Person Info and/or customer records. The orders that are returned are classified into in progress orders, completed orders, and purged orders in the service output.
  • In progress orders indicate that the authorized individual’s personal data that is stored in the IBM Sterling Order Management database is still required for businesses processes.
  • Completed orders are the orders for which the business processes are complete but the order records are not yet purged from the IBM Sterling Order Management database.
  • Purged orders are the orders that are purged and for which the data exists in either the history tables or an external data source.
  • Opportunity and purged opportunity details are also available in the service output.
The GDPR_Get_Detail_Data service returns the following data in the output:
Table 2. GDPR_Get_Detail_Data service output template
Output Data Description
<PersonInfo> Identifies relevant personal information and addresses. Personal information is required in cases where personal contact needs to be established. For example, taking appointments or speaking during negotiations.
<Customer> Identifies the customer details specified by an organization. It contains personal information, customer contacts, addresses, payment methods, authentication questions, and answers.
@PersonalDataExist Indicates whether personal data corresponding to the parameters that are passed in the input exists in the data source or not.
@TotalInProgressOrders Identifies the total number of in-progress orders that are associated with the authorized individual’s personal data that is stored in the IBM Sterling Order Management database.
@TotalCompletedOrders Identifies the total number of completed orders that are associated with the authorized individual’s personal data that is stored in the IBM Sterling Order Management database.
@TotalOpportunities Identifies the total number of opportunities that are associated with the authorized individual’s personal data that is stored in the IBM Sterling Order Management database.
@TotalPurgedOrders

Identifies the total number of purged orders that are associated with the authorized individual’s personal data that is stored in the IBM Sterling Order Management database.
@TotalPurgedOpportunities

Identifies the total number of purged opportunities that are associated with the authorized individual’s personal data that is stored in the IBM Sterling Order Management database.
<InProgressOrderList> Contains the list of in-progress orders that are associated with the authorized individual’s personal data that is stored in the IBM Sterling Order Management database.
<CompletedOrderList> Contains the list of completed orders that are associated with the authorized individual’s personal data that is stored in the IBM Sterling Order Management database.
<PurgedOrderList> Contains the list of purged orders that are associated with the authorized individual’s personal data that is stored in the IBM Sterling Order Management database.
<OpportunityList> Contains the list of purged opportunities that associated with the authorized individual’s personal data that is stored in the IBM Sterling Order Management database.
<PurgedOpportunityList> Contains the list of purged opportunities that are associated with the authorized individual’s personal data that is stored in the IBM Sterling Order Management database.

The default output template can be extended to include related entities and attributes based on business requirements. Learn more...

For more information about the Person Info and customer attributes in the output template , refer getPersonInfoList and getCustomerDetails API Javadoc

The OMPGetPurgedDataCountUE and OMPGetPurgedDataUE user exits are called during the GDPR_Get_Detail_Data service execution to get information on the purged orders or opportunities, such that if purged orders or opportunities are stored on a different system, these user exits can be implemented to retrieve the purged order or opportunity details from an external system.
Note:
  • The purged orders or opportunities are retrieved from the order and opportunity history table by default. If the orders are moved out of the IBM Sterling Order Management on purge, the OMPGetPurgedDataCountUE and OMPGetPurgedDataUE user exits must be implemented to get the information on purged orders and opportunities.
  • The @TotalPurgedOrders or @TotalPurgedOpportunies attributes and <PurgedOrderList> and <PurgedOpportunityList> elements do not exist in the default service output template but these attributes and elements can be added later as part of custom implementation, if required.
For more information about the input and output structure of OMPGetPurgedDataCountUE and OMPGetPurgedDataUE user exits , refer to the Javadoc.