You are on page 1of 47

December 7, 2016 (UltiPro v12.1.

2)

Platform Configuration Guide

1212GUIDE12072016
This document is for Ultimate Software use only. No part of this document may be reproduced in any form or by any means or stored in a database or
retrieval system without the prior written authorization of The Ultimate Software Group, Inc. Information in this document is subject to change without
notice. The document is confidential information of The Ultimate Software Group, Inc. and may not be disseminated to any third party. Nothing herein
constitutes legal advice, tax advice, or any other advice.
© 2016 The Ultimate Software Group, Inc. UltiPro® is a registered trademark of The Ultimate Software Group, Inc.
All other company and product names referenced herein are the trademarks or registered trademarks of their respective holders.
Liability/Disclaimer
The Ultimate Software Group, Inc. makes no representation or warranties with respect to the accuracy or completeness of the document and specifically
disclaims any responsibility or representation for other vendor’s software. The terms and conditions of the license, Intersourcing, SaaS, or other
agreement regarding the software or services provided by Ultimate Software, which is the subject of the documentation contained herein, govern this
document. All company, organization, person, and event references are fictional. Any resemblance to actual companies, organizations, persons, and
events is entirely coincidental. Nothing herein should be considered legal or tax advice. All legal or tax questions or concerns should be directed to your
legal counsel or tax consultant.
Platform Configuration December 7, 2016 (UltiPro v12.1.2)

Table of Contents
Platform Configuration
Platform Configuration Overview ...................................................................................................................... 4
Provide Access to Platform Configuration ......................................................................................................... 4
UltiPro Classes and Fields .................................................................................................................................. 5
Supported Pages ................................................................................................................................................. 5
Auditing and Reporting ...................................................................................................................................... 6
Platform Configuration Process Overview ......................................................................................................... 7
Create a Field
Step 1 - Create a Field ........................................................................................................................................ 8
Identify the Class to Use .................................................................................................................................... 8
Class Editor Sections .......................................................................................................................................... 10
Field Creation ..................................................................................................................................................... 12
Fields with a Business Rule Type ...................................................................................................................... 14
Field Security Policies ........................................................................................................................................ 15
Calculated Fields Overview ............................................................................................................................... 17
Creating a Rule Expression ................................................................................................................................ 19
Update the Data Service
Step 2 - Update the Data Service........................................................................................................................ 22
Data Services Editor - Selected Fields ............................................................................................................... 23
Place the Fields on a Page
Step 3 - Place the Fields on a Page ..................................................................................................................... 25
Page Editor Overview ........................................................................................................................................ 25
View and Edit Modes ......................................................................................................................................... 26
Types of Pages ................................................................................................................................................... 27
Page Editor Tabs ................................................................................................................................................ 28
Visibility Rules ................................................................................................................................................... 30
Manage Properties for a Page ............................................................................................................................. 32
Export and Import Configurations
Export and Import Overview .............................................................................................................................. 38
Export a Configuration ....................................................................................................................................... 38
Import a Configuration ....................................................................................................................................... 38
Manage Labels
Manage UltiPro Labels ....................................................................................................................................... 40
Manage UlttPro Labels with In-Page Edit.......................................................................................................... 41
Create Value Rules
Value Rules Overview ....................................................................................................................................... 43
Add or Change Value Rules ............................................................................................................................... 44
Add or Change Value Sets for a Value Rule ...................................................................................................... 46
Platform Configuration December 7, 2016 (UltiPro v12.1.2)

Platform Configuration

Platform Configuration Overview


Platform Configuration is powerful feature that enables to you to configure many UltiPro pages to meet your
unique organizational needs. Using the Platform Configuration feature, you can add new fields, edit existing
field labels, and even change the layout of common UltiPro pages. As your business evolves, you can
reconfigure UltiPro over time without incurring additional cost.

As a system administrator, you can complete the following tasks in Platform Configuration:
 Configure existing UltiPro pages to meet your organizational needs by adding new fields.
 Hide or show fields based on specific criteria.
 Apply security policies to fields for different roles.
 Configure rules to pre-populate fields in commonly used work events based on the data from other fields.
 Change labels to reflect your organization’s preferences.

Provide Access to Platform Configuration


The Platform Configuration feature is delivered with all permissions disabled. To access Platform Configuration,
system administrators must enable permissions via Web Access Rights for applicable roles (Menu > System
Configuration > Security > Role Administration > select a role > Web Access Rights).

4
December 7, 2016 (UltiPro v12.1.2) Platform Configuration

UltiPro Classes and Fields


The UltiPro Domain Model is a blueprint for how UltiPro organizes your data. Every element of stored data
adheres to rules and relates to other data. The UltiPro Domain Model is a complete description of those rules and
relationships.

Certain related types of data called fields are organized into container templates called classes. For example, the
fields Primary Name, Gender, and Date of Birth belong to the Person class. Each Field has its own specific
value.

Platform Configuration exposes UltiPro’s classes through a Web interface enabling you to add new fields to the
existing UltiPro classes. The Person class can be extended to include a Nickname field so that employee
nicknames can be entered into UltiPro, if desired.
Class Field Value

