Designing and Using Custom Lookup Tables and User Interfaces

Objective

After completing this lesson, you will be able to create MDF object lookup tables and user interfaces.

Introduction to Custom Metadata Framework (MDF) Object Lookup Tables

A custom MDF object lookup table in SAP SuccessFactors is a specialized data structure built using the Metadata Framework (MDF). It is a powerful tool for storing predefined values and combinations. It functions as a reference table, simplifying complex business rules by providing a structured way to retrieve specific information based on defined conditions. Think of it like a dictionary or a cheat sheet for your system, providing quick access to specific information without needing to scan through large datasets repeatedly. Each row in the table represents a unique combination of conditions and associated output values.

Benefits of using a lookup table:

  • Reduced Complexity: Instead of creating numerous complex If/Else statements within business rules, you can simplify them by leveraging lookup tables to store valid combinations and retrieve the appropriate values based on the lookup conditions.
  • Enhanced Data Consistency: By providing a structured way to link related information, lookup tables help ensure the accuracy and reliability of your data by maintaining consistency across different fields and rules.
  • Easier Maintenance: Lookup tables are simpler to maintain than updating numerous business rules when values change or new ones are introduced.
  • Greater Flexibility: You can reuse lookup tables across multiple business rules, reducing duplication and improving maintainability.
Screen shows the configuration details and field list for a custom object used as a lookup table object named Employee Referral Bonus Lookup Table.

Example use case: Employee Referral Bonus (ERP) Lookup Table

Lookup tables can be extremely valuable for automating and streamlining various processes when used with business rules.  Let's say you need to automate Employee Referral Bonus (ERP) calculations based on job function and country. You could create a custom MDF object (for example, ERPLookupTable) with the following fields:

  • Job Function: Engineer, Manager Specialist
  • Country: United States, Mexico, Canada
  • ERP Amount: 1000, 750, 500 

Create a Custom MDF Object Lookup Table

Steps

  1. Navigate to Admin CenterConfigure Object Definitions.

  2. Select Create NewObject Definition.

  3. Enter a code and label. For example, ERPLookupTable.

  4. Set Status to Active. (Inactive objects are ignored.)

  5. Define Fields: In the Fields section, create custom fields for the different condition values that should be part of your lookup table.

    1. Create one field for each condition. If you want to reference an existing Metadata Framework object in your lookup, select Details to add details for the fields you've just created.

      • As Data Type, enter the data type of the Metadata Framework object you want to reference.
      • As Valid Values Source, enter the external code of the Metadata Framework object you want to reference.
  6. Save your changes.

    If your lookup table needs to retrieve multiple pieces of related information in a business rule, consider using a parent-child relationship within your MDF object.

    In this design:

    • The parent object holds the main information.
    • The child object contains the detailed data you want to access.

    When creating the business rule, you can perform a lookup to find the child object and store it in a variable. This enables you to use the child object's fields directly within your rule for more precise data retrieval.

    Additionally, setting up a 1-to-many (1:n) parent-child relationship provides a table-like interface for entering multiple related values, streamlining data entry and improving usability.

Populate a Lookup Table

Steps

  1. Navigate to Admin CenterManage Data.

  2. Select the Create New dropdown, locate the custom ERPLookup Table.

  3. Enter data for all the necessary combinations, for example:

    • Engineer, US, 1000
    • Manager, US, 1200
    • Engineer, CA, 500

Result

A lookup table has been populated using Manage Data.

Screen displays the creation Employee Referral Bonus Lookup Table data, including the external code, external name, effective date, Function, Job Level, Country of Job and ERP amount fields.

Custom User Interfaces (UIs) for MDF Object Lookup Table

In SAP SuccessFactors, a Custom User Interface (UI) for Metadata Framework (MDF) objects allows you to design and tailor the look and feel of how custom data objects are displayed and interacted in the system. Essentially, it's a way to create a user-friendly and company-specific experience for managing data stored in custom MDF objects.

Benefits of Custom UIs

  • Tailored Experience: Create interfaces that match the company's branding and specific data input/output needs.
  • Improved User Experience: Organize fields logically, use custom labels, and define the flow of information for better usability.
  • Flexibility and Adaptability: Modify UIs as business needs evolve, without relying on technical development.

Design a Custom UI Using Manage Configuration UI

Before you can create a UI, you need to define the custom object itself using the Configure Object Definitions tool. Once your object definition is ready, you can create the custom UI for the object, allowing for a greater user experience when creating the object data in Manage Data.

Steps

  1. Navigate to Admin CenterManage Configuration UI.

  2. Select Create New UI.

  3. Use the Select Base Object dropdown to choose the custom MDF object (ERPLookupTable).

  4. Arrange Fields: Use the drag-and-drop interface to arrange fields into sections or groups.

    • Customize section titles, labels, and display options.
    • Change the layout (for example, form, flow, grid).
    • Set field visibility (visible or hidden).
  5. Modify individual field properties:

    • Override field labels, change label visibility and visibility.
    • Change if a field is required or editable.
    • Change how the field is displayed, and change field to a Rich Text Editor field (RTE).
    • Apply onChange UI rules for greater customization.
  6. Save the configuration and test the custom UI to ensure it behaves as expected.

    Displayed is the Manage Configuration UI screen for Employee Referral Bonus Lookup object, displaying the object fields and the ability to edit field characteristics.

    Note

    You may need to refresh the UI or re-select the base object in Manage Configuration UI to see changes reflected after saving.

    Using custom objects for business rules extends efficiency throughout the SAP SuccessFactors Recruiting solution, offering simple solutions to complex requirements. In SAP SuccessFactors, while the use of a standard business rule supports basic automation, a business rule using a lookup table provides easier maintenance, as data can be maintained through Manage Data without requiring changes to the rule itself. Custom objects used as lookup tables also provide reusability, where a single lookup table can be reused across business rules and even across solutions.

    Finally, the use of business rules and lookup tables can significantly increase performance. Where a standard business rule, with many IF/THEN/ELSE statements, may affect performance, a business rule using a lookup table offers better system performance as the rule itself is simple and reduces processing needs.

Summary

  • Create custom MDF object lookup tables to simplify complex business rules by storing predefined values and combinations.
  • Leverage the benefits of lookup tables, including reduced complexity, enhanced data consistency, easier maintenance, and greater flexibility.
  • Design and implemented custom user interfaces for MDF objects to improve the user experience and tailor the look and feel of data management within SAP SuccessFactors.
  • Utilize the Manage Configuration UI tool to create and customize the layout, fields, and properties of the custom UI.