Applications list
The Application Workbench is currently available to CMA administrators only.
In Workbench > Applications you create and maintain the applications that your users connect to Canvas (for example an ERP, a CRM or any other system with an API). This page lists the applications of an organization and lets you open, publish and version them.
To create or change an application, use the Application wizard.
The page at a glance​
| Part | What it does |
|---|---|
| Organization | Chooses whose applications you see. |
| Add new application | Starts a new application in the wizard. |
| Search applications | Finds applications by what you type. |
| Filter button | Narrows the list by status, type or authentication. |
| List | One row per application, with its status and actions. |
Organization​
The drop-down at the top lists the organizations. Pick one to see its applications. Start typing to find an organization quickly.
Searching and filtering​
Type in Search applications to find an application. Use the filter button on the right to narrow the list:
| Filter | Shows |
|---|---|
| Filter by status | Only published or only unpublished applications. |
| Filter by type | Only one application type (see "Type" below). |
| Filter by auth | Only applications that sign in in one way. |
Click Clear all to remove all filters.
The list​
| Column | What it shows |
|---|---|
| (logo) | The logo of the application. |
| Name | The name of the application. |
| Tags | The search tags set in Basic information. |
| Description | The description from Basic information. |
| Type | API Connector or Direct REST API. |
| Organization Access | Who can use the application, see below. |
| Status | The publish switch and its state: Published or Unpublished. |
| Version | The latest committed version, for example v.0.0.3. |
| Last Modified | The date of the last change. |
Organization Access​
| Shown | Meaning |
|---|---|
| Admin | Only CMA administrators can use the application. |
| All | Every organization can use it. |
| All except 1 | Every organization except the given number can use it. |
| A number, for example 3 | Only that number of chosen organizations can use it. |
You change access in Access.
Status​
Use the switch to publish or hide an application without opening it:
| Switch | Meaning |
|---|---|
| On, Published | The application is shown to the organizations that have access. |
| Off, Unpublished | The application is hidden from the list users choose from. |
The same setting is in Access.
Drafts and versions​
Every change is first saved as a draft, a working copy that users do not see. Users keep getting the last committed Version until you commit the draft. Read more in Versions.
When an application has a draft, a second line appears under it, named Draft followed by the application name, with
these actions:
| Action | What it does |
|---|---|
| Commit | Makes the draft the new version. Users get it from now on. |
| Edit | Opens the draft in the wizard to continue working on it. |
| Delete | Deletes the draft. The committed version stays as it was. |
While a draft exists, the Edit button of the application itself is disabled: continue with the draft, or delete it first.
Actions of a row​
| Action | What it does |
|---|---|
| Edit | Opens the application in the wizard. Your changes are saved to a draft. |
| Three dots | Opens a menu with more actions for the application. |
Typical tasks​
| I want to | Do this |
|---|---|
| Create a new application | Add new application, then follow the wizard. |
| Change an existing application | Edit, change the steps, then Commit the draft. |
| Hide an application for a while | Switch Status to Unpublished. |
| Give an application to a pilot customer | Access, Custom Access. |
| Throw away unfinished changes | Delete on the draft line. |