Configuration of API for BI Systems

[#1]

• Overview
• Create a new file (1)
• Change/Copy a file (3)

The csv files which are retrieved with the API for BI systems can be configured easily with our API configuration application.

The application is available in the YouServe Portal and via direct web address:  https://apiconfiguration.youserve.nl/

How to use the configurator is described in this article

Overview

Create a new file (1)

To create a new file in the API for BI systems, use the green button on the right bottom.

1a) The entity number will always be added to the file. Example: CompanyData becomes CompanyData_17.csv

Continue to add elements (columns in the csv-file):

The number of columns in the file is limited. Please check the maximum numbers of columns in the table below:

Level/ Data entity	Max number of columns/ elements
90014669 (90014669)	5
Assignment	5
Child(7262)	5
Client(15)	10
ClientCla(191)	5
Company (17)	20
CompanyCar	20
CompanyCla(193)	10
ConnectionLeavePayroll	5
ContactPerson(7580)	15
contract (49)	200
Education(7170)	10
Employee(21)	140
Establishment (7449)	30
Establishment_824	5
Evaluation	5
Experience(7157)	5
FormationPlace	5
Function(97)	5
FunctionInformation	5
Gatekeeper	10
GatekeeperAction	5
IncomeRelationship	25
IndividualLeaveRights(7701)	10
Knowledge	5
LeaveBalance	5
LeaveRequest	10
LeaveRequestDetails	5
MaternityLeave(7593)	10
MedicalLeaveManagement(7471)	20
OrganizationalUnit(6000)	15
OrgUnitWorkLocation	5
Person (821)	10
ProcessingUnit	5
ReductionLeaveRights	5
RoleAssignment	5
TemporaryWorker	5
TradeMagazine	5
Trainee	15

A newly created file will be available in the next creation of the csv files. This is done once a day between 00:00 and 5:00 in the morning.

Change/Copy a file (3)

You can change the columns of the csv-files. If elements/columns are added, they will always be added to the end of the columns in the csv -file.

The copy (clone) function will allow you to make changes without immediate effect on your process after you have downloaded the files. For instance: you want to add some fields and want to test first. Take the next steps:

1. Copy the current file with the name CompanyData_17, give a new name. For instance:  CompanyDataV2_17
2. Open the configuration of CompanyDataV2_17 and apply the changes.
3. The next day, the API for BI systems delivers both files: CompanyData_17 and CompanyDataV2_17
4. Now you can use the new file to test the process.
5. If you are ready to start using the new file, change the current filename and rename the new file to the old filename:
   1. CompanyData_17 rename to CompanyDataV1_17
   2. CompanyDataV2_17 rename to CompanyData_17
6. Once you have your process complete, you can delete the CompanyDataV1_17  file.

Changing/ copying a file will take affect in the next creation of the csv-files. This is done once a day between 00:00 and 5:00 in the morning.