Person Primary Name Jeri Abella


Gender Female

Date of Birth 06/08/1972

New Field: Nickname Jer

Supported Pages
Platform Configuration enables you to add new fields to over 50 different UltiPro pages. Some pages are fully
configurable; you can edit the layout of the entire page and add new fields to almost any section of the page.
Other pages are partially configurable; you can add new sections and fields to the foot of the page, but cannot
edit the delivered sections and fields.
Employee Pages You Can Configure Fully Configurable?

Add Employee (Hire/Rehire) work event: Yes


 Start page
 Personal page
 Jobs/Payroll page
 Dates page
Termination Information Yes
Terminate Employee
Name, Address, and Telephone Yes
Change Name, Address and Telephone
Private Information Yes
Change Private Information
Add/Change Contacts No

Add/Change Company Property No

Status and Key Dates Yes


Change Status and Key Dates

5
Platform Configuration December 7, 2016 (UltiPro v12.1.2)

Employee Pages You Can Configure Fully Configurable?

Job Summary Yes


Change Job
Add or Change Secondary Job Yes

Change Salary No

Change Job and Salary work event:


 Change Job page  Change Job page - Yes
 Change Salary page  Change Salary page - No
Job History No
Change Job History

Contract/Change Contract No

Compensation Summary - Employee's View Yes

Compensation Summary - Manager's View Yes


Organization/Change Organization Yes

Add Global Employee work event: Yes


 Employee Information page
 Job/Compensation page
Add/Change Global Bank Account No

Other Country Information pages for over 20 countries Yes

Business Rule Pages You Can Configure Fully Configurable?

Add/Change Location page No

Add/Change Jobs work event: No


 Main page
 Job Details page
Add/Change Organization Level page (Levels 1 No
through 4)

Auditing and Reporting


All changes made to configured fields on employee pages can be tracked on the employee’s Audit page (Menu >
My Team > My Employees > select an employee > Audit or Menu > Administration > Employee Admin > My
Employees > select an employee > Audit).

Additionally, you can report on the data entered in configured fields in Business Intelligence. To view the steps
on how to add configured fields to Business Intelligence reports, view the UltiEasy QuickTips, Reporting on
Configurable Fields in UltiPro Using Business Intelligence.

6
December 7, 2016 (UltiPro v12.1.2) Platform Configuration

Note:
You cannot report on any calculated fields in Business Intelligence.

Platform Configuration Process Overview


The steps required for creating a new field appear on the Platform Configuration page (Menu > System
Configuration > Platform Configuration) for reference.

Step 1 – Create a field

Determine which class most closely relates to the type of field, and then create the new field in that class.

For example, new fields related to termination can be added to the Employment class because these fields collect
data about employment status.

Step 2 – Update the data service

After creating the field, but before adding the field to a supported page, update the page’s data service. Data
services link classes with supported pages.

For example, before adding a newly created field to the Termination Information page, you must update the
Termination Information page’s data service.

Step 3 – Place the fields on a page

Finally, place your field on the supported UltiPro page. You can add new sections to the page and edit the layout
of your newly added page elements.

In addition to adding fields to a page, you can define policies that specify how the field behaves and when to
include it on the page.

7
Create a Field December 7, 2016 (UltiPro v12.1.2)

Create a Field

Step 1 - Create a Field


The first step in the Platform Configuration process is to add a new field to an existing UltiPro class. Begin by
selecting Classes from the menu bar.

Identify the Class to Use


There are essentially two types of classes: employee-related classes and company-related classes.

Company-Related Classes

To collect, capture, or display data specific to your company, jobs, locations, or organization levels, add the
fields to one of the following company-related classes:
 Component Company
 Job
 Location
 Master Company
 Organization Level 1
 Organization Level 2
 Organization Level 3
 Organization Level 4

8
December 7, 2016 (UltiPro v12.1.2) Create a Field

Employee-Related Classes

To collect, calculate, or display employee-specific data on one of the supported employee pages, add fields to
one of the following employee-related classes:
 Employee
 Employment
 Employment History
 Employee Multiple Jobs
 Employee Health Care Eligibility Group
 Contacts
 Work Permit
 Contract*
 Employee Property*
 Global Bank Account*
*To add fields to the following pages, you must add fields to the following classes:
Page Name Class Name

Add/Change Global Bank Account Global Bank Account


Add/Change Employee Property Employee Property

Add/Change Contract Contract


Best Practice:
When you need to capture employee-specific information on one of the employee pages, we recommend
adding fields to the Employee or Employment classes when possible. Often, you will find that you do not
need to use the Person, Person Name, International Employee, Address, or Phone Number classes.

Note:
Fields created in the Employment class are created in the Employment History class automatically.
However, security policy configurations on the fields are not carried over from the Employment class and
must be configured separately.

9
Create a Field December 7, 2016 (UltiPro v12.1.2)

Class Editor Sections


When you select a class from the Classes page, the Class Editor appears. To navigate to the sections of the Class
Editor, use the links at the top of the Class Editor or scroll down the page.

