Table of Contents
Appendix A - Supported 3D model file extensions
Appendix B - Configuring BIM360\ACC Integration with O3
Appendix C - Configuring SharePoint Integration with O3
Objective
This article will outline major functionalities of the 3D model parser used by O3 solutions. Moreover, it aims to enable admins to better understand the process of reading 3D model files in O3 and how the 3D model parser works and analyzes the 3D model.
Supported 3D model file extensions
We support all formats that Navisworks supports, as well as PCF and IDF. Please check Appendix A for detailed file extensions supported
Configuring BIM360\ACC Integration with O3
Please check Appendix B for details.
Configuring SharePoint Integration with O3
Please check Appendix C for details.
Data Repository Integration
Overview
O3 Solutions allows users to integrate data repositories to store and access data. Currently, O3 supports integration with Autodesk ACC and SharePoint.
Creating a New Integration
To create a new integration:
Navigate to Project Setup > Project Settings > Integrations.
Click the + sign to add a new integration.
Selecting an Integration Type
Choose the integration type: BIM360 or SharePoint.
Integration with Autodesk ACC
To integrate with Autodesk BIM360 or ACC, select BIM 360 as the integration type and provide a description.
Connection
Please provide the following credentials to establish a connection with the BIM 360 / ACC repository. Refer to Appendix B for instructions on configuring BIM360 / ACC to integrate with O3 Solutions.
BIM 360 Account ID
Log in as an Account Administrator in BIM 360, navigate to Settings, and select View Account ID.
BIM 360 Project ID
The Project ID can be found in the BIM 360 URL. It is the string following /projects/.
Autodesk Integration Client ID
O3 will provide a Client ID after completing the integration setup. Refer to Appendix B for detailed instructions on enabling integration with O3.
Autodesk Integration Client Secret
O3 will provide a Client Secret key after completing the integration setup. Refer to Appendix B for details on enabling integration with O3.
EMEA Server
Enable or disable the EMEA server, which is located in the EMEA region (Europe, the Middle East, and Africa).
Report Top Folder ID
To store generated reports in BIM360, specify the Folder ID where the reports will be saved.
Populate Drawing Revision Date from BIM360
When integrating drawings from BIM360, this option allows the drawing revision date in BIM360 to be used in O3.
Sync
Scheduled Sync API User
Specify a user responsible for scheduled API synchronization.
Post Sync Actions
Define tasks to be executed after synchronization, prioritized based on the actions order.
Scheduled Sync
Define a BIM360 sync schedule. Synchronization can be scheduled to occur daily, weekly, monthly, etc.
Drawings
Drawing Folders
Use the ADD ITEM button to browse and select BIM360 folders where drawings are stored. Specify the drawing type to categorize them.
Drawing Filename Patterns
If the drawing filename differs from the actual drawing name, O3 allows you to configure which part of the filename represents the drawing number and revision. This feature automatically links the physical drawing file stored in BIM360 with the drawing in O3. Example Filename Pattern:
Documents
Similar to Drawings, O3 allows you to map the document folder and specify the document filename pattern.
Schedule
Use the ADD ITEMS button to browse and select BIM360 folders where schedules are stored. Select a schedule from the list to import schedule data into a specific schedule in O3.
3D Models
Use the ADD ITEMS button to browse and select BIM360 folders where models are stored. Choose a Parser Configuration from the list to process the 3D model when importing it to the project. Parser configurations contain rules for creating Construction Components.
Non-Graphical Imports
Use the ADD ITEMS button to browse and select BIM360 folders where non-graphical data is stored. Select an import type from the list to import the data to the specified destination. Optionally, select a Data Deliverable to pre-process the data before importing.
Pipe Data Folders (PCF/IDF)
Use the ADD ITEMS button to browse and select BIM360 folders where PCF/IDF models are stored. Select a Translation Type if translation should be applied to the PCF/IDF geometry when processing the PCF/IDF data.
Import History
The Import History grid lists all data imported from BIM360.
Change History
The Change History grid lists all changes made to the integration configuration.
Integration with SharePoint
To integrate with SharePoint, select SharePoint as the integration type and provide a description.
Connect
Provide the necessary credentials to establish a connection with the SharePoint repository. Refer to Appendix C for instructions on configuring SharePoint and obtaining the necessary credentials to integrate with O3 Solutions.
Sync – Change History
These settings are identical to the BIM360 settings. Please refer to the corresponding BIM360 settings for more information.
Importing 3D models
We can import 3D models into O3 using below methods:
Direct import using O3 UI
BIM360 connection
SharePoint connection
A.1 Import Models using O3 UI
Go to the Models tab.
Press on the “+” Add icon.
Browse and select your model file.
** If you have a parser file, select it. If not, leave it blank and the model will be imported without parsing action.
Wait for the model to be imported. You can monitor the progress of the import in import screen below
** If you haven’t specified a parser, you will get a warning saying that parser is invalid. This is just a warning, and your model will be imported with raw data.
Once the model is imported, double click on it to open.
View and inspect your 3D Model. Note the warning in the upper right corner indicating a missing parser configuration.
Make sure to deselect “Hide out of scope objects” to see all components of the 3D model. Since we don’t have any parser configuration in place, all objects are now out of scope. They do not appear in any tree. The only tree and data visible now are the raw data coming in the 3D model file.
You can download model metadata using the 3 dots ellipsis menu. Downloading metadata into JSON format will allow the 3D model administrator to inspect and analyze the data in order to start building the parser.
A.2 Import Models using BIM360
Work with BIM360 Administrator to establish a connection with O3. There are 4 parameters needed to establish the connection.
BIM360 Account ID
BIM 360 Project ID
AUTODESK Integration Client ID
AUTODESK Integration Client Secret
** An API User should be created under O3’s System Admin menu. Share the API Key with BIM360 Admin. The O3 API User should be given proper permissions on the BIM360 side.
Once the 4 parameters are available, please append them to O3 and test connection.
Go to Project Setup menu \ Project Settings.
Go to Integrations. You can either double click on the existing integration or create a new integration by clicking on the ‘+.’
Add language around adding client secret etc..
Test out the connection. Double click the integration that you would like to test.
Under 3D Model Folder, Add Item and select the folder containing the models with BIM360
You can leave the parser configuration option blank, if no parser is configured yet.
Run a “Manual Sync” to bring in and read the model files from BIM360.
Wait for the import to complete.
Once completed, you will see the model file available with O3.
Importing / Exporting parser files
If the user already has a parser file, it can be imported into O3.
Go to Project Settings / Models / Model Parsing.
Press on ellipsis menu and select “Import Configurations.”
Browse for your .JSON Parser file and press “Upload.”
Parser file is now imported. Double click on it to see its details.
Parser files can be exported into .JSON format. Exporting is used to either inspect the parser and/or to be imported into another project.
To export parser files, use the ellipsis and select “Export Configurations”.
Parser file - models
The Models section indicates which Models will be processed or are applicable to this specific parser. In O3, you can have many parser files. Some files will be responsible for processing Engineering 3D models coming from S3D, others will be for .IFC models coming from Tekla.
To assign an applicable model file, go to “Models” and press the “+” Add sign.
A drop-down list will appear. Select applicable 3D Models and press “Choose Items”.
Press “Save Changes”. This will let O3 know that each time you import those specific models, to use the specific parser.
Parser file – History
Will show Audit and Change History on the parser.
Parser file – Object Filter
Object Filter is used for Model Conditioning. You can use it to filter out certain object types that you do not wish to process. Object types such piping insulations, bolts / nuts, Cranes and human bodies are sometimes filtered out. Filtering is beneficial with large models because it will enhance the speed of model rendering. Moreover, construction personnel would benefit from hiding unnecessary components, thus giving them better visibility when it comes to packaging / inspecting work areas.
Parser file – Linking
Linking is used if you want to link your 3D model construction components with other sources other than the parent 3D Model. An example of this would be linking with PCFs for piping spools or isometric construction components.
Parser file – Rules
‘Rules’ is the main page where the O3 3D Model Admin will configure the parsing rules. This step includes:
Identifying major Construction Components (CC)
Identifying Construction Subcomponents (CSC)
Identifying and parsing major properties and attributes
Identifying and parsing Bill of materials for each CC
Parser file – Rules – foundation Pile example
In this example, we are going to build our parsing rules for Foundation Piles Construction component.
To add a CC press on the “+” add button.
The name will be “Pile CC”.
Component type is a drop-down list, listing major construction components / disciplines. In this case we will pick “Concrete”
‘Is Subcomponent’ will be blank, since this is not a subcomponent. A subcomponent for example is the nozzle on a major vessel, or pipe fittings of an isometric piping line.
The Selection Filter section is where we filter on Foundation piles. We will need to investigate and analyze the 3D Model Metadata in order to segregate and identify a rule to only bring Foundation Piles.
By looking at the raw data in the 3D Model, we can easily identify piles from “Item.Name” property.
The Item property = the word “PILE”.
Let’s add a selection filter rule by pressing on the “+” icon and writing the rule.
Our rule in this case will be “Item.Name = Pile”
** Always save changes within the rules page and on the parser side **
Next, we will need to define the Lookup unique key for our Piles. This could be the Sp3D Moniker value or the “Element.IfcGUID” property. We will select the Element.IfcGUID property. Lookup key can also be a combination of both values (if the name is not unique in the 3D raw data). The important point here is that we need to define a unique identifier for our CC.
Next is Field Mappings. Field mappings is a library of standard fields that we can map and read from the 3D Model. Examples are Object type, CWA , CWP , EWP , System , Units , Area , Weight , length , etc.. We will try to map as much data as possible from the 3D model into our CC fields.
To add a field mapping, click on ADD ITEM.
The left side represents built-in fields in O3, and the right side represents fields from data.
Let's map object type filed and give it a static value of “Pile.”
Select field “Object Type.”
Click on the “+” icon on the right.
Select Rule “Append Static Value” and write “Pile” and press OK.
There is a built-in library for all the rules and how they work. If you are unsure which rule to pick, please read the help article indicated here:
Next let's add “Tag Number.” Tag number will read the dynamic value SmartPlant Element.Tag.
Next, we will add remaining fields such as Surface Area, Volume, CWA, CWP, EWP, System path, etc.
Conditional field mapping will not be used in this example. We can use conditional field mapping if we want to map our fields based on specific conditions. We will cover this section in the next example (not in piles).
The Materials section will be used to define material take off rules for pile.
Press on “Add Material” tab. Name will be “Piles Material”
Within Field mapping add catalog code and description same as SmartPlant 3D.Name.
Quantity will be static as 1.
UOM will be static as “EA.”
Source will be static as “3D Model” ( Note that you will need a data source named exactly as this value).
Weight will be SmartPlant 3D.Dry Weight. We will introduce a Regex to take only the numbers of the weight field without the UOM.
The same logic will be applied to surface area and volume.
** Do not forget to save **
Now let's apply our parser configuration to the 3D model.
Go to Project settings / Integrations.
Make sure your 3D model is linked to the parser.
Run a Model sync.
Import your model with a force refresh to add the new Pile CC.
Wait for the import to finish.
Now let’s go to Model tab in O3 to inspect and view our parsing results. You will notice that the CC Piles is now listed under “Concrete” object type tree:
Select one Pile and notice the components details
Also note that the Construction components table was updated based on latest 3D model import with Pile parser i.e. pile CC are now part of that table.
Parser file – Bill of materials – foundation Pile example
Go to Bill of Materials
From the ellipsis select “Refresh BOM with Components Data.”
This will generate the Bill of Materials section.
Wait for the import to finish, then check your BOM table. You can filter by one CC in the grid.
One Pile BOM example:
Parser file – Rules – Concrete Footing example
Let's build parsing rules for a concrete footing example.
By looking at the data, we can see that we can use Systempath property to identify all footings.
Lookup Key will be “SmartPlant 3D.Name”
Field mappings:
Materials: Notice that we have taken the quantity here based on footing’s volume. We are using a regex to transform "0.19 ft^3" to 0.19. UOM property is a static value as “CU Ft”.
Let’s rerun our parser by doing a manual sync and then refresh the BOM Table to see the end result for the concrete footings.
Footings in Construction Components table:
Footings in 3D model:
BOM:
Parser file – Rules – Piping isometrics from 3D model
In this step we will define the Construction Component and subcomponents for piping isometrics.
Add Isometric CC.
Selection Filter:
The Lookup Key will be the unique identifier for isometric numbers which is found in the “AVEVA.PDMS LINE NO” property.
Field mappings:
We need to map as much data as possible.
Conditional field mappings:
Populating static values based on the AVEVA.UNIT
The materials section will be left blank. We will determine material takeoffs from Subcomponents.
Add Isometric Subcomponents (CSC).
The Selection Filter will be the same as Isometric CC.
The Parent Component Lookup Key will be “Parent:2.AVEVA.PDMS LINE NO” Property.
Lookup key will be "AVEVA.NAME”. We can use other values such as a combination of Isometric name and item name, but it is important to look at the data and understand what could be a unique identifier for our Piping components.
Field mappings:
Map as much as possible. Some values such as weight and service will be copied to the parent CC.
Let’s see the results in CC table. We’ve got 115 Isometrics:
Same Isometric line in 3D Model:
PCF/IDF PARSING – Project settings
Notes:
PCFs will be loaded based on availability and will be loaded together with the Native engineering 3D Models (they do not need to be loaded separately). No need to have all PCF files ready for all the scope isometrics.
PCFs have to be put in a folder in BIM360 / SharePoint.
Pipe fittings and support geometry are from the original 3D Model. The geometry of pipes is created by O3 in anticipation of field welds and pipe breaks. This depends on the configuration and varies from one project to another. In some cases, we don’t create geometry and only read the geometry from the 3D model.
Nuts, bolts and gaskets geometry can be created with O3 (separately or as a flange union).
Place the PCF files in a folder on BIM360
Map the above location in your integration settings:
Notice that we can pick a translation configuration. Translation is applicable if the coordinates of Piping components inside the PCF file don’t match with the native 3D Model.
To define a translation, go to “PIPE DATA SETTINGS” / Geometry Translations:
Add translation parameters:
X, Y, Z offset, rotation and scale can be acquired from the client, or by doing a manual 3 points analysis between the PCF and the native 3D model.
Translation appears on the project settings
If PCFs are part of the Document Management System (DMS) and they are imported as attachments to Drawings in O3, we can read the PCFs directly from drawing attachments from below options. In that case, it is not necessary to create a separate folder on BIM360.
PCF/IDF PARSING – Pipe data settings
M.1 General Settings
Drawing type here is the category used to categorize drawings created during parsing PCF files. This is a picklist from your project settings for drawing types.
Ignore bolts without coordinates. Sometimes bolts come without coordinates, or the coordinates are wrong. This can be turned on or off based on the needs of the project.
Allow unspooled files: Yes/No. Usually we ‘Allow’ to get the material takeoffs. Materials will be categorized as field material or shop materials with the labels below.
Add spools to IWPs that contain parent isometric: If IWP scoping began on isometric CC before receiving spooled isometrics, we can turn this option on, and when we start receiving spooled PCF files, the spools will automatically be added to the same IWP.
M.2 Geometry creation
Geometry samples created from PCFs:
Geometry padding is used for pipes created by O3 to differentiate between pipes rendered by original 3D model and pipes rendered from O3. In many cases, O3 creates geometry for pipes to allow for field breaks coming from spooled PCFs. Padding in the below sample setting is set to 0.01 mm.
Pipes from the original 3D model vs pipes created from PCF geometry (with padding settings applied).
Additional padding and cylinders length settings:
We are taking diameters of gaskets for example and adding a bit more for geometry clarity.
Also notice that you can put specific colors for pipe cylinders or welds.
If you need to group Gaskets, Bolts and Nuts under one component, then we need to activate the below settings.
Diameter Mapping: Usually, we use the default diameters. We can change the actual diameters if needed. This is only for geometry purposes. You can add all sizes that you need in the project. If the large bore looks fine in the 3D model but the small bore doesn’t look right, then we can review this table to double check the settings.
Geometry translation is where we define the translation for X, Y, Z, rotation and scale if needed. We map this to our import settings as shown in section L.
The Refresh Geometry button will create O3’s Geometry from the settings created.
M.3 Imports
By looking at the data in PCF files, we identified that the attribute “WELD-ATTRIBUTE3” is used as a flag for shop/field welds.
Attribute mappings are used to change labels shown under components for attribute names. For example, if you want to change the label for ATTRIBUTE32 to be Insulation thickness or ATTRIBUTE34 to show as Stress Relieve.
You will need to open a PCF and an Isometric drawing at the same time and analyze the attributes to identify their true labels. Example below:
M.4 Default Shop Spool Name Pattern
Used to identify which attribute from the PCF stores spool numbers. By looking at the data, we identified the attribute “SPOOL-IDENTIFIER” as the one.
You can add more attributes to the above table and concatenate them together to create a unique spool number if needed for your project.
Conditional Shop Spool Name Patterns are used in special cases where you need to filter for a specific criteria, and then replace (for example “SPOOL1” with “SP1”) or if you want to concatenate Spool number with Isometric number to create “uniqueness.”
In our example here, we are making sure that the spool identifier is not blank and that it contains a value.
M.5 Field Items
Group Settings
Separate or group field items:
For example, if you have 3 valves in one isometric, do you want to group them all under one field item called V01, or do you want to split them into V01, V02, V03?
Field Items Name Pattern: define the attributes needed to form your field item name.
Conditional field names: we can use these options to give valves, for example, a different tag (V1, 2, 3,..) or pipe supports (PS1, 2,3 ,..).
M.6 Pipeline ref mapping
Define Isometric number: Reading PCF attribute “Pipeline Reference”
Drawing Number Mapping: Reading Isometric Drawings & PID drawings from PCFs.
PCF Source mapping can be used to differentiate spooling companies or the source of the spooled PCF files.
M.7 Component Mapping Rules
Mapping to create the Construction Components.
M.8 Testing the Parser
Testing the parser is used when we need to test the results of our parsing configuration for PCF files.
Load a sample PCF and check the results.
Results export in CSV format. Admins should always check the results and make changes as needed.
M.9 IDF mapping
If the project is using IDFs instead of PCFs, then follow the mapping below to ensure the mapping is correct:
IDF attributes mapping: IDF codes.
PCF/IDF PARSING – BOM
Under BOM Mapping.
This is for PCF BOM mapping.
Spool component mapping example:
Notice the source is listed as “PCF.”
PCF/IDF PARSING – Results
Construction Components: Field Fittings and spools
Spool example:
3D Model results:
TEKLA .IFC Steel structure parsing
Place Steel model on BIM360 and map it in Model settings.
Add your Steel model parser:
Steel parser is linked and applicable to .IFC Tekla model files:
Configure your Construction Components and Subcomponents rules:
The same logic applies here. We need to define lookup keys for major steel components such as Steel Frame, Assemblies, Stairs (primary, secondary, tertiary steel).
Appendix A
Format | Extension | File Format Version |
Navisworks | .nwd .nwf .nwc | All versions |
AutoCAD | .dwg, .dxf | Up to AutoCAD 2017 |
MicroStation (SE, J, V8 & XM) | .dgn .prp .prw | v7, v8 |
3D Studio | .3ds .prj | Up to Autodesk 3ds Max 2017 |
ACIS SAT | .sat .sab | All ASM SAT. Up to ACIS SAT v7 |
Catia | .model .session .exp .dlv3 .CATPart .CATProduct .cgr | V4, v5 |
CIS/2 | .stp | STRUCTURAL_FRAME_SCHEMA |
DWF/DWFx | .dwf .dwfx | All previous versions |
FBX | .fbx | FBX SDK 2017.0 |
IFC | .ifc | IFC2X_PLATFORM, IFC2X_FINAL, IFC2X2_FINAL, IFC2X3, IFC4 |
IGES | .igs .iges | All versions |
Inventor | .ipt .iam .ipj | Up to Inventor 2017 |
Informatix MicroGDS | .man .cv7 | v10 |
JT Open | .jt | Up to 10.0 |
NX | .prt | Up to 9.0 |
PDS Design Review | .dri | Legacy file format. Support up to 2007. |
Parasolids | .x_b | Up to schema 26 |
Pro/ENGINEER | .prt .asm .g .neu | Wildfire 5.0, Creo Parametric 1.0-3.0 |
RVM | .rvm | Up to 12.0 SP5 |
Revit | .rvt | Up to 2017 |
SketchUp | .skp | v5 up to 2016 |
Solidworks | .prt .sldprt .asm .sldasm | 2001 Plus-2015 |
STEP | .stp .step | AP214, AP203E3, AP242 |
STL | .stl | Binary only |
VRML | .wrl .wrz | VRML1, VRML2 |
All versions | ||
Rhino | .3dm | Up to 5.0 |
Appendix B: Configuring BIM360/ACC Integration with O3
Navigate to BIM 360 Admin
Click on Settings
Click on Custom Integrations
Click Add Custom Integration
Ensure Document Management is checked
Select “Invite a developer” and enter support@o3.solutions for the address. Click Send.
While waiting for O3 to complete setup the integration will show as pending
Once O3 support has completed the configuration, click the Approve button
Once approved, the app goes live
More information regarding third party integrations on BIM 360 can be found here.
Appendix C: Configuring SharePoint Integration with O3
Click on App registrations
Click + New registration
Enter a name for the app (i.e. O3 SharePoint Integration).
On the API permissions tab, click to Add Permissions to the application.
Select the Microsoft Graph API
Select Application Permissions
Add the following permissions: Sites.Selected
Click to Grant admin consent:
From the Overview tab, click generate client credentials: (Add a certificate or secret).
Click + New client Secret.
Enter a description and set the expiration policy.
Click Add.
Copy the Secret Value (NOT THE SECRET ID).
This will be entered into the Application Secret field in O3.
Store the value in a safe location. Client secret values cannot be viewed, except for immediately after creation. Be sure to save the secret when created before leaving the page.
From the Overview tab, copy the Application(client) ID and Directory (tenant) ID.
On the connection tab of the SharePoint integration in O3, input the following values:
Save Changes.
At this point, you will need to execute the following scripts using Powershell to grant access to the site to the application:
$targetSiteUri = 'https://{{YourDomain}}.sharepoint.com/sites/{{SiteName}}'
Connect-PnpOnline $targetSiteUri -Interactive
Grant-PnPAzureADAppSitePermission -AppId {{ApplicationID}}' -DisplayName 'O3 Sharepoint Integration' -Permissions Read, Write -Site $targetSiteUri
Note: this requires the Pnp.Powershell module, and Powershell V7
For more information, follow the link: https://pnp.github.io/powershell/articles/installation.html
Next, click the Choose Site button and enter the URL for the Site.
IMPORTANT, enter the site name in the following format:
'{{yourdomain}}.sharepoint.com:/sites/{{sitename}}'
(do not include http:// or https:// and be sure to include the colon)
After selecting a site, Save Changes again and configure the mapped folders from the Document Library on the SharePoint Site.
For more information regarding App registration, refer to the following documentation from Microsoft
