Tenant configuration

The Tenant configuration page can be found in the Options menu.

General configurations

Include cover sheet in upload service for new service uploads

When enabled, new uploads will include a cover sheet when using the API Call History feature for Download as Excel (Legacy). If the Download as Excel (Legacy) is being used, it is recommended to keep this enabled to maintain the existing functionality. Disabling this option will lead to faster upload times.

Enable notifications for API key expiration

The API key creator and any users entered below will receive an email 30, 14, and 1 day in advance of the API key expiry. Each username should be separated by a comma, for example: [e-mail],[e-mail].

Choose the Neuron compiler version for newly uploaded services

The Spark team updates Neuron periodically for new Excel function support, performance enhancements, and bug fixes.

• Stable Latest: Spark will use the latest stable release of Neuron available.

• Release Candidate: Spark will always use a release candidate if available. A release candidate is a version of Spark that may contain enhancements and fixes that were not included in the latest stable version. If there are no release candidate versions available, Spark will use Stable Latest. When a service is compiled using a Release Candidate, subsequent updates will also be performed using Release Candidate.

• In addition to these options, a specific version of Neuron can be used for all newly uploaded services for compatibility reasons.

Choose the Neuron compiler version for additional service versions

When publishing a new version of a service, this setting determines which Neuron version is used in the compilation.

Note: Any services compiled using a release candidate will update with the latest release candidate by default. This can be changed by using the Recompile Neuron feature for a service.

• Tenant Default: Spark will use the version of Neuron defined above for newly uploaded services.

• Maintain Version: Spark will try to use the same version of Neuron as the previous version of the service. If Spark cannot determine what version of Neuron was used on the previous version of the service, then Spark will use the Stable Latest version of Neuron.

• Stable Latest: Spark will use the latest stable release of Neuron available for the update.

• Release Candidate: Spark will use the release candidate version (see definition above) if available.

Manage access to Deployment requests

Enter the user groups that are able to submit Deployment request. Each user group should be separated by a comma, for example: user:alpha,user:beta.

Set the Coherent Assistant hybrid runner URL

When this is defined, Coherent Assistant will direct API calls and execution to your hybrid runner URL instead of the Spark systems.

Set the Explainer Domain URL

Replace this URL with your own if you need to host the Explainer UI in your own domain.

Features permissions

Manage the security of your tenant and set permission rights for accessing Spark features externally via APIs.

Assign user groups to the following objects to control who can externally access Spark features with their Authorization - API keys. Supervisor user groups can't be granted permissions to proxy objects.

See Permissions - Features permissions.

IP allowlisting

Restrict access to the Spark UI and its service APIs to specific IP addresses. In case you need to heighten your network security, this will significantly reduce the possibility of unauthorized access. The IP addresses can be written either in IPv4 for individual addresses or in CIDR notation for specifying blocks of IP addresses. Accounts, credentials, or keys that include tenant-admin are excluded from the IP allowlisting.

1. Select Enable IP allowlisting.

2. Select New IP.

3. Enter the Rule name.

4. Enter the IP address in IPv4, IPv6, or in CIDR notation standard for specifying blocks of IP addresses under IP address.

5. Enter a Description if you have one.

6. Select Save.

Public APIs

Enable public API visibility settings

Spark service APIs are set to private visibility by default. When this option is selected, the public API settings will be enabled for your Spark services. Services can then be set to public visibility and called without authentication.

Set default visibility of Spark service APIs

This applies only to newly created services.

Enable public APIs for Spark Shell functionality

This enables full functionality of Spark Shells that do not require sign in. When enabled, endpoints will allow fetching detailed information about the Spark service and posting records to the API Call History.

Enable public APIs for access to WebAssembly Modules

When enabled, any Spark services set to public will also make their compiled code (WebAssembly Modules) available from the WebAssembly module APIs without authentication.

Public API synthetic key

The Authorization - API keys inserted in this field will be used to correspond to all public API requests.

Tags

Tags categorize the service versions uploaded to Spark. Tags are set at upload or edited from the Service Documentation Version details.

1. Select Enable tags.

2. Optionally, choose to Require tags for new services.

3. Select New tag.

4. Enter the Tag name.

5. Enter a Description if you have one.

6. If you would like the tag to be used to segment usage analytics in the Dashboard, select Analytics. Select a ranking that determines the order of the analytics tags. Up to three tags can be marked for analytics.

7. Select Save.

Webhooks

Spark can send a webhook event when particular actions occur in Spark. More information can be found in How to: Automate workflows with webhooks.

1. Select Enable webhooks.

2. Select New webhook.

3. Enter the Name.

4. Enter the Endpoint URL.

5. Select which Event types will trigger webhook messages.

6. Add Request headers and Query string parameters that may be needed for the webhook call to be consumed.

7. Enter a Description if you have one.

8. Select Add to add this webhook to the list.

9. Select Save to save the new webhook.