Workspace Configuration Documentation

The workspace configuration in Kudo determines the layout and functionality of the workspace, including which widgets are displayed and which menus/toolbars are loaded. This document provides an overview of the structure and elements of workspace configuration in Kudo.

Loading Workspace

The workspace to be loaded is determined based on the combination of access and mobile parameters. Kudo provides four default workspaces, each tailored for different access and mobile scenarios:

Viewer.xml: Default workspace for viewing purposes.
Classic Default.xml: Default workspace for editing on desktop.
MobileViewer.xml: Default workspace for viewing on mobile devices.
MobileEditor.xml: Default workspace for editing on mobile devices.

The table below illustrates the mapping of access and mobile parameters to the respective default workspaces.

Access	Mobile	Workspace Loaded

Access	Mobile	Workspace Loaded
Edit	False	Classic Default.xml
View	False	Viewer.xml
Edit	True	MobileEditor.xml
View	True	MobileViewer.xml

Developers can override the default workspace by specifying the workspace and/or viewerWorkspace query parameters and passing the name of the custom workspace.

Workspace Configuration Structure

A workspace xml file has this structure

<?xml version="1.0" encoding="UTF-8"?>
<workspace>
    <name workspace_name="Classic Default" />
    <description description="" />
    <status_bar_visible status_bar_visible="1" />
    <groups/>
    <root_menu_items>
        <menu group_id="Id_XenonMainGroup" uid="ID_MnFile" />
        <menu group_id="Id_XenonMainGroup" uid="ID_MnEdit" />
        ...
    </root_menu_items>
    <navigation_toolbars>
        <toolbar group_id="Id_XenonMainGroup" uid="ID_NavBarDefault" />
    </navigation_toolbars>
    <dockable_windows>
        <window object_name="CommandWindow" visible="1" name="Command Prompt" />
        <window object_name="PropertyWindow" visible="1" name="Properties Window" />
        <window object_name="XRefManager" visible="0" name="References" />
        <window object_name="LayerPanel" visible="0" name="Layer Panel" />
        <window object_name="CustomPanel" visible="0" name="My panel" />
    </dockable_windows>
</workspace>

The workspace configuration file (*.xml) follows a structured format with the following key sections:

<name>: Specifies the name of the workspace. This name is used when overriding the default workspace.
<description>: Provides an arbitrary description of the workspace (not currently in use).
<status_bar_visible>: Defines the visibility of the status bar in Kudo (1 for visible, 0 for invisible).
<groups>: Placeholder section for future use.
<root_menu_items>: Specifies root menu items defined in the application.xml to be added to the Kudo menu.
- <menu>: Represents individual menu items.
  - group_id: ID of the group in application.xml.
  - uid: ID of the menu in application.xml.
<navigation_toolbars>: Specifies navigation toolbars defined in the application.xml to be loaded.
- <toolbar>: Represents individual toolbar items.
  - group_id: ID of the group in application.xml.
  - uid: ID of the navigation toolbar in application.xml.
<dockable_windows>: Specifies the visibility of Kudo's command line and other widgets.
- <window>: Represents individual widgets.
  - object_name: Object name of the widget.
  - visible: Specifies if the widget will be visible (1 for visible, 0 for invisible).
  - name: Optional, not currently in use.

ARES Kudo Partner Documentation

Workspace

Analytics

Loading Workspace

Workspace Configuration Structure

Related content