How to create projects and XR procedures¶
Using the XR Platform¶
Note
Make sure Guide square is selected. You can change squares by clicking on the corresponding icon.
Note
Make sure you have the Designer role. You can change roles by clicking on them and switch to another one in the list.
This is the hierarchy of projects, procedures and steps:
Project
-
Procedure A
-
Step 1
-
Step 2
-
Step 3
-
-
Procedure B
- Step 1
All the procedures you create are managed in projects. A project can hold multiple procedures.
Create a project on the XR Platform¶
-
Go to the XR Platform.
-
Open projects and press 'Create'.
-
When pressing create, you need to fill in the empty fields
-
Choose a clear title.
-
Give a description of the project.
-
Add Members to the project. They will have access to all procedures within. Don't forget to give them the right role:
-
Designer
-
Validator
-
Planner
-
-
You can add a VR environment. This environment will be used when using procedures in VR.
-
Press 'Create' in the upper right corner to create the project.
Create a Procedure on the XR Platform¶
- Go to the XR Platform.
- Go to projects and choose a project where you want to add a procedure.
- Press create and choose a title and description for the procedure.
- Start creating steps. Choose a title of the new step and a description. This could be an instruction.
- After creating the step, it will appear in the list of the procedure. Click on the step again to make changes or add media.
Manage existing projects on the XR Platform¶
-
To manage an existing project, select a project in the list.
-
Here you can access settings, linked procedures and persons.
Using the Passerelle MR editor¶
Note
Make sure you have the Designer role.
Log in the Passerelle editor on Hololens¶
Open Passerelle editor¶
Open the windows icon on your left wrist and go to the apps. There you select the Passerelle editor app
Activate your license¶
You only need to do this step once at the beginning. When the Passerelle editor has the license information, you only need to log in with your account.
For this we need the License QR-code. You can find the license on the XR Platform under subscriptions. Press download to download the License QR code.
- Press 'Scan QR code' in the login menu to scan the license.
-
If scanning the license QR code does not work, check that you have not opened the app multiple times.
-
Keep your head close enough to the QR code. The hololens must be able to scan the code.
-
A green frame with a QR code will appear: everything has been scanned correctly.
-
Press 'activate license' on the login menu.
If you have problems with scanning, print the QR code first.
Verify your company ID and environment¶
-
Your environment and company ID must be set up once before use. If this is correct, you can log in immediately in the future.
- Example: S2 (company ID) – prod (environment).
-
To check this, press 'License' in the log in menu.
-
Check if the companyID is right. The environment should be 'prod'.
-
If this is not set up correctly, scan the license file as instructed in the Activate your license step.
Change your language¶
You can change the language by pressing the flag icon in the log in menu.
Log in Passerelle MR editor¶
To log in to the Passerelle Editor you need your account QR code. You can find this on the XR Platform.
- Select your profile and press QR Authentication.
- Your temporary account QR code will appear.
- Go to the Passerelle editor on hololens and press 'Scan code' (1).
-
Aim your hololens camera at your account QR code. Make sure there is a small distance of 5-10cm between you and the QR code. If that doesn't work, you can print the QR code to scan.
-
The code will be filled in automatically (2).
-
Lastly, press Log in (3).
Create a project with the Passerelle MR editor¶
Hierarchy of projects, procedures and steps:
Project
-
Procedure A
-
Step 1
-
Step 2
-
Step 3
-
-
Procedure B
- Step 1
Choose a clear and unique name for your project. It is important to be able to distinguish between projects.
Create a procedure¶
You can have multiple procedures within a project. Give this procedure a specific name.
Create steps¶
-
Press 'Create step'
-
Give the new step a name and description.
- For this you can tap the microphone icon to start dictating. You can give short descriptions and edit it on the XR Platform later.
-
Add pictures and video's to the step.
- Press the camera icon to make a picture or video. Wait until the countdown is finished and you hear a camera sound.
-
Add markings to the step.
-
When using markers, you first need to create a (spatial) anchor. The anchor is necessary to position your markers in the physical space correctly. You can place markers within a radius of 3m of the anchor.
-
Create anchors with an Anchor QR code or using the 3 point alignment.
-
You can have multiple anchors or alignments in your procedure.
Download Anchor QR codes for your procedure here:
They are reusable in different procedures.
If you need multiple anchors in 1 procedure, use a different Anchor QR code listed above.
-
- Add annotations to your step. Annotations are notifications or labels you can add for extra information
-
When saving the step, you'll see all your steps in order.
-
Don't forget to save your progress regularly by using the 'Save' button in the navigation bar.
Don't forget to Publish, Save, Refresh and Preview your procedure regularly!¶
-
When refreshing, all the changes between the platform and MR editor are synchronized.
-
'Saving' your procedure automatically synchronizes between the MR editor and the XR Platform on your account. These changes are only visible to you.
-
You need to 'Publish' to share and schedule your project changes with the XR Platform and other members. After publishing, your changes will be visible to everyone
-
If you want to see and test your procedure personally you can use the 'Preview' feature.
-
When you 'Publish' your procedure it is sent to a validator who will approve or reject your changes. When approved, your procedure can be scheduled as a job.
Preview on the XR Platform¶
-
If you press 'Preview' you'll receive a pin code:
-
Use the pin code in the Guide player app on your pc, hololens or other android devices.
-
Press the pin code to preview the procedure in browser.
-
Publish on the XR Platform¶
- When publishing, give a brief description of the changes you made.
-
A validator will receive your request and has to approve it.
-
After this, designers or planners can schedule the procedure for other users.
Preview in the MR editor¶
- Go to projects and select 'Preview'. You'll receive a pincode usable in the Passerelle Player.
Refresh in the MR editor¶
- Use the refresh button in the steps overview.
Save and Publish in the Passerelle MR editor¶
- In the steps overview you can save the procedure by pressing 'Save' in the bar below.
- If you want to publish your procedure, go to projects and press 'Publish'.
-
Wait a few seconds until your project is published. Depending on how much data you added, it could take a little longer.
-
When the process is done you'll see "Publish succeeded".
-
Don't forget to close the application when finished.