Managing workspaces

  6 minute read  

Workspaces

A Workspace is identified by a Name, a unique Namespace, and an ID. It contains data, organized in a Cells, and tools used for marking and managing it. It is possible to create and manage all the Tag templates with Tag rules, Shape templates, Access control, Aggregations and Queries in the Workspace settings.

Create new Workspace

  1. To add a new Workspace, click the New button.

    Add Workspace
    Figure 1. Add Workspace

  2. Set the Name and unique Namespace in the popup window. There is an editable ID in the Advanced setting.

    Create new Workspace
    Figure 2. Create new Workspace

Import Workspace

  1. Click the Import button to import a JSON of an exported Workspace.

    Import Workspace
    Figure 3. Import Workspace

  2. In the popup window, drop the Workspace JSON file.

    Import Workspace window
    Figure 4. Import Workspace window

  3. Save the imported Workspace.

    Save Workspace
    Figure 5. Save Workspace

Open Workspace in the Viewer

  1. Click the Open workspace button to open the Workspace in the Viewer app.

    Open workspace
    Figure 6. Open workspace

View logs

  1. Click the View logs button to open the Workspace Logs.

    View logs
    Figure 7. View logs

    The Logs show information about changes in the Workspace.

Export Workspace

  1. Click the Export workspace button to download the Workspace JSON file.

    Export Workspace
    Figure 8. Export Workspace

    The Workspace descriptor is downloaded as a JSON file with information about the Workspace itself, Tag templates and rules, Shape templates, and Favorite Queries and Aggregations. This file can be imported again.

Edit Workspace

  1. Click the Edit workspace button to open the Workspace setting.

    Edit Workspace
    Figure 9. Edit Workspace

    In the Workspace settings, it is possible to edit the name of the Workspace, copy its ID, manage Tag templates and Tag rules, Queries, Aggregations, Shapes templates, and Access control.

Delete Workspace

  1. Click the Delete workspace button to remove the Workspace.

    Delete Workspace
    Figure 10. Delete Workspace
Note
 It is possible to delete a Workspace only if it does not contain any Cells. A confirmation dialog will appear.

Tags

Tag templates have to be created before using the corresponding Tag. They can be managed in the Workspace settings, and applied in the Editor.

Add Tag template

  1. Click the Add tag button.

    Add tag
    Figure 11. Add tag

  2. Fill in the Tag category and name in the popup window.

    Enter new tag
    Figure 12. Enter new tag

  3. Set the Tag category from the list of already existing categories or choose a new one. The combination of Tag category and name has to be unique.

  4. Save the Tag. Tags are displayed in the list of Tags, sorted by category.

    Tags
    Figure 13. Tags

Remove Tag template

  1. Click the Remove tag button on the Tag itself.

    Remove tag button
    Figure 14. Remove tag button
Note
 The Tag template cannot be removed if any Cell or Cell File is assigned the corresponding Tag.

Tag rules

Tag rules can be created for any custom Tag category. They are managed in the Workspace settings, in the same tab as Tags.

Add Tag rule

  1. Click the Add rule button.

    Add rule
    Figure 15. Add rule

  2. In the popup window, set the rule name, Tag category, and minimum amount of Tags from that category per Cell, optionally maximum value too.

    The combination of rule name and category has to be unique, but there can be more rules applied for one category.

    Create new rule
    Figure 16. Create new rule

  3. The saved rule is displayed in the list of Tag rules, grouped by category.

    List of rules
    Figure 17. List of rules

Edit Tag rule

  1. Click the Edit rule template button on the Tag rule itself.

    Edit rule template button
    Figure 18. Edit rule template button

  2. A popup window with rule settings is displayed, with all values editable.

    Edit rule
    Figure 19. Edit rule

Remove Tag rule

  1. Press the Remove rule button on the Tag rule itself.

    Remove tag button
    Figure 20. Remove tag button

Queries

