Creating Workspaces (Dashboards)

Owned by Vaishnavi Sridhar (Unlicensed)

In the subsequent steps, let's look at the details for creating a Workspace in Workspace Designer.

  1. Click Workspace Designer on the top right pane to launch Workspace Designer.



  2. Click Workspace to create a new Workspace.



  3. Provide the Workspace details based on the description in the following table:



    #

    Field Name

    Description

    Sample Values

    1

    Workspace Title

    Label key of the localized text that appears as Workspace Title.

    Transaction summary

    2

    Resource Bundle

    Name of the bundle key associated with the property file.
    This file can contain label keys for the current workspace title, and all the sub workspaces names and the apps associated with current workspace. The bundle key allows only alphabets, numbers, hyphens and underscores.

    common

    3

    Workspace ID

    Specify a unique ID for the workspace. This value is automatically configured and can be edited if required.

    Transaction summary536

    4

    Choose Channel

    Select the devices that are applicable for the workspace.

    –

    Entitlement Configuration

    Canvas provides ability to restrict the workspace access through entitlement configuration. At workspace level, you can give a product and sub product names to your workspace. Later, when the workspace is rendered, the contents of the workspace (and apps) will be visible only to those users who are authorized to the product and sub product.

    5

    Entitlement

    Toggle on - Switch on the toggle to set entitlement based access for Workspace.
    Toggle off - Switch off the toggle if you do not want to enable entitlement based access for Workspace.

    Yes

    6

    Product Code

    Name of the Product that the Workspace is tagged. Only the users who are authorized to this product can view the data in this Workspace.

    To add new entitlement details, make an entry of the product code in OD_PRODUCT_MASTER_MB and OD_FUNCTION_PRODUCT_MAP_MB tables in database.

    CUSER

    7

    Sub Product Code

    Name of the Sub Product within the Product for which the Workspace is tagged. The users who are authorized only to this sub product can view the data in this Workspace.

    To add new entitlement details, make an entry of the sub product code in OD_PRODUCT_MASTER_MB and OD_FUNCTION_PRODUCT_MAP_MB tables in database.

    This is an optional field for the Workspace creation.

    CUSER

    Activation Handler

    8

    Activation Handler

    This is for a unique and customized option; A link of an external application can be given here. Provide the handler class name registered using Canvas Global Handler (CGH) to render any custom application as a Workspace.

    Toggle on - Switch on the toggle to link the Workspace to any external application.
    Toggle off - Switch off the toggle to proceed and configure sub-workspace(s) for the Workspace.


    9

    Proceed

    Click Proceed to configure the sub-workspace(s) for the Workspace.

    The Workspace configuration ends with this next step, if activation handler toggle is on.


    10

    Cancel

    Click Cancel to cancel the Workspace configuration.


    11

    Icon

    The option of Icon appears on the Workspace Designer page, adjacent to the title of the workspace. This option allows you to choose an icon for the workspace. 

    Selected: The icon will appear. 

    De-Selected: The icon will not appear. 

    To select an icon for a workspace, perform the following steps: 

    1. Click the iconadjacent to the display name or title of the workspace, e.g. PAYMENT_WS.



    A screen, comprising of various icons appears.  



    2. Default and Active are the two available options, categorized under the field, Choose icons for different state. To find an icon, type the name of the icon in the Search box to find it. You can assign separate icons for the two different states of Default and Active. Default indicates the default icon of the workspace, whereas Active depicts the active state of the workspace. 



    3. For customized icons, click Custom tab.   



    4. Click Browse Files button to select an image from your local drive. You can even drag and drop the customized image file directly.  



    5. After selecting the image, provide unique names for Class Tag and Search Tag. The Image Name gets assigned automatically. In case, if you wish to change the Image Name, then you can modify it. The name, which you provide in Search Tag, will be detrimental, when you perform a search. Use the name, provided in the Search Tag to find the customized icon.  Click Ok to upload the customized icon. 

    If you upload a customized icon for the workspace, ensure that you restart the app server, after saving the workspace. Make sure to log out from Canvas Studio and close the Studio application, before restarting the app server. If you do not restart the app server, the uploaded custom icon will not appear as the assigned icon for the selected workspace.





    6. For any changes or modifications, click the iconadjacent to the title of the workspace. The appearance of the icon takes the shape of the previously selected default icon. If any changes are made, then the icon, adjacent to the title of the workspace, appear in the form of newly selected icon. 



    7. To remove an existing icon of the workspace, clickicon. 



  4. Refer Create New Sub Workspace to continue.