Configuring Credentials for External Data Connectors in Spotfire Automation Services

Configuring Credentials for External Data Connectors in Spotfire Automation Services

book

Article ID: KB0137789

calendar_today

Updated On:

Products Versions
Spotfire Automation Services 14.0.0

Description

When running Spotfire Automation Services jobs that interact with external data sources, the data connectors require specific credentials to establish a successful connection. These credentials need to be configured in a way that the Automation Services instance can securely access and utilize them during job execution. Incorrect configuration can lead to authentication failures.

To ensure successful execution, you must implement one of the following three methods. Please note the order of precedence: If multiple methods are configured, the system will prioritize them from highest to lowest as listed below (Method 1 overrides all others).

 

  1. METHOD 1 - Add a "Set Credentials for External Connection" Step in the Automation Services Job:

    • This method defines the credentials directly within the specific Automation Services job definition itself (configured via the Spotfire client or job builder).

    • Precedence: Highest - This method takes the highest precedence and will override any credentials configured using Method 2 or Method 3.

    • Note: The dialog interface for the "Set Credentials for External Connection" step typically does not allow any new lines within the credentials input field. Ensure multi-line credentials (like service account keys) are provided as a single, continuous string if pasted directly.

  2. METHOD 2 - Add a Credentials Profile in a Separate File within a Specified Folder:

    • This method allows for more flexible management by placing credentials in a separate file (populated with XML profile) on the machine where the Automation Services instance is running.

    • You can specify this folder's path in the Automation Services configuration file, or place the credentials file directly into the default credentials folder. The file name is the profile name, and the file should have no file extension.

    • Precedence: Medium - This method takes precedence over credentials configured directly within the Automation Services configuration file (Method 3).

    • Note: If this method is used, ensure there is no 'Set Credentials for External Connection' task in the job, as it will override these settings

  3. METHOD 3 - Add a Credentials Profile to the Automation Services Configuration File:

    • This method involves embedding the credentials directly into the main configuration file for your Automation Services instance (e.g., Spotfire.Dxp.Worker.Host.exe.config).

    • Precedence: Lowest

    • Note: Similar to method 2, if this method is used, ensure there is no 'Set Credentials for External Connection' task in the job, as it will override these settings.

 

Always select the method that best aligns with your organization's security policies and administrative practices. Careful attention to these precedence rules will ensure the correct credentials are applied during job execution, preventing authentication failures.

Environment

All

Issue/Introduction

This article outlines the three primary methods for configuring credentials to be used by external data connectors within Spotfire Automation Services jobs. It details their implementation, nuances, and the order of precedence when multiple methods are employed.

Additional Information

Doc: Set Credentials for External Connection

Doc: Credential Profile in separate file (search DataAdapterCredentialsFilesDirectory)

Doc: Credential profile for connector

 

NOTE: Please check the documentation corresponding to your specific version.