{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Workspace Configuration Documentation","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"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.","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"Loading Workspace","type":"text"}]},{"type":"paragraph","content":[{"text":"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:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Viewer.xml","type":"text","marks":[{"type":"strong"}]},{"text":": Default workspace for viewing purposes.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Classic Default.xml","type":"text","marks":[{"type":"strong"}]},{"text":": Default workspace for editing on desktop.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MobileViewer.xml","type":"text","marks":[{"type":"strong"}]},{"text":": Default workspace for viewing on mobile devices.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MobileEditor.xml","type":"text","marks":[{"type":"strong"}]},{"text":": Default workspace for editing on mobile devices.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"The table below illustrates the mapping of access and mobile parameters to the respective default workspaces.","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"b755c636-438a-416e-8b71-165222433417"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"background":"#ededed","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Access","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"#ededed","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Mobile","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"#ededed","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Workspace Loaded","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Edit","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"False","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Classic Default.xml","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"View","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"False","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Viewer.xml","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Edit","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"True","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"MobileEditor.xml","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"View","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"True","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"MobileViewer.xml","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Developers can override the default workspace by specifying the ","type":"text"},{"text":"workspace","type":"text","marks":[{"type":"code"}]},{"text":" and/or ","type":"text"},{"text":"viewerWorkspace","type":"text","marks":[{"type":"code"}]},{"text":" query parameters and passing the name of the custom workspace.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Workspace Configuration Structure","type":"text"}]},{"type":"paragraph","content":[{"text":"A workspace xml file has this structure","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n\n \n \n \n \n \n \n \n ...\n \n \n \n \n \n \n \n \n \n \n \n","type":"text"}]},{"type":"paragraph","content":[{"text":"The workspace configuration file (","type":"text"},{"text":"*.xml","type":"text","marks":[{"type":"code"}]},{"text":") follows a structured format with the following key sections:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"strong"}]},{"text":": Specifies the name of the workspace. This name is used when overriding the default workspace.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"strong"}]},{"text":": Provides an arbitrary description of the workspace (not currently in use).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"strong"}]},{"text":": Defines the visibility of the status bar in Kudo (1 for visible, 0 for invisible).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"strong"}]},{"text":": Placeholder section for future use.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"strong"}]},{"text":": Specifies root menu items defined in the ","type":"text"},{"text":"application.xml","type":"text","marks":[{"type":"code"}]},{"text":" to be added to the Kudo menu.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"strong"}]},{"text":": Represents individual menu items.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"group_id","type":"text","marks":[{"type":"strong"}]},{"text":": ID of the group in ","type":"text"},{"text":"application.xml","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"uid","type":"text","marks":[{"type":"strong"}]},{"text":": ID of the menu in ","type":"text"},{"text":"application.xml","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"strong"}]},{"text":": Specifies navigation toolbars defined in the ","type":"text"},{"text":"application.xml","type":"text","marks":[{"type":"code"}]},{"text":" to be loaded.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"strong"}]},{"text":": Represents individual toolbar items.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"group_id","type":"text","marks":[{"type":"strong"}]},{"text":": ID of the group in ","type":"text"},{"text":"application.xml","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"uid","type":"text","marks":[{"type":"strong"}]},{"text":": ID of the navigation toolbar in ","type":"text"},{"text":"application.xml","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"strong"}]},{"text":": Specifies the visibility of Kudo's command line and other widgets.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"strong"}]},{"text":": Represents individual widgets.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"object_name","type":"text","marks":[{"type":"strong"}]},{"text":": Object name of the widget.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"visible","type":"text","marks":[{"type":"strong"}]},{"text":": Specifies if the widget will be visible (1 for visible, 0 for invisible).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"strong"}]},{"text":": Optional, not currently in use.","type":"text"}]}]}]}]}]}]}]}],"version":1}

Browser not supported