Creating Sub Workspaces (Layouts)

Sub workspaces are the layouts that arrange the apps within the workspace in a structured manner. Once the Workspace configuration is complete and when the developer clicks Proceed, the subworkspace configuration screen gets loaded.


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

  1. Click Plus icon on the design area to create a new Sub Workspace or click the look up icon to add any existing Sub Workspace(s).

    Click  icon to modify Workspace configuration details.




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




    #

    Field Name

    Description

    Sample Values


    1

    Display Name

    Label key of the localized text that appears as Sub Workspace display name.

    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 na mes and the apps associated with current workspace. The bundle key allows only alphabets, numbers, hyphens and underscores.

    common


    3

    Sub Workspace ID

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

    TRANSACTIONSUMMARY139


    4

    Choose Channel

    Select the devices that are applicable for the Sub Workspace.


    Entitlement Configuration 

    5

    Entitlement

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

    Yes


    6

    Product Code

    Name of the Product that the Sub Workspace is tagged. Only the users who are authorized to this product can view the data in this Sub 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 Sub Workspace is tagged. The users who are authorized only to this sub product can view the data in this Sub 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.

    CUSER


    8

    Proceed

    Click Proceed to add apps to the sub-workspace.



    9

    Cancel

    Click Cancel to cancel the Sub Workspace configuration.



    10

    Icon

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

    Selected: The icon will appear. 

    De-Selected: The icon will not appear. 

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

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

    If the chosen workspace layout is Stack, then you cannot select an icon for the sub workspace. The selection of icons is applicable only for the layouts of Tabs, L-Menu and R-Menu. 




    A screen, consisting 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 sub workspace, whereas Active depicts the active state of the sub 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 sub 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 sub workspace.




    6. For any changes or modifications, click the iconadjacent to the title of the sub 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 sub workspace, appear in the form of newly selected icon. 



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




  3. Once the Sub Workspace is created, select the layout for the Workspace to arrange the Sub Workspace(s) in a Workspace. The available Workspace layouts are:





  4. Select the Sub Workspace layout to arrange the apps in sub workspace(s). The available Sub Workspace layouts are:

    • One column
    • Two column
    • Three column
    • Four column
    • Five column
    • Six column
    • Carousel




    Position of each thick black line denotes the number of columns. For example, in the above screenshot second thick black line is selected, it denotes two column layout. 

  5. Click the Look Up icon inside the Sub Workspace design area to add apps. 




  6. Click to add Workspace Menus to the Workspace.

    Workspace Menu configuration can be done in three regions (Left, Center and Right) as per the requirement.

  7. Click Add New Menu in any region to add new Workspace Menu.

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



    #

    Field Name

    Description

    Sample Values


    1

    Display Name

    Label key of the localized text that appears as Workspace Menu display name.

    LBL_INIT_PAY


    2

    Menu ID

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

    INIT_PAY


    3

    App Shortcut ID

    Toggle on - Switch on the toggle to link any existing App shortcuts to the Workspace Menu. Select the App shortcut from the drop-down.
    Toggle off - Does not link the Workspace menu to App shortcut.



    Entitlement Configuration 

    4

    Product Code

    Name of the Product that the Workspace Menu is tagged. Only the users who are authorized to this product can view the data in this Workspace Menu.
    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


    5

    Sub Product Code

    Name of the Sub Product within the Product for which the Workspace Menu is tagged. The users who are authorized only to this sub product can view the data in this Workspace Menu.
    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.

    CUSER


    6

    Function Code

    Name of the Function within the Sub Product for which the Workspace Menu is tagged. The users who are authorized only to this function can view the data in this Workspace Menu.
    To add new entitlement details, make an entry of the function code in OD_FUNCTION_MASTER_MB and OD_FUNCTION_PRODUCT_MAP_MB tables in database.

    VSBLTY


    7

    Label

    Indicates the label key of the localized text, which is assigned as the name of the workspace menu. 

    Selected: The label key will appear.

    De-Selected: The label key will not appear. 

    Selected


    8

    Icon

    This option allows you to choose an icon for the workspace menu. 

    Selected: The icon will appear. 

    De-Selected: The icon will not appear. 

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

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



    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 menu, whereas Active depicts the active state of the workspace menu. 



    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 menu, 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 menu.




    6. For any changes or modifications, click the iconadjacent to the title of the workspace menu. 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 menu, appear in the form of newly selected icon. 



    7. To remove an existing icon of the workspace menu, clickicon, adjacent to the selected icons in the states of Default and Active




    9

    Create

    Click Create to complete the Workspace Menu creation.



  9. To create a sub Workspace menu click the plus icon in the parent menu. Sub workspace menu configuration is similar to Workspace Menu creation.




  10. Click the Add labels icon to manage the display names of workspaces.



  11. Click Save icon to finish and create the Workspace.

You can change the position of a sub-workspace by clicking the drag-and-drop icon () for the sub-workspace and dropping it at the required position.