Basic Details

The Basic Details section provides the class name and description. Changing the values here changes the way the
class information is displayed in Platform Configuration only.

Configured Fields

The Configured Fields section is where you create and maintain new fields. There are two types of fields you can
add to this section - Fields and Calculated Fields.

10
December 7, 2016 (UltiPro v12.1.2) Create a Field

Standard Fields

The Standard Fields section displays all standard fields and user-defined fields that are delivered in the class.
You can add these standard fields to any of the supported pages. Select the Field Name or the Edit button to
change the labels of the standard fields that you place on a supported page.

Note:
When you change a standard field's label, the edited field label appears only when you manually add the
field to one of the supported pages. On the pages delivered with the standard field, the original field label
is retained, regardless of the label changes you make in the standard field editor.
To edit a field label for a standard field delivered on an UltiPro page, use the Labels feature of Platform
Configuration.

Advanced Settings

The Advanced Settings section displays whether the class is employee-owned. For example, the Employee and
Employment History classes are owned by the employee, but the Organization Levels, Master Company, and
Component Company classes are not. These classes support concepts related to the company.

Configured fields in classes owned by the employee (for example, Employee, Employment, Contacts) can be
enabled to be editable on employee-related pages only. Configured fields in classes not owned by the employee
(for example, Jobs, Component Company, or Locations) can be enabled to be edited on the business rules pages
only.

11
Create a Field December 7, 2016 (UltiPro v12.1.2)

Standard Relationships

The Standard Relationships section notes the other classes that are related to the class. UltiPro uses class
relationships to link classes together in a data service. Class relationships are important when updating a page's
data service to include specific fields.

Security Policies

The Security Policies section enables you to provide validation rules for an entire class. When you can add your
own classes in a future release, you can secure a new class rather than each field in that class.

Field Creation
Once you determine the applicable class for your new fields, you are ready to create the fields. From the
Configured Fields section of a class, you can choose to create a Field or a Calculation.

From the Field Editor, you must enter a field name, label, and description. The label is the actual value that
appears on the UltiPro page. (When adding the field to the page, you enter the label version to use.) Version 1
contains the default label.

12
December 7, 2016 (UltiPro v12.1.2) Create a Field

You must also select a field type.

There are many field types and most are self-explanatory; however, there are a few to explain further:
 Business Rule – Use the Business Rule type to create a field based on an existing business rule in UltiPro.
 Money and US Dollar – Use Money to create a field for a monetary amount with a required currency
selector. Use US Dollar for US dollar amounts.
 Phone Number and US Phone Number – Use Phone Number to create a field for a global phone number.
Use US Phone Number for a United States phone number field.
 True/False – Use True/False to create a check box.
 Unique ID – This field is used internally by Ultimate Software. Do not use this field type.

13
Create a Field December 7, 2016 (UltiPro v12.1.2)

Fields with a Business Rule Type


To create a field based on a pre-defined list of values, you can create a field with the Business Rule type. You
can create new fields based on any business rule in UltiPro. This includes a delivered business rule or a simple
business rule that you create.

Important!
The Business Rule must be added in UltiPro before it can be used to create a field. View the Add a
Simple Business Rule tour to learn how to add your own simple business rules. This tour is located in the
Quick Tours and Tips section of the Platform Configuration page.

For example, let’s say a simple business rule was created in UltiPro to capture the competitors for the To the
Max Amusement Park company. In this case, a Theme Park Competitor business rule.

When creating the configured field in Platform Configuration, select Business Rule from the Type drop-down
list. Then, select the applicable UltiPro business rule from the Business Rule Type drop-down list.

14
December 7, 2016 (UltiPro v12.1.2) Create a Field

When the newly configured field is added to the UltiPro page, users with access to edit the field can select a
business rule value from the Which Competitor? field. Note the field name and the business rule name do not
have to match. When you create your field, you can name the field whatever makes most sense to your users. In
this example, we named the field, Which Competitor? and the field is using the Theme Park Competitor business
rule.

Field Security Policies


A field's security policies enable you to control the behavior of a field on the page. For each field, you can
determine usage rules, who can access the field, default values, and unacceptable values. Security policies can be
configured at the time of field creation or after the fields have been saved.

15
Create a Field December 7, 2016 (UltiPro v12.1.2)

Usage Rules

Usage rules determine under which data conditions a field is customarily hidden, forbidden, optional, or
required.

Note:
Customarily hidden means that the field is hidden unless certain conditions are met. However, viewing or
editing the field even if those conditions are not met does not result in a security breach.
Forbidden means that a certain group of employees cannot not view or edit the field as doing results in a
security breach.

Access Rules

Access rules determine the users who can view and update a field. You can add access rules for users in specific
roles, companies, and countries under specific data conditions.

Validation Rules

Validation rules determine unacceptable values for a field. If an unacceptable value is entered for a field, the
page cannot be saved until the user corrects the value.

16
December 7, 2016 (UltiPro v12.1.2) Create a Field

Default Values

