The workspaceTemplate element controls how workspaces are displayed. Each workspaceTemplate contains one or more sideBarRef elements each of which identifies the sideBar elements that are to be displayed in the navigation area for a specific workspace via the sideBar/@name attribute. The workspace built-in command optionally identifies the workspaceTemplate used to display the workspace via the workspacetemplatename parameter which takes the name of the workspaceTemplate.

Example

4Here is an example of workspace template configuration:

<I4Config ...>

  ... 

  <sideBars>

    <sideBar name="EditionTracking">

      <searchContextRef name="Pages" />

    </sideBar>

    <sideBar name="Editorial">

      <searchContextRef name="Articles"/>

    </sideBar>

    <sideBar name="Tasks">

      <searchContextRef name="Tasks"/>

    </sideBar>

    <sideBar name="Collections">

      <searchContextRef name="Collections"/>

    </sideBar>

  </sideBars>

 

  <workspaceTemplates>

    <workspaceTemplate name="Editorial" option="Initial">

      <sideBarRef name="Tasks"/>

      <sideBarRef name="Editorial"/>

      <sideBarRef name="EditionTracking"/>

    </workspaceTemplate>

    <workspaceTemplate name="Wires" option="Initial">

      <sideBarRef name="Tasks"/>

      <sideBarRef name="Content"/>

      <sideBarRef name="Wires"/>

    </workspaceTemplate>

    <workspaceTemplate name="Archive">

      <sideBarRef name="Tasks"/>

      <sideBarRef name="Content"/>

      <sideBarRef name="Archive"/>

    </workspaceTemplate>

  </workspaceTemplates>

 

Here is an example of a workspace command:

  <dashboardItem name="New Editorial Workspace" 

    iconName="icon-briefcase" command="workspace">

    <params>

      <add key="workspacetemplatename" value="Editorial"/>

     </params>

   </dashboardItem>

 

Properties

workspaceTemplate/@name

The name of the workspaceTemplate and must be unique within a configuration file. The workspace built-in command references this value via the parameter workspacetemplatename.

workspaceTemplate/@option

An optional enumeration  attribute that takes the following values:

•None: No option and is the same as have no option attribute defined.

•Initial: The workspaceTemplate will be used to create a workspace when starting a new session in the case that there are no workspaces saved from a previous sessions. This is provided to create a default workspace environment when new users start a session for the first time.

•Permanent: The associated workspace is created on login if it doesn't already exist. Once created, it cannot be deleted by the workspace manager.

•Single: Only one instance of this workspace can be extant at any particular time.

Elements

workspaceTemplate/sideBarRef

The workspaceTemplate  must contain on more sideBarRef elements that identify via its @name property which sideBar to display. The sideBarRef/@name value must match a sideBar/@name defined in the sideBars section.

Translations

The heading (workspaceTemplate/@name) are translated using StringScope.Default.