> For the complete documentation index, see [llms.txt](https://docs.amltd.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.amltd.com/dc-works/suites-and-deployment/suite-workspace-overview.md).
# Suite Workspace Overview
The Suite workspace has two primary areas:
* The **Suites list**, where Suites are created and managed.
* The **Suite design workspace**, where an individual Suite’s Applets, fields, layout, appearance, and behavior are configured.
The Suites list provides access to existing Suites and Suite-management commands.
### Open the Suites workspace
To open the Suites workspace:
1. Sign in to DC Works.
2. Select **Suites** from the main navigation.
The workspace displays the Suites available to your account.
The Suites section in the main navigation can also be expanded to display links to existing Suites.
### Understand the Suites list
Each row represents a Suite and displays the following information:
| Column | Description |
| ---------------------- | ---------------------------------------------------------------------------- |
| **Name** | Identifies the Suite. |
| **# Devices Assigned** | Shows the number of devices currently assigned to the Suite. |
| **Enrollment Barcode** | Provides controls for viewing or downloading the Suite’s enrollment barcode. |
Use the checkbox beside a Suite to select it before using commands that apply to an existing Suite.
### Filter the Suites list
Select **Filters** to narrow the list and locate a specific Suite.
Filtering is useful when the account contains multiple Suites for different users, locations, customers, or workflows.
Clear or change the filters to display additional Suites.
### Create a Suite
Select **Create Suite +** to begin creating a Suite.
Suite creation includes selecting a launcher template, entering the Suite’s information, choosing its initial settings, adding Applets, and configuring its logo.
Detailed instructions are provided in **Create and Configure a Suite**.
### Rename a Suite
The pencil icon edits the Suite’s name. It does not open the Suite Editor.
To rename a Suite:
1. Locate the Suite in the Suites list.
2. Select the pencil icon beside the Suite.
3. Enter the new Suite name.
4. Save the change.
### Open the Suite Editor
To open an existing Suite for editing:
1. Locate the Suite in the Suites list.
2. Select the Suite’s name.
3. Wait for the Suite Editor to open.
The Suite’s current Applets, fields, logo, layout, and properties appear in the Suite Editor.
### Delete a Suite
To delete a Suite:
1. Select the checkbox beside the Suite.
2. Select **Delete**.
3. Confirm the deletion if prompted.
{% hint style="warning" %}
Before deleting a Suite, confirm that it is no longer assigned or required. Deleting a Suite can prevent users from accessing the workflow it provides.
{% endhint %}
### Import and export Suites
DC Works uses `.dcworks` files to transfer Suite structures.
A Suite export includes:
* The Suite.
* Its Applets.
* Its databases.
* Its table structures.
The records contained in those tables are not included.
#### Export a Suite
To export a Suite:
1. Select the checkbox beside the Suite.
2. Select **Export**.
3. Save the generated `.dcworks` file.
The exported file can be retained as a structural backup or imported into another DC Works environment.
#### Import a Suite
To import a Suite:
1. Select **Import**.
2. Select the applicable `.dcworks` file.
3. Follow the displayed prompts to complete the import.
4. Review the imported Suite, Applets, databases, and tables.
Because table records are not included, imported tables are created without their original record data.
{% hint style="info" %}
Suite import and export transfer the complete Suite structure—including its Applets, databases, and tables—but do not transfer the records stored in those tables.
{% endhint %}
#### Transfer table records separately
When record data must also be transferred, export the required tables separately to a supported format such as CSV.
The general process is:
1. Export the Suite to a `.dcworks` file.
2. Export the required table records separately.
3. Import the `.dcworks` file into the destination.
4. Import the table records into the corresponding destination tables.
5. Verify the imported data and its field mappings.
Review dates, primary fields, and other data types after importing the records.
### Duplicate a Suite
Use **Duplicate** to create a complete copy of a Suite within DC Works.
Unlike Suite import and export, duplication includes:
* The Suite.
* Its Applets.
* Its databases and tables.
* The records stored in those tables.
To duplicate a Suite:
1. Select the checkbox beside the Suite.
2. Select **Duplicate**.
3. Enter or confirm the name of the duplicated Suite.
4. Complete the duplication.
5. Open and review the new Suite.
Select a Suite and use Duplicate to copy its complete structure and record data.
### Configure Suite permissions
Use **Permissions** to control access to a selected Suite.
To view Suite permissions:
1. Select the checkbox beside the Suite.
2. Select **Permissions**.
3. Review the users and their permissions.
The Suite Permissions workspace displays:
* **User**
* **Read**
* **Write**
* **Effective**
**Read** controls whether the user can access the Suite. **Write** controls whether the user can modify it. **Effective** displays the resulting permission available to that user.
\[Insert screenshot: Suite Permissions showing User, Read, Write, and Effective columns]
Use Suite Permissions to review and configure access to the selected Suite.
Administrator permissions may provide full access independently of Suite-specific settings.
### View or download an enrollment barcode
The **Enrollment Barcode** column contains controls for viewing and downloading a Suite’s enrollment barcode.
Use the view control to display the barcode on screen. Use the download control when the barcode must be saved, printed, or provided through another approved method.
The enrollment barcode is scanned during device enrollment to connect an Android device to the Suite.
Detailed instructions are provided in **Deploy a Suite to an Android Device**.
{% hint style="info" %}
Treat enrollment barcodes as deployment information. Provide them only to the users or administrators responsible for enrolling authorized devices.
{% endhint %}
### Understand the Suite design workspace
Opening a Suite displays its design workspace.
The workspace contains:
* The **Top Taskbar**.
* The **Fields** panel.
* The **Add Fields** Toolbox.
* The central design area.
* The **Properties Panel**.
Use the Suite design workspace to add and arrange Applets and other elements, configure Suite properties, and control its appearance and launch behavior.
### Top Taskbar
The Top Taskbar contains controls used while designing the Suite.
These include controls for:
* Zooming the workspace.
* Setting or previewing the Suite dimensions.
* Changing the workspace orientation.
* Editing and arranging content.
* Saving changes.
The Suite name and version appear at the top of the workspace.
Use the zoom and dimension controls to review the Suite at the size and orientation of its intended screen.
{% hint style="info" %}
The Suite workspace does not include a Play or test-run control. Test the Suite on an enrolled Android device or as a Web App.
{% endhint %}
### Fields panel
The **Fields** panel lists the elements already contained in the Suite.
For example, it may contain:
* An Image used as the Suite logo.
* App Buttons linked to Applets.
* Other visual or action fields.
Select an item in the Fields panel to display it in the Properties Panel.
The Fields panel selects and manages elements that have already been added to the Suite.
### Add a field to the Suite
To add a field:
1. Select the **+** button beneath **Fields**.
2. Locate the required field in the **Add Fields** menu.
3. Click and drag the field from the menu into the **Main Workspace**.
4. Drop the field at the desired location.
5. Select the new field.
6. Configure it in the Properties Panel.
7. Save the Suite.
Select the + button to open Add Fields, then drag the required field into the Main Workspace.
The available fields are organized into the following categories.
#### Visual fields
Visual fields include:
* **Header**
* **Horizontal Divider**
* **Vertical Divider**
* **Text**
* **Image**
* **Connectivity Display**
Use visual fields to add labels, branding, separation, and status information to the Suite interface.
#### Action fields
Action fields include:
* **App Button**
* **Logout Button**
* **Update Button**
An **App Button** opens its linked Applet. A **Logout Button** allows the user to sign out. An **Update Button** provides a control for updating the Suite.
### Central design area
The central design area displays the Suite interface as it is being configured.
Use it to:
* Select and arrange Suite fields.
* Position the Suite logo.
* Review App Button placement.
* Check the background and spacing.
* Preview the Suite at different dimensions and orientations.
Selecting an element changes the settings displayed in the Properties Panel.
Select an empty part of the Suite to display the overall Suite properties.
### Properties Panel
The Properties Panel changes according to the currently selected item.
It can display properties for:
* The Suite.
* An App Button.
* The logo or another Image.
* A visual field.
* An action field.
Confirm that the intended item is selected before changing its settings.
### Suite properties
Select an empty area of the Suite to display its overall properties.
The Suite properties are organized into:
* **Info**
* **Layout**
* **Background**
* **Actions**
Use the Suite Properties to configure the Suite as a whole.
#### Info
The **Info** section includes:
* **Applets**
* **Require User Login**
* **Offline Support**
* **Auto Update**
* **Show Loading Indicator**
Use **Applets** to select the Applets included in the Suite.
The remaining settings determine how users access the Suite and how it behaves when loading, operating offline, or receiving updates.
These settings are covered in **Create and Configure a Suite**.
#### Layout
Use **Layout** to control the horizontal arrangement of fields within the Suite.
The available alignment and spacing options allow elements to be aligned or distributed across the available width.
Review the layout at the intended Suite dimensions after making changes.
#### Background
Use **Background** to configure:
* **Main Background**
* **Background Image**
* **Loading Indicator**
The main background can use a selected color. A background image can also be uploaded. The loading-indicator color should remain visible against the selected background.
Detailed appearance instructions are provided in **Style and Configure the Suite**.
#### Actions
Use **Actions** to configure **Launcher Load Actions**.
Launcher Load Actions execute when the Suite launcher loads. They can be used to perform supported Suite-level operations before the user opens an Applet.
### Field properties
Select a field to display its properties.
The available sections vary by field type and may include:
* **Info**
* **Position**
* **Size**
* **Color**
* **Border**
* **Text Alignment**
* **Field Properties**
* **Actions**
These properties control the selected field without changing the overall Suite.
### App Button properties
An App Button represents an Applet within the Suite.
Its Info properties include:
* **Field ID**
* **Field Type**
* **Field Name**
* **Hidden**
* **Disabled**
* **Field Text**
* **Linked Applet**
**Field Text** controls the text displayed on the button. **Linked Applet** determines which Applet opens when the button is selected.
Select an App Button to configure its displayed text and linked Applet.
Changing the Suite-level App Button does not change the internal pages or behavior of the linked Applet.
### Save Suite changes
Save the Suite after:
* Adding or removing fields.
* Adding or removing Applets.
* Changing Suite settings.
* Rearranging App Buttons.
* Modifying the logo or background.
* Changing field properties.
* Adding Launcher Load Actions.
Select the save control in the Top Taskbar to preserve the current configuration.
After saving, test the Suite on an enrolled Android device or as a Web App.
### Next
Continue to **Create and Configure a Suite** to learn how to select a launcher template, choose the Suite’s settings, add its initial Applets, and prepare it for deployment.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.amltd.com/dc-works/suites-and-deployment/suite-workspace-overview.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.