Default value rules enable you to enter default values for configured fields.

Note:
To enter a default value for a system-delivered field on a fully configurable page, use the Rules feature of
Platform Configuration.

Calculated Fields Overview


Calculated fields use a rule expression to perform simple or complex data calculations. Calculated fields can be
added to any of the supported pages in a read-only state. You cannot add security policies to calculated fields.

Calculated fields can be composed of operands and operators, though some expressions are simply text
constants, numeric constants, or variables.

The Calculated Field Editor contains fields for the name, label, and description. It also provides limited field
types and a link to create the calculation formula. Because calculated fields cannot be secured, a Security
Policies section does not appear.

Create Formulas Using the Calculation Editor

When you select Create Formula, the Calculation Editor appears. The Calculation Editor enables you to build the
formulas for the calculation by assigning operands and operators. By default, you have a left operand and a right
operand, which is important to identify as there may be times when you want to remove one or the other.

17
Create a Field December 7, 2016 (UltiPro v12.1.2)

Select the operands and operator to configure the calculation.

Operand Options

When editing an operand, you can select to edit a variable, change the operand to a text, date, or true/false
constant, or enclose within operation. Enclose Within Operation adds parentheses to create a sub expression.

After you select an option, the second drop-down list updates automatically so you can configure the operand
further. As an example, selecting Edit Variable enables you to select the applicable variable (the field in the class
that contains the value for the calculation). Selecting Change to Text Constant enables you to enter the text of
your choice as the operand.

Note:
When Edit Variable is selected, the second drop-down list contains all standard and configured fields in
the class. Standard fields are listed alphabetically by field name first. Configured fields are listed
alphabetically by field name at the bottom of the list. You can also search for the field name.

After the fields are completed, select OK. The operand is displayed in the formula.

Operator Options

Selecting an operator, you can choose to:


 Edit the operator.
 Remove the operator while keeping the left or right operand.
 Change the operator to a text, numeric, date, or true/false constant.
 Change the operator to a variable.
 Enclose within operation.

18
December 7, 2016 (UltiPro v12.1.2) Create a Field

Like operands, depending on the operator option selected from the first drop-down list, you can use the second
drop-down list to configure the operator further.

Enclose

When UltiPro performs a calculation, it uses the order of operations. The Enclose button and the enclose options
that are available when configuring operands and operators enable you to create sub expressions within your
formula.

Creating a Rule Expression


Rule expressions can express complex manipulations of UltiPro data. Expressions are typically composed of
operands and operators, though some expressions are simply text constants, numeric constants, or variables.
Operand Type Definition

Variable Variable whose value can be set to any UltiPro field


in the current class
Text constant Entered text constant

Numeric constant Entered numeric constant

Date constant Entered date constant

Operator Type Definition Valid Operand Type

and Logical and Boolean

or Logical or Boolean

not Logical not Boolean

= Equals Numeric

<> Not equal to Numeric

> Strictly greater than Numeric

>= Greater than or equal to Numeric

< Strictly less than Numeric

<= Less than or equal to Numeric

contains Contains the substring String

starts with Starts with the substring String

19
Create a Field December 7, 2016 (UltiPro v12.1.2)

Operator Type Definition Valid Operand Type

ends with Ends with the substring String

is null Is empty String

is not null Is not empty String

/ Divided by Numeric

* Multiplied by Numeric

+ Add Numeric

- Subtract Numeric

% Modulo Numeric

integer division Quotient Numeric

coalesce Return first non-empty value String

concatenate String concatenate String

substring Is a substring of String

string to number Converts string to number String

To create a rule expression:


1. For a rule, select Create Formula.
2. Select the first operand.

3. Select the operand type from the top drop-down list, or select Enclose within operation to create a
subexpression for this operand.

4. If an operand type was selected, enter or select the value in the bottom box.

5. Select OK.

20
December 7, 2016 (UltiPro v12.1.2) Create a Field

6. Select the first operator.

7. Select the top drop-down list to edit the operator, remove an operand, change the operation to a constant or
variable, or select Enclose within operation to create a subexpression in place of this operator.

8. If Edit operator was selected, select the operation from the bottom drop-down list.

9. Select OK.
10. Make selections for each unselected operand and operator.
11. Select Enclose to create a sub-expression out of the whole expression, or complete the rule expression
creation process.
Note:
Select Clear to remove an expression.

21
Update the Data Service December 7, 2016 (UltiPro v12.1.2)

Update the Data Service

Step 2 - Update the Data Service


A data service brings multiple related classes together into one cohesive entity that can be displayed on one or
more pages. There are 45 data services available, including data services for the supported business rules and the
Other Country Information pages for over 20 countries.

Once your fields are added to a class, the next step is to update the page's data service to include the new fields.
To identify the data service to be updated, you can use the Search field to find the associated page. The
corresponding Name link is the page's data service. Select the Name link to open the Data Services Editor.

From the Data Services Editor page, you can:


 View and change the data service name and description.
Note:
Changing the data service name or description changes its appearance on Platform Configuration pages
only.
 Update the data service to include new fields.
 View pages and business processes associated with the data service.

