Managing Shell files

Shell Overview

Existing Shell files will maintain an overview of the Shell, available by opening the source file for the Shell and logging into the Coherent Assistant Add-in. This page contains a summary of your Shell configuration, and management options of your Shell, including:

• Updating your Shell

• Deactivating your Shell

• Downloading a copy of the latest version of your Shell

• View API Call History for the service associated with your Shell

As a Shell Creator, to manage a Shell you need to be linked to the source Spark service. From the Coherent Assistant Overview screen, choose Services and select the source Spark service that was uploaded when creating the shell. The menu will be available with the different management options.

Shell Overview page

Version History

You can also navigate to the Version History of your Shell from this page, which provides details and download options for each version of your Shell.

Version History for Shell

Updating a Shell

If you wish to update your model or the configurations of your Shell file, you can Update your Shell to seamlessly deploy an updated version of your Shell to users. You can access the Update Shell flow via the Overview page in your source file. The Update Shell flow is similar to the initial Shell creation flow, but it will maintain your existing configurations by default - you can edit configurations as needed. Note that updating your Shell file will upload a new version of your Shell service to Spark.

Updating a Shell file will create and open a new Shell file on the desktop in the same process as initial Shell creation - refer to Create Shell for more information.

Shell users will be notified via Coherent Assistant when you update the Shell, and will be provided a download link for the new Shell. If your Shell contains a submit button, the Submit button on old Shell versions will be disabled, and will only work in the most recent Shell version.

Shell update screen

Deactivating a Shell

Creators can deactivate a Shell if they no longer want any users to have access to use features of the Shell. You can deactivate via the dropdown menu shown above in the Overview page of your Shell source file. Deactivating a Shell will deactivate all versions of the Shell for all users.

Deactivation flow via Overview

You can deactivate a Shell immediately, or schedule deactivation for later. If you choose to deactivate later, you can select a specific date and time for deactivation.

Setting a specific deactivation date/time

Users can set a custom deactivation message to display to Shell operators once the Shell is deactivated, or use the default message:

Set a custom deactivation message

If you choose to deactivate your Shell at a later date/time, you can cancel this pending deactivation via the Overview page in your Source file.

Shell with pending deactivation

Deactivated Shell source files will show an inactive status in the Add-in.

Reactivating a Shell

Deactivated Shells can be reactivated via the Shell Overview in the Shell source file. Reactivation is effective immediately for Shell files.

Reactivate a Shell file