This article is intended to help you understand how our CivilPro team set up the field mapping in Teambinder. Administrators/ Users do not have to carry out these tasks.
Related Link:
There are a few considerations involved in configuring CivilPro so that it integrates with Teambinder. It requires us to map fields between databases that collect data in different ways. In addition to this, the data shapes used by Teambinder can change between projects based on how it is set up.
To enable CivilPro and Teambinder to communicate effectively, we need to set up how the following data in CivilPro is mapped to Teambinder.
- Teambinder Configuration Tables vs. CivilPro Work Types, Area Codes, Control Lines and Custom Registers
- Lots
- Documents
The configuration of Teambinder is performed in the Teambinder Settings. Configuring the mapping of your Teambinder integration is part of our configuration service when you license the Teambinder integration. It is generally something that users will not be undertaking themselves unless they have a thorough understanding of the integration.
1) Teambinder Settings
The Teambinder settings is accessed under Project Operations. (Note: End users will not see this).
2) Connection
These are the login details for a user authorised to access Teambinder and the Teambinder API. This information will be supplied by the person that administers the Teambinder instance you are connecting to. To use the integration, the supplied user will need access to at least one Lot Type, and authorization for the Lots and Docs modules.
The Teambinder URL is where CivilPro makes queries to get and set data for your project.
The Teambinder Alt URL is the URL of your normal Teambinder logon.
3) Configuration Tables
Teambinder uses a set of customizable fields that can be assigned to lots and documents to aid in classification. These are called Configuration Tables. It also has a concept called Lot Types which provides a register separate to the config tables that has no equivalent in CivilPro.
Similarly, CivilPro has specific registers for things like Control Lines, Work Types and Area Codes that have no equivalent in Teambinder, although there can be analogues through the Configuration Tables.
In order to be able to send data to Teambinder, CivilPro data needs to map its data. Any data that isn’t normally recorded in CivilPro can be added using Custom Registers. This screen manages how CivilPro lots collect the required information for Teambinder through one of:
- Worktype register
- Areacode register
- Controlline register
- Custom Register
Configuring the mapping of your Teambinder integration is part of our configuration service when you license the Teambinder integration.
To start mapping the config tables, you can use the Get TB Configs button. This will retrieve a list of all of the Teambinder config tables. You can then specify which config tables map to which CivilPro data source.
The Align with FieldMaps button can be used if you have set your fieldmaps for Lots and Docs. Essentially, it ensures that every field that relies on a custom register value is available in the custom registers. When run it unselects every custom register and CR Lot Required check except for those appearing in one of the fieldmaps (See the following sections on Lots and Docs config). The CR Lot Required column is checked if the matching entry in the fieldmap is has a scope of Post_Reqd.
4) Lots and Documents Field Mapping
CivilPro and Teambinder collect different information regarding lots and documents as they are fundamentally different applications with different audiences and use cases. The Lot and Document field mapping provides details about how CivilPro fields are translated when creating and updating records in Teambinder. This is through a combination of CivilPro's existing Lot record data and custom registers created above. Configuring the mapping of your Teambinder integration is part of our configuration service when you license the Teambinder integration.