For the complete documentation index, see llms.txt. This page is also available as Markdown.

Services

After an Excel file has been uploaded to Spark and the logic is converted to code, it is referred to as a service. The Folder overview screen is used to manage the services within the selected folder.

Multiple versions of a service can be added to an existing service, called service versions.

From the Home page, selecting a folder opens the Folder overview page. The initial tab is for Services to manage your Excel-to-code Spark services.

Change how services are displayed

  • Search: Enter a search term and the list will update.

  • Favorite services: Favorite services are displayed first.

  • File types: Filter for a particular file type.

  • Sort: Change the sort order by selecting A-Z or the List view headers.

  • List view / Card view: The default Card view shows services and documents as tiles. List view is more compact and displays one item per line.

Add a new service

See Tutorial: Get started in 5 minutes for an overview of this process.

  1. There are two ways to add a new service.

    1. Select New service at the top right.

      1. If you want to choose a different version of the Neuron compiler for compatibility or testing reasons, you can select the Neuron version.

      2. Select Browse or drag the workbook into the upload area. Spark supports .xlsx and .xlsm files.

    2. Drag and drop an Excel file into a blank area of the screen.

  2. The upload will commence and the New service modal appears.

  3. You can change the Service name. The initial name is taken from the uploaded filename.

  4. After the metadata from the file is read, the version details will be populated with workbook statistics.

    • The person-months estimate is based on the Constructive Cost Model (COCOMO), similar to the "NASA STRS COCOMO Calculation". One person-month would represent one month's effort by one person to complete the development of a task.

  5. The remaining fields can be edited at your discretion:

    1. Spark's version numbering system supports Semantic Versioning MAJOR.MINOR.PATCH. Select between Major, Minor, or Patch increment for the initial version number. A Custom semantic version can also be entered.

    2. Add a Version label to better differentiate between versions in the user interface.

    3. Apply tags to the Spark service. The tenant-admin can make this a required action.

    4. Set Effective dates by clicking the expand and setting the Effective from and Effective until. These dates can be used by Spark to Manage service versions and effective dates functionality and to dynamically select the latest version given a particular transaction date.

    5. In the Notes tab, add a Release note and Description.

  6. When the model is successfully converted, the progress bar will show Successfully converted 100%.

  7. Any warnings or errors raised by the compiler will appear in the Upload log tab.

  8. Select Publish.

Update service

Each service can have multiple service versions without changing the integration API endpoint URL.

  1. There are a few ways to update a service.

    1. Select the ellipsis menu and select Update service.

      1. If you want to choose a different version of the Neuron compiler for compatibility or testing reasons, you can select the Neuron version.

      2. Select Browse or drag the workbook into the upload area. Spark supports .xlsx and .xlsm files.

    2. Drag and drop an Excel file on top of an existing service.

    3. Use the Add a new service journey with an Excel file that has the same name as an existing service. You will be prompted to either Create new service or Add version.

  2. If you were not the last person to update a service, Spark will ask Would you like to continue to add a version to this service? Select Add version to continue.

  3. The remaining steps follow Add a new service.

Service actions

Additional actions can be performed on a service from the ellipsis menu.

Activate service, Deactivate service, Archive service

This feature is only enabled on certain environments and tenants. Contact support for more information about this feature.

Change the Active services status.

Favorite service, Unfavorite service

A service set as a Favorite will be shown at the top of the list of services.

Analyze service with AI

This feature is only enabled on certain environments and tenants. Contact Support for more information about this feature.

Use AI to interact with your Excel workbook. See Analyze service with AI for more details.

Download service

Download a copy of the underlying Excel file.

  1. Select the service version to download. By default, the latest version will be selected.

  2. Select the file type:

    • Original workbook: Workbook that was uploaded to Spark. No changes were made to the uploaded file.

    • Coherent Assistant workbook (.xlsx): Workbook that was uploaded with additional metadata which will automatically load the Coherent Assistant when opened.

    • WebAssembly Module (.zip): Compiled workbook component that can be used in offline applications.

  3. Under Save as... the filename can be edited.

  4. Select Download.

Delete service

Before a service is deleted, Spark will request confirmation for the delete action. After confirmation, everything related to the service will be inaccessible. There is no process to recover services.

View in Files

This feature is only enabled on certain environments and tenants. Contact support for more information about this feature.

Open Files to where the service entities are stored.

Recompile service

Add a new version of the service and compile with a different version of Neuron. Take advantage of changes in the newer versions of the compiler or use older versions for compatibility and testing purposes. Reference the Neuron release history.

This follows a similar journey to Update service except:

  • The source Excel file is taken from the latest service version.

  • A Neuron version selection is required.

Last updated