Data Integration: General information
The aim of this data integration tutorial is to help you to understand what are the main concepts used into Opti-Time Geoscheduling
and the most important thing is to understand what is the logical sequence to integrate them.
Before starting to integrate data, please import the default rights profile with the CSV file under "%OptiTime config%\templates\csv" directory.
Use cases
That tutorial is defined as a sequence of entities to create to be able to manage the main concepts of a scheduling project.
It is designed as a sequence of short JSON templates with only main data needed. You can check yourself what are the added possible values with checking the documentation about Import CSV template.
If you are using that tutorial on an empty database (DB created from scratch), you have to follow a sequence to :
- Login to the Opti-Time application as the administrator
- Check that your user has the following rights (Administration > Users > Rights collection)
- Check into "Default right collection" these rights (ADMIN_EXTERN_APPLI and ADMIN_EXTERN_APPLI_TESTMODE)
- Save that collection if any update had to be done
- Logout
- Login to the Opti-Time application as the administrator
Then you can go in the ADMINISTRATION module > Nomadia Field Service API > Documentation
In that section "Nomadia Field Service API", you can click on "Data Integration" > "My first data integration"
Notice
By default, into an empty DB, there is some objects with pre-defined IDs
An area: DEFAULT_AREA
A worksite: DEFAULT_WORKSITE
A day template: STDWORKDAY (Do not modify that ID!)
A week template: STDWORKWEEK (Do not modify that ID!)
A team: DEFAULT_TEAM
A user: DEFAULT_HR for "Admin" / "system"
You can use these IDs to update data through API calls, or you can modifiy theses IDs into user interface to match with YOUR IDs you want to use in the application and update
Into Opti-Time, by default, when you use an ID :
- If ID do not exist, Opti-Time considers it's a NEW entity and It create it
- If ID exists, Opti-Time considers it's an EXISTING entity and It update it
Into Opti-Time, by default, an entity is never deleted, it is de-activated.
If you want really delete an entity, you can sometimes use a field keyword " ACTION " with the value " DELETE ". Please refers to CSV template file to get information on entities where it's available.
My first integration