GDPR_Get_Detail_Data service
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.
PersonInfoKey
and/or customer identifiers such as CustomerKey
or
CustomerID
along with the OrganizationCode
. For example,
<GDPRData PersonInfoKey="" CustomerID="" CustomerKey="" OrganizationCode=""/>
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.
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.
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
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.- 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
andOMPGetPurgedDataUE
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.
OMPGetPurgedDataCountUE
and OMPGetPurgedDataUE
user exits , refer
to the Javadoc.