Data Exchange & Integrations
- 1 Introduction
- 1.1 Rest Services API
- 1.1.1 API Documentation
- 1.2 Authentication
- 1.1 Rest Services API
Introduction
HDC can be easily integrated with other systems thanks to full coverage of standard REST Web Services.
External Information Domains (EID) are one of the key components that create a foundation for flexible data exchange.
Information regarding object metadata, documents and even information about relation between objects can be exchanged, translated and matched automatically.
Rest Services API
The same Web Services (WS) as used by native HDC web client can be used by 3rd party applications to access and modify objects, perform import and export of data or any other operation.
Flexible API decouples client applications from server, allowing for multiple platforms to use the same backend server (Web client, tablet client, rich desktop client, integration server). All web services are secured and can only be accessed by an authorized user or service.
Data Exchange can be automated or performed manually and is supported by REST API and aided by Tessel Data eXchange Manager (TDXM) modules. Accepted formats can be extended as needed by system configuration. Base formats include JSON and XML/IFC. Schemas for validating and providing proper output are used. FI2 Standard based formats are supported and can be reconfigured to support future versions.
High level API (HOPA) can be used for easy integration with third party websites, returning easy to use views for selected object or predefined printouts.
API Documentation
Full REST API documentation with authentication methods, status codes, accepted methods and data formats is available and delivered with each server instance.
Currently, most of HDC services are based on JSON format. Selected parts of the API responsible for external integrations can be also provided with XML format or even their SOAP or other standard alternatives.
Authentication
HDC users can be authenticated against internal user database. LDAP support is built in as well; in that case, users are authenticated against external Directory Service.
Other methods of authentication are on our roadmap, including oAuth support and other single sign on (SSO) solutions depending on customer needs
Child Pages
Export
Internal Information Domains
Contains internal HDC list of Object Classes and their fields that can be used in TDXM External Domain mappings.
External Information Domains
External Information Domains are used to define Object classes, Object Mapping, Layer Mapping and Object Identity rules used by specific external system.
- Object Classes tab
- Object Mapping tab
- Layer Mapping tab
- Object Identity (TOBIS) tab
- Live Data Source — EID with Live Data Source enabled means that HDC is configured to receive and send data directly to selected external system.
- Fi2 Mappings
HDC Remote Agent
HDC Remote agent is a small application that can be used by system integrators to easily import data packages to HDC without exploring details of our API. It can be also seen as a guide on how to use those services. It supports upload of large files in chunks with resume capability.
Embedded Viewer API
- Custom Menu Items
- Events subscriptions
- Temporal Symbols (Icons)
- External Authentication Configuration for Embedded Applications
LDAP
Explore Documents and Spots with API (use case)
Integration with 3rd party websites
Plugins
HDC Internal Export Format
Asset+ Sync
MasterGUID / FMGUID
Import
Import panel allows controlling of import packages.
- HyperDoc Classic data import — Guide showing steps needed to perform export data from HDoc Classic and import into new HyperDoc system.
- MS Excel data import
- DokumentNavet data import
- IFC data import — Guide showing steps needed to perform import of IFC model into HDC.
- FI2 data import
- ObjectData