Step 5 Setting up entities in SwissSalary |
|
General setup
1.On the “Cloud Connector Management” page, select ‘Setup’ and then “Entity Setup.” 2.The columns “Table ID,” “Source,” and “Web Service Endpoint” must be filled in the table. •Table ID: Enter the name of the SwissSalary/Business Central table here. Click in the “Table ID” column, select “Select from complete list” and select the corresponding SwissSalary/Business Central table to which you want to transfer data from the connected system or from which you want to write data to the connected system. The same table can be set up multiple times with different endpoints in the connected system. •Order: Specifies the order in which this entity table should be synchronized. Note the table dependencies; the table relationships are validated during synchronization. After this step, click on the value in the “Table Name” column and fill in the following fields in the “Details” section. •Endpoint: This is where you specify Personio's API endpoint. Click on the three dots in the “Endpoint” field and select one of the following Personio endpoints. Data can only be synchronized from Personio to SwissSalary via these endpoints: ov1/company/employees ov2/cost-centers ov2/legal-entities You can synchronize documents from SwissSalary with Personio via the endpoint v1/company/documents. •Source: For the endpoints v1/company/employees, v2/cost-centers, and v2/legal-entities, only “External System” can be selected as the source. For the endpoint v1/company/documents, only “Business Central” can be selected. •Aggregation Field: Specifies the field used to aggregate data during synchronization. This is useful when synchronizing an entity that contains multiple related records for a single parent record, such as multiple cost centers for a single employee. •Synchronize Deletions: Specifies whether deletion operations for this entity should be synchronized. Enabling this setting can have a significant impact on overall synchronization performance. •Skip data integration checks: Specifies whether data integrity checks in SwissSalary that are performed before synchronization begins for this entity should be ignored. 3.You can set up the mapping of the fields to be synchronized by clicking on the corresponding table name. The following fields can be filled in as follows in the “Entity Field Mapping” section: •Field ID: Here you must select the field from the selected SwissSalary/Business Central table. •Field name: The name of the field in the selected SwissSalary/BusinessCentral table is automatically filled in here. •Service field name: This is where the name of the field on the selected endpoint (for example: v1/company/employees) from Personio is displayed. All fields approved for the Personio endpoint are displayed here. In Personio, you can add or remove fields for the endpoint as desired. •Enabled: Specifies whether this field should be included when updating records in the source or target instance. •Key: Specifies whether this field is part of the primary key for this entity. •Validate: Specifies whether the table field validation should be performed when data is specified for this field. This only applies if data from the connected system is transferred to SwissSalary. 4.In the “Value assignment” section, you can specify constant or mapping values for the fields to be synchronized. Select the desired field in the “Entity field assignment” section; it will then be displayed in the “Service field name” field in the “Value assignment” section. •Value: Here you can specify the value that needs to be replaced with another value. •To value: Here you can specify the value with which the original value must be replaced. Example: You want to synchronize the “Salary Code” field on the Employee card in the connected system and replace the enum values (salary, monthly wage, hourly wage, piecework wage, monthly wage LMV) in this field with other text values. Enter “Salary” in the “From Value” field and enter the desired replacement value, for example “MW,” in the “To Value” field. In the next line, you can enter “Monthly Wage” in the “From Value” field and, for example, ‘ML’ in the “To Value” field. In the next lines, you can specify the remaining mapping values. You can also set a constant value by entering an asterisk (*) in the “From value” field and the constant value in the “To value” field. 5. If the SwissSalary fields Nationality and Gender are selected, the fields in “Value assignment” are filled in automatically.
Establishment of special entities:
I. Bank details To synchronize employees' IBAN numbers, you must set up the entity as follows: 1. In the “Table ID” field, enter 3009087. You can determine the “Order” yourself. 2.“Endpoint” is v1/company/employees and “Source” is External System. 3. In the “Template code” field, create a new entry by clicking on “+ New”. oIn the “Code” field, enter “Bank.” oIn the “Field Name” column, select “Pos.” oIn the “Default value” field, enter the number 1. oClick on “Back”
These settings ensure that the IBAN number stored in Personio is always synchronized with SwissSalary as the main bank account.
4. You must set up the entity field mapping as follows:
*The service field name in Personio may differ from the one displayed..
II. Cost centers (Dimensions) If you set up this entity, you only need to maintain the dimensions in Personio. To synchronize the dimensions from Personio to SwissSalary, you must set up the entity as follows 1.Enter 349 in the “Table ID” field; you can determine the “Order” yourself. 2.“Endpoint” is v2/cost-centers and “Source” is External System. 3.In the “Template code” field, create a new entry by clicking on “+ New”. oIn the “Code” field, enter “COSTCENTER.” oIn the “Field Name” column, select “Dimension Code.” oIn the “Default value” field, enter the dimension name in SwissSalary. This may vary for this customer. oClick on “Back” 4.With this entity field mapping, the dimension master can be transferred from Personio to SwissSalary.
III. Documents (Paycheck, Salary certificate, etc.) from SwissSalary To synchronize the selected documents from SwissSalary to Personio, the following settings must be made. 1. On the “SwissSalary Document Setup” page, the ID of the corresponding Personio document category must be entered in the “Personio Category ID” field for the SwissSalary document category. All documents from this SwissSalary document category will be transferred to Personio in the specified category. 2. A new entity must be created on the “Entity Setup” page under “Cloud Connector Setup.” 3. Enter 3009140 in the “Table ID” field. You can determine the “Order” yourself. . 4. The Endpoint is v1/company/documents and the Source is Business Central. 5. With this entity field mapping, the documents are transferred to Personio:
IV. Dimension mappings from Personio
To synchronize the assignment of employees to personnel dimensions, the following settings must be made. 1. In the “Table ID” field, enter 3009084. You can determine the “Order” yourself. 2. “Endpoint” is v1/company/employees and “Source” is External System. 3. In the “Template code” field, create a new entry by clicking on “+ New oIn the “Code” field, enter “EMPCOST”. oIn the “Field Name” column, select “Dimension.” oIn the “Default value” field, enter the dimension name (for example, COST CENTERS) in SwissSalary. This may vary for this customer. oClick on “Back”
4. With this entity field mapping, the documents are transferred to Personio:
5. The “Aggregation Field” must have the value “cost_centers”. |