Brief Summary
Documentation Form - Used for individual observations. You register a brief note of what was found, which category it belongs to, and how severe it is.
Your job is to:
1. Fill out the fields clearly and update the status when changes occur.
2. Use the model, attachments, and comments to document findings thoroughly and traceably.
This article describes how you work with the documentation process:
1. Using the documentation form
1.1 Finding and opening the documentation form
1.2 Understanding the fields in the documentation form
1.3 Editing an existing documentation entry
1.4 Link documentation to model or map, attachments, and comments
2. Typical ways to use the documentation form
1. Using the documentation form
The documentation form is used when you want to register individual observations – which do not necessarily belong to a specific checklist or require extensive processing.
1.1 Finding and opening the documentation form
- Go to the menu on the left.
- Under Registration Types, click on a Documentation Process.
- You will now see a list of entries.
- Click on a row to open a side menu summarizing an entry.
- Press open entry to get a detailed view of the entry.
- If you have the rights to create a new documentation registration, a button for this will appear just above the list view.
When you have opened a documentation, you see:
- Properties in the main area.
-
Location view on the right, with tabs for:
- Location – Model or map placement of the entry.
- Attachments – Files and images.
- Comments – Dialogue related to the entry.
1.2 Understanding the fields in the documentation form
A typical documentation form may include a description, category, or other information. This is the information filled out in the field and should give you the full context of what you are observing. Which information should be collected is customer-specific, so the options will vary.
We recommend the following setup for the best possible sharing of information:
-
Description
A brief description of the observation. This is usually a required field and should be included. -
Category
Category for the observation, selected from a dropdown list (for example, discipline, type of defect, etc.).
A good way to group, sort, or filter afterward. -
Risk/Priority
Indicates how critical or time-sensitive the observation is. A good way to plan your work.
The system also automatically fills in:
- Created / Created by – When and by whom the entry was created.
- Modified / Modified by – Last modification time and author.
These system fields are used for tracking and cannot be edited.
1.3 Editing an existing documentation entry
- Open the entry as described in 1.1 Finding and opening the documentation form.
- Click Edit at the top of the Properties panel.
- Update the fields you need.
- Save the changes.
If some fields are mandatory, the system will prompt you to fill them out before you can save.
1.4 Linking documentation to model or map, attachments, and comments
-
Location
When you are in the entry, you can link a location in the 3D model or on the map- In both cases, you can click "Show Location" to open the location view.
- Navigate to the correct area in the model and select an object or navigate on the map before clicking a point.
- Confirm the location by clicking "Select Location." A screenshot is taken and displayed in the entry.
- To change the location, you can again click "Show Location," select a new object, and confirm the change by following the same workflow.
-
Attachments
- Go to the Attachments tab.
- Upload images, reports, or other documentation supporting the entry.
- You can also view existing documentation, download it, or set it as the main document.
-
Comments
- Use the Comments tab to ask questions, provide status updates, or log dialogue related to the entry.
1.5 Connected entries
You can connect a registration to other entries with no restrictions on type or origin. A registration can be connected to issues, tasks, inspections, or other documentation – both within Interaxo Capture and across to Interaxo Project.
Creating a connection:
- Click Add connection.
- Search for the desired registration.
- Click + Add to create the connection.
Once registrations are connected, you can easily navigate back and forth between them.
Removing a connection:
- Click x next to the connection.
- Confirm the removal.
This article only gives an overview. For a full walkthrough, see How to use connecting entries.
2 Typical ways to use documentation
- Record status / diary from the construction site.
- Log events (HSE, quality).
- Document completed work, with attachments and position in model or on map.
Comments
0 comments
Please sign in to leave a comment.