22
December 7, 2016 (UltiPro v12.1.2) Update the Data Service

Data Services Editor - Selected Fields


The Selected Fields section of the Data Services Editor displays the classes that support the associated page.
Every data service has a root class, which can reference related classes. Each related class can also reference
additional related classes, essentially forming a single view based on a class hierarchy.

23
Update the Data Service December 7, 2016 (UltiPro v12.1.2)

For the fields you need to enable, select the class’s Fields link to display all standard and configurable fields in
the class.

Then, enable the desired fields with the View and Edit check boxes. View enables the field to be viewed on the
associated page. Edit enables the field to be edited on the associated page.

Note:
Standard fields and calculated fields can only be added to the supported UltiPro pages in a read-only
state; therefore, an Edit check box does not appear.

If the class containing your fields is not listed, select Add to add the class to the hierarchy.

24
December 7, 2016 (UltiPro v12.1.2) Place the Fields on a Page

Place the Fields on a Page

Step 3 - Place the Fields on a Page


The third step in adding new fields to supported pages is to place the fields on an UltiPro page. The Pages page
displays all UltiPro pages to which new fields can be added. Select a page to add new fields or manage
properties for existing fields.

Page Editor Overview


Once a page name is selected from the Pages page, the Page Editor appears. From the Page Editor page, you can:
 Add fields to the page or change properties for existing fields.
 Add sections to the page or change properties for existing sections.
 Add collections to the page or change properties for existing collections.
 Move existing fields, sections, or collections on the page.
 Change page settings.

25
Place the Fields on a Page December 7, 2016 (UltiPro v12.1.2)

Important!
In the Page Editor, use the Cancel button to cancel a change that has not been saved yet. Use Reset to
restore the entire page to the system-delivered default configuration.

View and Edit Modes


When you select a page that has read only and edit components, the View and Edit modes appear at the top of
the Page Editor. Selecting each mode opens the corresponding page’s Page Editor. For changes to appear on
both pages, edit both pages. For example, the View mode of the Change Name Address and Telephone page in
Platform Configuration enables you to edit the read-only Name, Address, and Telephone page. The Edit Mode of
the same page enables you to edit the editable Change Name, Address, and Telephone page.

The Platform Configuration pages that include View and Edit modes include:
 Change Organization
 Organization (View)
 Change Organization (Edit)

26
December 7, 2016 (UltiPro v12.1.2) Place the Fields on a Page

 Change Private Info


 Private Information (View)
 Change Private Information (Edit)
 Employee Job
 Job Summary (View)
 Change Job (Edit)
 Employee Name Address and Telephone
 Name, Address, and Telephone (View)
 Change Name, Address, and Telephone (Edit)
 Employee Termination Information
 Termination Information (View)
 Terminate Employee (Edit)
 Status Key Dates
 Status and Key Dates (View)
 Change Status and Key Dates (Edit)

Types of Pages
In Platform Configuration, a page is either fully or partially configurable.

Fully Configurable Pages

If a page is fully configurable, you can edit almost any part of the page. You can do the following on fully
configurable pages:
 Change the layout by moving content around to create a look and feel that reflects your organization.
 Create new fields and hide existing fields so all fields on a page are applicable to your organization (hide
with care).
 Define field-level security policies and assign default values.
 Modify the rules that drive field behavior on a page.
 Apply validations to existing fields.
The sections and fields delivered on the page appear in the Page Editor. Most items on the page can be moved
and/or edited.

27
Place the Fields on a Page December 7, 2016 (UltiPro v12.1.2)

Partially Configurable Pages

If a page is partially configurable, you can add fields to new sections that appear below the sections that are
delivered with UltiPro. In the Page Editor, the delivered fields and sections do not appear. If a partially
configurable page does not have any configurations, an empty Additional Fields placeholder section appears.
The Additional Fields section does not appear when users view the page in UltiPro until fields are added to it.

Page Editor Tabs


The left pane of the Page Editor contains three tabs – Controls, Properties, and Page Settings.

Controls Tab

From the Controls tab, you can drag new fields, sections, and collections to the page.

28
December 7, 2016 (UltiPro v12.1.2) Place the Fields on a Page

Note:
A collection is used to display multiple records for a related class.

You can add the same elements from the page's section headers. Additionally, from the section headers, you can
add columns and delete sections.

Properties Tab

When you select a field, section, or collection from the right pane of the Page Editor, the Properties tab opens.
The Properties tab enables you to view and edit the page element's properties.

29
Place the Fields on a Page December 7, 2016 (UltiPro v12.1.2)

The options available in the Properties tab depend on the type of page element and whether the page element is
system-delivered. For example, you can only hide the labels for system-delivered sections. However, when a
configured section is added to a page, you can choose to hide the label or the entire section.

Page Settings Tab

The Page Settings tab enables you to edit the page properties, such as the page name. These changes only appear
in Platform Configuration and do not affect the UltiPro page your users access.

Visibility Rules
Field visibility rules enable you to control the behavior of a specific field on a specific page. Visibility rule
options include Enable, Disable, and Hide.
Visibility Rule Description

