Share

Project Template Example

Below is an example of a JSON project template file. The template contains the following sections:

  • General - Specify details of the shared and consumed folders. Also contains project type and version information, which does not need to be edited.
  • Companies - Add companies, create folders, and assign permissions.
  • Roles - Add roles and define associated permissions.
  • Teams - Specify team details.
  • Users - Add users and specify their team, role, company, and permissions.
  • Folders - Create and name folders in Document Management.
  • Shared Coordination Spaces - For projects with Model Coordination activated, create a coordination space against the shared folder and specify a name for it.
  • Config - Enable or disable DWG file support for the project.
Note: The users, roles, and companies added in the template must already exist in the BIM 360 account.
Tip: Folders and teams must be specified in the template for successful project creation. Other sections of the template are optional. For example roles and users can be added to teams, and team details changed, once the project has been created.

General - When you set up a Design Collaboration project and create teams, shared and consumed folders are automatically created in Document Management for each team. But you can use this section to define the shared folder location and the consumed folder name. See Teams in Design Collaboration for more information.

{
   "type": "dcs:project:template",
   "version": "1.0",
   "sharedFolderPath": [
        "Folder A",
        "Folder B",
        "Shared"
    ],
    "consumedFolderName": "Consumed",

Companies - Companies can be used to control folder access and permission levels of each team in a project. Use this section of the template to define the companies in the project, the team each company belongs to, and the associated permissions. If necessary, you can also create folders for users assigned to this company, and specify permissions for those folders.

    "companies": [
       {
        "name": "Premier Architects",
        "teams": [
            {
                "team": "Arch",
                "permissionLevel": "CAN_EDIT_PACKAGES"
    ],
    "folders": [
            {
                "folder": [
                    "Arch"
                ],
                "permissions": [
                    "EDIT",
                    "PUBLISH",
                    "VIEW",
                    "DOWNLOAD",
                    "COLLABORATE"
                ]
            }
        ]

Roles - Roles can be used to control the folder access and permission levels of each team in a project. Use this section of the template to define the roles in the project, the team that each role belongs to, and the associated permissions. If necessary, you can also create folders for users assigned this role, and specify permissions for those folders.

The role-level permissions that can be defined are as follows:

  • CAN_VIEW_PACKAGES - View only.
  • CAN_EDIT_PACKAGES - View + Edit.
  • CAN_SHARE_PACKAGES - View, Edit, and Share.
  • CAN_CONTROL_TEAM - View, Edit, Share, and Control.

The folder-level permissions that can be defined are as follows:

  • VIEW - View only.
  • DOWNLOAD - View + Download.
  • PUBLISH - Upload only.
  • COLLABORATE - View + Download + Upload.
  • EDIT - View + Download + Upload + Edit.
  • CONTROL - Folder control.

See Member Permissions for more information about roles and permission levels in Design Collaboration. See Folder Permissions for more information about folder-level permissions.

    "roles": [
        {
            "name": "Architect",        
            "teams": [
                {
                    "team": "Arch",
                    "permissionLevel": "CAN_SHARE_PACKAGES"
                }
            ],
            "folders": [
                {
                    "folder": [
                        "Arch",
                        "WIP"
                    ],
                    "permissions": [
                        "EDIT"
                    ]
                }
            ]
        },
        {
            "name": "Engineer",
            "teams": [
                {
                    "team": "MEP",
                    "permissionLevel": "CAN_EDIT_PACKAGES"
                }
            ],
            "folders": [
                {
                    "folder": [
                        "MEP", 
                        "WIP"
                    ],
                    "permissions": [
                        "COLLABORATE"
                    ]
                }
            ]
        }
    ],

Teams - Use this section to add a team name, and use a hex code to define a unique team color. Optionally, you can specify the location of team folders, select the folders you want content to be included from in your team space, and set up coordination spaces against team folders.

Tip: Team folders are created automatically in the default Project Files location when teams are created if you don't specify a location here.
Note: It is not recommended to set up more than one coordination space against a single folder.

You can also create a publish schedule for each team.

Note: Only weekly publishing is currently supported. But you can specify the day of the week, and hour of the day in which the publish happens, and an email address to receive notifications. Publishing times are displayed in GMT.
    "teams": [
        {
            "name": "Arch",
            "color": "#3266BC",
            "homeFolderPath": [
                "Teams",
                "Arch"
            ],
            "teamFolderPaths":[
                "Teams",
                "Arch",
                "01 Designs"
            ],
            [
                "Teams",
                "Arch",
                "02 Specifications"
            ]
        },
        {
            "name": "MEP",
            "color": "#BC3247",
            "homeFolderPath": [
                "Teams",
                "MEP"
            ],
            "scheduledPublish": {
                "type": "WEEKLY",
                "weekday": "WEDNESDAY",
                "hour": "22",
                "email": "michael.lebsack@autodesk.com"
            }
            "coordinationSpaces": [
                "Phase 1 Designs"
            ]
        }
    ]
}

Users - Use this section to add users to the project using their email address. You can also specify the company they belong to, their role, email notification settings, team assignment, and their permissions. If necessary, you can also create folders for users, and specify permissions for those folders.

The email notification frequencies that can be defined are as follows:

  • NEVER
  • INSTANTLY
Tip: In addition to role-based permissions defined in the preceding section, users can be assigned extra user- and folder-level permissions here. The higher permission set always takes precedent.

When adding users with an administrative responsibility, such as a Project Manager, you can also make them a project administrator. See the first user in the following example.

    "users": [
        {
            "email": "michael.lebsack@autodesk.com",
            "isProjectAdmin": true,
            "roles": [
                "Project Manager"
            ],
            "company": "United Construction",
            "emailSubscription": "NEVER"
        },
        {
            "email": "philip.rushworth@autodesk.com",
            "company": "Premier Architects",
            "roles": [
                "Architect"
            ],
            "emailSubscription": "INSTANTLY",
            "teams": [
                {
                    "team": "Arch",
                    "permissionLevel": "CAN_SHARE_PACKAGES"
                }
            ],
            "folders": [
                {
                    "folder": [
                        "Premier Architects"
                    ],
                    "permissions": [
                        "COLLABORATE"
                    ]
                }
            ]
        },
        {
            "email": "emma.thompson@autodesk.com",
            "company": "Emma's Electricals",
            "roles": [
                "Engineer"
            ],
            "emailSubscription": "INSTANTLY",
            "teams": [
                {
                    "team": "MEP",
                    "permissionLevel": "CAN_EDIT_PACKAGES"
                }
            ],
            "folders": [
                {
                    "folder": [
                        "Emma's Electricals"
                    ],
                    "permissions": [
                        "COLLABORATE"
                    ]
                }
            ]
        }
    ],

Folders - It is recommended that you export and customize a template from a project that has the desired folder structure in Document Management, but you can use this section to create folders as required. 

    "folders": [
        [
            "Photos"],
            ["Bids"],
            ["Specifications"],
            ["Contracts"],
            ["Schedules"],
            ["Submittals"],
            ["RFIs"],
            ["Coordination"],
            ["WIP"
        ]
    ],

Shared Coordination Spaces - For projects with Model Coordination activated, you can create a coordination space configured against the shared folder, and specify a name for the coordination space here. This enables automatic clash detection between all of the models in the shared folder.

Note: It is not recommended to set up more than one coordination space against a single folder.
    "sharedCoordinationSpaces": [
        "Coordination"
    ],

Config - Specify whether you want support for DWG files turned on or off for a project by default. See Work with DWG Files for more information.

    "config": {
        "disabledFileTypes": [
            "dwg"
        ]
    }
Parent page: Project Templates

Was this information helpful?