Queries can be created and used in Viewer, Editor, Gallery or Statistics. There are more options, for how to create a query, from very simple ones, to advanced options. Fast query is used for Tags, Add query option is used to create simple or advanced queries. As an Advanced query, it can be saved and then used again. All of those can be used only in the active Workspace.

Only advanced queries can be saved and shared.

Add query

  1. Click the Add query button.

    Add query button
    Figure 21. Add query button

  2. Name the query, select sort by, and create the query. Next to the save button is help with an example query and two buttons to format the query.

    Create query
    Figure 22. Create query

  3. The saved query is displayed in the list.

    Saved query
    Figure 23. Saved query

Edit query

  1. To edit a saved query, click the Edit query button.

    Edit query
    Figure 24. Edit query

Remove query

  1. To remove a saved query, click the Remove query button.

    Remove query
    Figure 25. Remove query

Aggregations

Aggregations for local use can be created in the Data Miner.

Add Aggregation

  1. Click the Add aggregation button.

    Add aggregation button
    Figure 26. Add aggregation button

  2. Name the aggregation and create it. To add aggregation created in the Data Miner, go to the Data Miner, create the aggregation or select a favorite one, use the export aggregation button, and copy the displayed aggregation.

    Create aggregation
    Figure 27. Create aggregation

  3. Saved aggregation is displayed in the list.

    Saved aggregation
    Figure 28. Saved aggregation

Edit Aggregation

  1. To edit a saved aggregation, click the Edit aggregation button.

    Edit aggregation
    Figure 29. Edit aggregation

Remove aggregation

  1. To remove a saved aggregation, click the Remove aggregation button.

    Remove aggregation
    Figure 30. Remove aggregation

Shapes

Every Workspace is created with a set of default Shape templates, one for each Shape type, ready to be used for annotation in the Editor app. A list of available Shape templates is displayed after selecting the Shape to add to the Image. The list of Shape templates belonging to the Workspace is located in the Workspace settings.

Add Shape template

  1. Click the Add shape button.

    Add shape template button
    Figure 31. Add shape template button

  2. Name the new Shape template and select the Shape type.

    Create Shape template
    Figure 32. Create Shape template
    Select Shape type
    Figure 33. Select Shape type

  3. Set color and alpha of the Shape.

    Set color
    Figure 34. Set color

  4. The saved Shape template is displayed in the list.

    Saved shape template
    Figure 35. Saved shape template

Edit Shape template

  1. To edit a saved shape template, click the Edit shape template button.

    Edit shape template
    Figure 36. Edit shape template

Remove Shape template

  1. To remove a saved shape template, click the Remove shape template button.

    Remove shape template
    Figure 37. Remove shape template

Access control

If a user is assigned the own-only role, his or her access rights are defined on a Workspace basis. It is possible to set up a general read/write access, and it is also possible to set up very specific rules, e.g., the user can only access Cells with a specific Tag.

In the Access control is a list of all users with easy Read and Write options and detailed settings.

Users
Figure 38. Users
Note
 The Workspace Access control only manages the user rights in that particular Workspace provided the user is not granted any global roles.

If any access rule was set up, it is possible to click the arrow up/down to see access details, or the clear user settings button to reset it.

Access details
Figure 39. Access details

Edit User settings

  1. Click the Edit user settings button to open detailed user settings.

    User settings
    Figure 40. User settings

  2. A popup window with detailed access rules opens.

    Manage access control rules
    Figure 41. Manage access control rules

    The Workspace tab shows available access rules related to Workspaces. The Cells and Cell data tabs list access rules related to Cells.

    Manage access control rules to Cells
    Figure 42. Manage access control rules to Cells

  3. Click Add cell rule to add a new access rule.

    Add cell rule
    Figure 43. Add cell rule

  4. A new Cell access rule is added at the top of the list. Select Authority and optionally Tags.

    New cell rule
    Figure 44. New cell rule