A JSON script can be set up in any JSON script editor.

You can find an example script as an attachment to this article, to get you started.

The script starts with the title of the script and optionally the version, followed by the actions to be performed in BIMcollab Zoom when the script is executed.

{

"title": "Example_Script",
"version": "0.1",

"actions": [

Open models / Add to project

1. OPEN_MODELS: adds and loads a model to the Navigator and closes any previously loaded models
   
2. ADD_TO_PROJECT: adds and loads a model to the Navigator without closing models that are already present in the Navigator
   

Note: when you connect to a project where a Project folder is active, all the models in the project folder will be automatically loaded, regardless of their loadstatus in your Zoom project. There is no additional input in the script necessary to open these models.
If you want to add additional models to the project which are not located in the project folder, use the ADD_TO_PROJECT prompt.

Script

{

"type": "OPEN_MODELS",

"models": [

"C:/Users/userone/Desktop/1.ifc",

"C:/Users/userone/Desktop/2.ifc",

"C:/Users/userone/Desktop/3.bcp"

]

}

Explanation

Always use forward slashes "/" in the path definition, not backslashes.

Connect to project

{

"type": "CONNECT_TO_PROJECT",

"space_name": "example.bimcollab.com",

"project_name": "My BIMcollab project"

}

Explanation

1. Replace "example.bimcollab.com" with the URL of the space you want to connect to.
   
2. Replace "My BIMcollab project" with the name of the project you want to connect to. Pay attention to the correct spelling of the name and the URL.
   

It is important to note that the project you want to connect to is part of the recent projects list in BIMcollab Zoom and that your credentials are saved in BIMcollab Zoom. This can be achieved by marking the checkbox 'Remember me' when manually connecting to the project.



Also make sure that the format of the "space_name" parameter precisely matches the format in which the space name was entered when connecting to the project.

If you for example entered https://example.bimcollab.com/ or example.bimcollab.com, this needs to be exactly matched in the script.

{

"type": "FILTER_ISSUES",

"filter_type": "Issue",

"area": "Model",

"milestone": "Design phase",

"label": "Architecture",

"priority": "Normal",

"show_active": true,

"show_resolved": true,

"show_closed": false,

"hide_invisible": false,

"show_to_approve": false,

"assigned_to_user_email": "example@bimcollab.com",

"deadline": "01-01-2021",

"created_by_user_email": "example@bimcollab.com",

"custom1": "Value 1",

"custom2": "Value 2"

}

Explanation

1. When this prompt is added to the script, the issue filter in BIMcollab Zoom is first reset to the default filter, and then adjusted according to the values in the script.
   
2. Nightshift assumes default parameter settings whenever possible, so you only need to specify changes that are made from the default settings. All of the parameter lines in this part of the script, except for "type": "FILTER_ISSUES", (mandatory action definition), and the "priority", may be omitted from the script. If for example the parameter "label" is omitted, Nightshift will keep that parameter setting at "All".
   
3. Pay attention to the spelling of the entered values. They must be exactly the same as they are in the project.
4. 

   Tip: Open the Issue filter window in BIMcollab Zoom next to the JSON editor to avoid typos in the script.
   

1. "filter_type"
   Replace "Issue" with the type you want to filter. The default value is "All" (or the corresponding value in the language of your project).
   
2. "area"
   Replace "Model" with the area you want to filter. The default value is "All" (or the corresponding value in the language of your project).
3. "milestone"
   Replace "Design phase" with the milestone you want to filter. The default value is "All" (or the corresponding value in the language of your project).
4. "label"
   Replace "Architecture" with the label you want to filter. The default value is "All" (or the corresponding value in the language of your project).
5. "priority"
   Replace "Normal" with the priority you want to filter. The default value is "All" (or the corresponding value in the language of your project).
6. "show_active"
   This is a checkbox determining whether the active issues of the project should be displayed. Enter 'true' if the checkbox should be enabled or 'false' if it should be disabled. The default value is true.
7. "show_resolved"
   This is a checkbox determining whether the resolved issues of the project should be displayed. Enter 'true' if the checkbox should be enabled or 'false' if it should be disabled. The default value is true.
8. "show_closed"
   This is a checkbox determining whether the closed issues of the project should be displayed. Enter 'true' if the checkbox should be enabled or 'false' if it should be disabled. The default value is false.
9. "hide_invisible"
   This is a checkbox determining whether issues that are not visible for all team members should be hidden. Enter 'true' if the checkbox should be enabled or 'false' if it should be disabled. The default value is false.
10. "show_to_approve"
    This is a checkbox determining whether the issues that you have to approve should be displayed. Enter 'true' if the checkbox should be enabled or 'false' if it should be disabled. The default value is false.
11. "assigned_to_user_email"
    Replace "example@bimcollab.com" with the email address of the assigned user, not just their name. The default value is "" (issues assigned to all users are shown).
12. "deadline"
    Replace "01-01-2021" with the deadline on which you want to filter, in the format dd-mm-yyyy. The default value is "" (no deadline is taken into account).
13. "created_by_user_email"
    Replace "example@bimcollab.com" with the email address of the creator, not just their name. The default value is "" (issues created by all users are shown).
14. "custom1"
    Replace "Value 1" with the value of Custom List field 1 you want to filter. The script line should always start with "custom1", not with the actual name of the Custom field. The default value is "" (All values for this custom field are shown).
15. "custom2"
    Replace "Value 2" with the value of Custom List field 2 you want to filter. The script line should always start with "custom2", not with the actual name of the Custom field. The default value is "" (All values for this custom field are shown).

If one of the inputs of the filter is incorrect, the script will not be executed further.

Update issues

{

"type": "UPDATE_ISSUES",
"close_where_clashes_solved": true,
"reopen_previously_closed_issues": false,
"comment": "Updated with Nightshift"
}

If any of the options are missing, a default value will be added, as shown in the image below.

Run and share Lists

All Lists located in 'Shared' in the Lists tab can be run and shared at the same time so the most recent information is available for all team members in BIMcollab Nexus.

The prompt for this action is RUN_AND_SHARE_LISTS

Script

{

"type": "RUN_AND_SHARE_LISTS",

"list_set-name" : "List set 3"

}

{

"type": "SYNCHRONIZE_PROJECT"

}

Follow up on the status of the task

Once the task has run, you can check whether all actions were performed successfully in the Nightshift logfile. The file gives feedback about the execution status of all actions in the scripts, and error codes if something went wrong.

You can find all logfiles at C:\Users\\AppData\Roaming\KUBUS\BIMcollab Zoom\Nightshift.

Replace with the name of your own user profile in windows.

The AppData folder is a hidden folder by default. Display the hidden folders in the File Explorer to navigate to the correct location.