Een JSON script maken voor Zoom Nightshift

Een JSON script maken voor Zoom Nightshift

ZOOM Nightshift automatiseert acties in Zoom met behulp van JSON scriptbestanden in combinatie met de Windows Taakplanner.
Met Nightshift kan je de volgende acties automatiseren in BIMcollab Zoom:
  1. Modellen openen / Aan project toevoegen
  2. Verbinden met project
  3. Issues filteren
  4. Issues updaten
  5. Alle Lists uitvoeren en delen
  6. Project synchroniseren
In dit artikel beschrijven we hoe je een script maakt om uit te voeren in Zoom Nightshift.
Voor meer informatie over het instellen van een taak in Windows Taakplanner, raadpleeg het artikel Configureer een taak voor Zoom Nightshift in de Windows Taakplanner.
Een JSON script kan worden opgezet in elke JSON script editor.
Je kunt een voorbeeldscript vinden als bijlage bij dit artikel, om je op weg te helpen.

Het script begint met de titel van het script en optioneel de versie, gevolgd door de acties die moeten worden uitgevoerd in Zoom wanneer het script wordt uitgevoerd.
{
"title": "Example_Script",
"version": "0.1",
"actions": [
De verschillende acties die aan het script kunnen worden toegevoegd, zodat Zoom ze kan uitvoeren tijdens Nightshift, worden uitgelegd in de rest van dit artikel.

Modellen openen / Aan project toevoegen

Het eerste wat je in Nightshift wilt doen, is een set modellen openen waarop de rest van de acties kan worden uitgevoerd. Hiervoor zijn er twee verschillende mogelijke prompts:
  1. OPEN_MODELS: voegt een model toe en laadt het in de Navigator en sluit alle eerder geladen modellen
  2. ADD_TO_PROJECT: voegt een model toe en laadt het in de Navigator zonder modellen te sluiten die reeds in de Navigator aanwezig zijn
Opmerking: wanneer je verbinding maakt met een project waar een Projectmap actief is, zullen alle modellen in de projectmap automatisch geladen worden, onafhankelijk van hun laadstatus in je Zoom project. Er is geen extra invoer in het script nodig om deze modellen te openen.
Als je extra modellen aan het project wilt toevoegen die zich niet in de projectmap bevinden, gebruik je de 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"
]
}

Toelichting

Vervang "C:/Users/userone/Desktop/1.ifc", enz. door de paden naar de modellen die je wilt openen, gescheiden door komma's.
Gebruik altijd forward slashes "/" in de definitie van de lokatie, geen backslashes.

Verbinden met project

Om een update van Smart Issues te kunnen uitvoeren en Lists te kunnen delen, moet je verbonden zijn met een project op BIMcollab Nexus.
De prompt hiervoor is CONNECT_TO_PROJECT.

Script

{
"type": "CONNECT_TO_PROJECT",
"space_name": "example.bimcollab.com",
"project_name": "My BIMcollab project"
}

Toelichting

  1. Vervang "example.bimcollab.com" door de URL van de space waarmee je verbinding wilt maken.
  2. Vervang "My BIMcollab project" door de naam van het project waarmee je wilt verbinden. Let op de juiste spelling van de naam en de URL.
Het is belangrijk te weten dat het project waarmee je wilt verbinden deel uitmaakt van de recente projectenlijst in BIMcollab Zoom en dat je inloggegevens opgeslagen zijn in BIMcollab Zoom. Dit kan worden bereikt door het selectievakje 'Onthoud mij' aan te vinken wanneer je handmatig verbinding maakt met het project.



Zorg er ook voor dat de opmaak van de "space_name" parameter precies overeenkomt met de opmaak waarin de space naam is ingevoerd bij het maken van de verbinding met het project.
Als je bijvoorbeeld https://example.bimcollab.com/ of example.bimcollab.com hebt ingevoerd, moet dit exact overeenkomen in het script.

Issues filteren

Zodra je verbonden bent met een project, zullen alle issues die voor jou zichtbaar zijn in het project geladen worden in BIMcollab Zoom.
In de volgende stap kunnen alle Smart Issues die deel uitmaken van deze lijst automatisch worden bijgewerkt. Om alleen een selectie van issues van je keuze te updaten, moet eerst de issuefilter ingesteld worden.
De prompt is FILTER_ISSUES.
Als deze prompt wordt weggelaten in het script, zal de laatst actieve filter worden gebruikt.

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"
}

Toelichting

