Organizer
Connect Organizer Service
Overview
The Organizer Service enables the creation of hierarchical collections to group items with similar characteristics. For instance, in construction, BIM model objects could be organized by location to create a location breakdown structure. The API is flexible, allowing users to define the types of items and how they are grouped.
The service stores named hierarchies of nodes, with each node representing a group of items. Importantly, the items themselves are not stored in the Organizer Service. Instead, each item is represented by a link that points to an external resource, linking the external items to the hierarchy of nodes. The service also supports detailed access control policies, allowing users to define permission levels (e.g., read, write, or no access) for different users at the tree level.
The Organizer Service is a data-level service with REST API capabilities, complemented by SDKs for Javascript and .NET.
Use Cases
The generic nature of the Organizer Service means that it can be used as part of the Trimble Connect platform ecosystem or as a standalone service in a solution-specific context. Note that using the Organizer Service in the Trimble Connect ecosystem context requires using special API and access control policy conventions.
A typical use case within the Trimble Connect ecosystem is grouping construction objects in BIM models into breakdown structures. Examples include:
- Location breakdown structures
- Object property-based breakdown structures (for example, type, material)
- Work packages
Use cases for solution-specific context may include:
- Storing any user-defined hierarchies
- Data discovery: serving as a discovery index for collections of data
Concepts
An organizer Forests are collections of trees, where each tree is made up of nodes. Each node can have sub-nodes, forming a hierarchical tree structure. Nodes store links, which point to external resources.
- Forest - A container for a collection of trees (namespace type)
- Tree - A collection of nodes
- Node - A list that has a name and a collection of links
- Link - Pointer to the external resource, formatted using the FRN notation
- Group - Another name for a node, specifically used in the Trimble Connect for Browser application’s Organizer panel to denote groups of 3D BIM model objects
Getting Started
You need to complete the steps in the Getting Started guide to be able to call the API.
The authorization to individual Organizer Service resources is defined by Access Control Policies, see the API specification.
API & SDK
For detailed information, see the API specification.
The SDK is available for the following platforms:
- Trimble Connect .NET SDK (NuGet) - An API client for local data management and synchronization with Connect Core, Organizer, and Property Set APIs.
- Trimble Connect .NET Organizer SDK (NuGet)
- Trimble Connect typescript SDK (npm) - An API client for the Connect Core, Organizer, and Property Set APIs.