Certain aspects about the Benefits & Services card can be changed so it displays according to a company’s preferences. Many of the services that ship with the Equus Platform require configuration in order to display in the MEE. They must also be configured to display key information from the service.
Select the Benefits & Services tab from the Portal Configuration screen to display the Portal Services Configuration screen.
The Portal Services Configuration grid lists the services that can be configured on the Benefits & Services card in the MEE.
The following columns display:
Screen Group- Displays the Service Configuration screen, which allows the service and its details to be edited.
Sequence - The order in which the service is listed on the Benefits & Services card in the MEE.
Enter a new number to indicate the order in which the service will appear on the Benefits & Services card. Services display in ascending order on the card.
If left blank, a 1 will be automatically assigned to the service, and all subsequent services will be renumbered to account for the new number 1 service.
If a duplicate sequence number is entered, the duplicate service will be renumbered with the next higher number, and all subsequent services will be renumbered to account for the duplicate service.
Service Group - The system name of the service.
Portal Service Display Name - The name that displays on the Benefits & Services card in the MEE.
Icon - The image that displays next to the service on the Benefits & Services card in the MEE.
Display on Card - Indicates whether the service displays on the Benefits & Services card when that service is authorized for the employee. The (eyeball icon) indicates that the service displays. The (crossed eyeball) indicates the service does not display. Clicking the (eyeball icon) will toggle the service between displaying and not displaying.
After updating Sequence or Display on Card, click
to save the changes.
Service Configuration – [Service Name]
The Service Configuration – [Service Name] screen is displayed when the
is clicked for a row in the Portal Services Configuration screen. Use this screen to edit all of the information about the selected service. The service being edited appears in the title of the screen.
Appearance
The Appearance section of the screen is used to edit how the service displays on the card.
Sequence - Enter a new number to indicate the sequence the service will appear on the [Benefits & Services] card.
Portal Service Display Name - Enter a new name to change the name of the service that is displayed on the Benefits & Services card in the MEE.
Icon - Click the drop-down arrow to display the full list of icons, and select the image to display.
To filter the list after displaying the choice list, enter a word or phrase, and the list will display only those icons that match the word or phrase entered.
Display on Card - Check the check box to indicate the service will display on the Benefits & Services This works like the (eyeball icon) in the Portal Services Configuration grid.
Click
to save the changes. Click
to close the Service Configuration – [Service Name] window and return to the Portal Services Configuration screen.
Details
This section of the screen is used to change the information about the Service Details window, which is displayed when an individual service is selected on the Benefits & Services card in the MEE.
User Report – This is a type-ahead search drop-down and with an added link to the selected user report. Identifies the System User Report that populates the Benefits & Services Service Details window. Some of the services already reference Equus-provided user reports. If desired, the user report can be copied and modified to display other information if needed, or another user report can be specified to change the desired outcome.
When no user report is identified, the Key Information, Documents, and Contacts will not display in the Service Details window. If a user report is identified, but it returns no records, only Documents and Contacts will display in the Service Details window (no key details).
See below for additional information about developing the user report.
Resource
This section of the screen is configure the priority of the contacts that should be displayed on the selected service’s Benefits & Services card.
The Service Contact Types are as follows:
Assignment Coordinator: The resource identified as the Relocation/Assignment Coordinator on the Relocation/Assignment Details
Service Agent: The resource identified as the Service Agent on the Service Order screen. Note that some Service Order Types may have this field hidden.
Service Coordinator: The resource identified for an individual service record. For example, the Temporary Living Coordinator found on the Temporary Living Details Not all services support Service Coordinator.
Service Order Coordinator: The resource identified as the Service Order Coordinator on the Service Order screen.
Vendor Contact: The resource identified as the Vendor Contact on the Service Order screen.
Accounting Coordinator: The resource identified as the Accounting Coordinator on the Relocation/Assignment Details
Policy Services Coordinator: The resource identified as the Coordinator on the Assignment Services The service must be an authorized service within the policy.
Priority – Determines the order in which the contacts will display for a specific Benefits & Services card. Only one contact will display on each card. Setting a Service Contact Type’s Priority to number one (<1>) indicates that this is the first contact that should be displayed on the card. If this resource is not available (e.g., the resource has not yet been assigned to the employee), the contact with the next highest Priority will be displayed on the card.
A contact can be configured to never display on the card by choosing the <Never Display> option. If all contacts are set to a Priority of <Never Display>, the Contacts section will not show on the card.
Click [Save] to save the changes. Click [Close] to close the Service Configuration – [Service Name] window and return to the Portal Services Configuration screen.
Additional information about developing the User Report
The user report identified for a service must be an active System User Report that contains the following data fields to be properly read by the Service Details window. Each user report must have a User Report Type that correlates the service to the corresponding base table in order for the reports to show the correct information on the screen.
On the user report, the ID from the base table of the report type must be set equal to the ROW_ID field in the fields section. It is imperative that the correct base table is used in the user report type or incorrect information could display on the card. The ROW_ID field determines the Status, Details, Contacts, and Documents that show on the card. Below is a list of the various services and their corresponding base tables that can be referenced for creating User Report Types.
Service
|
Base Table
|
Appliances
|
APPLIANCE
|
Assessment, Orientation & Training
|
TRAINING
|
Car Loss On Sale
|
CAR_LOSS_ON_SALE
|
Contract
|
CONTRACT
|
Cost of Living
|
COST_OF_LIVING
|
Destination Appraisal
|
DESTINATION_APPRAISAL
|
Destination Buyer
|
DESTINATION_BUYER
|
Destination Buyer
|
DESTINATION_BUYER_SERVICE
|
Destination Renter
|
DESTINATION_RENTER
|
Emergency Leave
|
EMERGENCY_LEAVE
|
EnRoute Trip
|
EN_ROUTE_TRIP
|
Family Visit
|
FAMILY_VISIT
|
Furniture
|
FURNITURE
|
Home Country Home Sale
|
HOME_COUNTRY_HOME_SALE
|
Home Country Lease Termination
|
LEASE_TERMINATION
|
Home Country Storage
|
HOME_COUNTRY_STORAGE
|
Home Leave
|
HOME_LEAVE
|
Host Country Housing Rental
|
HOST_COUNTRY_HOME_RENTAL
|
Host Country Leased Cars
|
CAR_LEASE
|
Insurance
|
ASSIGNMENT_INSURANCE_EXAM_IMMUNIZATION
|
Interview Trip
|
INTERVIEW_TRIP
|
Leasehold Improvements
|
LEASEHOLD_IMPROVEMENT
|
Mail Service
|
MAIL_SERVICE
|
Mobility Premium
|
MOBILITY_PREMIUM
|
Mortgage Interest Differential
|
MORTGAGE_INTEREST_DIFFERENTIAL
|
Move Management
|
MOVE_MANAGEMENT
|
New Home Mortgage
|
NEW_HOME_MORTGAGE
|
Pre-Move Visit
|
PRE_MOVE_TRIP
|
Property Information
|
PROPERTY
|
Property Management
|
PROPERTY_MANAGEMENT
|
Relocation Allowance
|
RELO_ALLOWANCE
|
Repat Job Search Trip
|
REPAT_JOB_SEARCH_TRIP
|
Repat Location Visit
|
REPAT_LOCATION_VISIT
|
Repat Trip
|
REPAT_TRIP
|
Repatriation Allowance
|
REPAT_ALLOWANCE
|
RR Trip
|
RR_TRIP
|
Social Insurance Tax
|
TAX_SOCIAL_INSURANCE
|
Spousal/Family Assistance
|
SPOUSAL_FAMILY_ASSISTANCE
|
Tax
|
TAX_DETAIL
|
Tax Assistance
|
TAXCALC_ASSIGNMENT
|
Tax Equalization
|
TAX_EQUALIZATION
|
Temporary Living
|
TEMP_LIVING_DETAIL
|
Visas and Work Permits
|
ASSIGNMENT_VISA
|
The data fields in the table below must be visible on the user report (i.e., Hide is false for the field). Additional data fields may be included on the user report, but they will have no impact on the Service Details window.
Column Caption
|
Notes
|
ITEM_KEY_DETAILS
|
Used by the Service Details window to populate the key information displayed for each service record.
While this is not required, no key information will display in the Service Details window if this is missing.
|
ROW_ID
|
Used by the Service Details window to determine where the Documents, Contacts, Statuses, and Details information is for that service. Set equal to the base table’s Primary ID for the service to which the user report applies.
|
The user report must also include a filter for Assignment ID that is identified as a Prompt filter, which is needed to display the correct assignment to the employee. Do not include more than one prompted parameter. See below for an example of a User Report.
The MEE ships with the following user reports, which display for the following benefits and services. These can be changed to be a different user report if desired.
Benefit/Service
|
User Report
|
User Report Type
|
Host Country Housing Rental
|
Equus Portal - Host Country Housing Details
|
Equus – Host Country Housing Details
|
Temporary Living
|
Equus Portal - Temporary Living Details
|
Equus - Temporary Living Details
|
Assessment, Orientation and Training
|
Equus Portal - Assessment, Orientation & Training Details
|
Equus - Assessment, Orientation & Training Details
|
Immigration
|
Equus Portal – Immigration Details
|
Equus – Immigration Details
|
Move Management
|
Equus Portal – Move Management Details
|
Equus – Move Management Details
|
Social Insurance
|
Equus Portal – Social Insurance Details
|
Equus – Social Insurance Details
|
Tax
|
Equus Portal – Tax Details
|
Equus – Tax Details
|
Tax Equalization
|
Equus Portal – Tax Equalization Details
|
Equus Portal – Tax Equalization Details
|
To view the details of the User Report change the configuration search to search for User Reports. Enter the name of the user report and click on the result to open the user report.
To view the details of the User Report Type, click on the link of the User Report Type.
You will see the related Portal Services Configuration record page in the Reference section.
