on - edited on by
amrithaanayak
Table of Contents
Configuration for related list
Form layout configuration migration
Fulfilment instructions migration
Create lists within a category
There are two new tables which are created for the landing page carousel section-for card and tag configuration.
- sn_hr_agent_card_config
- sn_hr_agent_tag_config
These two tables are equivalent to sn_hr_ws_landing_page_card_list_config and sn_hr_ws_landing_page_tag_config respectively in the classic workspace. The seed data from the old tables have been migrated to these new tables. Customers can edit this or add new records to these tables.
For classic workspace this data was stored in sn_hr_ws_landing_page_card_list_config and sn_hr_ws_landing_page_tag_config, respectively.
The content delivery section in landing page has three components:
- Announcements
- Quick links
- My frequently used apps
The data for these components are coming from sn_cd_content_visibility table. Note that even the classic workspace derived this data from the same table. However, the content is distinguished from the classic workspace through a new column.
As seen from the above picture, for the content to show up in UIB, there are three major changes to take care of:
- Select the content location to UIB Workspace.
- Select the component to one of the three components (announcements, quick links and frequently used apps).
- Group the content to match with the identifier in the UIB workspace databroker.
The data is surfaced into the UIB, with the help of databroker. The announcements, quick links and my frequently uses apps will use ‘getAnnouncementContents’ , ‘getQuickLinksContent’ and ‘getMyFrequentlyUsedAppsContent’ databrokers, respectively.
Helpful: There is demo data added to show contents in these three components.
We are still mostly referencing to Case Creation Configuration (sn_hr_core_config_case_creation) for case creation page with a few slight changes.
Left task fields: (empty), Right task fields: Opened for, Subject Person
Now we have:
Left task fields: Opened for, Right task fields: Subject Person
With this change, our existing case creation page will have a slightly different layout:
Native case creation page:
This works similarly for classic workspace case creation page.
Similar changes were made to 3 OOB Case Creation Service Configuration Records:
- ER Create Case (sn_hr_er_case, activated with Employee relations plugin)
- Accommodation Create Case (sn_hr_er_case, activated with Employee relations plugin)
- Tuition Reimbursement (sn_hr_core_case_total_rewards, activated with Core plugin)
The configuration is still being referenced by native case creation page and classic workspace
For UIB workspace, the configuration needs to be done in UI Builder with data resource Case Create – Get Employee Information. By changing the Employee Fields property, customers can customize what they want to show for the Employee Information section.
Also, the Employee Information section is displayed differently in Configurable UIB workspace:
For configuring the employee fields in the employee information section, currently it isn't possible to modify the fields through UI Builder due to a defect. Use the following workaround to modify the employee fields:
- open the page definition of case creation page through the hamburger menu on the top left.
- In the data section, search for case_create__get_employee_information, and you'll find employeeFields' value string. You should be able to configure the fields by modifying same string. Here's an image for reference:
Configuration for related list
In configurable UIB workspace, related list configuration is done within UI Builder:
Previously, this is configured through a system property (sn_hr_ws.case_creation_tabs) which is not very intuitive: sys_properties_9f376431c32520102e123a7ea940ddf8
The related list is also displayed differently in Configurable UIB workspace compared to classic one:
Note: The related list in configurable workspace will be shown statically. The tab will always be shown even if there is no subject person/opened for or if there is no record under that tab.
In ‘sys_aw_form_header’ table there are 2 record each OOB for classic and configurable workspace. The changes done in classic workspace record need to be done in respective configurable workspace record (Add application column to help identify which record belongs to which workspace)
If there are no other record in ‘Human Resources: Workspace’ scope in this table then there is nothing else to do but if there are other records, then those records need to be duplicated in ‘HRSD Configurable Workspace’ scope.
Duplicate a record:
- Open the record that needs to be duplicated in ‘HRSD Configurable Workspace’ scope.
- Right-click on header and select ‘Insert and Stay’ option.
- The page will reload and a new record will open.
- Once the page has fully loaded go to ‘UX Header Configuration’ related table and click on edit.
- From the right-side picker, select ‘HR Workspace Header configID’ and click on save.
Follow the same steps for all other records that need to be duplicated.
Open ‘sys_aw_ribbon_setting’ table and check if there are any active records with scope as ‘Human Resources: Workspace’ (OOB all the records are shipped as inactive). Create a duplicate of active records by following the below steps:
- Open the record that needs to be duplicated in ‘HRSD Configurable Workspace’ scope.
- Right-click on header and select ‘Insert and Stay’ option
- Let the page reload fully.
Follow the same steps for all other records that need to be duplicated. Keep a note of all the records that were duplicated
Once the records in ‘sys_aw_ribbon_setting’ table have been duplicated open ‘sys_ux_ribbon_config_setting’ table, we need to create a new mapping record for each record that we duplicated in earlier table.
- Select the ribbon record we duplicated in earlier table.
- Ensure the order, width, and table remain the same as it is in ribbon record selected (click on ‘i’ icon to verify).
- Select ‘HR Workspace Ribbon ConfigId’ in Configuration field.
- Click on Submit to create a record.
Follow the same steps till a record has been created for all duplicated ‘sys_aw_ribbon_setting’ records.
Form layout configuration migration
The WEP HR Agent Workspace uses a view named “workspace_uib” depending on the role of the agent and what views are available in the system. The changes made in “workspace” view for older agent workspace need to be redone for tables in “workspace_uib” view. Few tables are present in “hr_workspace_uib” view. The new workspace defaults to “workspace_uib” for all tables.
Alternatively, a “UX Form View Rule” can be created to use a custom view for a table instead of “workspace_uib” view.
Documentation to create form layout is located at https://docs.servicenow.com/bundle/rome-platform-administration/page/administer/form-administration/...
All the UX form actions created in ‘Human Resources: Workspace’ scope need to be re-created in ‘HRSD Configurable Workspace’ scope. The UI action record used in UX form action record need to be re-created in ‘HRSD Configurable Workspace’ scope, if needed. For the UI action ensure to have Workspace Form Button or Workspace Form Menu set to true to reflect as a button or menu respectively.
All the form templates created in ‘Human Resources: Workspace’ scope need to be re-created in ‘HRSD Configurable Workspace’ scope.
All the response templates created in ‘Human Resources: Workspace’ scope need to be re-created in ‘HRSD Configurable Workspace’ scope.
Fulfillment instructions migration
All the fulfillment instructions created in ‘Human Resources: Workspace’ scope need to be re-created in ‘HRSD Configurable Workspace’ scope.
On the environment having both classic and WEP HR workspace installed, one of below cases is applicable to identify the table to identify the playbook card configuration (fields to be rendered, field values, access to the attachments):
Playbook card configuration (for both classic & WEP HR workspace) will continue to pick from the `sn_hr_ws_card_config` table (Module: HR Playbook Card Configuration).
This is because the system property `sn_hr_le.use_classic_playbook_card_config` is set to 'false' OOB.
If the system property is changed to 'true', the playbook card configuration (for both classic & WEP HR workspace) will pick from the `sn_hr_agent_ws_playbook_card_config` table (Module: UIB HR Playbook Card Configuration).
Note: Any customization records in the `sn_hr_ws_card_config` will not be available by default in the `sn_hr_agent_ws_playbook_card_config`. So, ensure all required changes are made on the later table before switching the system property to true.
Starting from San Diego version, the following system properties are moved to the HR LE (Lifecycle Events) scope, so any customizations done with them should be manually recreated to the new properties as well:
- sn_hr_ws.playbook_state_mapping ----> sn_hr_le.playbook_state_mapping
- sn_hr_ws.exclude_activity_types -----> sn_hr_le.exclude_activity_types
This section outlines step-by-step procedures for migrating list menus from HR Classic Workspace to HR WEP workspace.
To create a list category in HR WEP workspace we need to insert a new record in sys_ux_list_category table which is similar to the classic list category
table (sys_aw_list_category).
To migrate all list menu categories, create a record in table sys_ux_list_category corresponding to each record in table sys_aw_list_category.
Steps:
- Create a new record in table sys_ux_list_category.
- Specify the Title, Order and Description for the category as needed for the menu. These fields are same in classic sys_aw_list records.
- Select the 'Configuration' field as 'HRSD Configurable Workspace List Menu Config' (which is the list menu configuration record for HR WEP workspace).
Create lists within a category
For creating a list within a category, we need to create a new record in sys_ux_list table which is similar to the classic list table (sys_aw_list).
To migrate all the lists, create a record in table sys_ux_list corresponding to each record in table sys_aw_list.
Steps:
- Create a new record in the table sys_ux_list. (List Category created in Step 1 will have a related list below to add UX Lists to that category. Click on the New button on the
- related list.)
- Configure the fields like Title, Order, Category, Table, Columns etc. which are same in classic sys_aw_list records.
- Select the 'Configuration' field as 'HRSD Configurable Workspace List Menu Config'.
- Use 'List Feature Flags' for adding any UI customizations specific to the list. Example - 'Hide Header Count Badge' flag can be used to hide the count of records shown at the list header. (This is a new configuration, will not have any impact on existing customers).
In classic workspace, roles were configured for every list using the 'Roles' column in sys_aw_list table. This configuration is different in case of WEP
workspace. Please follow the below steps to add roles to lists in HR WEP workspace.
Steps:
- Create an audience for the list by creating a new record in sys_ux_applicability table. Specify the name of the audience and the roles. Multiple roles can be added in one audience record.
- Create a new record in table sys_ux_applicability_m2m_list to create a mapping between the list and the audience created above to apply the audience roles to a specific list.
- Configure the 'List' reference field with the appropriate list record (sys_ux_list) and' Applicability' reference field with the desired audience record (sys_ux_applicability).
Note: There is no change in the My Lists section on List Page.
This concludes the migration instructions for classic HR Agent Workspace to new HR Agent Workspace.
@Jamsheer1 - yes, if you are using the new UIB Workspace (Agent Workspace for HR Case Management) you can update this in UI Builder. See the below screenshot.
@Susan Britt Thanks for your response. Yes we are using UIB but I was looking for Case Creation Contact Card which is coming from a Script Include as shown below.
Hi very good post about the Agent workspace, But I am not able to figure out how to change the list title when clicked on once of the cards on the main page.
@Susan Britt Can you please guide me through this ?
Thanks
UI Actions not showing in Configurable workspace. Need to enable this in UI Actions. Once this is enabled it will show the Ui Action in Configurable Workspace.
