Service Configuration

Credentials

Use the Credentials tab to view or change the authentication credentials for the query service.

The service credentials for the query service need to be presented on each request to the service. Visit Sample Project for examples on setting up data sources with service credentials for executing queries against a database. Visit Connecting to Data for more on data sources in general.

The Service Id is the API equivalent to a user name in an application. It is the unique identifier for the service used for settings in the query service and to reference the service in API requests to the service.

The Secret Key is the API equivalent to an application password. In combination with the Service Id, it is used to authenticate each service request.

Data File

The query service configuration file is stored in the installation root in a JSON file called wire-qs-service.json. An example of the contents of the file is below.

{
  "Service": {
    "Id": "qs_ebi-appdev2",
    "Key": "WireBootstrap$"
  },
  "Providers": [
    {
      "Id": "MSSQL",
      "Name": "Microsoft SQL Server",
      "Type": "MSSQL",
      "DataSourceType": 1,
      "ConnectionString": "Data Source=%server%%port%;Initial Catalog=%database%;Integrated Security=%integratedsecurity%;User Id=%user%;Password=%password%;Connect Timeout=6"
    }
  ]
}

The Service property contains the Service Id and the Secret Key values for the service.

The Providers array contains one object which contains the Microsoft SQL Server provider connection details. With the exception of the ConnectionString property, these values should not be changed.

The ConnectionString property is a template for the connection string used to connect to SQL Server databases by the query service. The variables, denoted as keywords surrounded by percent signs (%), will be changed at run-time per the settings in a given data service connection presented in query requests from clients. This template can be changed (with caution) to meet specific connection string requirements for a target database service.

Last updated