Enable Field appears and is active on the user's page, according to assigned
field and page permissions.
Disable Field appears but is not active on the user's page. Even if edit
permissions are enabled via security policies or the data service, the
field cannot be edited.
Hide Field is hidden from the user's page. Even if view permissions are
enabled via security policies or the data service, the field is hidden.

30
December 7, 2016 (UltiPro v12.1.2) Place the Fields on a Page

You can configure visibility rules for all users or users in specific roles, companies, and/or countries.

Select Add Rule to add additional visibility rules for different types of users. For example, you can enable a field
for all users in a specific role, while at the same time hiding the field from all users in a specific country or
company.

When a field is hidden or disabled, the field remains unchanged in the Page Editor; however, the visibility rule is
respected when users access the associated UltiPro page.
Hint:
Use the Hide visibility rule to hide the field on the current page only. Use the Customarily Hidden usage
rule to hide every instance of the field or hide a field based on specific data conditions.

Important!
Do not hide required fields unless you have configured default values in the field's security policies or in
the Rules section of Platform Configuration. If you hide a required field without a default value, errors
occur on the user's UltiPro page.

Visibility Rules for Testing

If you do not have a test environment in which to test your page configurations, a Platform Configuration
Administrator role can be created and assigned. Then, using visibility rules or security policies, you can enable
users in the Platform Configuration role only to access the new fields. When testing is complete, you can remove
the visibility rule.

31
Place the Fields on a Page December 7, 2016 (UltiPro v12.1.2)

Manage Properties for a Page


Manage properties for a page from the Page Editor page. The page layout configured on this page is reflected on
the corresponding UltiPro page.

System administrators can:


 Add fields to the displayed sections. (If the page is partially configurable, only the Additional Fields section
appears. Additionally, if the title of the Additional Fields section has been changed, the new title appears
instead.)
 Add sections to the page
 Add collections to the page
Note:
A collection is used to display multiple records for a related class.
 Change properties for the displayed sections
 Change page settings

32
December 7, 2016 (UltiPro v12.1.2) Place the Fields on a Page

To add a field to the page:


Navigation: Menu > System Configuration > Platform Configuration > Pages > select a page

1. From the Page Editor page, Controls tab, drag the Field box to the desired section, or using the toolbox in the
section, select Add Field. The message, "Bind this control to a data service path expression to preview this
control," appears in the section, indicating that the control has not yet been bound to a field.

2. Select Bind This Control to a Data Service Path Expression to Preview This Control.

3. From the Properties tab, select the desired field to bind to the control from the drop-down list.
Note:
The desired field only appears in the drop-down list if the page's data service was updated to include it. If
the desired field does not appear in the list, update the data service on the Data Service Editor page for
the appropriate data service.

33
Place the Fields on a Page December 7, 2016 (UltiPro v12.1.2)

4. Select which translation version to display. Translation versions for the field are defined on the Field Editor
page.
5. Select whether the field is visible.
6. Select whether the field label is displayed.
7. Make selections for other field options.
Note:
Field options vary based on field type.
8. Select Save. The Pages page appears.

To add a section to the page:


1. From the Page Editor page, Controls tab, drag the Section box to the desired section, or using the toolbox in
the section, select Add Section. The new section appears in the section.
Note:
Sections can be placed within other sections to create the desired layout.

34
December 7, 2016 (UltiPro v12.1.2) Place the Fields on a Page

2. Select the new section.

3. Enter title translations for the section. The title of the section appears in the new section.
4. Select whether the section is visible.
Note:
If a section is not visible, then the controls and sections contained within the section are also not visible.
5. Select whether the section label is displayed.
6. In the new section, select Add Column to add columns. Adjust the width of the section columns to create the
desired layout.

7. Select Save. The Pages page appears.

35
Place the Fields on a Page December 7, 2016 (UltiPro v12.1.2)

To add a collection to the page:


1. From the Page Editor page, Controls tab, drag the Collection box to the desired section, or using the toolbox
in the section, select Add Collection. The new collection appears in the section. The collection title appears
as <Not Bound>, indicating that the control has not yet been bound to a class.
Note:
Collections are bound to classes instead of fields. Before you can add a collection to a page, you must
update the data service. In the data service, you must join a class that has a one-to-many relationship
with the base class, such as Employment History or Contacts. Then, you can add a collection using the
fields from the joined class.

2. In the new collection, select <Not Bound>.

3. From the Controls pane, select the collection. Only those joined classes that have a one-to-many relationship
appear.
4. Select the collection type.
5. Select whether the collection is visible.

36
December 7, 2016 (UltiPro v12.1.2) Place the Fields on a Page

6. Select whether the collection label is displayed.


7. Select whether to enable user paging and user sorting for the collection.
8. Select the initial page size. The initial page size indicates the number of records to display in the collection on
a single page.
9. In the Default Sort section, select Add Level to sort the collection.
10. Select Create Formula to create a rule expression (see "Creating a Rule Expression" on page 19) for sorting
the collection.
11. Select whether to sort the collection in ascending or descending order.
12. Add additional sort levels, as needed.
13. Add fields or collections to the collection by dragging them from the Controls tab or using the toolbox in the
collection.
14. Select Save. The Pages page appears.

