Multi Tenant Settings

Problem

Currently many settings specific to a merchant such as their Stripe, Mailchimp, and shipstation keys are stored as environment variables to processes running in marathon. As we go multi-tenant this is clearly not acceptable.

Outline

This document provides use cases for implementing mult-tenant settings. Each use case is briefly written describing the Actor, pre-conditions, post- conditions, the main path and alternate paths.

This document does not describe how the system should look but describes what it should be capable of doing.

Use Cases

Onboarding

New Tenants will go through an onboarding flow allowing then to configure the baseline system and 3rd party integrations

Setting Modification

Tenants should be able to go back through all integrations in ashes and modify existing settings. We also need general Fox commerce related settings available.

User Settings

Table 1: Use Case "Selecting 3rd Party Integrations"

Action	Selecting 3rd Party Integrations
Actor	Tenant Admin
Precondition	Tenant has create an organization and has a master tenant admin account. Tenant Admin is logged in.
Postcondition	System will know which 3RD party integrations they want configured
Main Path	Admin selects from a list of available 3rd party integrations
Alternate Path	No integrations are selected. User goes strait to Admin interface

Table 2: Use Case "Configuring Settings for an Integration"

Action	Configuring Settings for an Integration
Actor	Tenant Admin
Precondition	Admin has selected the integrations they want to configure.
Postcondition	The current integration in process is configured
Main Path	The available settings for the particular integration are displayed. The appropriate GUI widget is shown for the setting type. The user fills out all required fields. The user presses the “Test” button. Only with a good test can they continue to next integration.
Alternate Path	User selects “Skip”. Integration is marked as in- active but available to edit in the future

Table 3: Use Case "Editing Existing Settings"

Action	Selecting 3rd Party Integrations
Actor	Tenant Admin
Precondition	Admin has selected the integrations they want to configure
Postcondition	Settings are modified and available immediately
Main Path	Admin can go to settings tab and see settings arranged in some grouping. The groups they see are only those they are allowed to edit. They click on a group and can see each individual settings. Individual settings are displayed same way as during onboarding. If the settings are an integration, they press the “Test” button. Only if “Test”” succeeds can they save the changes. If the settings are an integration, they can disable it. If the setting group is not an integration, then saving button is enabled.
Alternate Path	They don’t want to change any settings, they can leave the screen

Table 4: Use Case "Adding an Integration"

Action	Selecting 3rd Party Integrations
Actor	Tenant Admin
Precondition	Tenant is logged into Ashes and has permissions to add integrations
Postcondition	Integration is added if successfully goes through flow
Main Path	Admin can go to settings tab and see settings arranged in some grouping. They click on button to add an integration. They are presented with a list of integrations not already added. They can then go through the “Configuring Settings For an Integration” use case.
Alternate Path	They don’t want to add an integration, they can leave the screen

Table 5: Use Case "Adding a Settings Group"

Action	Adding a Settings Group
Actor	Tenant Admin
Precondition	Tenant has login credentials and has permissions to add a settings group
Postcondition	Settings group is added and is available for other admins to edit.
Main Path	Admin can add a settings group at the tenant level using an API They can define setting keys and their types. Types influence how the settings are represented in the UI. They can do CRUD
Alternate Path	The setting group already exists, they can instead use CRUD API to modify.

Table 6: Use Case "User Edits Their Settings"

Action	User Edits Their Settings
Actor	Admin
Precondition	Admin is logged in and has permission to see their own settings
Postcondition	Settings are modified
Main Path	Admin can go to settings tab and see settings arranged in some grouping. The first settings groups are settings specific to them. They can modify any settings in their own groups. In addition to their settings, if they have permission they can modify tenant and integration settings.
Alternate Path	They don't want to change any settings, they can leave the screen