Hier zijn enkele dingen om rekening mee te houden voor dit deel van het script:
  1. Wanneer deze prompt wordt toegevoegd aan het script, wordt de issuefilter in BIMcollab Zoom eerst opnieuw ingesteld op de standaardfilter, en vervolgens aangepast volgens de waarden in het script.
  2. Nightshift gaat zoveel mogelijk uit van standaard parameterinstellingen, dus je hoeft alleen wijzigingen op te geven die afwijken van de standaardinstellingen. Alle parameter regels in dit deel van het script, behalve "type": "FILTER_ISSUES", (verplichte actiedefinitie), en de "prioriteit", mogen uit het script worden weggelaten. Als bijvoorbeeld de parameter "label" wordt weggelaten, zal Nightshift die parameterinstelling op "Alle" houden.
  3. Let op de spelling van de ingevoerde waarden. Ze moeten exact hetzelfde zijn als in het project.
    Tip: Open het Issuefilter venster in BIMcollab Zoom naast de JSON editor om typefouten in het script te voorkomen.
Alle regels in dit deel van het script vertegenwoordigen één van de eigenschappen in de issuefilter:
  1. "filter_type"
    Vervang "Issue" door het type dat je wilt filteren. De standaardwaarde is "Alle" (of de overeenkomstige waarde in de taal van het project).
  2. "area"
    Vervang "Model" door de area die je wilt filteren. De standaardwaarde is "Alle" (of de overeenkomstige waarde in de taal van het project).
  3. "milestone"
    Vervang "Design phase" door de milestone die je wilt filteren. De standaardwaarde is "Alle" (of de overeenkomstige waarde in de taal van het project).
  4. "label"
    Vervang "Architecture" door het label dat je wilt filteren. De standaardwaarde is "Alle" (of de overeenkomstige waarde in de taal van het project).
  5. "priority"
    Vervang "Normal" door de prioriteit die je wilt filteren. De standaardwaarde is "Alle" (of de overeenkomstige waarde in de taal van het project).
  6. "show_active"
    Dit is een selectievakje dat bepaalt of de actieve issues van het project getoond moeten worden. Voer 'true' in als het selectievakje ingeschakeld moet worden of 'false' als het niet ingeschakeld moet worden. De standaardwaarde is 'true'.
  7. "show_resolved"
    Dit is een selectievakje dat bepaalt of de opgeloste issues van het project moeten worden getoond. Voer 'true' in als het selectievakje ingeschakeld moet worden of 'false' als het niet ingeschakeld moet worden. De standaardwaarde is 'true'.
  8. "show_closed"
    Dit is een selectievakje dat bepaalt of de gesloten issues van het project moeten worden getoond. Voer 'true' in als het selectievakje ingeschakeld moet worden of 'false' als het niet ingeschakeld moet worden. De standaardwaarde is 'false'.
  9. "hide_invisible"
    Dit is een selectievakje dat bepaalt of issues die niet zichtbaar zijn voor alle teamleden verborgen moeten worden. Voer 'true' in als het selectievakje ingeschakeld moet worden of 'false' als het niet ingeschakeld moet worden. De standaardwaarde is 'false'.
  10. "show_to_approve"
    Dit is een selectievakje dat bepaalt of de issues die je moet goedkeuren moeten worden weergegeven. Voer 'true' in als het selectievakje ingeschakeld moet worden of 'false' als het niet ingeschakeld moet worden. De standaardwaarde is 'false'.
  11. "assigned_to_user_email"
    Vervang "example@bimcollab.com" door het e-mailadres van de toegewezen gebruiker, niet alleen zijn naam. De standaardwaarde is "" (issues toegewezen aan alle gebruikers worden getoond).
  12. "deadline"
    Vervang "01-01-2021" door de deadline op basis waarvan je wilt filteren, in het formaat dd-mm-jjjj. De standaardwaarde is "" (er wordt geen rekening gehouden met een deadline).
  13. "created_by_user_email"
    Vervang "example@bimcollab.com" door het e-mailadres van de auteur, niet alleen zijn naam. De standaardwaarde is "" (issues gemaakt door alle gebruikers worden getoond).
  14. "custom1"
    Vervang "Value 1" door de waarde van het Custom List veld 1 dat je wilt filteren. De scriptregel moet altijd beginnen met "custom1", niet met de eigenlijke naam van het Custom veld. De standaardwaarde is "" (Alle waarden voor dit custom veld worden getoond).
  15. "custom2"
    Vervang "Value 2" door de waarde van het Custom List veld 2 dat je wilt filteren. De scriptregel moet altijd beginnen met "custom2", niet met de eigenlijke naam van het Custom veld. De standaardwaarde is "" (Alle waarden voor dit custom veld worden getoond).



Als één van de ingevoerde gegevens van de filter onjuist is, zal het script niet verder worden uitgevoerd.

Issues updaten

Alle Smart Issues die zichtbaar zijn in het tabblad Issues van BIMcollab Zoom kunnen automatisch geüpdatet worden, volgens de status van de clashes in de geladen modellen.
De prompt is UPDATE_ISSUES.

