Merge pull request '[update] msproject and primavera6 export/import guides and api' (#102) from update-export-msproject-docs-56 into master

Reviewed-on: https://git.webix.io/Servers/gantt-docs/pulls/102

Author: Maria Rudenko

data/api/gantt_exporttomsproject.md

@@ -33,33 +33,17 @@ gantt.exportToMSProject({
 The **exportToMSProject()** method takes as a parameter an object with a number of properties (all of the properties are optional):
 
 - **name** - (*string*) the name of the obtained file ('gantt.xml' by default).
-- **auto_scheduling** - (boolean) indicates the scheduling mode for tasks in the exported project. **true** will mark tasks as auto scheduled, **false** will mark tasks as manually scheduled (the default state).
-- **skip_circular_links** - (boolean) indicates whether the circular links will be removed or not (true - will be removed (the default mode), false - will not be removed).
-- **project** - (object) allows setting custom properties to the exported project entity.
-- **tasks** - (object) allows setting custom properties to the exported task items.
-- **data** - (object) allows setting a custom data source that will be presented in the output Gantt chart. It is expected that the **start_date** and **end_date** properties will be specified in the format which includes both the date and time (*%d-%m-%Y %H:%i*).
-- **callback** - (function) if you want to receive an url to download a generated XML, the *callback* property can be used. It receives a JSON object with the *url* property.
-- **resources** - (array) allows exporting the list of resources into an MS Project file.
-- **server** - (string) the API endpoint for the request. Can be used with the local install of the export service. The default value is **https://export.dhtmlx.com/gantt**.
-
-### Response
-
-The response will contain a JSON of the following structure:
-
-~~~js
-{
-   data: {},
-   config: {},
-   resources: [],
-   worktime: {}
-}
-~~~
-
-- **data** - a gantt [data object](desktop/supported_data_formats.md#json). Each task has the following properties: *id*, *open*, *parent*, *progress*, *start_date*, *text*, *resource*. 
-Dates are stringified in the "%Y-%m-%d %H:%i" format.
-- **config** - a gantt [configuration](api/refs/gantt_props.md) object with settings retrieved from the project file.
-- **resources** - an array of objects (each having the following properties: {*id: string, name:string, type:string*}) that represent the list of resources from the project file.
-- **worktime** - an object containing the working time settings from the project calendar.
+- **auto_scheduling** - (*boolean*) indicates the scheduling mode for tasks in the exported project. **true** will mark tasks as auto scheduled, **false** will mark tasks as manually scheduled (the default state).
+- **skip_circular_links** - (*boolean*) indicates whether the circular links will be removed or not (true - will be removed (the default mode), false - will not be removed).
+- **project** - (*object*) allows setting custom properties to the exported project entity.
+- **tasks** - (*object*) allows setting custom properties to the exported task items.
+- **data** - (*object*) allows setting a custom data source that will be presented in the output Gantt chart. It is expected that the **start_date** and **end_date** properties will be specified in the format which includes both the date and time (*%d-%m-%Y %H:%i*).
+- **callback** - (*function*) if you want to receive an url to download a generated XML, the *callback* property can be used. It receives a JSON object with the *url* property.
+- **resources** - (*array*) allows exporting the list of resources into an MS Project file. If the resource calendars are used, you need to specify -1 for a task in the *CalendarUID* property during the export (in the **tasks** object). 
+Then the task will use the resource calendar.
+- **server** - (*string*) the API endpoint for the request. Can be used with the local install of the export service. The default value is **https://export.dhtmlx.com/gantt**.
+
+Check the detailed descriptions of the export settings in the [related section](desktop/export_msproject.md#exportsettings). 
 
 @related:
 desktop/export_msproject.md#exporttomsproject

data/api/gantt_exporttoprimaverap6.md

@@ -33,33 +33,17 @@ gantt.exportToPrimaveraP6({
 The **exportToPrimaveraP6()** method takes as a parameter an object with a number of properties (all of the properties are optional):
 
 - **name** - (*string*) the name of the obtained file ('gantt.xml' by default).
-- **auto_scheduling** - (boolean) indicates the scheduling mode for tasks in the exported project. **true** will mark tasks as auto scheduled, **false** will mark tasks as manually scheduled (the default state).
-- **skip_circular_links** - (boolean) indicates whether the circular links will be removed or not (true - will be removed (the default mode), false - will not be removed).
-- **project** - (object) allows setting custom properties to the exported project entity.
-- **tasks** - (object) allows setting custom properties to the exported task items.
-- **data** - (object) allows setting a custom data source that will be presented in the output Gantt chart. It is expected that the **start_date** and **end_date** properties will be specified in the format which includes both the date and time (*%d-%m-%Y %H:%i*).
-- **callback** - (function) if you want to receive an url to download a generated XML, the *callback* property can be used. It receives a JSON object with the *url* property.
-- **resources** - (array) allows exporting the list of resources into a Primavera P6 file.
-- **server** - (string) the API endpoint for the request. Can be used with the local install of the export service. The default value is **https://export.dhtmlx.com/gantt**.
-
-### Response
-
-The response will contain a JSON of the following structure:
-
-~~~js
-{
-   data: {},
-   config: {},
-   resources: [],
-   worktime: {}
-}
-~~~
-
-- **data** - a gantt [data object](desktop/supported_data_formats.md#json). Each task has the following properties: *id*, *open*, *parent*, *progress*, *start_date*, *text*, *resource*. 
-Dates are stringified in the "%Y-%m-%d %H:%i" format.
-- **config** - a gantt [configuration](api/refs/gantt_props.md) object with settings retrieved from the project file.
-- **resources** - an array of objects (each having the following properties: {*id: string, name:string, type:string*}) that represent the list of resources from the project file.
-- **worktime** - an object containing the working time settings from the project calendar.
+- **auto_scheduling** - (*boolean*) indicates the scheduling mode for tasks in the exported project. **true** will mark tasks as auto scheduled, **false** will mark tasks as manually scheduled (the default state).
+- **skip_circular_links** - (*boolean*) indicates whether the circular links will be removed or not (true - will be removed (the default mode), false - will not be removed).
+- **project** - (*object*) allows setting custom properties to the exported project entity.
+- **tasks** - (*object*) allows setting custom properties to the exported task items.
+- **data** - (*object*) allows setting a custom data source that will be presented in the output Gantt chart. It is expected that the **start_date** and **end_date** properties will be specified in the format which includes both the date and time (*%d-%m-%Y %H:%i*).
+- **callback** - (*function*) if you want to receive an url to download a generated XML, the *callback* property can be used. It receives a JSON object with the *url* property.
+- **resources** - (*array*) allows exporting the list of resources into a Primavera P6 file. If the resource calendars are used, you need to specify -1 for a task
+in the *CalendarUID* property during the export (in the **tasks** object). Then the task will use the resource calendar.
+- **server** - (*string*) the API endpoint for the request. Can be used with the local install of the export service. The default value is **https://export.dhtmlx.com/gantt**.
+
+Check the detailed descriptions of the export settings in the [related section](desktop/export_primavera.md#exportsettings). 
 
 @related:
 desktop/export_primavera.md#exporttoprimaverap6

data/api/gantt_importfrommsproject.md

@@ -49,7 +49,9 @@ The method takes as a parameter an object with configuration properties of an im
 - **projectProperties** - specifies an array of project properties that should be put into the response.
 - **taskProperties** - specifies an array of additional task properties to be imported.
 
-###Response
+Check the detailed descriptions of the import settings in the [related section](desktop/export_msproject.md#importsettings).
+
+### Response
 
 The response will contain a JSON of the following structure:
 
@@ -58,15 +60,29 @@ The response will contain a JSON of the following structure:
    data: {},
    config: {},
    resources: [],
-   worktime: {}
+   worktime: {},
+   calendars: []
 }
 ~~~
 
-- **data** - a gantt [data object](desktop/supported_data_formats.md#json). Each task has the following properties: *id*, *open*, *parent*, *progress*, *start_date*, *text*, *resource*. 
+- **data** - (*object*) a gantt [data object](desktop/supported_data_formats.md#json). Each task has the following properties: *id*, *open*, *parent*, *progress*, *start_date*, *text*, *resource*. 
 Dates are stringified in the "%Y-%m-%d %H:%i" format. 
-- **config** - a gantt [configuration](api/refs/gantt_props.md) object with settings retrieved from the project file.
-- **resources** - an array of objects (each having the following properties: {*id:string, name:string, type:string*} that represent the list of resources from the project file.
-- **worktime** - an object containing the working time settings from the project calendar.
+- **config** - (*object*) a gantt [configuration](api/refs/gantt_props.md) object with settings retrieved from the project file.
+- **resources** - (*array*) an array of objects (each having the following properties: {*id: string, name: string, type: string, calendar: string*} that represent the list of resources from the project file.
+- **worktime** - (*object*) an object containing the working time settings from the project calendar. It can contain the following attributes:
+    - **id** - (*string | number*) optional, the calendar id
+    - **hours** - (*array*) an array with global working hours, sets the start and end hours of the task
+    - **dates** - (*array*) an array of dates that can contain:
+        - 7 days of the week (from 0 - Sunday, to 6 - Saturday), where 1/true stands for a working day and 0/false - a non-working day
+        - other records are dates 
+- **calendars** - (*array*) an array containing calendar configuration objects for creating a new calendar. 
+    - **calendarConfig** - (*object*) a calendar configuration object that can contain the following attributes:
+      - **id** - (*string | number*) optional, the calendar id
+      - **name** - (*string*) the calendar name
+      - **hours** - (*array*) an array with global working hours, sets the start and end hours of the task
+      - **dates** - (*array*) an array of dates that can contain:
+            - 7 days of the week (from 0 - Sunday, to 6 - Saturday), where 1/true stands for a working day and 0/false - a non-working day
+            - other records are dates
 
 @related:
 desktop/export_msproject.md#importfrommsproject

data/api/gantt_importfromprimaverap6.md

@@ -49,6 +49,8 @@ The method takes as a parameter an object with configuration properties of an im
 - **projectProperties** - specifies an array of project properties that should be put into the response.
 - **taskProperties** - specifies an array of additional task properties to be imported.
 
+Check the detailed descriptions of the import settings in the [related section](desktop/export_primavera.md#importsettings).
+
 ### Response
 
 The response will contain a JSON of the following structure:
@@ -58,15 +60,30 @@ The response will contain a JSON of the following structure:
     data: {},
     config: {},
     resources: [],
-    worktime: {}
+    worktime: {},
+    calendars: []
 }
 ~~~
 
-- **data** - a gantt [data object](desktop/supported_data_formats.md#json). Each task has the following properties: *id*, *open*, *parent*, *progress*, *start_date*, *text*, *resource*. 
+- **data** - (*object*) a gantt [data object](desktop/supported_data_formats.md#json). Each task has the following properties: *id*, *open*, *parent*, *progress*, *start_date*, *text*, *resource*. 
 Dates are stringified in the "%Y-%m-%d %H:%i" format. 
-- **config** - a gantt [configuration](api/refs/gantt_props.md) object with settings retrieved from the project file.
-- **resources** - an array of objects (each having the following properties: {*id:string, name:string, type:string*} that represent the list of resources from the project file.
-- **worktime** - an object containing the working time settings from the project calendar.
+- **config** - (*object*) a gantt [configuration](api/refs/gantt_props.md) object with settings retrieved from the project file.
+- **resources** - (*array*) an array of objects (each having the following properties: 
+{*id: string, name: string, type: string, calendar: string*} that represent the list of resources from the project file.
+- **worktime** - (*object*) an object containing the working time settings from the project calendar. It can contain the following attributes:
+    - **id** - (*string | number*) optional, the calendar id
+    - **hours** - (*array*) an array with global working hours, sets the start and end hours of the task
+    - **dates** - (*array*) an array of dates that can contain:
+        - 7 days of the week (from 0 - Sunday, to 6 - Saturday), where 1/true stands for a working day and 0/false - a non-working day
+        - other records are dates 
+- **calendars** - (*array*) an array containing calendar configuration objects for creating a new calendar. 
+    - **calendarConfig** - (*object*) a calendar configuration object that can contain the following attributes:
+      - **id** - (*string | number*) optional, the calendar id
+      - **name** - (*string*) the calendar name
+      - **hours** - (*array*) an array with global working hours, sets the start and end hours of the task
+      - **dates** - (*array*) an array of dates that can contain:
+            - 7 days of the week (from 0 - Sunday, to 6 - Saturday), where 1/true stands for a working day and 0/false - a non-working day
+            - other records are dates
 
 @related:
 desktop/export_primavera.md#importfromprimaverap6