Configuring the Client Job Sender

The configuration file Spotfire.Dxp.Automation.ClientJobSender.exe.config is a standard XML configuration file. It is used to configure authentication to the Spotfire Server, and the logging and handling of communication with Spotfire Server.

• Open the configuration file in an XML editor or a text editor, and edit the following settings as necessary:

  Setting	Description
  Spotfire.Server.RequestTimeoutSeconds	Specify the maximum number of seconds for a single request to the Spotfire Server. The default value is 600.
  Spotfire.MaxJobExecutionTimeSeconds	Specify the maximum number of seconds that a job can run before the application cancels the job. If set to 0 or less, the application will not cancel the job. The default value is -1. Note: If the async flag is used on the command line when running a job, this setting is ignored. Note: The specified value in the Spotfire Server setting max-job-execution-time will also affect the cancellation of the job. The lowest specified time will decide when the job is cancelled. For details on this setting, see the Spotfire Server and Environment Installation and Administration help.
  Spotfire.Logging.Level	Specify the logging level for the client job execution. The log file Spotfire.Dxp.Automation.ClientJobSender.exe.log is located in the same directory as the Client Job Sender files. The default value is INFO.
  Spotfire.AllowedCertificateValidationErrors	If SSL is enabled on the Spotfire Server, certificate errors can be suppressed by this client by changing this setting. Set to None to allow no certificate errors. To allow specific errors, set the value to any or all of these values, separated by commas: RemoteCertificateChainErrors, RemoteCertificateNameMismatch, RemoteCertificateNotAvailable.
  Spotfire.AllowedTlsVersions	Specify the TLS protocol version to use when communicating with the TSS server. If multiple values are used, they should be separated by comma. Possible values are: Ssl3, Tls, Tls11, Tls12.​ If the setting is left empty it will use the default system (machine) settings.
  Spotfire.Authentication.Basic.UserName	Specify the username for logging in to Spotfire Server, when Spotfire Server is set up with username and password authentication. This can also be used when the server is configured with NTLM or Kerberos if another user than the one executing the process is to be used when accessing Spotfire Server. (The domain must be included in username.) Note: This user must be a member of the group Automation Services Users.
  Spotfire.Authentication.Basic.Password	The password for the specified username.
  Spotfire.Authentication.ClientCertificate.Enabled	Set to True if Spotfire Server requires a client certificate.
  Spotfire.ClientCertificate.StoreLocation	The store location for the installed X.509 client certificate used to authenticate with Spotfire Server. Can be CurrentUser or LocalMachine.
  Spotfire.ClientCertificate.StoreName	The store name for the installed X.509 client certificate used to authenticate with Spotfire Server. Can be AddressBook, AuthRoot, CertificateAuthority, My, Root, TrustedPeople, or TrustedPublisher.
  Spotfire.ClientCertificate.SerialNumber	The serial number for the installed X.509 client certificate used to authenticate with Spotfire Server.
  Spotfire.Authentication.OAuth2.ClientId	The client ID for OAuth2 authentication. Set this to the clientId that is returned when you run the register-job-sender-client command-line interface (CLI) command. For instructions on running the command, see Configuring the Client Job Sender for OAuth2 authentication.
  Spotfire.Authentication.OAuth2.ClientSecret	The client secret for OAuth2 authentication. Set this to the clientSecret that is returned when you run the register-job-sender-client CLI command. For instructions on running the command, see Configuring the Client Job Sender for OAuth2 authentication.

  Note: If no username and password or client certificate is specified and Spotfire Server uses Windows authentication (NTLM or Kerberos), then the Client Job Sender will use the identity of the Windows user that executes the job to authenticate with Spotfire Server.

  Note: It is possible to encrypt the password or the client secret that is specified in the configuration file. To encrypt the password or client secret (whichever setting has a value in the configuration file), enter the following on the command line:

  Spotfire.Dxp.Automation.ClientJobSender.exe -encryptPassword [encryptWithUserScope]

  Add the encryptWithUserScope parameter to encrypt using the current Windows user account; otherwise, the computer account is used. For more information, see https://msdn.microsoft.com/en-us/library/system.security.cryptography.dataprotectionscope.aspx. After encryption, the password and clientSecret fields in the configuration file are empty and new fields (Spotfire.Authentication.Basic.Password.EncryptedUserscope or Spotfire.Authentication.Basic.Password.EncryptedMachineScope, and Spotfire.Authentication.OAuth2.ClientSecret.EncryptedUserscope or Spotfire.Authentication.OAuth2.ClientSecret.EncryptedMachineScope) containing the encrypted password or client secret are added.