To change properties for the section:


1. From the Page Editor page, select the desired section.
Note:
If the section was previously renamed, the new name appears instead. Select the new name.
2. If desired, from the Properties tab, change title translations for the section. The title of the section changes.
3. In the Data Service section, select whether the section is visible.
4. Select whether to display the section label.
5. Select Save. The Pages page appears.

To move an existing field, section, or collection on the page:


1. From the Page Editor page, drag the desired field, section, or collection to the desired location on the page.
Note:
If the page is partially-configurable, the Additional Fields section and any other sections you add will
always appear below the delivered sections on the page, but you can move the fields within that section.
2. In the Display Options section, select whether to display the page label. Select Save. The Pages page appears.

To change page settings:


1. From the Page Editor page, select the Page Settings tab.
2. If desired, change the page name and description translations for the page.
Note:
Changing the page name or description translation only changes its appearance on Platform
Configuration pages.
3. In the Display Options section, select whether to display the page label.
4. Select Save. The Pages page appears.

37
Export and Import Configurations December 7, 2016 (UltiPro v12.1.2)

Export and Import Configurations

Export and Import Overview


If you have a test environment, a benefit of Platform Configuration is that you can do all of your configuration
and validation in that test environment. Once you are ready for your production environment, you can export the
configuration from your test environment and seamlessly import it into your production environment for
immediate use.

Export a Configuration
Export a configuration from the Export Configuration page.

To export a configuration:
Navigation: Menu > System Configuration > Platform Configuration

1. From the Platform Configuration Overview page, Things I Can Do section, select Configuration Export. The
Export Configuration page appears.
2. Select each class, data service, and page customization to export.
3. Select Export. The export is complete and the SNAP file downloads in your browser.

Import a Configuration
Import a configuration for configured fields and configurable pages created using Platform Configuration from
the Import Configuration page.
Note:
At this time, Value Rules and Labels are not included in export configurations and therefore are not
available to be imported.

To import a configuration:
Navigation: Menu > System Configuration > Platform Configuration

1. From the Platform Configuration Overview page, Things I Can Do section, select Configuration Import. The
Import Configuration page appears.
2. From the File Name field, select the ellipsis icon to browse to the path of the configuration file for import.
The import file path, which must be a valid SNAP file, appears in the File Name field.
3. Select the applicable import mode for application to your target environment.
 Merge applies any updated and new configurations included in the import file
 Override deletes your existing configuration before applying the configuration in the import file
4. Select all or none from the available configurations list or check the boxes for each desired configuration.

38
December 7, 2016 (UltiPro v12.1.2) Export and Import Configurations

Note:
Each configuration will have an indicator for the status of the configuration being applied to the target environment.
 Added - is used for a new configuration being initially applied to the target environment
 Change - is used for a modified configuration
 Unchanged - the configuration remains the same
Configurations that are unchanged are not available to be re-imported.

5. Select Save. An information message indicating success or failure of your import appears.

39
Manage Labels December 7, 2016 (UltiPro v12.1.2)

Manage Labels

Manage UltiPro Labels


You can manage the labels that appear throughout UltiPro from the Labels page (Menu > System Configuration
> Platform Configuration > Labels).

The Labels page displays all UltiPro field labels that can be customized to meet your organization's preferences.
By default, labels are sorted alphabetically based on the default language in the Alias column. Select any column
header to re-sort the labels.

From the Language drop-down list you can select your preferred language. This does not override the user's
selected language preference in UltiPro, but instead changes the display of the labels in the Original Text
column. You can select the column headers to sort the labels.

40
December 7, 2016 (UltiPro v12.1.2) Manage Labels

Use the Search feature to quickly locate a field label or group of related labels. Replace the original text with
your preferred text using the Edit option. You can also enter a label for all alternate languages supported by
UltiPro.

The new label text appears in the Configured Text column.

Note:
When customizing labels, remember to enter custom label text in all desired supported languages.
Otherwise, the default text for the label for that language is retained. For example, if you enter Team
Member in the English label options and do not enter Membro da Equipe for the Portuguese label, then
the label for the Portuguese language remains as Funcionario (which is Employee).

Manage UltiPro Labels with In-Page Edit


From the Labels page, you can enable the in-page label editing option to edit labels on a page wherever you are
in UltiPro.

41
Manage Labels December 7, 2016 (UltiPro v12.1.2)

An Edit Labels icon appears on every UltiPro page when this feature is enabled for those who have web access
rights granted to the Labels page.

When you select the Edit Labels icon from any page, all fields on that page are available for field label edit via
an Edit link. Select the Edit link to enter custom label text in any of the languages supported by UltiPro.

If there are no available field labels for edit from the page, an informational message appears.

42
December 7, 2016 (UltiPro v12.1.2) Create Value Rules

Create Value Rules

Value Rules Overview


