Skip to main content

Connector Credentials Reference

Each connector installation requires a set of credential files that define how it authenticates with the platform and any external data sources.

Each connector installation requires a set of credential files that define how it authenticates with the platform and any external data sources. These files are uploaded via the Manage Credentials screen in the connector interface. Administrative permissions are required to upload or delete credential files. Changes take effect immediately after upload, except where noted.



S3 credentials (s3-instanceid.properties)

Required for all connector types. Defines the storage location used when the connector uploads files for processing. Each platform instance is associated with a specific storage bucket, so the S3 credentials file is unique per instance.

S3 credentials are treated as secure service credentials and subject to lifecycle management policies. If a credentials file is not used for 45 days, it will be deactivated under inactive credential policies, and a new credentials file must be requested from support.

To request a new S3 credentials file, contact Energysys support. Once received, upload it via the Manage Credentials screen.



Connector configuration (connector-config.properties)

Required for all connector types. Controls general operational behaviour of the connector service.

Property

Description

Default

data_file_dir

Directory where files generated by the connector are stored

<install-dir>/ConnectorData/

data_file_retention_period

How long generated files are retained before automatic removal

28 days

connector_timezone

Timezone used for connector jobs if different from the system timezone

System timezone

job_max_retries

Maximum retry attempts if a job fails

5

job_repeat_interval

Time between retry attempts

120 seconds

http_proxy_host

Hostname or IP of an HTTP/HTTPS proxy for network connections

None

https_proxy_port

Port used by the HTTP/HTTPS proxy

None

https_read_timeout

How long the connector waits for a response during HTTP/HTTPS reads

30,000 ms

http_connection_timeout

How long the connector waits when establishing an HTTP/HTTPS connection

30,000 ms

http_connection_trusting

Whether the connector automatically trusts HTTP connections

true

If connector_timezone is changed, the connector Windows service must be restarted for the new setting to take effect.



Platform OData credentials (platform-odata-credentials.properties)

Required for historian and Database (Measurement) connectors. Defines how the connector connects to the platform OData interface to retrieve tag lists and configuration.

Property

Description

Default

service_url

OData service URL for the platform instance

tag_list_object_name

Object used to retrieve tag lists (historian connectors)

PR_METER_LIST_MEMBER

asset_timezone_override

Timezone used by the platform when retrieving data

UTC

max_records_per_page

Maximum records retrieved per OData request

5,000

tag_list_timeout

Seconds to wait for an updated tag list before using cached version

30

tag_cache_check_timeout

How frequently cached tag lists are cleared

30 minutes

tag_list_replace_pipe_with_slash

Whether to replace pipe characters with slashes in tag identifiers

false

remote_query_execution_enabled

Whether the connector checks for remotely triggered jobs

false

remote_query_execution_object_name

Object used to store remote execution requests

EU_REMOTE_QUERY_EXEC

remote_query_execution_connector_name

Identifier used when checking for remote execution requests

connector

remote_query_execution_check_interval_mins

How frequently the connector checks for remote requests

1 minute

The service_url value is derived from the platform's OData endpoint and adapted for certificate-based access. Contact support for the correct value for your instance.



Historian and database-specific credential files

Each connector type that connects to an external data source requires its own credentials file. These are documented in the relevant connector articles: Historian Connector (PI, IP21, PHD) and Database (Measurement) Connector (JDBC).

Did this answer your question?