Script

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

Toelichting

Elke regel in dit deel van het script vertegenwoordigt een van de opties in het venster 'Smart Issues updaten'. Merk op dat ‘Enkel geselecteerde issues' niet aanwezig is, omdat er geen issues apart geselecteerd kunnen worden tijdens het uitvoeren van het script. De actie zal worden uitgevoerd op alle zichtbare issues in het issues tabblad.
  1. "close_where_clashes_solved"
    Dit is een selectievakje dat bepaalt of issues waarvan alle clashes zijn opgelost met de update kunnen worden gesloten. Voer 'true' in als het selectievakje moet worden ingeschakeld of 'false' als het moet worden uitgeschakeld
  2. "reopen_previously_closed_issues"
    Dit is een selectievakje dat bepaalt of gesloten issues die nog actieve clashes bevatten, heropend kunnen worden met de update. Vul 'true' in als de checkbox ingeschakeld moet worden of 'false' als hij uitgeschakeld moet worden
  3. "comment"
    Vervang "Updated with Nightshift" door een opmerking die je wilt toevoegen aan de bijgewerkte issues
Als een van de opties ontbreekt, zal een standaardwaarde worden toegepast, zoals te zien is in de onderstaande afbeelding.



Lists uitvoeren en delen

Alle Lists die zich in ‘Gedeeld' in het Lists tabblad bevinden kunnen tegelijkertijd worden uitgevoerd en gedeeld zodat de meest recente informatie beschikbaar is voor alle teamleden in BIMcollab Nexus.
De prompt voor deze actie is RUN_AND_SHARE_LISTS.

Script

{
"type": "RUN_AND_SHARE_LISTS",
"list_set-name" : "List set 3"
}

Toelichting

De parameter "list_set_name" is optioneel. Als je een bepaalde list set wilt uitvoeren, vervang dan "List set 3" door de naam van de list set die je wilt uitvoeren. Als de parameter niet aanwezig is, zullen alle lijsten in 'Gedeeld' uitgevoerd en gedeeld worden.

Project synchroniseren

Zodra Issues zijn bijgewerkt en Lists zijn uitgevoerd en gedeeld, is het belangrijk om het project altijd te synchroniseren met BIMcollab Nexus, zodat de wijzigingen worden opgeslagen en zichtbaar zijn voor de rest van het team.
Voeg deze prompt altijd toe aan het einde van het script.
De prompt is SYNCHRONIZE_PROJECT.

Script

{
"type": "SYNCHRONIZE_PROJECT"
}

Volg de status van de taak op

Zodra de taak is uitgevoerd, kan je in het Nightshift logbestand controleren of alle acties succesvol zijn uitgevoerd.
Alle logfiles zijn te vinden in C:\Gebruikers\\AppData\Roaming\KUBUS\BIMcollab Zoom\Nightshift.
Vervang door de naam van je eigen gebruikersprofiel in Windows.
De AppData map is standaard een verborgen map. Geef de verborgen mappen weer in de Bestandsverkenner om naar de juiste locatie te navigeren.


    • Related Articles

    • Configureer een taak voor Zoom Nightshift in de Windows Taakplanner

      ZOOM Nightshift vermindert de tijd die besteed wordt aan clashmanagement nog verder door repetitieve taken uit te voeren terwijl je weg bent van je computer. Het kan automatisch nieuwe modelversies controleren, Smart Issues en gedeelde Lists ...

    • Zoomen naar issues versnellen

      De Zoom-naar of Snelle zoom optie helpt bij het snel ophalen van zware viewpoints die een groot aantal componenten bevatten of bij het werken met zware projecten. Wanneer de snelle zoom is ingeschakeld, wordt alleen de camerapositie verplaatst naar ...

    • Een Zoom-licentie ophalen

      Als er een BIMcollab Zoom-licentie voor je beschikbaar is, kun je deze ophalen om het volledige potentieel van Zoom te benutten. Er zijn drie verschillende licentietypen (bedrijfslicenties op naam, floating bedrijfslicenties of een persoonlijke ...

    • Basics voor het maken van smart views

      Smart views filteren en kleuren objecten op basis van regels. Op basis van properties kan je componenten tonen, verbergen of kleuren in het 3D venster. Het kan bijvoorbeeld gebruikt worden om modellen te checken op basis van een ILS. De smart views ...

    • Een clashdetectie uitvoeren met BIMcollab Zoom

      BIMcollab Zoom-gebruikers die een Zoom-licentie hebben, dus niet in Zoom Viewer, kunnen clashdetectie uitvoeren binnen de geladen set modellen. Wil je je kennis over dit onderwerp vergroten? Ga naar onze BIMcollab Academy en schrijf je in voor de ...