Core TSIs : Agile Workplace Management : Agile Workplace Management - Field Descriptions : Connector - fields
Connector - fields
* 
The following Connector fields are available in the Planon application.
•    Note that not all fields are available for all connector types.
•    Fields with an asterisk (*) are Planon managed connectors only. Most fields are only editable if the connector is Inactive.
Field
Description
Code
Enter a unique code for the connector.
Name
Enter a description for the connector.
Comment
Enter notes (optional). The notes that you enter will be visible to the Planon administrator only.
Data engine
Select the data engine to which you want to link the connector.
URL*
Enter the URL of the web service published by the sensor system.
Login ID*
Enter the login ID of the web service (connector) to connect to the data engine.
Password*
Enter the password for the login ID.
API version*
Indicate the API version to be used for communication between the Data Engine and the sensor system. The following options are available:
• Version 3-4
This version is based on the REST protocol and can handle full data return and changed data returns. It includes Synchronization and Polling with multiple systems. API version 4 is the default version used.
LoRa AppEUI*
A hexadecimal identifier for the LoRa gateway.
* 
Only applicable when using a LoRa connection.
The value in this field must comply with hexadecimal format and length.
System status
Indicates the connector status:
Active – the connector is operational.
Inactive – the connector is not operational.
Immeasurable – the status of the connector cannot be resolved. The cause of the error (going from Active to Immeasurable) is printed in the event log.
The system status is provided by the system and not manually.
Synchronize*
Indicate whether the selected connector should be included in the synchronization process.
When set to Yes, a sync will happen during the next polling cycle.
* 
After a successful run, the application switches off the Activate monitoring mode? and Synchronize fields automatically. However, if encountering issues, the application will continue to try and do this for some time, clogging the process. To overcome this situation, you can inactivate the connector. By inactivating the connector, the Activate monitoring mode? and Synchronize fields will be switched off and the process is reset. After activating the connector again, you can manually enable these fields.
Latest synchronization*
Displays the date and time that the connector last synchronized with the sensor system.
Person
Indicate the field of BO Person to be used as lookup field by the sensor system. This field will be used to display the person occupying the location.
* 
•    Measuring person data is not mandatory and can violate privacy laws.
•    The sensor system determines whether measuring persons is actually possible. (See also Time occupancy calculation).
Activate monitoring mode?
When set to Yes, a record will be added to the event log at the next polling. You can activate monitoring mode by clicking Monitor communication on the action panel.
* 
After a successful run, the application switches off the Activate monitoring mode? and Synchronize fields automatically. However, if encountering issues, the application will continue to try and do this for some time, clogging the process. To overcome this situation, you can inactivate the connector. By inactivating the connector, the Activate monitoring mode? and Synchronize fields will be switched off and the process is reset. After activating the connector again, you can manually enable these fields.
Polling count (time-out)
When a Polling count (time-out) is set, a time-out check is executed at the end of each polling cycle performed by the data engine.
This setting determines whether a connector or measurement point needs to be set to Immeasurable.
Specify the number of polling cycles for the connector to time-out (minimum value is 5).
If this field is available and a value is filled in, the AWM connector will be set to Immeasurable if AWM does not receive a response within x polls of the AWMDataEngine.
See also:
Poll every x cycles
To balance the load of the polling cycle, you can use this field to fine-tune the polling cycles.
When specified, the connector will only poll every <value specified here> cycles.
Example
If the Polling interval on the data engine is set to 60 seconds and the Poll every x cycles is 5, then the polling will be done every 300 seconds.
Polling offset
To balance the load of the polling cycle, you can use this field to fine-tune the polling cycles.
When specified, the connector will not be polled immediately in the first polling cycle, but it will wait for the polling cycle that matches the offset.
Example
If the Polling offset is 2, polling will only happen every second cycle.
Last polling response
Date time stamp of last response received by the connector or its measurement points (server time zone).
Email address for notification
When set to Yes, an email will be sent to the members of the Email address(es) (AlertEmailList) if the measurement point/connector is set to Immeasurable.
Email address(es)
Enter the email address of the person(s) who should receive an email alert when the connector is set to Immeasurable.
To enter multiple email addresses, use a comma (,) or semi-colon (;) as separator.
Classname
Select one of the available classes, installed by apps, that performs the communication (polling) for the custom managed connector.
App name
The value in this read-only field is filled in automatically based on the selected class.
App module name
The value in this read-only field is filled in automatically based on the selected class.
Partner identifier
The value in this read-only field is filled in automatically based on the selected class.
Onboarding class
Specify the app's class for onboarding (optional).
Settings
Settings example
Settings schema
Custom managed connectors can feature settings that are app specific.
Typically, app settings are specified in the AppCenter, but for custom managed connectors, there can be a split in module settings and component settings.
The component settings are then moved to the Connector (Settings, Settings example, Settings schema tabs), these are connector-specific.
The module settings remain in the app (AppCenter) - these are settings that are valid for the entire app.
For more information about the required values of these settings, see the specific app documentation.