The Value Rules Engine enables system administrators to configure UltiPro to automatically populate fields on
fully configurable pages without the need for manual intervention. This can help to eliminate data entry errors
and streamline your processes.

You can set the values for selected fields even if visibility rules have been configured to hide those fields.

Rules can be configured only for fully configurable pages/work events:


 Add Employee (Start, Personal, Jobs/Payroll, Dates pages in the work event)
 Job Summary/Change Job
 Change Job and Salary (Change Job page only)
 Add or Change Secondary Job
 Name, Address, and Telephone/Change Name, Address, and Telephone
 Termination Information/Terminate Employee
 Compensation Summary (Employee and Manager/Administrator’s view)
 Organization/Change Organization
 Other Country Information pages for over 20 pages
Value rules can only be configured by users in roles with the System Administrator role type. Using this feature
requires that security access rights be enabled for users in applicable system administrator roles (Menu > System
Configuration > Platform Configuration > Rules).

43
Create Value Rules December 7, 2016 (UltiPro v12.1.2)

Add or Change Value Rules


From the Add/Change Value Rules page, you configure the drivers (the specific conditions that must be met in a
specific field or numerous fields) and the targets (the fields to be automatically populated) for each value rule.
Keep in mind:
 All driver conditions must be true (only the Boolean logic of AND, not OR, is available)
 Numeric fields can have inequality operators: >, <, >=, <=, (the 'not equal to' operator is not available)
Add a value rule:
Navigation: Menu > System Configuration > Platform Configuration > Rules

1. From the Add/Change Value Rules page, select Add. The Add/Change Rule page appears.
2. Enter a unique name for the value rule. The name should be descriptive and unique. Blank spaces between
words are permitted.
3. From the Class drop-down list, make a selection.
Available fields from the selected class appear as driver field options in the When These Conditions Are Met
section and as target options in the Then These Fields Will Bet Set section.
4. Select ON from the Enabled slider button only if you are ready for this value rule to be used immediately.

44
December 7, 2016 (UltiPro v12.1.2) Create Value Rules

Best Practice:
It is recommended that the value rule remain disabled until configuration is complete. Errors can occur if
you enable a value rule before configuration for the rule or its associated value sets are complete.

5. From the When These Conditions Are Met section, select Add to add drivers for this value rule.
6. From the Field drop-down list, make a selection or use the search option to locate the driver field.
7. Repeat to add multiple drivers.
8. From the Then These Fields Will Be Set section, select the target field or use the search option to locate the
target in the Available column.
9. Check the box for each target field or fields and move the target field(s) to the Selected column.

10. Repeat to add additional targets as needed.


Note:
You cannot use a field value as a Target that is already assigned as a Driver.

11. Select Save. The new value rule appears.

To change a value rule:


Navigation: Menu > System Configuration > Platform Configuration > Rules

45
Create Value Rules December 7, 2016 (UltiPro v12.1.2)

1. From the Rule Name column, select a rule name link.


2. On the Add/Change Rule page, modify the selections as needed.
3. Select Save.
Important!
Changes can be made to all fields of a value rule before value sets are added. When value sets are
added for a value rule, only the name and status can be modified.

Add or Change Value Sets for a Value Rule


A value set defines the set of values for the newly created value rule. Add or change value sets for each value
rule by selecting the associated Add link from the Value Sets column.

To add a value set for a rule:


Navigation: Menu > System Configuration > Platform Configuration > Rules

1. From the Add/Change Value Rules page, select the value rule's Add link from the Value Sets column.
2. Select the Add button. The Add Value Set pop-up window appears.
3. From the When column, select the <empty> button. The Search option for the Driver field drop-down list
appears.
4. Select the Search field to view a list of driver values or enter key words to locate the applicable driver value.
5. Select the driver value and select OK.
6. Repeat for each driver field.
7. From the Then column, select the first <empty> button.
8. Select the down arrow to view a list of target values or use the search option to locate and select the
applicable target value.
9. Select OK.
10. Repeat for each target field.
11. When finished, select Save. The value rule field page appears.
12. Select Add to add additional value sets.
13. Select Back to return to the Add/Change Value Rules summary page.

46
December 7, 2016 (UltiPro v12.1.2) Create Value Rules

The number of the value sets now replace the Add link in the Value Sets column.
To modify a value set:
1. From the Value Sets column on the Add/Change Value Rules page, make a selection for the desired value
rule.
2. From the When column, select the driver link to change any of the value set selections. The Change Value
Set page appears.
3. Select a driver or target to be modified and select the new desired value.
4. Select Save after all changes have been made.
5. Select another value set to change or Select Back to return to the Add/Change Value Rules page.

To add default value sets:


1. From the Value Sets column on the Add/Change Value Rules page, make a selection for the desired value
rule.
2. Check the If Nothing Else Matches, Apply These Values box, and then select Edit. The Edit Default Values
window appears.
3. Select the <empty> button for the target default. A drop-down list appears. Use the Search field as needed.
4. Select Ok. Repeat for each target value default.
5. Select Save.

47

You might also like