跳到主要内容

导出与从 Primavera P6 导入

dhtmlxGantt 库允许将甘特图中的数据导出到 Primavera P6。你也可以将 Primavera P6 的数据导入到 Gantt。

注释

服务是免费的，但输出文件将包含该库在 GPL 许可下的水印。若你购买了许可证，在有效的支持期内（所有 PRO 许可证均为 12 个月）导出的结果将无水印。

有多种导出服务可用。你可以在本地计算机上安装它们，将甘特图本地导出到 Primavera P6。请注意，导出服务不包含在 Gantt 包中， 请阅读 corresponding article 以了解每种服务的使用条款。

在线导出服务限制​

注释

导出服务有时间和请求大小的限制。

时间限制​

如果进程超过 20 秒，导出将被取消，并出现以下错误：

Error: Timeout trigger 20 seconds

如果多个人同时导出 Gantt，处理时间可能比平时更长。但没关系，因为来自特定用户的导出请求所耗费的时间是单独计算的。

请求大小限制​

存在一个通用 API 端点 https://export.dhtmlx.com/gantt，用于所有导出方法（exportToPDF、exportToPNG、exportToMSProject 等）。最大请求大小为 10 MB。

还有一个针对 MSProject 与 Primavera P6 的单独 API 端点 https://export.dhtmlx.com/gantt/project， 用于特定的导出/导入服务（仅 exportToMSProject / importFromMSProject / exportToPrimaveraP6 / importFromPrimaveraP6）。最大请求大小：40 MB。

使用导出模块​

注释

如果你需要导出大型图表，可以使用一个 standalone export module。 若你在 Commercial、Enterprise 或 Ultimate 许可下取得 Gantt，导出模块免费提供，或者你也可以单独购买模块使用。

在 MS Project 上使用导出模块的更多用法。该导出模块提供 MS Project 和 Primavera P6 的导出/导入功能。

导出到 Primavera P6​

Gantt 组件支持将链接、任务和资源导出到 Primavera P6。

要将数据从 Gantt 图导出到 Primavera P6，请执行下列操作：

  • 要使用导出/导入功能，请通过 plugins 方法启用 export_api 插件：
gantt.plugins({
    export_api: true
});

它允许你使用在线导出服务或本地导出模块。

注释

如果你使用的 Gantt 版本低于 8.0，在页面上需要包含 https://export.dhtmlx.com/gantt/api.js 以启用导出功能，例如：

<script src="codebase/dhtmlxgantt.js"></script>
<script src="https://export.dhtmlx.com/gantt/api.js"></script>
gantt.exportToPrimaveraP6();

该方法将向远程服务发送请求，服务要么输出一个 XML Project 文件，要么返回一个用于下载生成文件的 URL。

相关示例： Export data : MS Project, PrimaveraP6, Excel & iCal

请注意，当将数据导出到 Primavera 时，需要为项目任务的 Summary 属性返回 true，以使该功能正确工作：

gantt.exportToPrimaveraP6({
  tasks: {
    Summary: function (task) {
      return !!gantt.hasChild(task.id);
    },
    CustomProperty: function (task) {
      return task.custom_property;
    },
    SlateId: function (task) {
      return task.id + "";
    },
  }
});

