Skip to Content
Technical Articles

APM(ProducerPro) API Sync to SAP Commissions – Part 3

Dear All,

In the previous article Part 2we completed to setup Database view.       

Let’s continue to create Sync TargetEntity for Producers, Contracts and Contract Hierarchy.

Create SyncTargetEntity

The next step is to define and configure the target system (Commissions) entities. For this section of the configuration please refer to the Commissions API documentation.

Under the SyncTargetEntity section click the “+” symbol on top of the header to add a new SyncTargetEntity and then fill out the following details:


New form will pop out to fill the required fields as per below steps

Step1: 
SyncTargetEntity: This should be the name of the API end point for the entity you plan to sync to. For example according to the Commissions API documentation above the end point to create and update producer data is called “producers” as indicated in screenshot below:

Step2:
VersiondEntity: If the Producer Manager entity is versions (for example ProducerVer) then check the box.

Step3:
Click the Save button.

Step4:
Once the form is saved you should see a SyncTargetEntityField section.
Click the “+” symbol to define the individual fields on this Commissions entity end point.


The field definitions can also be found in the Commissions API documentation as well. Populate the following details for each entity field: Refer below example for detailed.

SyncTargetEntityField: The name of the field as indicated in the API documentation. In the example above the field names are indicated in the first column: payeeId, firstName,lastName, etc.

PrimaryKey: This is the primary key for the entity in the Commissions system. In the documentation above (payeeSeq) this is the field that has the description of “..unique Id of …” Please check this box if the field you are configuring is the primary key.

LogicalKey: The logical key(s) will be the combination of fields that make each record in the Commissions table unique. In the example above this would be producerId because this field is a unique field for each producer record and cannot be repeated on another record. Therefore this is the logical key. Logical keys can be one field or a combination of fields. If the field you are configuring is part of the logical key then check this box.

DateEffKey: This is the field for a versioned Commissions entity that indicates the effective start date. Typically this field in Commissions will be the effectiveStartDate. If the field you are configuring is the effective start date then check this box.

ReferenceKey: A reference field in Commissions is any field that is a reference to another entity (or in other words is a foreign key).

SyncTargetEntityNo SyncTargetEntityField Primary Key Logical Key Reference Key DateEff Key
producers payeeId Yes
businessUnits
effectiveStartDate Yes
effectiveEndDate
firstName
lastName
hireDate
taxId
terminationDate
payeeSeq Yes
prefix
userId
email
producerType Yes
statusCode Yes
genericAttribute1
genericBoolean1
genericDate1
genericNumber1

List of field names are as below and its case sensitive.

How to enable Producer Types and Status Code ?

If Tenant is provisioned with Channel Management , follow below steps in sequence

New tenants for HANA customers, follow the RestAPI Method to create Producer Types and Status code.

API for Status Code Creation

Be the first to leave a comment
You must be Logged on to comment or reply to a post.