Suitcase

Suitcase lets you compile and transfer objects from one Slate database to another. You can create your own Suitcases out of groups of Slate objects, like queries, messages templates, reports, portals, and more, or import Suitcases from other databases, including our Showcase databases.

You can use Suitcase to share a number of Slate objects between databases, including:

• Application configurations

• Application logic

• Bots

• Components

• Datasets

• Deliver mailings

• Files

• Forms, including form communications, form logic, and form rules

• Message mailings

• Message templates

• Portals

• Queries

• Reports

• Rules

• Slate Scholar Classroom courses

• Source formats

• Trips

Importing a Suitcase

To import a Suitcase object:

1. Copy a Suitcase ID. See our Suitcase ID Index for a list of IDs you can import.

2. Go to Database → Suitcase Import.
   

3. Paste the ID.

4. Select Import.

If the database where the Suitcase object is imported does not have a folder of the same name in the relevant tool, Slate creates a folder with that name. You can move the objects to a different folder after import.

Your Suitcases

The Suitcases page in Database → Suitcase lists all imported objects. Each entry shows:

• Created: When the item was added as a Suitcase object

• User: The Slate user who added the object

Select any item to view or update its details.

📝 Note

A Suitcase Import captures the object in its current state. If the original object changes, the imported copy is not updated until you select Update Content.

Creating a Suitcase from an existing Slate object

👤 Required Role: Administrator (All Access)

To create a new Suitcase:

1. Go to Database → Suitcase.

2. Select New Suitcase.

3. Enter a name. The author is set automatically to the current user logged into Slate.

4. Select Save.

Adding Items to a Suitcase

Select Add Item. A pop-up appears with two tabs, Choose Item to Add and Review Dependencies to Include.

Within the Choose Item to Add tab, the Select Item Type menu lets you select from a list. Selecting an item type generates a list of available options. Select your item directly from the list, or use the search bar to filter your results.

Import templates first, then their individual items

The order in which items are added to your Suitcase matters. If adding an Event and a Template to your Suitcase; make sure to add the Template before you add the associated event.

Can’t import objects where the base doesn’t exist

Query and report bases must exist in the database into which you want to import a Suitcase. Form-Specific Form Response bases are also database-specific. We recommend using the “All forms and events” setting for Form Response bases instead.

Reviewing dependencies

Selecting an item moves you automatically to the Review Dependencies to Include tab, which breaks the item you selected into its constituent parts (in this example, a form, and a follow-up communication).

Expanding the form in this example, we see the form fields and the form message that follows submission. Deselect any items you wish to exclude from the Suitcase.

Select Add Item at the bottom to add the item to Suitcase; it appears as a new item in the Items tab. Select the arrow next to its name to view the nested types contained in.

Fields and prompts

The Fields and Prompts tabs include any field IDs and prompt names contained in the added items.

Selecting the different column headings in the Fields tab toggles the sort between ascending and descending alphabetical order.

In the Prompts tab, selecting the arrow next to each prompt key displays its associated values. Select the prompt's name to open the Edit Prompt Value window, which lets you deselect any prompt items to exclude from your Suitcase.

Editing Suitcase properties

Select the Edit button at the upper right, and a pop-up appears. In this pop-up, you can

• Change the Suitcase's internal name

• By selecting Is Shared, generate a Suitcase ID to share the Suitcase with specific individuals as needed

• Set an Expiration Date that determines the length of time the Suitcase ID remains active

• Add comments

Sharing a Suitcase

To share a Suitcase:

1. Select the Edit button in the upper right corner.

2. Select the Is Shared option in the pop-up.

3. This will generate the Suitcase ID.

4. Copy the Suitcase ID by selecting on the copy icon.

5. Share the copy of the Suitcase ID with specific individuals as needed.

📝 Note: The generated Suitcase ID references items contained within as they existed, either at the time they were added to the Suitcase, or the last time that the Suitcase content was updated using the Update Content button. This date is reflected in the As Of column.

Merge/Replace with Suitcase

The Merge/Replace feature in the Suitcase tool lets you update forms from Test to Production without deleting and reimporting them. This works by matching the unique ID (GUID) of your form in Test and Production to identify forms that can be merged or replaced.

1. In the test environment, navigate to Database → Suitcase

2. Add updated form to a new Suitcase following the steps above, marking the new Suitcase as Shared

3. Copy that Suitcase ID

4. In the production environment, navigate to Database → Suitcase Import

5. Paste the Suitcase ID from the test environment and select Import

6. In the Import Suitcase popup screen, select Merge with Existing as the Action

7. Select Import.

   
   

After you import the suitcase, the form in Production will show your changes.