相关示例： Custom properties for WBS tasks (PrimaveraP6's Summary tasks)

导出设置​

exportToPrimaveraP6() 方法接收一个对象作为参数，该对象包含若干属性（所有属性均为可选）：

  • name - (string) 获取到的文件名（默认为 'gantt.xml'）。
gantt.exportToPrimaveraP6({
    name:'custom.xml'
});
  • auto_scheduling - (boolean) 指示导出项目中任务的排程模式。true 表示任务为自动排程，false 表示任务为手动排程（默认状态）。
gantt.exportToPrimaveraP6({
    auto_scheduling: false
});
  • skip_circular_links - (boolean) 指示是否移除循环链接（true - 将移除（默认模式），false - 不移除）。
gantt.exportToPrimaveraP6({
    skip_circular_links: false
});
  • project - (object) 允许为导出的 project 实体设置自定义属性
gantt.exportToPrimaveraP6({
    project: {
        'Author': 'I am!',
        'MinutesPerDay': function () {
            return gantt.config.hours_per_day * 60;
        }
    }
});

该对象的属性对应 [Project entity] 的相应属性。支持的属性列表可在 这里 找到。属性可以包含固定值或在导出调用时执行的函数。

  • tasks - (object) 允许为导出的任务项设置自定义属性
gantt.exportToPrimaveraP6({
   tasks: {
        'StartVariance': function (task) {
           if (task.startVariance)
               return task.startVariance;
           else
               return 0;
        },
        'PercentWorkComplete': function (task) {
           return (task.progress + 0.1);
        },
        'Custom': function (task) {
           return 'Custom value';
        },
        'Custom 2': 'My Custom value'
    }
});

该对象的属性对应 [Task entity] 的相应属性，这里是 [properties] 的支持列表。属性可以包含固定值或在导出调用时对每个任务执行的函数。

  • data - (object) 允许设置将在导出 Gantt 图中呈现的自定义数据源。
注释

预计在 start_date 和 end_date 属性中指定包含日期和时间的格式（%d-%m-%Y %H:%i）。

const customData = {
    "data": [
        { "id": "10", "text": "Project #5", "start_date": "01-04-2025 00:00", 
            "duration": 3, "order": 10, "progress": 0.4, "open": true, 
            "end_date": "04-04-2025 00:00", "parent": 0 
        },
        { "id": "1", "text": "Task #67", "start_date": "02-04-2025 00:00", 
            "duration": 2, "order": 10, "progress": 0.6, "parent": "10", 
            "end_date": "04-04-2025 00:00" 
        },
        { "id": "2", "text": "Task #89", "start_date": "01-04-2025 00:00", 
            "duration": 2, "order": 20, "progress": 0.6, "parent": "10", 
            "end_date": "03-04-2025 00:00" 
        },
    ],
    "links": [
        { "id": 1, "source": 1, "target": 2, "type": "1" },
    ]
}

gantt.exportToPrimaveraP6({
    data: customData
});

相关示例： Gantt. Export custom data

  • callback - (function) 如果你想获取用于下载生成的 XML 的 URL，可以使用 callback 属性。它接收一个带有 url 属性的 JSON 对象：
gantt.exportToPrimaveraP6({
    callback: function(res){
        alert(res.url);
    }
});
  • resources - (array) 允许将资源列表导出到 Primavera P6 文件
gantt.exportToPrimaveraP6({
    resources: [
        { "id": "1", "name": "John", "type": "work" },
        { "id": "2", "name": "Mike", "type": "work" },
        { "id": "3", "name": "Anna", "type": "work" }
    ]
});

可用的资源类型为 "work"、"cost"、"material"。资源分配通过任务配置的 ResourceAssignments 属性来指定：

var users = [// resources
    { key: '0', label: "N/A" },
    { key: '1', label: "John" },
    { key: '2', label: "Mike" },
    { key: '3', label: "Anna" }
];

gantt.exportToPrimaveraP6({
    resources: users
        .filter(function(u){
            if(u.key === '0')//跳过默认选项
                return false;
            return true;
        })
        .map(function(u){
            return {
                id: u.key,
                name: u.label,
                type: "work"
               };
          }),
    tasks: {
        ResourceAssignments: function(task){  
            return task.user;                   
        }                                       
    }
});

ResourceAssignments 属性可以是一个函数，接收任务对象并返回字符串/数字或字符串/数字数组:

tasks: {
    ResourceAssignments: function(task){
        return [task.user, task.office];
    }
}

相关示例： Export Gantt with resources to Primavera P6

可以在 ResourceAssignments 属性中返回以下对象以指定 units 参数：

{
    resource_id: "id",
    units: "units value"
}
  • resource calendars

默认情况下，每个任务都会添加一个日历。如果使用资源日历，需要在导出期间在 CalendarUID 属性中为任务指定 -1（在 tasks 对象中）。那么该任务将使用资源日历。

在导出 resource calendars 时，可以在 resources 数组的对象中指定资源日历：

gantt.exportToPrimaveraP6({
    resources: [
        {
            id: "10",
            name: "John",
            type: "work",
            calendar: gantt.config.resource_calendars[10]
        }
    ]
});
  • server - (string) 请求的 API 端点。可用于本地安装的导出服务。默认值为 https://export.dhtmlx.com/gantt。
gantt.exportToPrimaveraP6({
    server: "https://myapp.com/myexport/gantt"
});

从 Primavera P6 导入​

为了转换 XML 或 XER 文件，你需要向导出服务发送以下请求：

  • 请求 URL - https://export.dhtmlx.com/gantt
  • 请求方法 - POST
  • 内容类型 - multipart/form-data

请求参数为：

  • file - XER 或 XML Primavera P6 文件
  • type - "primaveraP6-parse"
  • data - (可选) 带有设置的 JSON 字符串

例如：

<form action="https://export.dhtmlx.com/gantt" method="POST" 
    encType="multipart/form-data">
    <input type="file" name="file" />
    <input type="hidden" name="type" value="primaveraP6-parse"/>
    <button type="submit">Get</button>
</form>

或者，你也可以使用 client-side API，如下所示：

gantt.importFromPrimaveraP6({
    data: file,
    taskProperties: ["Notes", "Name"],
    callback: function (project) {
        if (project) {
            gantt.clearAll();
            if (project.config.duration_unit) {
                gantt.config.duration_unit = project.config.duration_unit;
            }                    
            gantt.parse(project.data);
        }
    }
});

相关示例： Import Primavera P6 file

其中 file 是一个 File 的实例，应包含一个 XML 或 XER Project 文件。

注释

gantt.importFromPrimaveraP6 需要 HTML5 File API 的支持。

响应​

响应将包含以下结构的 JSON：

{
    data: {},
    config: {},
    resources: [],
    worktime: {},
    calendars: []
}
  • data - (object) 一个甘特图 data object。每个任务具有以下属性：id, open, parent, progress, start_date, text, resource。日期以字符串形式表示，格式为 "%Y-%m-%d %H:%i"。
  • config - (object) 一个甘特图 configuration 对象，包含从项目文件中检索的设置。
  • resources - (array) 一个对象数组（每个对象具有以下属性： (id: string, name: string, type: string, calendar: string)）表示来自项目文件的资源列表。
  • worktime - (object) 包含来自项目日历的工作时间设置的对象。它可以包含以下属性：
    • id - (string | number) 可选，日历 ID
    • hours - (array) 全局工作时间数组，设置任务的开始和结束时间
    • dates - (array) 日期数组，可包含：
      • 每周的 7 天（从 0 - 星期日，到 6 - 星期六），其中 1/true 代表工作日，0/false 代表非工作日
      • 其他记录为日期
  • calendars - (array) 包含用于创建新日历的日历配置对象的数组。
    • calendarConfig - (object) 日历配置对象，可能包含以下属性：
      • id - (string | number) 可选，日历 id
      • name - (string) 日历名称
      • hours - (array) 全局工作时间数组，设置任务的开始和结束时间
      • dates - (array) 日期数组，可包含：
        • 每周的 7 天（从 0 - 星期日，到 6 - 星期六），其中 1/true 代表工作日，0/false 代表非工作日
        • 其他记录为日期

导入设置​

设置持续时间单位​

要设置期望的持续时间单位，可以将 durationUnit（"minute"、"hour"、"day"、"week"、"month"、"year"）字符串也发送到服务器。

<form action="https://export.dhtmlx.com/gantt" method="POST" 
    encType="multipart/form-data">
    <input type="file" name="file" />
    <input type="hidden" name="type" value="primaveraP6-parse"/>
    <input type="hidden" name="data" 
        value="{ "durationUnit": "hour" }" />
    <button type="submit">Get</button>
</form>

或

gantt.importFromPrimaveraP6({
    data: file,
    durationUnit: "hour",
    callback: function(project){}
});

获取项目属性​

要获取项目字段，可以向服务器发送带有所需字段数组的 projectProperties 输入。 它将 Project entity 的任意属性提取到输出的 config 属性中。支持的 properties 列表如下。

  • projectProperties - 指定应放入响应中的项目属性数组。
<form action="https://export.dhtmlx.com/gantt" method="POST" 
    encType="multipart/form-data">
    <input type="file" name="file" />
    <input type="hidden" name="type" value="primaveraP6-parse"/>
    <input type="hidden" name="data" 
        value="{ "projectProperties": ["Author", "Title"] }" />
    <button type="submit">Get</button>
</form>

或

gantt.importFromPrimaveraP6({
    data: file,
    durationUnit: "hour",
    projectProperties: ["Author", "Title"],
    callback: function(project){
        var config = project.config;
        alert(config.$custom_properties.Author);
    }
});

获取任务属性​

要获取任务字段，可以向服务器发送带有必要字段的 taskProperties 输入。 它将 Task entities 的任意属性提取到输出中的任务属性。下面是 properties 的支持列表：

  • taskProperties - 指定要导入的额外任务属性数组。
<form action="https://export.dhtmlx.com/gantt" method="POST" 
    encType="multipart/form-data">
    <input type="file" name="file" />
    <input type="hidden" name="type" value="primaveraP6-parse"/>
    <input type="hidden" name="data" 
        value="{ "taskProperties": ["Contact", "Priority"] }" />
    <button type="submit">Get</button>
</form>

或

gantt.importFromPrimaveraP6({
    data: file,
    durationUnit: "hour",
    taskProperties: ["Contact", "Priority"],
    callback: function(project){
        var config = project.config;
        alert(config.$custom_properties.Author);
        gantt.parse(project.data);
    }
});
gantt.attachEvent("onTaskLoading", function(task) {
    if (task.$custom_data) {
        task.contact = task.$custom_data["Contact"];
        task.priority = task.$custom_data["priority"];
        delete task.$custom_data;
    }
    return true;
});

获取任务类型​

以下逻辑可帮助你获取任务类型：Project 类型的任务具有 Summary: "1" 属性，Milestone 类型的任务具有 Milestone: "1" 属性。我们需要导入带有这些属性的数据，然后根据这些属性设置任务类型。

调用导入函数的示例看起来像这样：

gantt.importFromPrimaveraP6({
    data: file,
    taskProperties: [
        "Summary", 
        "Milestone",
    ],
    callback: function (project) {
        if (project) {
            console.log(project)
            gantt.clearAll();
            if (project.config.duration_unit) {
                gantt.config.duration_unit = project.config.duration_unit;
            }
            console.log('import: ', project.data);
            gantt.parse(project.data);
        }
    }
});

之后你可以基于接收到的属性将任务类型转换如下：

gantt.attachEvent("onTaskLoading", function (task) {
    if (task.$custom_data) {
        if (task.$custom_data.Summary == "1") {
            task.type = "project";
        }
        if (task.$custom_data.Milestone == "1") {
            task.type = "milestone";
        }
        // delete task.$custom_data;
    }
    return true;
});

相关示例： Gantt. Import Primavera P6 files. Get task type from properties

添加和调整日历​

请注意，在导入期间日历不会自动添加。你需要使用 addCalendar() 方法将它们添加进去。 之后，应该通过 setWorkTime() 方法来设置日历设置。例如：

gantt.importFromPrimaveraP6({
    data: file,
    taskProperties: ["Notes", "Name"],
    callback: function (project) {
        if (project) {
            // 添加日历的设置
            project.calendars.forEach(function (calendar) {
                let addedCalendar;
                // 为全局日历添加工作时间设置
                if (calendar.id == project.config.global_calendar_id) {
                    addedCalendar = gantt.getCalendar("global");
                }
                else {
                    // Gantt 不会在 hours 参数为空数组时添加日历
                    let calendarHours = calendar.hours;
                    if (!calendarHours.length) {
                        calendarHours = undefined
                    }
                    gantt.addCalendar({
                        id: calendar.id,
                        hours: calendarHours,
                        name: calendar.name
                    });

                    addedCalendar = gantt.getCalendar(calendar.id);
                }
                const worktimeDates = calendar.dates;
                for (let element in worktimeDates) {
                    const date = new Date(+element)
                    if (element < 10) {
                        addedCalendar.setWorkTime({ 
                            day: element, 
                            hours: worktimeDates[element] 
                        })
                    }
                    else {
                        addedCalendar.setWorkTime({ 
                            date: date, 
                            hours: worktimeDates[element] 
                        })
                    }
                }
            })
        }
    }
});

相关示例： Gantt. Calendars settings for export/import in MSProject and Primavera P6

资源日历​

如果存在资源日历，需要通过 gantt.config.resource_calendars 属性来指定：

gantt.importFromPrimaveraP6({
    data: file,
    taskProperties: ["Notes", "Name"],
    callback: function (project) {
        if (project) {
            // 日历设置
            project.calendars.forEach(function (calendar) {
                // 添加日历及其工作时间设置
            })

            // 资源日历设置
            gantt.config.resource_calendars = {}

            project.resources.forEach(function (resource) {
                if (resource.calendar) {
                    gantt.config.resource_calendars[resource.id] = resource.calendar;
                }
            })
        }
    }
});

相关示例： Gantt. Resource calendars settings for export/import in MSProject and Primavera P6

资源与资源分配​

如果文件中存在资源，它们在导入时会出现在 resources 数组中。resources 属性的 calendar 参数指定资源日历：

{
    resources: [
        { id: 6, name: "John", type: "work", calendar: "8" },
        // 更多资源
    ]
}

如果存在资源分配，它们将导入到 assignments 数组，其中分配对象包含 resource_id: string 和 value: number 参数。例如：

{
    tasks: [
        {
            id: 5,
            text: "Interior office",
            type: "task",
            start_date: "03-04-2024 00:00",
            duration: 7,
            parent: "2",
            priority: 1
        },
        // 更多任务
    ],
    links: [],
    assignments: [
        { id: 1, task_id: 5, resource_id: 6, value: 3},
        // 更多分配
    ],
    resources: [
        { id: 6, text: "John", unit: "hours/day" },
        { id: 7, text: "Mike", unit: "hours/day" },
        // 更多资源
    ]
}

请求大小限制与大文件导入​

Primavera P6 导出/导入服务有两个 API 端点：

  • https://export.dhtmlx.com/gantt - 默认端点，提供所有导出方法（exportToPDF、exportToPNG、exportToPrimaveraP6 等）。最大请求大小为 10 MB。
  • https://export.dhtmlx.com/gantt/project - 针对 MSProject 与 Primavera P6 的导出/导入服务专用端点（仅 exportToMSProject / importFromMSProject / exportToPrimaveraP6 / importFromPrimaveraP6）。最大请求大小：40 MB。

该端点可以通过导出配置对象的 server 属性指定：

gantt.importFromPrimaveraP6({
    server: "https://export.dhtmlx.com/gantt",
    data: file,
    callback: function(project){
       // 某些逻辑
    }
});

如果未指定端点，默认使用 https://export.dhtmlx.com/gantt。下述调用等价于上面的调用：

gantt.importFromPrimaveraP6({
    data: file,
    callback: function(project){
       // 某些逻辑
    }
});

为了导出或导入超过 4MB 限制的大型项目，可以使用第二个端点：

gantt.importFromPrimaveraP6({
    server: "https://export.dhtmlx.com/gantt/project",
    data: file,
    callback: function(project){
       // 某些逻辑
    }
});

它允许发送高达 40MB 的请求，并支持 Primavera P6 的导出和导入。它可用于 Primavera P6 的导出，但其他方法（例如，gantt.exportToPDF({server:"https://export.dhtmlx.com/gantt/project"})）应返回服务器错误。

Need help?
Got a question about the documentation? Reach out to our technical support team for help and guidance. For custom component solutions, visit the Services page.
Need more help?Contact Support