SP Admin Workplace Customizations

  • Release version: Washingtondc
  • Updated February 18, 2024
  • 2 minutes to read

    • Add customizations by including KPIs with duplicated landing page default variants.

    Before you begin

    Role required: sn_sp_admin_ws.admin

    Procedure

    1. Navigate to All > HR Service Delivery > SP Admin Workspace.
    2. Locate duplicated variant in UI builder.
      Note:
      For any modifications on Landing Page or Client Detail Default Variants you must duplicate the variants and update the order.
    3. Select one of the KPI containers.
    4. Select Services Per Customer.
    5. Select the ellipsis (three dots) and select duplicate.
      Note:
      Container, KPI and Buttoncomponents are created.
    6. Locate the duplicated button component preset and update it to none.
    7. Select required Data Sources, Group by and Metric Properties for KPI.
    8. Create the client state variable datForShowAllModalCustom JSON type.
    9. Select and duplicate the Show ALL KPI Values modal.
      Note:
      For duplicated indicator scorecard update the following properties: @state.dataForShowAllModalCustom.indicators, and @state.dataForShowAllModalCustom.breakdowns. Don’t modify the main Show All Indicator Scorecardcomponent.
    10. Next, configure the following events for duplicated Show all button.
    11. Select the Update Client State parameter and set the mode to script.
    12. Paste the following script with the appropriate values: 
      
/**
        * @param {params} params
        * @param {api} params.api
        * @param {any} params.event
        */
        function evaluateEvent({
            api,
            event
        }) {
            return {
                propName: "dataForShowAllModalCustom",
                value: {
                    "label": ""//Heading,
                    "indicators": [{
                        "id": ""//Indicator ID,
                        "label": ""//Indicator Label
                    }],
                    "breakdowns": [{
                        "breakdownId": ""//Breakdown ID,
                        "breakdownLabel": ""//Breakdown Label,
                        "elementIds": [],
                        "perPage": "ALL"
                    }]
                }
            };
        }
    13. Select Open or close modal dialog event and enable O pen modal dialog.
    14. Select duplicated Modal and select Save.

    To add new Trend to duplicated Landing Page Default variant.

    1. Navigate to indicator group in navigator.
    2. Open the SP admin landing page KPI record and add the indicator in the indicator related list.
      Note:
      Selection will automatically appear in Trends in workspace.

    To add KPI to duplicated Client Page Default variant.

    1. Navigate to script includes.
    2. Open MSPUtil record.
    3. Add a function within the script shown here: 
      
fetchIndicatorsWithBreakDowns: function() {
          return {
               "INDICATOR_KEY_NAME": {
                    "id": '', //Indicator ID
                    "label": '',//Label to shown in Trend
                    "breakdown": '',//Indicator breakdown
                    "domainBreakdownId": ''//Domain Breakdown within selected indicator
               }
          }
     }
    4. Use an object in the fetchIndicatorsWithBreakDowns function to get OOB Trends. 
       
{
          "casesPerServices": {
               id: '60450b1e53da3110d959ddeeff7b1213',
               label: 'Cases per services',
               state: 'casesPerServices',
               breakdown: 'a868c712531e3110d959ddeeff7b1225',
               domainBreakdownId: '0095cf1e53da3110d959ddeeff7b122f'
          },
          "breachedSLAs": {
               id: '8c61139a531e3110d959ddeeff7b12b5',
               label: 'Breached SLAs',
               state: 'breachedSLAs',
               breakdown: 'f5421fda531e3110d959ddeeff7b124a',
               domainBreakdownId: '6ba2133353ba7110d959ddeeff7b123a'
          }
     }
    5. Navigate to the duplicated client detail page default variant in UI builder.
    6. Select KPIs Section Container.
    7. Add a KPI using Data Visualization component.
    8. Select the required Data Sources, Group By and Metric properties for the KPI using the following data binding:
      Properties Indicator Key
      Data Sources @data.msp_client_page.kpiBreakdowns.INDICATOR_KEY_NAME.dataSources
      Metric Label @data.msp_client_page.kpiBreakdowns.INDICATOR_KEY_NAME.metrics
      Group By @data.msp_client_page.kpiBreakdowns.INDICATOR_KEY_NAME.groupBy
      Note:
      The INDICATOR_KEY_NAME key should match with the key given in the MSPUtil script.

    To add Trend in both duplicated Client Details Default variants.

    1. Navigate to indicator group in navigator.
    2. Open SP admin client page KPI record.
    3. Add an indicator in the indicator related list.
      Note:
      Selection will automatically appear in Trends in workspace. However, make sure that the indicator you added has a domain breakdown.

    HR Services.

    1. Navigate to HR Services for a role validation check.
    2. If HR Services is available to MSP users, create a Read ACL in the HR service table.
    3. Add sn_sp_admin_ws.admin role to the table.
      Note:
      To see the KPI and Trends across all domains in the workspace dashboard, MSP admin must be in the global domain.

    Troubleshooting.

    1. Navigate to a duplicated Client Detail Default variant macro component file.
    2. Check the propertyValues for cases_per_service and the breached_sla.
    3. Validate that the components don't have the key value pair scoreType:null.
      Note:
      When any file has a key value of scoreType:null, remove it and update the file.