Unifier Admin General
Unifier Admin General
Primavera Unifier
General Administration Guide
Version 24
December 2024
Oracle Primavera Unifier General Administration Guide
Copyright © 1998, 2024, Oracle and/or its affiliates.
Primary Author: Oracle Corporation
2
Contents
Getting Started with General Administration Guide ....................................................................... 11
Security Considerations .................................................................................................................. 13
Authentication: How Users Sign On ..................................................................................................... 14
Authorization: What Users Can Access ............................................................................................... 14
Endpoint Security ................................................................................................................................. 15
Confidentiality ....................................................................................................................................... 16
Integration with Other Applications ..................................................................................................... 16
Security for Developers - API Security ................................................................................................. 16
Establishing Security Contacts ............................................................................................................ 16
Signing In the First Time and Confirming the Base Currency ......................................................... 17
Companies ...................................................................................................................................... 19
Administrators ................................................................................................................................ 21
Permission-Based Security ............................................................................................................. 23
Company Workspace Landing Page (Admin) .................................................................................. 25
User Administration .............................................................................................................................. 27
General Administration ........................................................................................................................ 28
Data Structure Setup ........................................................................................................................... 28
uDesigner .............................................................................................................................................. 29
Configuration ........................................................................................................................................ 31
Integrations ........................................................................................................................................... 32
Standards & Libraries .......................................................................................................................... 32
Configuration Package Management.................................................................................................. 34
System Information .............................................................................................................................. 34
Templates ............................................................................................................................................. 35
Company Workspace ........................................................................................................................... 36
Company Sponsored Shells ................................................................................................................. 37
Shell Landing Page (Admin) ............................................................................................................ 39
Project Landing Page (Admin)......................................................................................................... 43
Queries............................................................................................................................................ 45
How Queries Work ................................................................................................................................ 45
Using Formulas or Conditions in Queries ............................................................................................ 46
Field Value Comparison .................................................................................................................. 47
Date Plus or Minus .......................................................................................................................... 47
Date Difference ............................................................................................................................... 48
Compare Date Fields ...................................................................................................................... 48
Dynamic Date Value ........................................................................................................................ 49
3
General Administration Guide
4
Contents
5
General Administration Guide
6
Contents
7
General Administration Guide
8
Contents
9
General Administration Guide
10
Getting Started with General Administration
Guide
Within our documentation, some content might be specific for cloud deployments while other
content is relevant for on-premises deployments. Any content that applies to only one of these
deployments is labeled accordingly.
The Unifier General Administration Guide explains how the Company Administrator should use
the general options that are available in the Admin mode of operation.
Depending on permissions, among other tasks, the Company Administrators can:
Create or modify projects
Create data definitions for custom attributes on BP forms
Activate business process schemas
Define record numbering schemas
Create users and groups and grant their permissions
Set up templates
Add currencies
For more details about Company Administrator, see Administrators (on page 21).
Access to functionality is granted through permissions.
A Company Administrator can set permission from the following modules:
Access Control
Company User
User Administration, Groups sub-node
Standards & Libraries, Permission Templates sub-node
The ability to utilize a specific function depends on permissions settings granted by the
Company Administrator, set in Admin mode.
There are two modes of operation:
Admin (Administration) mode: The Company Administrator works in Admin mode to set up,
for example, company and project/shell properties, user permissions, templates for major
features, data structures, and configure and set up business process (BP) workflows.
User mode: Users spend most of their time in the User mode. The User mode allows users
perform the day-to-day activities, collaborate through business processes and Mailbox,
maintain, for example, the Cost Manager, Activity Manager, and Document Manager, and
run reports.
User Help explains how to use the options that are available in the User mode of operation.
You can switch between modes using the mode icons (User mode and Admin mode ).
These options are not available for the Home workspace.
11
General Administration Guide
for every page or tab in the location bar at the top of the application,
instead of being displayed only for the active page or tab.
12
Security Considerations
For any company that deals with sensitive data, keeping it secure is crucial to success. While
hosting Unifier data on the Oracle Cloud provides security measures, it cannot do everything.
For example, it cannot prevent phishing attempts or other attacks that exploit gaps in its users'
security awareness. That is why it is important for everyone who works with Oracle Primavera
Unifier, whether hosted on-premises or on the Oracle Cloud, to understand what they can do to
keep data secure.
13
General Administration Guide
Learn to recognize phishing. Phishing is when someone disguises an email or some other
transmission as a legitimate message in an attempt to get a user to reveal sensitive
information. For example, a hacker may send you an email disguised to look like an email
from your employer requesting login information. These attacks are becoming more
sophisticated, but you can still protect yourself by making sure any emails you receive or
websites you visit are legitimate before using them to share sensitive information.
In This Section
Authentication: How Users Sign On ......................................................................... 14
Authorization: What Users Can Access ................................................................... 14
Endpoint Security .................................................................................................... 15
Confidentiality .......................................................................................................... 16
Integration with Other Applications .......................................................................... 16
Security for Developers - API Security ..................................................................... 16
Establishing Security Contacts ................................................................................ 16
To learn how to change the authentication settings, refer to Authentication Options for
Primavera Unifier in the Unifier Security Guide for On-Premises.
14
Security Considerations
Endpoint Security
From laptops to cellphones, organizations have to keep track of data on more devices than ever,
and more devices means more risk. It is important to implement Enterprise Mobility Management
(EMM) tools and policies.
15
General Administration Guide
Confidentiality
Confidentiality ensures that only the authorized users see the stored and transmitted
information. In addition to the documentation included with other applications and hardware
components, follow the Unifier-specific guidance below.
For data in transit, use SSL/TLS to protect network connections among modules. If you use
SSO authentication, ensure that you use LDAP to connect to the directory server.
For data at rest, refer to the documentation included with the database server for instructions
on securing the database.
16
Signing In the First Time and Confirming the
Base Currency
When your Test or Development environment is first provisioned, a Base Configuration Package
is installed. This package contains the essential attribute forms, a single-instance shell, and a
multi-instance shell, which creates a basic framework that you can use to build your own
customized configurations. At the time of company creation, the first time that you sign in to a
Test or Development environment, an alert regarding the Base Configuration Package appears
only if it was not successfully imported. If the package was successfully imported, the Select
Base Currency dialog box appears.
If additional packages were installed in your Test or Development environment and the import
failed due to issues such as duplicate shell names, an error message is displayed. If other
issues occur, such as a design was imported for which the version labeling matches the existing
design, a warning message is displayed. Provided that the Base Configuration Package installed
successfully, you can view any additional messages by going to the Company Workspace and
switching to Admin mode, selecting Configuration Package Management in the left Navigator,
and then selecting Configuration Packages.
The Base Currency is the default currency used by the company. Although it might be set by
Oracle when the system is first provisioned, the Base Currency must be selected the first time
that the Company Administrator signs in. No other users are allowed to sign in until the
Company Administrator sets the Base Currency. Because the type of currency plays a large role
in nearly all financial functions, the Base Currency cannot be changed after data has been
entered into the system.
To sign in the first time:
1) Sign in to the system as the Company Administrator.
2) If a Re-import Base Configuration Package alert appears for a Test or Development
environment, select the applicable option:
To initiate the import process again, click OK. When the process completes successfully,
you can set the Base Currency and continue the configuration process.
To prevent the import process from running again, click Cancel. If you click Cancel, the
login page is displayed. Until the import process is completed, you cannot sign in, set the
Base Currency, and continue the configuration process.
3) When the Cookies in Unifier notification appears, click Got It to continue.
4) In the Select Base Currency dialog box, select a currency from the list, and click Save.
Note: If you click Cancel or X (close), no changes are saved and the
login page is displayed.
5) In the Confirmation message, click Yes to accept your selected Base Currency or click No
to select a different Base Currency.
After you set the Base Currency, the system updates the Event Audit Log with all relevant
information, such as the date on which the Base Currency was confirmed and the name of
the Company Administrator who confirmed it.
17
General Administration Guide
18
Companies
The following describes the company types used within the system:
Owner Company (also referred to as the Sponsor Company): The entity that engages in
business and has complete control (or ownership) of the application. An Owner Company
(Sponsor Company), commissions projects/shells. Projects/shells are created under the
Owner Company.
Notes:
Project/shell access is limited to the users (including Sponsor
Company users or Member Company users) who are chosen for the
project/shell and permissions are configurable for each company.
When a Member (also known as Partner) Company is removed from
a project/shell, the Member Company users are automatically set to
Inactive.
The application lets you add a Partner Company or Member Company to enable project users to
collaborate on (and coordinate) the execution of a project.
19
Administrators
Note: The following information is based on the default settings and
typical use of the system.
Company Administrator
Generally, a Company Administrator administers the Owner Company (Sponsor Company)
functions. For more information about an Owner Company, see User Administration (on page
95).
The Company Administrator can also perform user tasks.
A Company Administrator typically performs the following tasks, depending on the permission:
Creating multiple Partner Companies in the Owner Company.
Creating users for each Partner Companies in the Owner Company.
Modifying the company properties, including Company Workspace.
Managing company details such as contact information.
Managing company-level users, groups, and granting permissions.
21
General Administration Guide
22
Permission-Based Security
The application offers a flexible yet powerful permission-based security system, as opposed to
role-based security. Role-based security by definition limits the user to a fixed set of functions or
tasks. With permission-based security, access to all modules, functions and tasks are controlled
by granting each user any combination of permissions.
For ease of use, permissions can be set for both individuals and for groups of users. You can
even copy permissions from one user to another and then make modifications.
A user may belong to any (or all) of the administration groups and perform functions as a
company or project/shell administrator. Company Administrators generally have project/shell
permissions and may or may not work within the specific projects/shells. You may want a
project/shell administrator to have the ability to perform some company administrator functions,
such as creating a project. Creating different types of user permission templates will help you to
grant access more easily to different staff members, whether they are administrative staff,
engineers or architects, managers, vendors or subcontractors, IT personnel, and so on.
Use default permissions as a guideline, but your users' actual permission settings will depend on
your organization's needs.
Depending on what you are setting up or configuring, such as users, groups, projects/shells,
business processes, and so on, there are different permissions that might be available for
selection. Some (this is not a comprehensive list) of these permissions include:
Create
Full Access
Modify Status
Modify Properties
View
Allow Bulk Edit
Configure User Dashboard
Allow Quick Calendar Entry
Hide Audit Log
Organize
View All Sheets
23
Company Workspace Landing Page (Admin)
When you go to your Company Workspace tab, you will see the company landing page, as
shown below:
As shown, the company landing page has a heading which displays the Primavera Unifier logo
and enables you to access the following:
Below the heading, the tab row enables you go to the Analytics tab ( ) (depending on your
permissions), Home tab (Home workspace) ( ), Company Workspace tab, and shell tabs. You
can close all the tabs except the Home tab (Home workspace). You can click New tab ( ) to
open a window that enables you to search for company or shells by:
a) Opening all locations and searching, for example, in all projects, all properties, or buildings.
b) Opening the company or shells that are displayed (categorized under: Recent Locations,
Key Locations, and Bookmarks).
Below the tabs row is the mode row, which enables you switch the mode of operation, from the
User mode to the Admin mode or reverse.
Below the mode row is the menu options row, which provides access to the following menu
options:
File
25
General Administration Guide
New: Creates a new Company Workspace. A company can only have one Company
Workspace. This node is read-only.
Open: Opens the Edit Company window, which provides access to company properties
through the following tabs:
General: Enables you to manage multiple company features, such as
company name and description.
Address: Enables you to enter multiple company addresses, including one for
the company headquarters.
Security: Enables you to configure policies for multiple items, including file
security and account logins.
Contact: Enables you to provide contact information that can be used when
users need support and training.
E-Signatures: Enables you to configure account settings for DocuSign and
Adobe Acrobat Sign and select a default system for e-signatures.
Outgoing E-mails: Enables you to manage the size of attachments that can
be included on an outgoing email.
See Access Company Details (Edit Company Window) (on page 63) for details about
the tabs.
Edit
Delete: Removes a Company Workspace. This node is read-only.
View
All: Displays a list of all Company Workspaces. This node is read-only.
Find: Enables you to search for a specific Company Workspace. This node is read-only.
Audit Log: Displays a history of all actions that have been taken on the Company
Workspace, including changes to the hyperlink security policy. The information provided
includes such identifiers as the date, type of event, values (old and new), and who made
the change.
Help
User Help: Accesses the User Help web page.
Admin Help: Accesses the Administrator Help web page.
uDesigner Help: Accesses the uDesigner Help web page.
Unifier Library: Accesses the Administrator Help web page.
User Productivity Kit: Accesses the portfolio type training.
Below the menu options row, the toolbar options row enables you to open the Edit Company
window. For more information, see the descriptions provided earlier in this topic. The New and
Find options on this row are not available.
Below the toolbar options row is the area that displays more details about the company such as
the:
Description of the company
Administrator information
Home Page URL of the company
Help URL for the company
26
Company Workspace Landing Page (Admin)
Company Addresses
Partner Companies
On the left side of the company landing page, the navigation (left Navigator) grouping nodes and
functional nodes are displayed. The following topics explain each grouping and functional node
in the Company Workspace landing page (Admin mode).
Note: You can click a grouping node to expand it and access the
functional nodes that are associated with that grouping node. In some
instances, some of the items under the grouping nodes are considered
sub-grouping nodes which have their respective functional nodes, also
known as leaf nodes.
In This Section
User Administration .................................................................................................27
General Administration ............................................................................................28
Data Structure Setup ...............................................................................................28
uDesigner ................................................................................................................29
Configuration ...........................................................................................................31
Integrations ..............................................................................................................32
Standards & Libraries ..............................................................................................32
Configuration Package Management .......................................................................34
System Information ..................................................................................................34
Templates ................................................................................................................35
Company Workspace...............................................................................................36
Company Sponsored Shells ....................................................................................37
User Administration
The User Administration grouping node contains the following functional nodes:
Partner Companies: An Owner Company (also referred to as a Sponsor Company) might
work with one or more Partner Companies (for example, subcontractors, vendors, and so on)
to work on projects/shells or company-level activities. Use this functional node to grant
Partner Company users access to specific company-level and project/shell-level features.
Company Users: Company users are the main users that will have access to the system
and your company's functions. Use this functional node to grant Company users access to
specific company-level and project/shell-level features.
Partner Users: Partner users are members of Partner Companies that can be given
permission to access the system and specific company functions. Use this functional node to
grant Partner users access to specific company-level and project/shell-level features.
Groups: Use this functional node to create and manage groups, such as Project
Administrators. You can also specify the applicable Permissions for the group and manage
the group membership.
27
General Administration Guide
Task Reassignment: Use this functional node to access comprehensive lists of active tasks
currently assigned to active and inactive users. Using the Task Reassignment - Active
User Tasks and Task Reassignment - Inactive User Tasks logs, you can reassign
individual tasks to other active users.
Integration Users: Integration users can perform integration, using external programs to
import data into the system. Use this functional node to grant Integration users access to run
requests related to Representational State Transfer (REST)ful services, such as Workflow
Business Process Permissions.
Access Control: Use this option to see the users and groups who have access to each
module (access range is from the Admin mode to the User mode, including the individual
modules or managers), to see the permission settings, and to change the permissions.
General Administration
The General Administration grouping node contains the following functional nodes:
Announcements: Lets you create announcements and indicate who should see the
announcement—users, bidders, or both.
License Manager: Displays the number of licenses allocated to each user type, such as
Standard, as well as the current number of active users. Also provides access to the License
Terms option in which you can enable alerts regarding the level of consumption.
Consent Notice
User Consent: Lets you create and enable consent notices that require each user to
accept or reject acknowledgment of the notice on the first login occurrence.
Consent Status: Lets you track the status of each recipient's response.
Bidder Consent: Lets you create and enable consent notices that require each bidder to
accept or reject acknowledgment of the notice on the first login occurrence.
Consent Status: Lets you track the status of each recipient's response.
Customer Support Logins: Lets you view the name and contact information for those
identified as customer support. You can also see when each customer support person last
logged in and out.
28
Company Workspace Landing Page (Admin)
Data Elements: Lists the Data Elements defined for your environment. A Data Element is a
field, and it is defined by using a Data Definition. A Data Element consists of a name and
label, and it might be a text box, a menu, a check box, and so on.
Data Indexes: Lets your database administrator (DBA) or Oracle Cloud Administrator create
user-defined indexes that speed up the performance of large data sets. For more
information, contact your DBA or Oracle Cloud Administrator.
Data Views: Lets you create and deploy SQL data views that can be used as a data source
for custom reports, user-defined reports (UDRs), and Data Cube Definitions.
Dynamic Data Sets: Lets you view and update a list of data sets that control what other
data elements display or how they behave. For example, you can use a data set to control
how check boxes behave when a user has multiple-choice options.
Reports: Lets you view a list of the Custom and System types of reports that were loaded
by your Site Administrator.
Statuses: Lets you view a list of the following types of status that were loaded by your Site
Administrator. The status indicates the state of a line item or record, such as approved or
pending, at any point in the business process.
Asset Statuses
Line Item Statuses
Record Statuses
Tags
ER Views: (Entity Reference [ER]) Provides a list of modules and a corresponding tabular
view of the Data Elements and Data Definitions for each.
uDesigner
The uDesigner grouping node contains the following functional nodes:
Business Processes: Displays a list of the Business Process templates.
Activity Manager: Displays a list of activity, OBS, and WBS sheets (the activity manager
components).
Configurable Modules: Displays a list of configurable managers, including their description,
type, and other related information.
A configurable manager is a manager that has been especially created for your company. Up
to 25 managers can be created to consolidate and monitor any entities you want.
Configurable managers differ from the managers that are shipped with the system in that
configurable managers can roll up not only currency amounts, but also quantity amounts.
You can design two kinds of managers: Code and Records-based and Code-based.
A Code and Records-based manager employs both codes to create a tracking sheet
and records of individual items.
A Code-based manager employs only a sheet to keep track of the values it is monitoring.
29
General Administration Guide
From a Code and Records-based manager, you can drill down from the sheet to individual
items; from a Code-based manager, you cannot.
Cost Manager: Displays a list of the cost-related attributes.
Document Manager: Displays a list of the folder- and document-related attributes.
Planning Manager: The Planning Manager is where users can plan for new projects and
proposals and create forecasts for those projects that are already running in the system.
They cannot administer planned projects the way they administer real projects in the system;
however, they can manage the planning phases for these projects as business processes
using the same functions used by other business processes.
Resource Manager: Displays a list of resources, their owners, status, level, type, and other
related information.
The Resource Manager is where users can set up and manage a company’s personnel
resources. These resources are always maintained at the company level, to be distributed
among the company’s projects.
The Resource Manager classifies job functions into roles that can then be allocated to
projects. These roles are used to define billable rates, which are used in budgeting, and can
also be used in planning for resource demands across projects. Roles are associated with
personnel resources—the people who can perform these roles in a project. The Resource
Manager is where users assign personnel to roles and projects.
The Resource Manager manages time sheets, and also hard and soft resource bookings
using a calendar that shows what projects a resource has been booked for, as well as the
resource’s availability.
Schedule Manager: Displays a list of schedules, their owners, status, level, type, and other
related information.
The Schedule Manager is where users can create and manage schedules at the
project/shell level. They can create a schedule sheet that is customized to a project's or
shell’s needs. After these sheets are created, users can then use them to create project/shell
activities and tasks, assign resources to tasks, create relationships between activities, track
schedule progress and variables, and calculate the schedule’s critical path.
Space Manager: Displays a list of space-related items, their owners, status, level, type, and
other related information.
A space is an entity—such as a cubicle, office, or conference room—that resides on a level
in the Space Manager.
Shell Manager: The Shell Manager is where uDesigner users create the shell types that will
be used in the system. Administrators group shells into hierarchies, create shell “instances,”
and specify what functions and features will be included in the shell, such as a cost manager
(standard or generic), Document Manager, Schedule Manager, and so on.
User Administration: Displays a list of the user attributes, including logs and pickers, their
owners, status, level, type, and other related information.
30
Company Workspace Landing Page (Admin)
Configuration
The Configuration grouping node contains the following functional nodes:
Business Process: Displays a log of the Business Processes that have been imported and
lets you update their configuration settings.
Document Manager: Lets you configure views for the Folder and Document Attributes log.
Planning Manager: The Planning Manager is where users can plan for new projects and
proposals and create forecasts for those projects that are already running in the system.
They cannot administer planned projects the way they administer real projects in the system;
however, they can manage the planning phases for these projects as business processes
using the same functions used by other business processes.
Portfolio Manager: Lets you configure the scenarios that should be analyzed by each
portfolio component.
Resource Manager: The Resource Manager is where users can set up and manage a
company’s personnel resources. These resources are always maintained at the company
level, to be distributed among the company’s projects.
The Resource Manager classifies job functions into roles that can then be allocated to
projects. These roles are used to define billable rates, which are used in budgeting, and can
also be used in planning for resource demands across projects. Roles are associated with
personnel resources—the people who can perform these roles in a project. The Resource
Manager is where users assign personnel to roles and projects.
The Resource Manager manages time sheets, and also hard and soft resource bookings
using a calendar that shows what projects a resource has been booked for, as well as the
resource’s availability.
Shell Manager: Lets you update configuration settings for shell types, such as project
number, cost codes, and status.
Space Manager: Displays a list of configured space items, their level, status, and ID.
Custom Templates: Lets you create and update Oracle Analytics Server-based Custom
Reports and Custom Prints.
Navigation Tabs: Lets you view the order in which the tabs for the Company Workspace
and each shell are displayed in the tabs row. Also lets you rename the Company Workspace
tab and the Organization and Test shells.
User Mode Navigator: Lets you update the appearance and organization of the modules
and business processes that are available in the left Navigator for all company users.
Landing Page: Displays the available landing pages, their type, status, and other related
information.
Internationalization: Lets you view a list of translated content for customized strings and
rename data element labels and other system strings by updating the English column. In
addition to the translated items provided with the system, you can provide users and groups
with translation privileges with the option of viewing translations or configuring them.
Material Inventory Manager: Displays an inventory list of the materials at the project/shell
level.
The Material Inventory Manager is a Project/Shell level Code and Record-based type
manager.
31
General Administration Guide
If you are using a Code and Records-based configurable manager, there are sheets and
classes (for example, Sheets and Material Inventory Manager).
To access a sheet, click the Sheets node, and select a sheet from the log.
To access a class, select a class. The log for the class opens.
If you are using a code-based configurable manager, there is just one sheet, which is listed
under the log (for example Parts Manager).
Integrations
The Integrations grouping node contains the following functional nodes:
Analytics: Use this node to define data mapping between Unifier data sources and
Primavera Analytics subject areas. For more information, see Unifier and Primavera
Analytics (on page 299).
Bluebeam: If Bluebeam is enabled for your environment, use this node to configure the
information that is tracked throughout review sessions. For more information, see the Unifier
Bluebeam User Guide.
Event Notifications: Use this node to view events triggered by steps reached within
Business Processes. For more information, see Event Notifications.
Gateway: Use this node to view information about specific objects within Unifier and whether
communication with other objects has been enabled. For more information, see Unifier and
Primavera Gateway (on page 340).
Business Objects: Use this node to view a list of the objects that are available in your
environment. For more information, see Business Objects Node in Unifier (on page
349).
Primavera Cloud: Use this node to integrate Cash Flow between Unifier and Oracle
Primavera Cloud. For more information, see Unifier and Oracle Primavera Cloud.
Oracle Integration Cloud: If you are using Oracle Primavera Cloud and Oracle Integration,
use this node to integrate Schedule data between Oracle Primavera Cloud and Unifier. You
can also update workflow business processes (BPs), the System Activity Sheet, and the
Master Rate Sheet. For more information, see Unifier and Oracle Integration.
32
Company Workspace Landing Page (Admin)
Calendars: Lets you create multiple calendars, which supports using a library of calendars
that can be selected for use at the company, shell, and project levels and accounts for
holidays and other non-working days in a range of locales.
Cash Flow: The Cash Flow feature is a way to view a time-based record of income and
expenditures, which can be presented in tabular or graphical format. It enables users to
create a baseline for project expenditures, track actual costs, and calculate future
expenditures based on a known forecast or calculate from trends compared to “Baseline”
curves. The Cash Flow node consists of the following functional nodes:
Data Sources: Lets you define budget sources and curve types, and customize the
display and order for graphical elements.
Distribution Profiles: Lets you create and manage profiles that can be used for the
display of cash-flow graphics.
Templates: Lets you create and manage templates used in the display of cash-flow
graphics.
Currencies: Use this node to create and manage different currencies to suit business
requirements.
Exchange Rates: Use this node to create and manage the exchange rates for different
currencies.
Permission Templates: Lets you create templates for permission sets that you can
subsequently apply to individual users or to group.
User Preference Templates: Lets you create templates for a default set of user-based
preferences that you can subsequently apply to existing users and to new users.
Approved Email List: In addition to the dedicated company email address that was
originally specified for your company, use this node to create and manage
project/shell-specific identifiers that are used in conjunction with the company email. You can
also specify additional email addresses that are approved for use within your organization.
Period Structure: Use this node to define and manage time periods that support cost
calculation for budgets used in cash flow and portfolio management. The default setting is
monthly, but you can define alternate periods such as different fiscal years, quarterly
periods, twice yearly periods, and so on.
Seasonal Dates: Supports work-order management for preventive maintenance.
P6 Data Sources: Displays a list of P6 data sources. The P6 Data Sources enables you to
access the following information, based on your permissions:
Data source: Captured from P6 Summary Sheets, for use in Cost Sheets or Cost Sheets
Templates.
Examples of P6 Data Sources: Current Schedule Summary, Original Baseline Summary,
Sanctioned Baseline Summary
Dataset for the attribute "Type" for P6 Summary Sheets
33
General Administration Guide
You can manage the configuration package creation and import through the Configuration
Package Management grouping node in the left Navigator. The grouping node contains the
following functional nodes:
Component Lists: Displays a list of all components in a configuration package.
Add-on Component Lists: Displays a list of add-on components and enables you to
create an add-on component list for use with a configuration package that can be imported in
to a different development environment.
The Add-on Component Lists functional node is available for the users who have "Enable"
permission for the Configuration Package Management grouping node.
The Add-on Component Lists and the Add-on Configuration Packages (below) follow the
same naming convention as regular Component Lists and Configuration Packages, for
package names. Similar to the component lists, the add-on component lists can be saved
with or without performing error check.
Configuration Packages: Displays a list of component packages and enables you to create
and import newly created or existing component packages.
Add-on Configuration Packages: Lists all the added configuration packages existing in the
Development environment and is available for the users who have "Enable" permission for
the Configuration Package Management grouping node.
For more information, see Configuration Package Management in the Unifier Modules
Administration Guide.
System Information
The System Information grouping node contains the following functional nodes:
Auto Creation Audit Log: Use this node to view the auto creation events across the
company.
Autopublish Log: Use this node to view the status—successful or failed—of all auto-publish
events.
34
Company Workspace Landing Page (Admin)
Background Jobs: Use this node to view the status of tasks that are running or waiting to
run. This includes items such as running reports and refreshing cash flows at specific
intervals.
Background Jobs History: Use this node to view the status of tasks that have run
previously.
Background Jobs Statistics: Use this node to access a visual representation of the data
regarding background jobs. This node lets you identify the jobs that might be experiencing
issues during execution.
BP Visualizer: Use this node to view a list of BPs deployed in your environment and
detailed information about each one.
Cash Flow Jobs: Use this node to view a list of all active cash flow jobs. If you have the
Modify permission, you can disable scheduled jobs or auto-snapshots for cash flow curves
across all projects.
Design References: Use this node to view a list of BPs deployed in your environment and
the various references between the components used in the design of each BP.
Design Reports: Use this node to view a list of BPs deployed in your environment and view,
print, or export details about the components used in the design of each BP.
Design Usage: Use this node to view a list of BPs deployed in your environment and identify
where they are used.
Event Audit Log: This node tracks all action events across the company that are initiated by
a click. All clicks on hyperlinks are tracked from all users, regardless of their roles.
OIC Integration Log: Use this node to view a list of every Oracle Integration event. The list
includes the Initiated date and time, Origin (project number), Origin Name (project name),
Source (a Business Process, Master Rate Sheet, or an Activity Sheet), Source Reference,
Source Number, Integration, Step Name, Action, and so on.
RAP Audit Log: This node tracks all Reverse Auto-Population (RAP) processes and lists
read-only diagnostic information that includes the trigger, source, and destination names;
status; and how long execution took. Events are grouped by Trigger Name; however, you
can sort the list using any of the columns. Audit records are retained for one month or until
the table reaches 50 thousand entries. To view additional information, select the applicable
record to display a Details tab in the right pane.
REST Service Audit Log: This node tracks all REST Service Requests, including all web
service calls. To view additional information, such as response times and performance, from
the toolbar, click Trend Analysis.
System Reports: Use this node to run any of a set of predefined reports and output the
information to different formats.
Templates
The Templates grouping node contains the following functional nodes:
Shells: Lets you create and maintain templates of the following shell types. Shell templates
are used to create new or update existing shells.
35
General Administration Guide
Buildings
Linear Assets
Projects
Commitment Summaries: Displays a list of summaries for all the Commit Cost Business
Processes.
Configurable Modules: The Configurable Modules consists of the following sub-nodes:
FCA Manager: The Facility Condition Assessment (FCA) manager is a Project/Shell
level Code-based type manager with the following components:
Detail Form
Picker
Generic Cost Manager
Material Inventory Manager
Parts Manager
Cost Sheets: Lets you create and manage Cost Templates that can help you track and
manage cost in projects/shells, and across the company.
Folder Structures: Lets you create and manage templates for the folder and subfolder
structure used in a shell document manager.
Funding: The Funding node consists of the following functional nodes:
Funding Sheets: Lets you create and manage one template for a company funding
sheet and multiple templates for project/shell funding sheets.
Commitment Funding Sheets
Region/District
Site/Campus
General Spends SOV: Lets you define the required columns and formulas that are used to
validate summary commitments.
Reports: Lets you create and manage user-defined reports (UDRs) that can be added to a
shell or shell template.
Rules: Lets you create and manage the requirements that are used to validate the steps
taken for business process records.
Schedule Sheets: Lets you create and manage schedules of activities within the company.
Company Workspace
The Company Workspace node contains the following functional nodes:
Business Process Setup: Lets you configure how a business process deployed at the
Company level will function.
36
Company Workspace Landing Page (Admin)
Business Process Updates: Lets you update Preventive Maintenance (PM) Books for PM
functionality at the Company level.
Planning Manager: Provides sponsoring companies the ability to create, organize, manage,
and update all company or project/shell planning initiatives from conception to completion.
Resource Manager: Lets you create and manage personnel resources and assign roles to
each resource.
Roles
Resources
Rules: Lets you create and manage rules that govern transactions on the Company level
cost sheet.
Auto-update Status Setup: Lets you configure automatic updates of project statuses for
active projects.
37
Shell Landing Page (Admin)
After you create a shell, it is available for use.
To access your shell landing page:
1) Click the shell tab to open it.
2) Switch to Admin mode.
3) In the left Navigator, select your shell name on top.
The top section of the landing page contains the Shell Dashboard.
By default, the shell dashboard contains the following blocks:
Tasks
Notifications
Mail
Image
Details
Links
By default, the following two tabs are displayed.
Summary
Workspaces
You can change the layout of the tabs in My Dashboard.
Example
Block Length: 2 units
Block Height: 2 units
The following explains the various informational blocks in the Summary tab:
Tasks
This block lists the total number of tasks belonging to the shell. In User mode, when you click
Tasks, you go directly to the Task log.
Notifications
This block lists the total number of notifications belonging to the shell. In User mode, when
you click Notifications, you go directly to the Notifications log.
Mail
This block lists the total number of e-mails belonging to the shell. In User mode, when you
click Mail, you go directly to the Inbox log.
Note: Accessing the Tasks, Notifications, and Inbox logs by clicking their
respective tabs is not supported in Admin mode.
Image
This block displays an image, if available; otherwise, the block will be blank.
39
General Administration Guide
Details
This block is displayed with either custom fields or default fields based on the configuration of
the details block that is designed in uDesigner, shell manager. In the latest version, the shell
home landing page displays the custom fields; otherwise, the shell home landing page only
displays the default fields.
You can edit the details block by clicking My Dashboard, selecting Edit Dashboard, and
using the pen icon that appears when hovering over the block. This capability applies to
block information, or to the fields that must be displayed in the block.
Links
If links have been added to the shell details, those links are displayed in this block.
Important Information
The Tasks, Notification, and Mail are grouped together in a standard block called "Items
Requiring your Attention" that can be added or removed. Individual tiles cannot be added or
removed.
You can add this block by navigating to the Add Block button (the plus button with a down
arrow), clicking Standard, and selecting Data Type as "Items Requiring Your Attention." When
you save the Standard Block, the block will be added automatically to the dashboard.
The following explains the various informational blocks in the Workspaces tab:
The Workspaces tab is only available when geo-code server details are configured in Unifier.
If there is no geo-location present in the sub-shells, Unifier displays a map without location
markers.
If there is a geo-location present in the sub-shells, Unifier displays a map with location
markers.
When you hover over the location markers on the map, you can see the details for the location
marker based on available information.
When you right-click the location marker, you can open the shell (for that location) in a new tab.
The left pane of the workspaces tab displays a log of all sub-shells that have been created under
the currently selected shell. You can access sub-shell dashboards by clicking the gear menu (
) and selecting Open. If you would like to navigate backwards to parent shells, you can use the
breadcrumb links listed above the Workspaces tab.
The user-created dashboards support all the existing functionalities, except the sub-shell log.
You can show or hide this tab in the Edit Dashboard window.
You cannot delete the Workspaces tab in any Dashboard.
The My Dashboard submenu (the three dots) enables you to:
Access additional dashboards for the shell, if available.
Edit Dashboard
To open the editing mode of the current dashboard.
Details
To view the shell details, as overlay. The details include Shell Name, Shell Number, and the
following tabs:
40
Shell Landing Page (Admin)
General
Currency
Options
Images
Links
Calendar
Custom Print Template
Gateway Integration
Print
To print the information on this page.
Audit Log
To open the Audit Log as an overlay.
The Workspaces tab Sub-shell log has the following toolbar options:
View
For example, Buildings, Land, Projects, Regions.
Group By
Select, Hierarchy.
Actions
Get Activity Sheet Data
All Shells
Selected Shells
Filtered Shells
History
Send Activity Sheet Data
All Shells
Selected Shells
Filtered Shells
History
Search
Find on page
Expand All Groups
The columns in the Workspaces tab sub-shell log are not hard-coded. The fields defined in Shell
Detail form (in uDesigner) are added as columns in the Sub-shell log.
Name
Shell Number
Shell Name
Description
Status
Administrator
41
General Administration Guide
Location
User-Defined Text
The right pane displays the map that shows the regions.
42
Project Landing Page (Admin)
To access your project landing page (Admin):
1) Click your project tab to open it.
2) Switch to Admin mode.
3) In the left Navigator, at the very top, click your project name.
The project landing page has the following elements:
Left Navigator contains the following nodes (modules):
Project name
Member Companies
Access Control
User Administration
Setup
Rules
Right pane, which contains:
On the top:
Tab name: Company Workspace
Menu options (File, Edit, View, and Help)
Toolbar options (New, Open, and Find)
Below the top, on the left, project general information:
Project name
Description
Number
Address
City
State
Country
Phone
Fax
Email Address
Below the top, on the right:
Progress
Links
43
Queries
You will be using queries to extract data from the database for reports and data pickers and to
set up auto-creation with creator elements.
A query is a data mining tool—a method for retrieving information from a database. A query
filters the information returned from the database according to restrictions or conditions you
specify. Unifier queries can:
Filter or narrow the data being retrieved for use in reports and manager sheets.
Set up conditions or triggers to make something happen automatically.
Filter or narrow the data being retrieved for use in a data picker element.
In This Section
How Queries Work .................................................................................................. 45
Using Formulas or Conditions in Queries................................................................. 46
Assignee Filter Query Condition .............................................................................. 50
Query Based Data Element (QBDE) ........................................................................ 52
Defining the Format of the Currency for QBDE ........................................................ 53
45
General Administration Guide
When (or if) the data meets the condition you specify, the system retrieves it from the
database for use in a report, manager sheet, auto-creation, data picker, and so on.
46
Queries
47
General Administration Guide
Date Difference
The formula for date difference subtracts one date from another to give you the number of days
between the dates.
48
Queries
49
General Administration Guide
Between Dates
You can compare a date field value to see if it falls between two dates. This is then used to
populate a data picker.
50
Queries
Note: If the workflow setup has any of the new operators, the list of
assignees that the user sees at runtime retains the stated query
parameters.
51
General Administration Guide
Notes:
Oracle recommends that you do not use a Required field to create a
query that uses a Data Picker, Cost Breakdown Structure (CBS)
Picker, or Fund Breakdown Structure (FBS) Picker. If the data
entered in a data element (DE) field with a Required condition is
cleared, the system bases the query on the previous value of the
field.
When using QBDE, be aware that query elements are rounded off to
use two decimal places, even if the Base Currency and various
defined currency fields are different.
52
Queries
For more information about importing data, see Importing Configuration Packages in the
Unifier Modules Setup Administration Guide.
53
General Administration Guide
The Data Element properties tab of SYS Numeric Query Based Data definition contains a check
box option for hiding the currency symbol in Cost type BP. By default, this option will be
deselected.
Notes:
When the same DE is placed in non-Cost BPs, this option will be
ignored because these BPs do not display currency symbol for data
definition with Input type of Currency Amount at runtime.
When using QBDE, be aware that query elements are rounded off to
use two decimal places, even if the Base Currency and various
defined currency fields are different.
54
Dashboards
Similar to other software applications, the dashboard in Unifier is a user interface that provides a
view of important performance indicators and data related to the shell, organization, or company.
The shell dashboard is a general view of a specific shell's data, and it is not specific to any one
user view of data; therefore, the administrators can create multiple shell instance dashboards
per shell.
Administrators can configure the dashboard from the Dashboards sub-node, under the Setup
node:
1) Go to the applicable project/shell and switch to Admin mode
2) In the left Navigator, select Setup, and then select Dashboards.
The Dashboards log contains a list of existing dashboards, and the details are listed in the
following columns:
Name
Description
Last Modified By
Last Modified Date
Use the gear menu ( ) located next to each item on the log to conduct the following on each
dashboard listed:
Open
Copy
Mark as Default (Unmark as Default)
Delete
Depending on the setup, this option will change. If the Mark as Default option is available,
the selected dashboard name will replace the label My Dashboard on the shell landing
page. If the Unmark as Default option is available, the label My Dashboard will replace the
selected dashboard name on the shell landing page.
The Dashboards log also lets an administrator:
Create, delete, or find dashboards by using the following toolbar options:
Create
Delete
Find on Page
Change the dashboard properties and set permissions within the following tabs on the right
pane:
Properties tab
Change the dashboard name (Name)
Provide a description for the dashboard (Description)
Permissions tab
55
General Administration Guide
56
Self-Service Portal
The Self-Service Portal enables users to sign in and work with specifically-enabled business
processes. For example, Oracle Primavera customers use Unifier for corrective work order
management. These work requests are usually generated from project participants who do not
use Unifier. These participants can use the Self-Service Portal, which allows request submittals
through a web-based tool. Users can use the Self-Service Portal to submit requests, to view the
status of these requests, and to collaborate on submitted requests.
In uDesigner, you can enable certain business processes to be accessed through the
Self-Service Portal. The business processes that you can enable to be accessed through the
Self-Service Portal must have the following characteristics:
Simple
Company level
Non-workflow
Multi-record
The actions users can take through the Self-Service Portal are:
Create a business process
Modify a business process
Add or remove business process attachments
Add General Comments to a business process
Before you begin, design the Landing Page in terms of the text and graphics that you want it to
contain. Then:
Step 1: Set Landing Page permission.
Step 2: Configure and activate the Landing Page.
Step 3: Specify users that receive portal-specific notifications. For more information, see Setting
Up a Non-Workflow Business Process in the Unifier Modules Setup Administration Guide.
57
General Administration Guide
Note: If the Landing Page is not configured, the user who signs in to the
Self-Service Portal will see the Announcement page.
58
Adding & Managing Partner Companies
An Owner Company (also referred to as a Sponsor Company) may work with one or many
Partner Companies (for example, subcontractors, vendors, and so on) to work on projects/shells
or company-level activities. Company Administrators can manage Partner Companies and
users. The Site Administrator will first add the potential Partner Company to the list of available
companies, from which you can select the companies to activate. Partner Company users can
be granted access to specific company-level and project/shell-level features.
When a Partner Company user is added to a project/shell, the system verifies that the user's
company is a Member Company; if not, the system adds the Partner Company. When a Partner
Company is removed from a project/shell, the Partner Company users are automatically set to
Inactive.
To access Partner Companies:
1) Go to the Company Workspace tab and switch to Admin mode.
2) In the left Navigator, select User Administration, and then select select Partner
Companies.
The Partner Companies log opens. The log displays current Partner Companies.
In This Section
Add a Partner Company.......................................................................................... 59
Remove a Partner Company ................................................................................... 60
View Partner Company Profile ................................................................................ 60
59
General Administration Guide
60
Adding & Managing Partner Companies
61
Access Company Details (Edit Company
Window)
Company detail information is managed in the Edit Company window (also known as the
Company Properties window).
To access the window:
1) Go to the Company Workspace tab and switch to Admin mode.
2) In the left Navigator, select the [Company Name] icon.
3) From the toolbar, click Open.
The Edit Company window has the following tabs:
General: Use this tab to manage several company features, such as the name of the
company and a contact. The fields with red asterisks are required.
Address: Use this tab to enter up to seven company addresses. There must be at least
one address entered for the company headquarters.
Security: Use this tab to set up a file security policy and a password/login policy that your
users must follow after they sign into the system.
Contact: Use this tab to maintain support contact and e-Learning access information for
your users. The information entered here appears in the Support window (Contact tab).
E-Signatures: Use this tab to manage the default e-signature type, DocuSign setup or
Adobe Acrobat Sign (Adobe Sign) setup, to use these digital E-signature solutions within
Unifier documents.
Outgoing E-mails: Use this tab to specify the size (in megabyte [MB]) of attachments
allowed in each outgoing email.
4) After you are done updating information on the applicable tabs, click OK to save your
changes, sign out of Unifier, and then sign in again.
In This Section
Edit Company (General Tab) ................................................................................... 64
Edit Company (Address Tab) .................................................................................. 68
Edit Company (Security Tab)................................................................................... 69
Edit Company (Contact Tab) ................................................................................... 74
Edit Company (E-Signatures Tab) ........................................................................... 76
Edit Company (Outgoing E-mails Tab) .................................................................... 79
63
General Administration Guide
64
Access Company Details (Edit Company Window)
65
General Administration Guide
66
Access Company Details (Edit Company Window)
67
General Administration Guide
68
Manage Company Addresses (Address Tab)
At a minimum, a Headquarters address must be entered in the Edit Company window. The
Headquarters address will be the default company address. The default address displays on the
Company Home page and is used to generate an online company location map. You can add up
to six additional company addresses.
To manage company addresses:
1) Go to the Company Workspace tab and switch to Admin mode.
2) In the right pane, click Open. The Edit Company window opens.
3) Click the Address tab.
4) Complete all fields marked as required (red asterisk *). To enter additional addresses, click
Address Type and choose another address to enter. See the table below for details.
5) Click Apply to save changes, or OK to save and close the Edit Company window.
69
General Administration Guide
70
Access Company Details (Edit Company Window)
71
General Administration Guide
72
Access Company Details (Edit Company Window)
73
General Administration Guide
74
Manage Support and eLearning Contact Information (Contact Tab)
In the Contact tab of the Edit Company window, you can provide your users with an email
address and/or phone number of your internal support staff. This information will be displayed in
error messages users may encounter if their accounts become locked, on the Support window
Contact tab, and at the bottom of email notifications. The information included for email
notification can contain a hyperlink to your local support. For information about translating Email
Notifications, see the Internationalization (Email Notifications) section.
In addition, if your company is part of the eLearning suite of interactive tutorials, you can provide
access information to your users in this tab. This space can also be used for any location (such
as an internal website) where you have provided Unifier training materials.
To manage user support contact information:
1) Go to the Company Workspace tab and switch to Admin mode.
2) In the right pane, click the Open button. The Edit Company window opens.
3) Open the Edit Company window and click the Contact tab.
4) Under Support Contact Info and eLearning Access, you can add or modify the contact
information as needed. See the following table for details.
5) Click Apply to save changes, or OK to save and exit the Edit Company window.
75
General Administration Guide
Field/Block Description
Default E-Signature Type (Required field) To select the default
technology that provides an electronic
signature solution for the company.
DocuSign This block contains the following fields and
options:
Url: The API URL which the customer
or Oracle attains after acquiring the
license.
Account Id: The ID for the DocuSign
account
Client ID: To enter the user
identification needed to log on to
Adobe Acrobat Sign.
Client Secret: This field is needed to
76
Access Company Details (Edit Company Window)
Field/Block Description
set up integration between the system
and DocuSign.
Token: This field is needed to set up
integration between the system and
DocuSign.
Status: Inactive by default. When you
click Active, the system tests the
connection. If the connection is
successful, you can lock the status as
Active. If the connection is not
successful, you will receive pertinent
messages and the status remains
Inactive. If you successfully change
the Status as Active and then change
any of the fields, the Status changes to
Inactive, and you must select Active to
run the test connection.
Generate Token
Test Connection
To establish a connection between the
system and DocuSign:
1) Click Generate Token. The system
inspects the integrator key and the
client secret and directs the end-user
to DocuSign URL to enable them to log
in to their Demo or Production
DocuSign account.
2) After the end-user logs in to their
DocuSign account, the token will be
generated automatically in the Token
field.
3) Click Test Connection to ensure that
the connection has been made
successfully. This option is available
after you successfully entered in, and
selected values for, all the fields. If the
testing the connection fails, the system
displays the error message: Integrator
key / Client Secret / Token combination
is not correct.
4) Follow the prompts to complete the
work.
Adobe Sign This block contains the following fields and
options:
77
General Administration Guide
Field/Block Description
Url: The API URL which the customer
or Oracle attains after acquiring the
license.
Client ID: To enter the user
identification needed to log on to
Adobe Acrobat Sign.
Client Secret: This field is needed to
set up integration between the system
and Adobe Acrobat Sign.
Token: This field is needed to set up
integration between the system and
Adobe Acrobat Sign.
Status: Inactive by default. When you
click Active, the system tests the
connection. If the connection is
successful, you can lock the status as
Active. If the connection is not
successful, you will receive pertinent
messages and the status remains
Inactive. If you successfully change
the Status as Active and then change
any of the fields, the Status changes to
Inactive, and you must select Active to
run the test connection.
Generate Token
Test Connection
To establish a connection between the
system and Adobe Sign:
1) Click Generate Token. The token will
be generated automatically in the
Token field.
2) Click Test Connection to ensure that
the connection has been made
successfully. This option is available
after you successfully entered in, and
selected values for, all the fields.
3) Follow the prompts.
OK Click when you are finished.
78
Access Company Details (Edit Company Window)
79
Background Jobs
The system uses jobs to perform various:
Operations (such as auto creation)
Scheduled jobs (such as user-defined report [UDR] runs)
Record creations (from workflow [WF] templates)
Analytics data pushes (to staging table)
There are several nodes under System Information that provide access to detailed information
about background jobs. These nodes, Background Jobs, Background Jobs History, and
Background Jobs Statistics, provide certain users and groups (Company Administrators) with
access to a list of current jobs and their status, information about jobs that have previously run
and what their schedule and impact is for running again, and a more detailed view that lets you
filter and sort jobs for a visual cue that helps identify potential issues.
All current jobs (scheduled UDR, scheduled refresh of the attach flow, BP record creation using
templates) across the shells are run based on the time zone that you set up in the company
Background Jobs module (company-level time zone). In cases where the project time zone is
different from the company time zone (for example, facilities based on a certain geographical
location), you can go to the shell details (Options tab of the Details window) and from the Time
Zone for Background Jobs drop-down list select the desired time zone for all shells in the log.
After saving your changes, all the jobs within the shell will use your selected time zone.
In This Section
Setting Permissions for the Background Jobs Nodes .............................................. 81
Using the Background Jobs and Background Jobs History pages ........................... 82
Using the Background Jobs Statistics page ............................................................. 83
81
General Administration Guide
6) In the Permissions Setting for <selected item> dialog box, click the Add Users/Groups
button.
7) In the Users/Groups window, select the intended users and/or groups and click the Add
button.
8) To return to the Permissions Settings for <selected item> dialog box, click OK.
9) In the Select Users/Group section of the window, select the users or groups, and then
select the applicable level of access for the user or group in the Permissions Settings
section.
Modify: Lets the selected users and groups create or update settings. This setting
includes the View permission.
View: Lets the selected users and groups view the applicable log.
Users/Groups with View permission can view the Background Jobs log without having the
ability to edit the time zone. Users/Groups with Modify permission can view the Background
Jobs log content and edit the time zone.
10) To save your selections and return to the Module Permission Settings window, click OK.
11) Click Apply to save changes and keep the window open, or click OK to save changes and
close the window.
Refresh ( ): Lets you reload the contents of the page. When the action is complete, the
list might change.
Find on Page ( ): Lets you find items on the displayed page. When you click this option,
the system inserts a row that lets you enter filter parameters.
By default, the Time Zone for Recurring Job field shows the "(Default) <Time Zone
Name>." An Edit icon ( ) is displayed next to the field if the user has the Modify
permission.
The system uses the set time zone to calculate the next start time for time-based jobs.
The Background Jobs log displays a sortable list that supplies the following information for
each job:
Name: The name of the job. Examples include: system:collect action emails, alert:Hourly
Trigger, and so on.
Status: The possible values are Running and Waiting.
Refer to the Unifier Data Reference Guide for the default time zones and the possible values.
Next Start Time: The time that the scheduler runs the job. The value seen here will be per
User Preferences. Example: If the User preference is set, the format of the next run will be
according to this time.
Type: The possible values are Simple and Recurring. Simple is a type of job that was done
once, at a specific time. Recurring is a type of job that is done based on a calendar
schedule.
82
Background Jobs
Priority: The job priority. Only high priority jobs will have this column populated with the
value of "High." The values for other jobs will be blank.
Workspace: Displays the name or number of the shell for the job (listed under the Name
column).
At the bottom of the page is the total number of jobs that exist in the system.
The Background Jobs History log contains the same Refresh and Find on Page toolbar
options, plus includes a Search option ( ) that lets you filter what is displayed in the log.
The Background Jobs History log displays a sortable list that supplies the following
information for each job:
Name: The name of the job. Examples include: BPBulkExcelUpdate_70536_1161_uxueest,
DailyCFTrigger, and so on.
Type: The possible values are Simple and Recurring.
Thread Name: The name of the thread that executes instructions.
Trigger Time: The time at which the thread started.
Elapsed Time (ms): How long the thread took to run the job.
Delay (ms): How long a delay, if any, occurred during the running of the job.
At the bottom of the page is the total number of jobs that have run in the past.
83
Event Audit Log
The Event Audit Log functional node tracks all action events across the company that are
initiated by a click, particularly when a user clicks a hyperlink within the system. All clicks on
hyperlinks are tracked from all users, regardless of their roles. The log tracks the following
details:
Event Date: Lists when the event occurred.
Action: Lists the action taken, or the hyperlink that was clicked.
User Name: Lists the user that clicked the hyperlink or initiated the action.
Origin: Lists the shell that contains the hyperlink or action within the system. If the hyperlink
or action occurs at the company level, the value in this field is the name of the Company
Workspace tab.
Source Name: Lists the business process that contains the clicked item.
Source Number: Lists the number of the record that contains the clicked item. If the record
was not yet created at the time of the event, the value in this field will be "New Record." This
field will be blank if the event occurred in one of the following locations:
Cost Sheet
Funding Sheet
Generic Cost Manager
Configurable Manager Sheet
Planning Manager Sheet
Portfolio Manager Sheet
Company Properties
Field: The name of the hyperlink picker from where the click was made.
Proxy User: If the link was clicked by a proxy user, their user name will appear here.
Source Type: Lists the type of business process that contains the clicked item. The possible
values are:
Business Process
User Attributes
Document Manager
Cost Sheet
Funding Sheet
Generic Cost Manager
Configurable Manager
Planning Manager
Portfolio Manager
Company Properties
The toolbar of the Event Audit Log contains the following options:
Refresh: Allows you to refresh the log.
Print: Allows you to print the log through the following options:
85
General Administration Guide
Print
Export To CSV
Export To Excel
Search: Allows you to search for log items based on the source type, source name, user
name, or event date.
Find on Page: Allows you to find items on the displayed page. When you click this option,
the system inserts a row that lets you enter filter parameters.
86
Event Notifications
The event notifications are meant for the external applications that integrate with Unifier. When
data changes (based on certain triggers), the event notifications (notification records) are
generated that can be used by the external applications to pull data from Unifier.
The Event Notifications node has been set up by Oracle. The event notifications have already
been incorporated within the design of the business processes (BPs) forms.
To access the Event Notifications functional node:
1) Go to the Company Workspace tab and switch to Admin mode.
2) In the left Navigator, select Integrations, and then select Event Notifications.
The Event Notifications log displays events that happen within the Workflow or Non-workflow
BPs.
When a BP record reaches a status that is meant to generate event notifications, an entry gets
listed in the Event Notifications log. This applies to both Workflow and Non-workflow BPs.
The Event Notifications log has the following toolbar options:
View: This drop-down list lets you select the system-defined views that are available to
all users that have access to view the Event Notifications log. It also lets you create and
manage log views. The options are:
All Notifications: This is the default view for the log. By default, all rows in this log
(sorted by Event Date and in descending order) are visible to the users.
Group by Object Name: This means grouping the rows in the grid by the "Object
Name" parameter. The user has the ability to create a view and manage views.
Any view created by any user who has permissions to this log will be available to
all other users who have permissions to this log. Similarly, any view edited or
deleted by one user will be edited or deleted for all other users using this log.
Create New View: Use this option to create a custom view. Custom views appear
in the View list.
Manage Views: Use this option to change the order of views, show or hide views,
and delete the custom views.
Edit View: Lets you select which columns to display or hide, apply filters, group and sort
by available fields, and save custom views.
Refresh: To update the information displayed on the screen.
Print: To print the information displayed on the screen. Your options are:
Print
Export To CSV
Export To Excel
Search: To open a screen and search for a record by applying value operators in
columns.
Find on Page: To find items on the displayed page. When you click this option, the
system inserts a row that lets you enter filter parameters.
87
General Administration Guide
88
Event Notifications
89
General Administration Guide
90
Event Notifications
When finished, click Apply and then click OK to close the window. To discard your changes
or close the window click Cancel.
Users or groups with the View permission have the ability to:
a. See the Event Notifications node in the left Navigator.
b. Take actions using available options in the log toolbar.
c. View all notifications records within the log.
91
uDesigner Overview
uDesigner is a functional module of Unifier and is enabled automatically when the system is
installed. When your Test or Development environment is first provisioned, a Base Configuration
Package is installed. This package contains the essential attribute forms, a single-instance shell,
and a multi-instance shell, which creates a basic framework that you can use to build your own
customized configurations.
The uDesigner module is used to create:
Business Processes (BP)
Managers (such as Asset, Cost, Document, Planning, Portfolio, Space, Shell, and so on)
Configurable Modules
Attribute Forms (Users, Shells, Document Manager, Cost)
Collapse by Default Option in Block Properties
In the Block Properties window of both a BP form and a manager attribute form, there is a new
check box called Collapse by Default. If the check box is checked, the block is collapsed by
default. If the check box is deselected, the block is expanded by default.
With the Collapse by Default option, you can avoid scrolling through irrelevant information.
Under the Collapse by Default check box, the following note is displayed: “The block will be
collapsed in User mode, only if the block has a label and the Show Border and Show Label
options are checked. This option is applicable only for Standard View of forms.”
Collapse by Default is applicable to the following forms: Action form, View form, Detail form,
and various attribute forms.
Additional uDesigner Options
You can use the uDesigner module to:
Create a design in the Development environment.
Configure, set up, and test your designs in both the Development environment and Test
environment.
After this point you can import your designs to the Production environment by way of
Configuration Package.
Oracle recommends that you:
Create your Configuration Package in the Development environment and import your
Configuration Package to the Test environment for additional testing.
Import your Configuration Package from the Development environment onto the
Production environment for use.
You can select the Unifier environment in the Unifier Configurator.
The Development environment is a server deployed by selecting the server type as
"Development" in the Unifier Configurator.
93
General Administration Guide
The Test environment is a server deployed by selecting the server type as "Test" in the
Unifier Configurator.
The Production environment is a server deployed by selecting the server type as
"Production" in the Unifier Configurator.
The Development/Test environment is an environment that replicates the Unifier Production
environment.
An object (for example a BP) can be deployed multiple times only in the Development
environment.
94
User Administration
This section covers adding and managing related permission settings and related access control
for:
Company Users (Sponsor Company and Partner Company users)
Partner Users (Partner users)
Groups (user groups)
Task Reassignment (access control)
Integration Users
In This Section
Owner Company or Sponsor Company ................................................................... 95
Partner Company or Member Company .................................................................. 96
Assigning Application Access (Cloud Only) ............................................................. 97
Editing User Permissions at Company, Shell, and Project Levels ............................ 97
Importing User Attribute Form.................................................................................. 99
Adding and Managing Company Users ................................................................... 99
Creating Partner Companies, Users, and Permission Settings (On-Premises Only)119
Creating Partner Companies and Users (Cloud Only) ........................................... 121
Adding and Managing Partner Company Users ..................................................... 121
Adding and Managing Groups ............................................................................... 129
Integration Users ................................................................................................... 131
Managing Users in Bulk ......................................................................................... 139
Creating and Managing User Preference Templates ............................................. 141
Updating the Email Address for a Project/Shell ..................................................... 144
Creating and Maintaining an Approved Email List for Project/Shell Mailboxes ....... 145
Managing Permissions and Access Control ........................................................... 149
Announcements Node ........................................................................................... 152
Working with the License Manager ........................................................................ 155
Running System Usage Reports............................................................................ 158
Setting Permissions for Inbox ................................................................................ 174
Setting Permissions for Unpublished Attachments................................................. 175
Task Reassignment (Company and Project).......................................................... 175
95
General Administration Guide
Note: You can only edit the user attribute fields that are relevant to each
project/shell.
Within a shell, on the General tab (of the members in Users or Groups) you can click the Copy
Attributes from Company Workspace option to fetch all the company-level user attribute
values from the company (Company Workspace tab) and populate the user attributes values
the General tab.
1) Go to the Company Workspace tab and switch to Admin mode.
96
User Administration
2) In the left Navigator, select User Administration, and then select Company Users or
Partner Users to open the log.
3) Select a member from the log and click Open.
4) In the Edit User window for the user that you selected (General tab) enter the user
attributes.
5) Click Apply to save your changes and then click OK to close the window.
6) Go to the project/shell tab and switch to Admin mode.
7) In the left Navigator, select User Administration, and then select Users or Groups to open
the log.
8) Select the member from the log and click Open.
9) In the Edit User window for the user that you selected (General tab) click Copy Attributes
from Company Workspace.
10) Follow the prompts so that the system can fetch all the company-level user attribute values
from the company (Company Workspace tab) and populate the user attributes values the
General tab.
When finished, click Apply to save your changes and then click OK to close the window.
Click Cancel to discard your changes and close the window.
97
General Administration Guide
A user with Create permission at the company level will be able to create users and modify
all the properties of the users, including the status and permissions.
When a user has Modify Status permission only, the Status option is enabled. The Apply
and OK options are displayed and enabled. All the other fields are not editable. A user who
only has the Modify Status permission will be able to modify the status of users both from
the User Properties window and the log.
Note: The ability to update the status from the log is not available at the
shell, or project, level.
When a user has the Modify Properties permission only, the Status option is not enabled
(disabled). In this case, the user needs the Modify Status permission to be able to edit the
Status field. The Apply and OK options are displayed and enabled. All the other fields are
editable.
A user who has the Modify Properties permission without the Modify Status permission
can modify the properties of the user. A user who has the Modify Properties permission
without the Modify Status permission cannot modify the status of the users.
When a user does not have the option to view the Audit Log because Hide Audit Log is
enabled, it prevents the user from viewing the Audit Log for a project/shell, which ensures
that the user is not aware of what changes are made to the shell, when they are made, and
by whom.
You can grant specific permissions to the project/shell team members to allow them to conduct
specific user administration setup tasks (such as maintenance tasks) according to the
permissions that you have granted to them. You can set up these permissions in the Permission
Settings for Users under the User Administration category in Access Control (Admin mode).
The Permissions tab for the Users (under the User Administration) are:
Add Users
Modify Status
Modify Permissions
Modify Properties
View
You can select any of the above permission options independently. When applicable, the
second-level options will be selected automatically, when the first-level option is selected. This
does not work in the opposite order. The same applies to the User/Groups.
Example
If you select "Add Users" (a first-level option), the "View" (a second-level option) is selected
automatically, but if you select "View" only, no other options are selected automatically.
While you are adding or modifying a user's permissions in a project/shell, the Permissions tab
displays the user's permissions in read-only mode, if the user does not have the permission to
modify permissions (Modify Permissions), despite having other permissions.
98
User Administration
Note: The new attribute will be available only for Company Users log
and Partner Users log and will not be available as part of custom
attributes in other module designs.
All designs, including user attribute forms, are designed in uDesigner and deployed to Unifier.
For more information, see Importing Configuration Packages in the Unifier Modules Setup
Administration Guide.
Note: For information about the columns, such as time zone, user type,
and language, see the Unifier Integration Interface Guide.
To ensure compliance with company standards and to restrict access, Oracle recommends that
the responsibility for user administration (at the company level) be delegated to one person or a
small group of people.
To access the Users log:
1) Go to the Company Workspace tab and switch to Admin mode.
2) In the left Navigator, select User Administration, and then select Company Users.
The Users log lists the users defined for your organization.
3) To open an existing record, select a user in the list and click Open.
99
General Administration Guide
Note: If a User Attribute form has been imported, the columns that
appear in the Users log can vary. If designed in uDesigner, the log can
include navigation in the left pane. This navigation lets you filter the
display of listed users listed. If you decide that you want a standard log
to display, you can remove the navigation from the log in uDesigner.
Also, the search criteria in the Find window and sort order can vary
depending on what was added to the User log design in the User
Attribute form.
User Type
The User Type column in the Users log identifies the type of user per following:
SYS User Type/Standard: The SYS User Type/Standard User, which refers to both
Company and Partner users, can have access to all modules, except Earned Value
Management (EVM). If the Earned Value Management component is selected for a Standard
User, the component will be available to the Standard User. The licensing purchased by your
organization determines whether EVM is included.
SYS User Type/Portal: The SYS User Type/Portal User can only have access to the
self-service portal login.
The Users log contains multiple menu options that you can use to perform steps such as
creating new users manually or through import or updating types. The toolbar options provide
access to some of the same features as well as providing quick access to changing the Status of
a user account.
The Update User Type (To Portal and To Standard) option, collectively, work as a bulk action
on one or more selected user rows for updating the user type. For example, you can select one
row, or multiple rows, click Update User Type, and change the user type to portal or standard.
If the user type attribute is not mentioned when creating the user, the user type for that user will
be set to Standard by default.
The Attribute "Earned Value Management" displayed is unchecked by default. If the user selects
this option, the user will be granted access to the Earned Value Management module. This
check box will be disabled for Portal users. The licensing purchased by your organization
determines whether this check box is visible.
Note: The check box for Earned Value Management users will be seen
only when the Earned Value Management module is loaded.
In the License Manager, the Company user and Partner user are considered Standard users in
terms of license count and combined count for License Terms and Current Usage. (For more
information on using the License Manager, see Working with the License Manager (on page
155).) The License Manager page will generate and update a gauge chart for the following
license types, which varies depending on the licensing purchased by your organization:
Standard Users
100
User Administration
Portal Users
Collaborator Users
Earned Value Management Users
The counts for Portal users and Earned Value Management (EVM) users depend on:
Whether a particular Company user is marked as a Portal user, and
The Earned Value Management user in User Administration.
If there are more active users with accounts than the product is licensed for, the calculations in
the Active Named Users fields might be higher in the Current Usage sections versus the
License Terms sections. The excess or surplus (overage) is calculated in the same way as the
Standard users.
The Site Administrator can edit the license terms and view the audit log for the users by clicking
the Settings icon. When editing the user count, the Site Administrator will have to enter a
combined number for active named users. Depending on the licensing purchased by your
organization, the Site Administrator will also be able to edit the Portal users and EVM users
count by using the General and Notifications tabs on the License Terms window.
The User Type column will be seen by default in the standard user data picker. For the custom
user data picker, if the user has added the column, the user will be seen in User Type column.
In addition to the standard user (a user with access to all functionalities) and the portal user (a
user with access to limited functionalities), the system supports the Collaborator User.
Notes:
The Collaborator User is a Partner User. Any user can be declared as
a Collaborator User, but a Collaborator User will have limited access
to Unifier functionality. The Collaborator User status must be granted
to external users such as vendors.
A Collaborator User has access to the Mailbox node and its
sub-nodes.
If permission is granted, Collaborator users can view existing
user-defined reports (UDRs) and custom reports, and they can
create UDRs.
License terms for a company (customer) can only be changed by the Site Administrator (for
the cloud customers this is the Oracle Cloud Administrator). As a result, to allow a Company
Administrator to add a Collaborator User, the Site Administrator must first add licenses for the
Collaborator User. See Collaborator User (on page 104) for more details.
101
General Administration Guide
If you have created a User Preference template (in the User Preference Templates section of
Standards & Libraries), the active template will automatically be used to generate the new
user's user preferences. If there is no active template present, the system default settings will be
used for the user preferences.
To add a company user:
1) Go to the Company Workspace tab and switch to Admin mode.
2) In the left Navigator, select User Administration, and then select Company Users.
3) From the toolbar, click New, and then select Manual.
4) In the Edit User window, complete the fields of the General tab as discussed in the following
table.
5) Click the Security tab. You must also add a login user name before saving the record. See
Manage User Login Information (Security Tab) (on page 111) for details.
6) At this point, you can activate the user, save the record, or complete the rest of the tabs:
Groups: You can add the user to existing groups. The default groups are Company
Administrators, Project Administrators, Shell Administrators, and Support. The user
automatically inherits group permissions. See Manage a user's group membership
(Groups tab) for details.
Permissions: You can configure individual permission settings for the user in this tab.
See Edit User Permissions (Permissions Tab) (on page 113) for details. Alternatively,
you can assign the user to a group (the user will automatically inherit group permissions),
or assign permission through Access Control.
Projects/Shells: This tab lists the projects/shells to which the user has been added and
is view-only. See View User's Project and Shell Membership (Project/Shell Tabs).
Proxy: You can add or view the user's proxy users in this tab. See Designate a Proxy
User (Proxy Tab) (on page 114).
7) Click Apply to save changes, or OK to save and exit the window.
102
User Administration
103
General Administration Guide
Collaborator User
The Company Administrator can:
Create a user of the type "collaborator" only in the Partner Users functional node (go to the
Company Workspace tab and switch to Admin mode; in the left Navigator, select User
Administration and then select Partner Users).
Bulk update the user type to "Collaborator."
Grant view-only permissions to existing user-defined reports (UDRs) and custom reports.
Grant permission to create UDRs.
104
User Administration
If you make a user a Contractor by assigning the Contractor User Type in Primavera
Administration, the user consumes a Collaborator license in the system. Any other user
classification (Employee, Intern, Temp, External, Service, Generic) consumes a Standard
license.
Attention Unifier Cloud Administrator
When you are provisioning users in Primavera Administration:
a) While setting up users of Collaborator license type, you must select the user type as
“Contractor” in Primavera Administration. The user type of “Contractor” is reserved for the
"Collaborator" user type of Unifier. You must not use the user type “Contractor” for any other
user type that may count towards Standard license.
b) If you want to create users with Standard license type, you can choose the user type to be
any of the other values such as Generic, Intern, and so forth.
105
General Administration Guide
You can add a Collaborator User of the new license type in User Administration for Partner
Users through CSV.
For the identity domain or Primavera Administration, to create a Collaborator User, a new
attribute for the user type must be created, when creating a user.
Navigational nodes seen (Home):
Home
Tasks
E-Signatures
Notifications
Inbox
Drafts
Sent items
106
User Administration
Inbox
Notifications
Sent Items
Deleted Items
Information
Document Manager, with all the sub-nodes (based on logged-in user permissions).
Logs, with all the business processes (that the logged-in user has navigational-level access
to).
Reports (based on permissions).
User-Defined
Custom
Because Project Mailbox is not available to the Collaborator User, the same option is also not
available under "Linked Mail" of a BP. If there are any existing emails from the Project Mailbox in
the linked mail of the particular BP, the emails would still be visible and accessible.
The Collaborator User will not have access to any non-BP type object in the left Navigator. If
there are references on the BP forms, the Collaborator User will be able to access them. Also,
any records that can be opened by way of a hyperlink in a non-BP type picker will be accessible
to user.
Note: A user who does not have permissions for any shells can click any
shell picker on the BP forms and add or reference a shell in a BP; the
system does not restrict this based on the permissions. The same rule
applies to a Collaborator User.
A Collaborator User can have other Standard users who can act as proxies and can act as a
proxy for other users. A Collaborator User can view this list in the My Proxy tab. All sub-options
seen in the Preferences window are the same as other Standard users, including the Email
Subscription options.
Note: The system does not prevent the Company Administrator from
setting Collaborator user types as Proxy users; however, at runtime
these types of users will not see the option to proxy on behalf of
someone else.
The User Type "Collaborator User" is not available in the Bulk Edit log, and the license count is
not checked when updates are made through bulk edit.
107
General Administration Guide
A Collaborator User has access to the following options in the top pane:
Announcements
Bookmarks
Help
Recent Locations
Key Locations
Delete a User
Company Administrators can delete an existing user from the shell template. This section
describes how to manually delete a user from a shell.
Note: You can delete a user from a specific shell template but not from
other Projects/Shells that have been created using the template.
108
User Administration
3) From the File, select Export , and then select All; or select users in the log and from the
File menu, select Export, and then select Selection.
Depending on your browser, the CSV file will be automatically downloaded or you will be
prompted to download it manually.
To populate the CSV file with user information:
1) Open Microsoft Excel (or another program compatible with CSV format) and open the CSV
file you just saved.
2) Enter or modify user information in the spreadsheet. The fields are discussed in the following
table. Ensure that you review the notes after the table.
3) Save in CSV format.
109
General Administration Guide
110
User Administration
If any rows contain errors, no rows are imported. Error messages are listed in the CSV file.
To fix import errors:
If you receive the Confirmation message:
Import could not be completed. Do you want to download a file with errors
shown?
1) Click Yes to open the CSV file.
2) Fix the rows that contain errors.
3) Re-import the file.
111
General Administration Guide
Notes:
The Security tab is not available if Unifier is integrated with SSO
(LDAP, OAM).
To retain the Admin options when you log in to LDAP, you must
create a new Admin (for LDAP log in) and add the new Admin to the
company user/group. Only one company Admin can be added, with
all pertinent privileges.
112
User Administration
Note: If you are using OIM to add users to your company, you will still
have to use these instructions to add users to groups.
113
General Administration Guide
Note: If the specified proxy user has Send notifications in a single daily
digest selected on the Options tab of their User Preferences, it will
impact when they receive notification of the task they must perform as
proxy. Ensure that the Send notifications in a single daily digest check
box is deselected for the proxy user if that user must receive the task
notifications immediately.
114
User Administration
Users can add proxy users in their User Preferences window only if the Site/Company
Administrator has not checked the Do not allow Proxies option in the Proxy tab of Edit User
window.
Add
The Company Administrator can assign other users to act as proxies to your account, if you are
unable to do so.
To add a proxy:
1) Click Add to open the Proxy User Settings window.
2) Click Select to open the Users/Group Picker window.
3) Select users, click Add, and then click OK to go back to the Proxy User Settings window.
4) Enter the Start Date/Time and End Date/Time values.
5) Select the Status (Active) and click OK.
If enabled by the Administrator, Partner Users can add Owner Company Users as proxy users.
1) Go to the Company Workspace tab and switch to Admin mode.
2) In the left Navigator, select User Administration, and then select Partner Users.
3) Select a user from the Users log and click open to open the Edit User window
4) Click Proxy tab.
5) Click Add to open the Proxy User Settings window.
6) Click Select to open the Users/Group Picker window.
7) Select the desired company from the List Names from list.
8) Select users, click Add, and then click OK to go back to the Proxy User Settings window.
9) Enter the Start Date/Time and End Date/Time values.
10) Select the Status (Active) and click OK.
Settings
Use this option to select an existing proxy and change the user settings of the proxy, such as
start and end date/time. To change the user settings of the proxy, click Settings and follow the
prompts.
115
General Administration Guide
The system sets the values in the time-related fields based on the user's preferred data and time
formats.
Note: If you do not specify a start or end date, the proxy user can
access your account immediately and their access privileges will not
expire.
You can select Active to activate proxy's access. To disable proxy's access, select Inactive.
Remove
You can use this option to remove a selected proxy. To remove a user as a proxy, select the
proxy from the list and click Remove.
Proxy Login History
Use this option to view the following information about the proxies:
Name
Login Date
Logout Date
The last login information appears on top.
Note: The Sign Out link at the upper-right portion of the Unifier window
allows a proxy's session to end.
116
User Administration
117
General Administration Guide
3) In the Audit Log, double-click a listed event to view the audit record detail, which details the
action taken. The details also include for reference the current time zone of the user viewing
the audit log.
To print the audit log:
In the Audit Log, click the Print button. A PDF file of the audit log is created.
Depending on your browser, the file will be downloaded automatically to your system, or you
will be prompted to download it manually.
Reactivating Users
When a company adds a Partner Company and Partner Users to specific company-level and
project/shell-level features, the Partner Company and Partner Users are automatically granted
the same level of access to the applicable features.
Notes:
Project/shell access is limited to users (including Sponsor Company
users or Member Company users) who are chosen for the
project/shell and permissions are configurable for each company.
These processes apply to the proxy users.
Go to the Company Workspace tab and switch to Admin mode. In the left Navigator, select
User Administration, select Partner Users, and select a user to open the Edit User window. In
this window:
If you (the administrator) deactivate a Partner Company user from a project/shell that the
Partner Company was associated with and later decide to reactivate the Partner Company
user for that project/shell, the status of that Partner Company user changes to what it was
prior to the deactivation of that Partner Company user.
If you (the administrator) remove a Partner Company from a project/shell and later decided
to re-add the Partner Company to that project/shell, the status of the Partner Company users
changes to what it was prior to the removal of the Partner Company. In this scenario, the
administrator must manually activate the Partner Company user at the company level
(global), and the system automatically changes the status of the Partner Company user to
what it was prior to the removal or deactivation.
Important Information about Reactivating Users
When you deactivate the Partner Company users who are active in a project/shell and later
activate the same users, the system reverts the status of the users to "Active" or whatever the
user's status was prior to the deactivation.
When you deactivate a Partner Company in Company Workspace, the system removes the
Partner Company that exists as a Member Company (in a project/shell). If you deactivate a
Member Company from the Partner Company list in the Company Workspace, the system
removes the Member Company from all associated projects/shells and sets all Member
Company users as "Inactive." When you reactivate the Member Company at the company level,
the system adds the Member Company to all previously associated projects/shells; however, the
Partner Company users remain as Inactive.
118
User Administration
If a Partner Company is a member of a project/shell, but the Partner Company users are all set
as "Inactive" in that project/shell, when you (the administrator) decide to reactivate the Partner
Company users at the company level, the status of the Partner Company users at the shell level
remains as "Inactive."
You can reactivate a deactivated Member Company at the company level (Company
Workspace tab).
119
General Administration Guide
a. Enter the name of the Partner Company (the system conducts a search and displays a
filtered list of partner companies).
b. Alternatively, you (Company Administrator) can select the name of the Partner Company
from the list by clicking the arrow.
c. Fill out the fields under "Contact Information as in Company Directory."
d. Select the Status, and click OK.
Security: To enter the password for the user.
Groups: To add the user to an existing group.
Permissions: To assign permissions to various modules in the system.
Projects/Shells: The content in this tab is blank when creating a user, and any existing
content varies based on the Projects/Shells that the user has access to.
Proxy: To manage Proxy settings.
If the user type attribute is not mentioned when creating the user, the user type for that user will
be set to Standard user type by default.
When you are creating a user, the User Type drop-down list is defaulted to Standard user, but
you can change the User type to Portal.
The Attribute "Earned Value Management" displayed is unchecked by default. If the user checks
this option, the user will be granted access to the Earned Value Management module. This
check box will be disabled for Portal type of users. The licensing purchased by your organization
determines whether EVM is included.
Note: The check box for Earned Value Management users will be seen
only when the Earned Value Management module is loaded.
In the License Manager, the Company user and Partner user are considered Standard users in
terms of license count and combined count for License Terms and Current Usage. The License
Manager landing page will define a gauge chart for all the following license types, which varies
depending on the licensing purchased by your organization:
Standard Users
Portal Users
Earned Value Management Users
Collaborator Users
Separate counts for Portal users and Earned Value Management (EVM) users are shown for
License Terms and Current Usage. These counts will depend on:
The licensing purchased by your organization,
Whether a particular Company user is marked as Portal user, and
The Earned Value Management user in User Administration.
If there are more users with accounts than the product is licensed for, the calculations in the
Active Named Users fields might be higher in the Current Usage sections versus the License
Terms sections. The excess or surplus (overage) is calculated in the same way as the Standard
users.
120
User Administration
The Site Administrator can edit the license terms and view the audit log for the users by clicking
the Settings icon.
When editing the user count, the Site Administrator will have to put a combined number for
active named users.
Depending on the licensing purchased by your organization, the Site Administrator will also be
able to edit the Portal users and EVM users count by using the General and Notifications tabs
on the License Terms window.
For users other than the Site Administrator, only the Notifications tab will be available to be
edited.
121
General Administration Guide
User Type
As part of the log attributes, the User Type column in the Users log identifies the type of user
per following:
SYS User Type/Standard: The SYS User Type/Standard User, which refers to both
Company and Partner users, can have access to all modules, except Earned Value
Management (EVM). (The licensing purchased by your organization determines whether
EVM is included.) If the Earned Value Management component is selected for a Standard
User, it will be available to the Standard User.
SYS User Type/Collaborator: The SYS User Type/Collaborator User can have access to all
modules, except Earned Value Management (EVM). (The licensing purchased by your
organization determines whether EVM is included.)
SYS User Type/Portal: The SYS User Type/Portal User can only have access to the
self-service portal login.
Partner Company user details are managed by the Site Administrator or the company
administrator for the Partner Company. As the company administrator for your company, you
can add Partner Company users to your own company at the company or project/shell level and
control their status and permissions within your company.
If a Partner Company user is added to a project/shell, the user is automatically added to the
Partner Company Users log. Additionally, the system verifies that the user's company is a
Member Company; if not, the system adds the Partner Company.
The License Manager controls the number of active partner company users within a system.
For more information, see Working with the License Manager (on page 155).
By default, new users will have a status of Active. You can change the status or other user
detail information selecting the user from the list and clicking Open.
To access the Partner Users log:
1) Go to the Company Workspace tab and switch to Admin mode.
2) In the left Navigator, select User Administration, and then select Partner Users.
3) To open an existing user record, select a user from the log and click Open.
Note: If a User Attribute form has been imported, the columns that
appear in the Users Log can vary. If designed in uDesigner, the log can
include navigation in the left pane. This navigation allows you to filter the
display of users listed in the log. If you decide that you want a standard
log to display, you can remove the navigation from the log in uDesigner.
122
User Administration
Also, the search criteria in the Find window and sort order can also vary
depending on what was added to the User log design in the User
Attribute form.
123
General Administration Guide
124
User Administration
You can manage the following information for Partner Company users:
Status: You can change the Partner Company user to Active, Inactive, or On-Hold.
Active users are eligible to participate in company or project/shell-level activities to which
they have permissions.
125
General Administration Guide
On-Hold users appear on user pickers and can be added to business process set ups and
project/shell user lists. However, the user cannot log onto the system until they are activated.
Inactive users will not appear in user pickers. If you inactivate Partner Company users, they
will automatically become inactive throughout the system, including in any projects/shells to
which they belong. After inactivating, if you then change the status back to Active, their
status in projects/shells will not automatically change back to Active; you will need to
reactivate them at the project/shell level.
Groups: You can add a partner company user to a company or project/shell-level group as
needed.
Permissions: You control permission access for partner company users within your company.
To edit a Partner Company user's details:
1) Go to the Company Workspace tab and switch to Admin mode.
2) In the left Navigator, select User Administration, and then select Partner Users. The Users
log opens.
3) Select a partner company user and click Open. The Partner Company Edit User window
opens.
Note: The License Manager controls the number of active users within
a system.
126
User Administration
The CSV file generated using All and Selection will export data, but it will not contain the
company attribute in the CSV file.
The CSV file generated using Export Structure will not include company attribute. Such
CSV file, when used to create user by way of the Import option, will return the error,
"Company is required" indicating that a partner user cannot be created without a company
attribute.
Similarly, the Import option will be available as a sub-option of the New option in toolbar and
menu options (select File, select New, and then select Manual or Import). The Import option, in
this case, lets you perform a bulk import by way of a CSV file. The functionality is similar to the
Import option on the Company Users log.
The user can import partner users through a CSV file only when the company attribute is
present. In this scenario, the Direction (for Integration) must be set to Input or Both in
uDesigner for the user to be able to create partner users by way of the Import option.
127
General Administration Guide
When the User Attribute Form is not present, the options to import or export will be available the
same ways as when a User Attribute Form is present.
If the User Attribute Form is not defined and the user clicks Export Structure for Partner Users,
the DE "Company" is displayed by default in the exported CSV file.
Reactivating Users
When a company adds a Partner Company and Partner Users to specific company-level and
project/shell-level features, the Partner Company and Partner Users are automatically granted
the same level of access to the applicable features.
Notes:
Project/shell access is limited to users (including Sponsor Company
users or Member Company users) who are chosen for the
project/shell and permissions are configurable for each company.
These processes apply to the proxy users.
Go to the Company Workspace tab and switch to Admin mode. In the left Navigator, select
User Administration, select Partner Users, and select a user to open the Edit User window. In
this window:
If you (the administrator) deactivate a Partner Company user from a project/shell that the
Partner Company was associated with and later decide to reactivate the Partner Company
user for that project/shell, the status of that Partner Company user changes to what it was
prior to the deactivation of that Partner Company user.
If you (the administrator) remove a Partner Company from a project/shell and later decided
to re-add the Partner Company to that project/shell, the status of the Partner Company users
changes to what it was prior to the removal of the Partner Company. In this scenario, the
administrator must manually activate the Partner Company user at the company level
(global), and the system automatically changes the status of the Partner Company user to
what it was prior to the removal or deactivation.
Important Information about Reactivating Users
When you deactivate the Partner Company users who are active in a project/shell and later
activate the same users, the system reverts the status of the users to "Active" or whatever the
user's status was prior to the deactivation.
When you deactivate a Partner Company in Company Workspace, the system removes the
Partner Company that exists as a Member Company (in a project/shell). If you deactivate a
Member Company from the Partner Company list in the Company Workspace, the system
removes the Member Company from all associated projects/shells and sets all Member
Company users as "Inactive." When you reactivate the Member Company at the company level,
the system adds the Member Company to all previously associated projects/shells; however, the
Partner Company users remain as Inactive.
128
User Administration
If a Partner Company is a member of a project/shell, but the Partner Company users are all set
as "Inactive" in that project/shell, when you (the administrator) decide to reactivate the Partner
Company users at the company level, the status of the Partner Company users at the shell level
remains as "Inactive."
You can reactivate a deactivated Member Company at the company level (Company
Workspace tab).
Create a Group
The following discusses how to create a group.
To create a group:
1) Go to the Company Workspace tab and switch to Admin mode.
2) In the left Navigator, select User Administration, and then select Groups. The Groups log
opens.
3) Click the New button. The Groups window opens.
4) Complete the General tab as outlined in the following table.
5) At this point you can also complete the other two tabs:
Add user to the groups in the Members tab.
Add group permissions in the Permissions tab.
6) Click OK to add the new Group.
129
General Administration Guide
5) Select the user(s) to add to the group. (Press the Ctrl or Shift keys to select more than one
user name.)
6) Click Add. Users will appear in the Selected Users box.
7) Click OK, and then click OK again to close the Groups window.
To remove a user from a group:
From the Groups window, Members tab, select the user on the list and click Remove.
130
User Administration
2) In the left Navigator, select User Administration, and then select Groups. The Groups log
opens.
3) Select a group and click Open. The Groups window opens.
4) Click the Permissions tab.
5) You may click the plus sign next to a module to expand the options. Scroll up or down, as
needed.
6) Select a module in the upper portion of the window. Choose the Permission level for that
module in the lower portion.
7) Click OK to save.
To copy permissions from a template:
1) In the Permissions tab, click the Copy Permissions button.
2) Select the template and click OK. All permissions settings in the user record will be
overwritten and replaced with the permission settings from the template.
Delete a Group
Company Administrators can delete an existing user group from the shell. This section describes
how to manually delete a user group from a shell.
Note: You can delete a user group from a specific shell template but not
from other projects/shells that have been created using the template.
Note: System prompts the user asking to confirm deletion of the user
group.
Integration Users
Integration user refers to a user who is performing integration, using the SOAP and REST
services.
131
General Administration Guide
You (Administrator) can use the Integration Users sub-node (under User Administration
node) to view the list of integrated users, create integrated users, and assign or edit permissions
for Document Manager and access protocol (Legacy).
Note: If you create a Support Request (SR) to switch from using Basic
Authentication (Basic) to Open Authorization (OAuth) Authentication, as
described in V1 and V2 OAuth Authentication Setup and Details of
the Oracle Primavera Unifier Integration Interface Guide, you must use
the Primavera Portal to create integration users; you cannot use Unifier.
Additionally, the Status of existing integration users is changed to
Inactive.
To view details for a specific user, select the user in the log, click the gear menu ( ), and
select Open.
The following explains each element in detail.
132
User Administration
Note: If you create a Support Request (SR) to switch from using Basic
Authentication (Basic) to Open Authorization (OAuth) Authentication, as
described in Setting Up Integration Users with OAuth Authentication
and V1 GET token REST service for OAuth Authentication of the
Oracle Primavera Unifier Integration Interface Guide, you must use the
Primavera Portal to create integration users; you cannot use Unifier.
133
General Administration Guide
Permissions block
It provides the ability to determine the permissions that the user has (for modules in the system).
The Permissions block has the following fields:
Administration
Company Administration
Full Access: This permission will provide full access to the system.
Create: This permission will provide access to all the POST services.
Update: This permission will provide access to all the PUT services.
Get: This permission will provide access to all the PUT services.
User Administration
Full Access: This permission will provide access to adding and maintaining user-level
access.
Create: This permission will provide access to all the POST services.
Update: This permission will provide access to all the PUT services.
Get: This permission will provide access to all the PUT services.
Business Process
Business Process Services
Full Access: This permission will provide full access to services related to business
processes (BPs).
Create: This permission will provide access to all the POST services related to BPs.
Update: This permission will provide access to all the PUT services related to BPs.
Get: This permission will provide access to all the PUT services related to BPs.
Non-Workflow Business Process Permissions
Update: This permission will provide access for maintaining non-workflow BPs.
Get: This permission will provide access to all the PUT services related to non-workflow
BPs.
Workflow Business Process Permissions
Update: This permission will provide access to all the PUT services related to workflow
BPs.
Get: This permission will provide access to all the PUT services related to workflow BPs.
Document Manager
Document Services
Full Access: This permission will provide full access to services related to Documents.
Create: This permission will provide access to all the POST services for Documents,
which includes:
Create Documents by Path
Create Documents by Parent Folder ID
134
User Administration
Update: This permission will provide access to all the PUT services for Documents, which
includes:
Update Documents Metadata by Path
Update Document Metadata by Document ID
Get: This permission will provide access to all the PUT services for Documents, which
includes:
Get Documents by Path
Get Documents by Parent Folder ID
Get Document by File ID
Folder Services
Full Access: This permission will provide full access to services related to Folders.
Create: This permission will provide access to all the POST services for Folders, which
includes:
Create Folder by Path
Create Folder by Parent Folder ID
Update: This permission will provide access to all the PUT services for Folders, which
includes:
Update Folders Metadata by Path
Update Folder Metadata by Folder ID
Get: This permission will provide access to all the PUT services for Folders, which
includes:
Get Folders, or Documents, Metadata by Path.
Get Folders, or Documents, Metadata by Parent Folder ID
Reporting
User Defined Reports
Get: This permission will provide access to all the PUT services for user-defined reports
(UDRs).
Legacy block
SOAP Services
The Full Access permission will be supported for all the Legacy SOAP services.
The check boxes will be selected by default when clicked on Full Access.
Cost
CBS Services
Full Access: This permission will provide full access to services related to Work/Cost
Breakdown Structure (WBS/CBS).
Create: This permission will provide access to all the POST services related to CBS
Services.
Update: This permission will provide access to all the PUT services related to CBS
Services.
135
General Administration Guide
Get: This permission will provide access to all the PUT services related to CBS Services.
CashFlow Services
Full Access: This permission will provide full access to services related to CashFlow
Services.
Create: This permission will provide access to all the POST services related to CashFlow
Services.
Update: This permission will provide access to all the PUT services related to CashFlow
Services.
Get: This permission will provide access to all the PUT services related to CashFlow
Services.
CashFlow Permissions
Update: This permission will provide access for maintaining permission levels for
CashFlow Services.
Get: This permission will provide access to all the PUT services related to CashFlow
Services.
Fund
Fund Services
Full Access: This permission will provide full access to services related to Fund Services.
Create: This permission will provide access to all the POST services related to Fund
Services.
Update: This permission will provide access to all the PUT services related to Fund
Services.
Get: This permission will provide access to all the PUT services related to Fund Services.
ScheduleSheet
Schedule Sheet Services
Full Access: This permission will provide full access to services related to Schedule
Sheet Services.
Create: This permission will provide access to all the POST services related to Schedule
Sheet Services.
Update: This permission will provide access to all the PUT services related to Schedule
Sheet Services.
Get: This permission will provide access to all the PUT services related to Schedule
Sheet Services.
Activity Manager
WBS Services
Full Access: This permission will provide full access to services related to Work/Cost
Breakdown Structure (WBS/CBS).
Create: This permission will provide access to all the POST services related to WBS
Services.
136
User Administration
Update: This permission will provide access to all the PUT services related to WBS
Services.
Get: This permission will provide access to all the PUT services related to WBS Services.
Activity Sheet Services
Full Access: This permission will provide full access to services related to Activity Sheet
Services.
Create: This permission will provide access to all the POST services related to Activity
Sheet Services.
Update: This permission will provide access to all the PUT services related to Activity
Sheet Services.
Get: This permission will provide access to all the PUT services related to Activity Sheet
Services.
Master Rate Sheet
Rate Sheet Services
Full Access: This permission will provide full access to services related to Rate Sheet
Services.
Create: This permission will provide access to all the POST services related to Rate
Sheet Services.
Update: This permission will provide access to all the PUT services related to Rate Sheet
Services.
Get: This permission will provide access to all the PUT services related to Rate Sheet
Services.
ExchangeRates
Exchange Rates Services
Update: This permission will provide access to all the PUT services related to Exchange
Rates Services.
Get: This permission will provide access to all the PUT services related to Exchange
Rates Services.
Space Manager
Space Manager Services
Full Access: This permission will provide full access to services related to Space
Manager Services.
Create: This permission will provide access to all the POST services related to Space
Manager.
Update: This permission will provide access to all the PUT services related to Space
Manager.
Get: This permission will provide access to all the PUT services related to Space
Manager.
137
General Administration Guide
138
User Administration
2) In the left Navigator, select User Administration, and then select Integration Users.
3) From the toolbar of the Integration Users log, click Print, select the Export To Excel
option, and follow the prompts.
139
General Administration Guide
Note: For cases where users have the same first and last name, the
combination of first name, last name, company, and email address is
used to uniquely identify a user. The email address is required on all
imported rows.
140
User Administration
Note: Bulk update of status is available through the Status button in the
Users log toolbar.
141
General Administration Guide
Note: The languages listed are the active languages selected by the
administrator in the Configuration - Internationalization log.
142
User Administration
143
General Administration Guide
Note: For an existing Project/Shell, the input box for Email address
144
User Administration
cannot contain zero (0) because internally the system uses zero (0), at
the time of creating the Project/Shell, to populate the Project ID
(<PID>_). As a result, zero (0) is not a valid input for the Email Address
field.
After an email resides in the Project/Shell Mailbox, a user can forward the email to appropriate
members, flag the email for review, or reply to the email.
When the system is installed for your environment, a dedicated email domain for your company
is specified. When you create a Project/Shell, the system assigns a unique identifier to the
Project/Shell. To create a dedicated mailbox as the communication repository for the
Project/Shell, the system combines your company email address (domain) and the Project/Shell
identifier.
The system considers email addresses used by any company or partner user as "approved" and
automatically whitelists the email addresses. To work with other External Users, such as
vendors, you (the Administrator) must create a list of approved domains or email addresses, or
both, that should be accepted by the Project/Shell Mailbox. This helps prevent spam and virus
attacks from infiltrating your system, by way of external emails. You can add the approved
domains and email addresses for all the users (Unifier users and External Users) by using the
Approved Email List feature. By adding a domain, you do not have to enter individual email
addresses. You can also use the Approved Email List feature to import names and email
addresses from a CSV file.
145
General Administration Guide
Note: The system accepts up to 1,000 emails from any single address
per day. The system ignores, as spam, any number of emails beyond
1,000.
Notes:
Domain names have to start with the "at" (@) symbol.
Names can include letters (abc), numbers (123), period (.), and
dashes or hyphens (- - -).
Names cannot include any other special characters or spaces.
Names cannot begin or end with a dash or hyphen.
If the system detects a domain name, the system disables the First
Name and Last Name fields.
5) Click Apply and then click OK.
To edit an email address:
1) Go to the Company Workspace tab and switch to Admin mode.
2) In the left Navigator, select Standards & Libraries, and then select Approved Email List.
3) In the log, select the email address that you want to edit and double-click the email address
to open it. The Add/Edit Approved Emails opens.
4) Edit the information and click OK.
To delete an email address:
1) Go to the Company Workspace tab and switch to Admin mode.
2) In the left Navigator, select Standards & Libraries, and then select Approved Email List.
3) In the log, select the email address you want to delete and click Delete.
To find a specific email address:
146
User Administration
Note: If you choose Export and then selected All, you do not need to
create a template structure.
The Import option, on the toolbar, lets you open the File Upload window and select files.
To import and export email addresses, you first need to create a template structure to use for
both the import and export actions.
To create a template structure:
1) On the Approved Email List log, click Export and select Structure.
2) At the prompt, click Open.
The system opens a CSV file (for example: unifier_approved_emails.csv) showing
the user information in the columns for:
Email / Domain*
First Name
Last Name
3) Save the CSV file.
147
General Administration Guide
This CSV file becomes the template for importing and exporting Approved Email List data.
In the CSV file, you can enter the email address information. If an email, or Internet domain
name, is in use and you try to add it again, the system notifies you about the duplicate record.
Notes:
Do not change column structure. Columns marked with an asterisk (*)
contain required information.
Upon importing, if the email, or Internet domain name, is not present
in the Approved Email List log, the system creates a record.
Upon importing, if the email is present in the Approved Email List log,
the system updates the First and Last Name information for that
associated record.
Upon importing, if the Internet domain name is present in the
Approved Email List log, the system ignores the First and Last Name
information for that associated record.
Example
148
User Administration
A user can be granted permissions individually or can inherit them from the groups to which the
user belongs.
If a user is in more than one group, the highest level of permissions granted in any group for a
module will prevail.
Users can be granted individual permissions in addition to group permissions. If the user-level
and group-level permissions are different for a module, the highest level will be granted to the
user.
Permissions in a project/shell template from which the project/shell is created override the
company-level permissions.
Access Control
Access Control displays the permissions granted to all users and groups per module. It lets you
quickly see which users and groups have access to each module and at what permission
setting.
You can add, remove, or adjust permissions for multiple users or groups at once, rather than
editing the properties for each user or group individually. For example, if you must grant access
permissions to a newly set up business process, or want to verify that all team members have
access to a new feature, it may be easier to do this in Access Control rather than opening each
individual group or user record.
149
General Administration Guide
You can also generate and print an Access Information table summarizing permission settings.
Permissions Tab
You can manage individual user or group permissions in the Permissions tab, which is part of
the Properties window for the user or group record. Use the Permissions tab to view or adjust
permission settings for a particular user or group.
The Permissions tab also enables access to permission templates. You can copy a permission
template to set up the permissions for a new user or group; you can also save an existing user
or group's permission settings as a new template for later use.
See Edit User Permissions (Permissions Tab) (on page 113) or Edit Group Permissions
(Permissions Tab) (on page 130).
150
User Administration
In the Module Permission Settings window, select the check box next to the user or group
and then click the Modify button. Make changes to permission settings as needed and click
OK.
151
General Administration Guide
Announcements Node
In addition to the Site (or System) Administrator, a Company Administrator will be able to create
Announcements. Also, A Company Administrator will be able to define whether a particular
announcement should be displayed to:
Users.
Bidders.
Users and bidders.
152
User Administration
Last Modified By
Last Modified Date
When the log is displayed, the default sort order is descending date of records (Last Modified
Date).
When you select an announcement record, or you hover over an announcement record, a gear
menu ( ) will be displayed. The gear menu lets you delete the selected announcement or
change the announcement status.
The Announcement properties page (the right pane) also lets you see, or change, the details of
an existing announcement. You must first select an announcement on the Announcements log.
The Announcement properties page (the right pane) also lets you:
Enter a title for your new announcement (Title). You must click the create announcement (+
Create icon) option, first.
Enter the text for a new announcement (Announcement Text). Maximum of 4000
characters, including formatting and HTML tags.
Assign a status for your new announcement (Status). Active announcements cannot be
deleted.
Determine the audience (Make an Announcement for). The default is "Both" the Users and
Bidders.
Announcement Properties
When you create an announcement record that is unread, a red bubble count-indicator icon
appears on top of the gray announcement icon (the megaphone icon). In the bubble icon, the
number of unread announcements is displayed.
When there are no unread announcements, the bubble count-indicator disappears.
When you click the announcement icon (the megaphone icon), a grid appears that displays all
the unread announcements, highlighted in red. All the announcements are displayed in
descending order, according to the date.
After an announcement record has been read by a user, the title of the record is displayed in
black. When you click the announcement hyperlink, the announcement grid appears.
In the announcement grid, only the active (Status = Active) announcement records are
displayed. The Title, Last Modified By, and Last Modified Date (for both company and system
announcements) fields are also displayed.
For the system announcements created by the Site Administrator, the sign-in name of the Site
Administrator is displayed in the Last Modified By field.
For company announcements, the full name (First + Last Name) of the user who created (Last
Modified By) the record, is displayed in the Last Modified By field.
153
General Administration Guide
2) In the left Navigator, select User Administration, and then select Access Control.
3) In the right pane, expand Administration Mode Access, and then expand General
Administration.
4) Click the Announcements sub-node to open the Module Permission Settings window
(Permission Settings for: Announcements).
5) Click Add, click Add Users/Groups, click and select user, group, or both, and click Add.
6) Assign permission: Create or View.
Create: Users/Groups with Create announcements permission will be able to create, modify,
and view all announcements.
View: Users/Groups with View permission will be able to view the existing announcements,
without the ability to modify them.
Note: "The Make an Announcement for" option is not available for the
Site Administrator.
For a Site Administrator, the following columns are displayed in the Announcements log:
Title
The title from the announcement displayed in the log.
Status
The current status of the announcement record is displayed in this column.
Last Modified Date
The date on which the announcement record was created or last modified. This an
auto-populated field. The date is displayed in the format selected by the user, in the user
Preferences window. When a field in an announcement record is modified and the
modification is saved, the Last Modified Date is updated.
Note: The Announcements log does not display the Last Modified By
column for Site Administrator.
154
User Administration
The license terms (that is, the number of allowed users) used for License Manager are
maintained by the Site Administrator and cannot be edited by the Company Administrator.
To define the threshold for License Manager notifications:
1) Go to the Company Workspace tab and switch to Admin mode.
2) In the left Navigator, select General Administration, and then select License Manager.
3) In the upper-right corner, click Settings and select License Terms.
The Earned Value Management block in License Manager is seen only when the module is
loaded. When licenses are provided for the Earned Value Management module, an additional
Earned Value Management check box is available in the Edit User dialog for standard users.
Select the check box to designate users as Earned Value Management module users, within
license terms.
Your Company Administrator can access the License Manager to:
View the current named users and user record limits.
View the usage charts.
Print usage reports.
Your Company Administrator can set up the License Manager to notify the Company
Administrator (or other designated user) automatically when the number of users is approaching
the limit.
If the number of users exceeds the number of available licenses, the system sends notifications
to the following:
Users specified in the Unifier Configurator (WebLogic).
Users who have Notify permission in the License Manager, which was set in Access
Control.
The License Manager counts users with status of Active or On-Hold. The term "active named
user" refers to any user in the system who has an Active or an On-hold status.
A user with the Inactive status is not counted against the license terms, and you can add/import
any number of Inactive users.
155
General Administration Guide
156
User Administration
157
General Administration Guide
158
User Administration
159
General Administration Guide
160
User Administration
161
General Administration Guide
162
User Administration
163
General Administration Guide
164
User Administration
165
General Administration Guide
166
User Administration
Date Added The date that this user was added to the
company. This column is empty for Partner
167
General Administration Guide
168
User Administration
Platform
Website
Mobile App
Website & Mobile App
169
General Administration Guide
About Platform
Unifier can be accessed through various platforms (website, mobile app, or both), and you have
the option to track the users when they sign in through these platforms. This ensures that you
can capture information such as number of sign-ins, device type, and so forth.
When you select the platform, the report output, will have the following columns:
170
User Administration
Last Login
This report displays last sign-in details for a user. It lists the users that have signed in, not all
user accounts. If a user has never signed in, that user will not be listed on the Last Login Report.
171
General Administration Guide
Current Login
The Current Login Report displays currently logged in users.
Report Query Parameters:
Source: All, Company Workspace, or Projects
Source Name: Active if Projects is the source. Click Select and select the Project name from
the list.
Partner Company: Select a partner or leave blank for all.
Platform: Select a platform to monitor.
172
User Administration
Proxy Login
This report displays user sign-in proxy details.
Report Query Parameters:
173
General Administration Guide
174
User Administration
175
General Administration Guide
In the case of a dynamic assignment (when a workflow is routed back to the previous step, and
the task on that step was assigned to the removed user), the system lets you send the task to
the new active user. (For any active tasks that are reassigned to a different active user, the
original assignee only receives tasks according to the configured Step Revisiting policy if the
original assignee is still active.) If the previous step was a match step <Creation> step, the
system automatically notifies the administrator and/or groups listed in the Send error
notification to field; if no one is listed in that field or the specified users are all inactive, the
system notifies the company or project/shell administrator. This also applies if a record must be
sent back for review.
The following topics describe the sub-nodes and provide more information about task
reassignment.
Active tasks are where the active user is an assignee and the record has not reached the
terminal step. This means that the previous user no longer sees the task in the log but because
of a previous action taken by the previous user, the task still appears in the log. The reasons for
this appearing in the log are as follows:
To account for Dynamic step assignment. For example, the workflow setup might have
match step <any step> in a subsequent step.
To account for step revisits.
Task Reassignment - Active User Tasks (toolbar options)
Option Description
Reassign To open the Select New Assignee
window and search for an Active user by
using the person's name or company.
You can select one or more tasks and click
Reassign.
View This option lets you view the following
pre-defined views:
All Tasks
Group by Assignee
Group by Origin
176
User Administration
Option Description
Group by Business Process
Reassignment History (For more
information, see the Reassignment
History description in Views.)
Create New View
Manage Views
You can use the Create New View option
to define user-specific views.
177
General Administration Guide
Option Description
Record Number
Reassigned on
Click Cancel to discard your changes and
return to the log.
Click Apply to apply your changes to the
view.
Click Save As to save an existing view
with another name.
178
User Administration
Option Description
Reassign To open the Select New Assignee
window and search for an Active user by
using the person's name or company.
You can select one or more tasks and click
Reassign.
179
General Administration Guide
Option Description
View This option lets you view the following
pre-defined views:
All Tasks
Group by Assignee
Group by Origin
Group by Business Process
Reassignment History
Create New View
Manage Views
You can use the Create New View option
to define user-specific views.
180
User Administration
Option Description
181
General Administration Guide
182
User Administration
The following charts describe the workflow for reassigning tasks. The first chart outlines the
high-level process as it pertains to source/origin. The second chart outlines the runtime
behavior. The subsequent topics explain each step in detail.
183
General Administration Guide
Source/Origin Overview
184
User Administration
185
General Administration Guide
Runtime Behavior
Figure 3: Flowchart of Task Reassignment
186
User Administration
187
General Administration Guide
188
User Administration
5) The system removes the notification for this task, which the user B had received because of
being a CC'd user, from the Notifications log.
Case 2: Selected new assignee is not in the Workflow (WF) setup
If the selected assignee is not in the WF setup, the user will still get the reassigned task. This
means that the task will be seen in the Tasks log.
Note: Reassigning the task does not add the user to the WF setup. This
action has to be performed by the administrator who is setting up the
workflow setup. Similarly, the user will not have navigation level
permissions to the Business Process log that the task belongs to. This
action again has to be performed by the administrator.
189
General Administration Guide
Views
You can use the views to sort or group tasks based on various attributes. You can also use the
Create New View and Manage Views options to define additional views and hide or show
views.
The following displays the views and their definitions:
View Definition
All Tasks Columns are in the following order.
Assignee
Company
Origin
Business Process
Record Number
Title
Record Due
Creation Date
Workflow Name
Other definitions are the same as in the
Tasks log.
Group by Assignee The Group By element will be Assignee.
Columns are in the following order.
Assignee
Company
Origin
190
User Administration
View Definition
Business Process
Record Number
Title
Record Due
Creation Date
Workflow Name
Other view attributes are the same as in
the All Tasks view.
Group by Origin The Group By element will be Origin.
Columns are in the following order.
Assignee
Company
Origin
Business Process
Record Number
Title
Record Due
Creation Date
Workflow Name
Other view attributes are the same as in
the Group by Origin in the Tasks log.
Group by Business Process The Group By element will be Business
Process.
Columns are in the following order.
Assignee
Company
Origin
Business Process
Record Number
Title
Record Due
Creation Date
Workflow Name
Other view attributes are the same as in
the Group by Business Process in the
Tasks log.
Reassignment History - log It is important to maintain the
reassignment history of tasks. The view
Reassignment History will enable
administrators to view all the past
191
General Administration Guide
View Definition
reassignments. When this view is active:
Toolbar option of Reassign will not be
seen. All other toolbar options will remain
as is.
Log columns will be Origin, New Assignee,
Business Process, Previous assignee,
Reassigned On, and Record Number.
The date column of Reassigned on will
retain user preferences.
Reassignment History - View settings Columns
Origin
New assignee
Business Process
Previous assignee
Reassigned on
Record Number
Filters
Previous assignee
New assignee
Origin
Business Process
Record Number
Reassigned on
The operators available will be dependent
on the data type. In addition to the filter
fields, the view definition will also have
Number of Records.
Group By
String fields
Sort By
String fields
View buttons
Note: The view settings will only have
Cancel and Apply. There can be only one
view of this type and this is already
provided by the system. While you can use
the settings to change the displayed
information temporarily, you cannot save
your changes.
192
User Administration
193
Viewing and Managing Cash Flow Jobs and Auto
Snapshots
Because your organization might have multiple cash flow jobs and automatic snapshots
scheduled to run for a multitude of projects, you can use the Cash Flow Jobs functional node to
manage the jobs and auto-snapshots and their impact on system performance. The Cash Flow
Jobs log provides an overview of all the projects and their status. For example, you might
disable the settings for any project whose Configuration Status is On-Hold or Inactive. Or
perhaps your organization has 10,000 projects managed through the system. Of those, 4,000
have reached a completed status but the cash flow jobs are still running every day because the
end date was not added or updated in the refresh schedule. Instead of updating each of the
4,000 projects separately to disable the refresh job, you can use the Cash Flow Jobs log to
disable multiple jobs simultaneously.
Using the Cash Flow Jobs log, you can sort the information displayed by clicking a column
header, such as Project Status or Auto Refresh. You can also limit the information displayed by
using the Search option. Before or after you filter what is displayed, you can print the log or
export it to a Microsoft Excel or comma-separated value (CSV) file.
You must have the Modify permission to use this page to disable the Refresh Schedule and
Auto Snapshot settings for any project managed within your organization.
To set the permissions:
1) Go to the Company Workspace tab and switch to Admin mode.
2) In the left Navigator, select User Administration, and then select Access Control.
3) In the right pane, expand Administration Mode Access, expand System Information, and
select Cash Flow Jobs.
To filter the list of items displayed:
1) Go to the Company Workspace tab and switch to Admin mode.
2) In the left Navigator, select System Information, and then select Cash Flow Jobs.
The Cash Flow Jobs log is displayed.
3) From the toolbar, click Search .
4) In the Search tab, use the various options to filter what is displayed in the log, and then click
Apply.
The system displays all the items that met the search criteria you entered.
To disable the refresh or snapshot or both:
1) Go to the Company Workspace tab and switch to Admin mode.
2) In the left Navigator, select System Information, and then select Cash Flow Jobs.
The Cash Flow Jobs log is displayed.
3) If applicable, sort or filter the list of jobs and snapshots.
4) If you only want to disable the Refresh Schedule or Auto Snapshot for specific jobs and there
are additional jobs displayed in the log, select the applicable jobs.
195
General Administration Guide
5) From the toolbar, click Actions, and select one of the following:
Disable Auto Refresh, and then select Selected Cash Flows: To disable the Refresh
Schedule for the selected items, select this option.
Disable Auto Refresh, and then select Filtered Cash Flows: To disable the Refresh
Schedule for all the items displayed after the log is filtered, select this option.
Disable Auto Snapshot, and then select Selected Cash Flows: To disable the Auto
Snapshot for the selected items, select this option.
Disable Auto Snapshot, and then select Filtered Cash Flows: To disable the Auto
Snapshot for all the items displayed after the log is filtered, select this option.
Disable Auto Refresh and Auto Snapshot, and then select Selected Cash Flows: To
disable the Refresh Schedule and Auto Snapshot for the selected items, select this
option.
Disable Auto Refresh and Auto Snapshot, and then select Filtered Cash Flows: To
disable the Refresh Schedule and Auto Snapshot for all the items displayed after the log
is filtered, select this option.
6) When the confirmation message appears, click Yes to continue or No to cancel.
After the update is processed, the Audit Log for the applicable cash flow is also updated to
reflect the change.
To print or export the list of items displayed:
1) Go to the Company Workspace tab and switch to Admin mode.
2) In the left Navigator, select System Information, and then select Cash Flow Jobs.
The Cash Flow Jobs log is displayed.
3) If applicable, sort or filter the list of jobs and snapshots.
4) From the toolbar, click Print, and select one of the following:
Print: The system generates a PDF version of the log, which you can save or print.
Export To CSV: The system generates and downloads a CSV version of the log.
Export To Excel: The system generates and downloads a Microsoft Excel version of the
log.
196
Using the BP Visualizer to View Business
Processes
Most organizations use a significant number of business processes (BPs) to facilitate business
logic within Unifier. In addition to looking at a BP in uDesigner, which is where they are created
and modified, you can use the BP Visualizer to see how a BP is set up. You can use the BP
Visualizer to view information about BPs deployed in an environment and detailed information
about each one, including their statuses, forms, logs, workflows, references, integrations, data
elements (DEs), data definitions (DDs), and general information. You can view the
cross-references between BPs and various objects, such as DEs. You can also use the BP
Visualizer to compare different versions of a BP to examine the changes that have been made
to it, which might be useful if you are responsible for determining whether a new version is ready
for deployment or for identifying a change that caused a BP to stop working in the expected
manner.
To access BP Visualizer node, you must have the View permission, which can be granted by an
administrator.
To set the View permission:
1) Go to the Company Workspace tab and switch to Admin mode.
2) In the left Navigator, select User Administration, and then select Access Control.
3) In the right pane, expand Administration Mode Access, expand System Information, and
select BP Visualizer.
4) In the Module Permission Settings window, click the Add button.
5) In the Permissions Setting for <selected item> dialog box, click the Add Users/Groups
button.
6) In the Users/Groups window, select the intended users and/or groups and click the Add
button.
7) To return to the Permissions Settings for <selected item> dialog box, click OK.
8) In the Select Users/Group section of the window, select the users or groups, and then
select the View level of access for the user or group in the Permissions Settings section.
9) To save your selections and return to the Module Permission Settings window, click OK.
10) Click Apply to save changes and keep the window open, or click OK to save changes and
close the window.
To access the BP Visualizer:
1) Go to the Company Workspace tab and switch to Admin mode.
2) In the left Navigator, select System Information, and then select BP Visualizer.
The Business Process list is displayed.
197
General Administration Guide
You can scroll through the list of BPs, use the up and down arrows next to the headings to
sort information in an ascending or descending order, or use the Filter option to refine the
display (for more information, see Filtering the List in the BP Visualizer). You can click any
BP in the list to see detailed information about it, such as forms, logs, and workflows.
The BP Visualizer log includes information for each BP ranging from the ID and name through
the date that it was created and the date on which it was last modified. After you select a BP, the
page for that BP provides the following tabs:
Tab Description
General Provides high-level information about the
BP, such as the ID, Name, Version, and
Type.
Statuses Identifies the statuses available for the BP,
such as Completed, and indicates whether
the status is a Terminal one.
Forms Lists the forms that are part of the BP, such
as Upper, Detail, and View, and provides
access to details about each form.
Logs Indicates the logs that are updated as part
of the BP and provides access to details
about each log.
Workflows Lists the workflows that the BP can follow
and lets you view the workflow itself. For
non-workflow BPs, this tab is empty.
References Lists the cross-references that might involve
the BP, ranging from a BP that might result
in the automatic creation of the selected BP
to all the pickers, data elements (DEs), and
attributes.
Integrations Provides data integration information, such
as the labels and DEs, and indicates
whether data flows in one direction or both.
Data Elements Provides detailed information about each
DE used in the BP.
Data Definitions Provides detailed information about each
data definition (DD) used in the BP.
Compare Versions Lets you compare any two versions of the
BP and view all changes or filter to show
only information that was changed, added,
or removed.
198
Using the BP Visualizer to View Business Processes
In This Section
Filtering the BP Visualizer List ............................................................................... 199
Examining Forms .................................................................................................. 199
Examining Workflows ............................................................................................ 199
Examining References .......................................................................................... 200
Comparing BP Versions ........................................................................................ 200
Examining Forms
You can use the Forms tab to view the forms that are part of the selected BP. For example, you
might want to see if an Action or View form is part of the BP, and if so, what triggers it. You can
drill down through the Forms of a BP and look at various fields and properties.
To examine the forms of a BP:
1) Go to the Company Workspace tab and switch to Admin mode.
2) In the left Navigator, select System Information, and then select BP Visualizer.
3) Click a BP.
4) In the BP Visualizer [BP Name] window, select the Forms tab.
A list of forms is displayed. You can open any of the forms and view more detailed
information.
5) To return to the list of BPs, click Show BPs in the upper-left corner.
Examining Workflows
You can use the Workflows tab to view the different workflows that the selected workflow BP
might be used in. You can drill down through a workflow and look at the steps involved using
different presentations. You can also review the information available for each step, such as the
corresponding status for a BP record.
To examine the workflows of a BP:
1) Go to the Company Workspace tab and switch to Admin mode.
2) In the left Navigator, select System Information, and then select BP Visualizer.
199
General Administration Guide
3) Click a BP.
4) In the BP Visualizer [BP Name] window, select the Workflows tab.
5) In the list of workflows, click Data Workflow for the one that you want to view.
6) To return to the list of BPs, click Show BPs in the upper-left corner.
Examining References
You can use the References tab to view the all the links within a BP and between the selected
BP and others.
To examine the references of a BP:
1) Go to the Company Workspace tab and switch to Admin mode.
2) In the left Navigator, select System Information, and then select BP Visualizer.
3) Click a BP.
4) In the BP Visualizer [BP Name] window, select the References tab.
5) Use the various options, such as Layout, to change the display.
6) To return to the list of BPs, click Show BPs in the upper-left corner.
Comparing BP Versions
You can compare any two versions of a BP design.
To compare versions:
1) Go to the Company Workspace tab and switch to Admin mode.
2) In the left Navigator, select System Information, and then select BP Visualizer.
3) Click a BP.
4) In the BP Visualizer [BP Name] window, select the Compare Versions tab.
5) In the Comparing section, select a version from the Version 1 list and the Version 2 list.
Differences are listed in alphabetical order for the elements that have changed.
System-generated changes are also included in the comparison.
You can use the options in the Filter to display all modifications or to display only specific
changes.
All: Displays all differences.
Modified: Displays the data that has been modified in the second version. Items that
differ between the two versions are highlighted in yellow.
Added: Displays the data that has been added to the second version. Items that exist in
the later version but not the earlier version are highlighted in green.
Deleted: Displays the data that has been removed from second version. Items that exist
in the earlier version but not in the later version are highlighted in pink.
6) To see detailed information about the modifications made to any part of the BP, expand the
branches of the configuration.
7) To return to the list of BPs, click Show BPs in the upper-left corner.
200
Using the BP Visualizer to View Business Processes
201
Activity Manager
Unifier enables you to create, consolidate, and monitor activities that must be completed on a
schedule by way of the Activity Manager.
Note: Unifier also enables you to set a series of rate rules that should be
applied when certain conditions are met in a project by way of the
Master Rate Sheet.
In This Section
Activity Manager Permissions................................................................................ 203
Master Rate Sheet Permissions ............................................................................ 204
203
General Administration Guide
204
About Consent Notices (Administrator)
Consent notices inform users how personal information (PI) is collected, processed, stored, and
transmitted along with details related to applicable regulations and policies. Consent notices also
alert users that the action they are taking may risk exposing PI. Unifier helps you to ensure that
you have requested the appropriate consent to collect, process, store, and transmit the PI your
organization holds as part of Unifier data. Consent notices are switched off by default in Unifier.
Consent notices should:
be written in clear language which is easy to understand.
provide the right level of detail.
identify the purpose and legal basis for your collection, processing, storage, and
transmission of PI.
identify whether data will be transferred to named third parties.
identify PI categories and list the data which will be collected, processed, stored, and
transmitted.
In This Section
About Personal Information ................................................................................... 205
Cookies in the system ............................................................................................ 206
Permission Control for Consent Notice .................................................................. 206
Your Responsibilities ............................................................................................. 207
205
General Administration Guide
206
About Consent Notices (Administrator)
3) In the right pane, expand Administration Mode Access, and then expand User
Administration.
4) Assign Consent Notice permissions through the Company Users, Partner Users, or
Groups sub-nodes.
Standards & Libraries
1) Go to the Company Workspace tab and switch to Admin mode.
2) In the left Navigator, select Standards & Libraries, and then select Permission Templates.
3) In the right pane, use Permission Templates to assign Consent Notice permissions.
Permissions can be given by anyone who has access to the nodes.
Users who have the Modify permission will be able to modify the setup and other details related
to Consent Notice, for either user or bidder consent.
If a user has only the View permission for the Consent Notice node, the user will have only
permission to view the setup and will not be able to make any edits to the consent notice setup
or other details.
Your Responsibilities
Information security and privacy laws can carry heavy penalties and fines for organizations
which do not adequately protect PI they gather and store. If these laws apply to your
organization, it is your responsibility to configure consent notices before they are required. You
should work with your data security and legal teams to determine the wording of the consent
notices you will configure in Unifier.
If a consent notice is declined, it is your responsibility to take any necessary action. For
example, you may be required to ensure that data is not stored or shared.
207
General Administration Guide
If you enable consent notices, you must enter consent notice text. Work with your data security
and legal teams to determine the wording of the consent notices. If no content is detected, the
system displays the message: The default consent notice is required if the consent notice option
is enabled.
208
About Consent Notices (Administrator)
Default Consent Notice: This option lets you enter the default consent notice for the
environment when the consent notice is enabled. You should work with your data security
and legal teams to determine the wording of the consent notices you will configure in Unifier.
You can enter the consent message (text) into the system directly as formatted text or HTML
text.
If you click Save without entering the consent notice, the system displays the message: The
default consent notice is required if the consent notice option is enabled.
Note: When you set the consent notice in this node, the consent notice
will be applicable to both the web and mobile sign-ins.
Send notifications when users reject the consent notice: This option lets you set users
or groups to be notified when a user rejects the consent notice.
Cancel: Lets you undo all the changes that you have made across all tabs. Users who have
View permission will not see this option.
Save: Lets you save all the changes that you have made across all tabs. Users who have
View permission will not see this option.
Preview: Lets you preview the content of the consent agreement.
Other tabs are language-specific consent notices that are supported in the system. If you enter
content for a specific language then the language specific consent notice will be displayed to the
users based on the user preferences for language. For example, when the language preference
(Preferences) is set to Dutch, and the Dutch consent notice is not entered, the user will see the
default consent notice content when signing in (web or mobile). The user will see the Dutch
consent notice only when a Dutch consent is entered.
209
General Administration Guide
By default, all users are tracked as Not Responded. When users sign in through web/mobile and
accept or reject the consent notice, the system tracks their responses and assigns a status
accordingly.
If you disable the consent notice option after it was enabled in an environment, the system will
not reset the tracking status for web/mobile consent and tracking statuses will remain as they
were.
The following toolbar options are displayed on the Consent Status log:
View: Lets you see the following out-of-the-box (OOTB) views:
All
Group by Consent Status
When the view is changed to Group by Consent Status, by default the groups will be
collapsed and an additional toolbar option of Expand/collapse will be displayed.
Search: Lets you find information about any user or group by way of:
Name
Email Address
Title
Company
Status
Record Number
Find on page: Lets you filter the contents of the log.
Print: Lets you print the contents of the log.
Reset Accepted Consent: This option is available when the consent notice option is
enabled. This option lets you reset the Accepted consent status to Not Responded when
there are changes in the agreement. Users who have View permission will not see this
option.
The following columns are displayed on the Consent Status log:
Name
Email Address
Title
Company
Record Number
Status
Time
210
About Consent Notices (Administrator)
2) In the left Navigator, select General Administration, select Consent Notice, and then
select Bidder Consent.
The Setup tab, which is open by default, has the following options:
Enable Consent Notice
This option is selected by default. You can use this option to enable the consent notice for
signing in through the Bidder portal.
Default Consent Notice
This option lets you enter the default consent notice for the environment when the consent
notice is enabled. You can enter the consent message (text) into the system directly, as
formatted text or HTML text. This is a required field and you must enter the consent notice. If
you click Save without entering the consent notice, the system displays the message: The
default consent notice is required if the consent notice option is enabled.
Note: When you set the consent notice it will be applicable to both the
web and mobile sign-ins.
211
General Administration Guide
Accepted
Rejected
Not Responded
By default, all the bidders seen are tracked as Not Responded. The bidders listed have been
invited to bid by way of invitations. For existing and upgrade users, all bidders who received an
invitation to bid are listed in the log.
When users sign in through the bidder portal and accept or reject the consent notice, the system
tracks their responses and assigns a status accordingly.
The log shows all bidders with Not Responded status before the web consent is enabled for first
time.
The following toolbar options are displayed on the Consent Status log:
View: Lets you see the following out-of-the-box (OOTB) views:
All
Group by Consent Status
When view is changed to Group by Consent Status, by default the groups will be collapsed
and an additional toolbar option of Expand/collapse will be displayed.
Search: Lets you find information about a user or group by way of:
Name
Email Address
Title
Company
Status
Record Number
Find on page: Lets you filter the contents of the log.
Print: Lets you print the contents of the log.
Reset Accepted Consent: This option is available when the consent notice option is
enabled. This option lets you reset the Accepted consent status to Not Responded, for
example if there are changes in the agreement.
The following examples explain how the system administers consent notices in the case of
an email address or user ID changes:
Example One
The email address of vendor record V1 was changed from Email1 to Email2, and the user
id Email1 was assigned to vendor record V2.
The system displays a new entry for the user ID (in the Consent Status log) after the
invitation is sent to the new email address. The system retains the consent agreement
provided to the previous user ID.
Example Two
The email address of vendor record V1 was changed from Email1 to Email2, and the user
id Email1 has left the organization.
212
About Consent Notices (Administrator)
The system displays a new entry for the user ID (in the Consent Status log) after the
invitation is sent to the new email address. The system removes the consent
agreement provided to the previous user ID, and the entry for that user ID is not
displayed in the Consent Status log.
The following columns are displayed on the Consent Status log:
Name
Email Address
Title
Company
Record Number
Status
Time
213
Translating Custom Strings (Internationalization)
The content of the material created by the Users (also known as custom strings) can be
translated into different languages.
Examples
Business Process (BP) name, Data Element (DE) label, drop-down labels, radio button,
navigation log names, and multi select values
Note: The user input data in Business Processes (BPs), attribute forms
of various Managers, and other similar elements, when entered at
runtime, cannot be translated.
The Internationalization node (a sub-node of the Configuration node) contains the custom
strings that the users have developed. The custom strings that are listed in the Configuration -
Internationalization log are set to provide the necessary details for translators.
Notes:
Users can translate custom defined strings into various supported
languages. The Internationalization module contains a list of custom
strings developed by the user, which provides the necessary details
for translators.
The numeric fields support international number formats (standards).
The system displays all available currencies and their respective
symbols.
Oracle provides translations for Arabic, Chinese (Simplified), Chinese (Traditional), Dutch,
English, French, German, Italian, Japanese, Korean, Portuguese (Brazilian), Russian, and
Spanish.
215
General Administration Guide
In This Section
Internationalization Node Properties ...................................................................... 216
Internationalizing Environments............................................................................. 218
Translating Methods .............................................................................................. 219
Assigning Permissions .......................................................................................... 222
Displaying Custom Strings and System Strings ..................................................... 222
Internationalization and CSV Files ......................................................................... 224
Internationalization and Web Services................................................................... 225
Internationalization (Email Notifications) ................................................................ 226
Internationalization (Support for Tools) .................................................................. 227
Internationalization (Oracle Analytics Server Custom Reports).............................. 227
Internationalization (Dashboards) .......................................................................... 228
Internationalization (Help Files) ............................................................................. 229
Internationalization (Spell Check) .......................................................................... 229
Internationalization (Date and Time Zone Formats) ............................................... 229
Internationalization (Audit Log) .............................................................................. 230
216
Translating Custom Strings (Internationalization)
Status: Active (for languages that are available for use) or Inactive (for languages
that are not available for use). Click the cell to change the status. The General tab
in the Modify Translation String window will list languages with Status = Active
so that you can modify the translation strings for each of those languages.
Default: Lets you select one language as the default language for the system.
Columns
In this tab, only languages that have been marked as Active in the Languages tab will
be displayed.
Column: Displays the column number (in the Configuration -
Internationalization log) corresponding to a particular language.
Language: Displays the name of the language.
Show Language: Lets you select which languages will be displayed in
Configuration - Internationalization log and elsewhere where the language is
available for use.
To change the sequence of the languages displayed in the log:
1) To rearrange the order of languages displayed on each row in the log list, select a language,
and click Move Up or click Move Down.
Alternatively, you can double-click the number next to the language, edit the number, and
click Update Order.
2) When finished, click Update Order, Apply, and OK.
3) Use Refresh to update the list in the Internationalization Log. The following explains the
refresh options:
Strings: Use this option to refresh the Internationalization log with the source strings
belonging to a particular source type. The system prompts you to select the Source Type
of the strings that need to be refreshed.
When you select Strings, the Refresh Strings window opens, which lets you select or
deselect the source types that you want the system to display. Click OK to save your
changes, Cancel to terminate the change.
All Strings: Use this option to refresh the Internationalization log with all custom strings
from all source types. This operation might take a few minutes.
When you select All Strings, a Confirmation message window opens explaining the
system status. Review the message and proceed as desired.
History: Use this option to see the history of refresh requests: Requestor, Source Type,
Submit Date, End Date, and Status. You can view History details after the refresh is
complete.
The following explains the function of each toolbar option in the Internationalization Log:
Open: This option lets you open the translated custom string.
Export: This option lets you export strings for bulk translation.
Import: This option lets you import a file that is ready (translated) into the system, or log.
Delete: This option lets you delete translated custom strings.
217
General Administration Guide
Note: You can delete a custom string only if it has not been used
elsewhere.
Find: This option lets you filter out the custom strings that are available in the log.
Note: When you select this option, you must select a source type and
provide search operator for the string that you want to find.
Language Log: This option lets you set the sequence of log columns.
Refresh: This option lets you refresh the items in the log with new or modified custom strings
that qualify for custom translation.
The following explains the function of each menu option in the Internationalization Log:
Note: You can perform the functions of menu options using the toolbar.
File: This option allows you to perform: Open, Export, Import, and Refresh
Edit: This option allows you to perform: Delete, Language Log
View: This option allows you to conduct a search: All, Find
Help: This option allows you to access: User Help, Admin Help, uDesigner Help, Unifier
Library, and User Productivity Kit.
The CBS Code Label and CBS Item Label data elements are available as source strings, for
Internationalization.
The following data elements are not available as source strings, for Internationalization:
CBS Code
CBS Picker
CBS Description
Also, the text "CBS Picker" is a system-defined string and not available as a source string, for
Internationalization. If you want to change the text "CBS Picker," you can use the label name for
the "bItemID" data element for the picker title. For example, if Cost Code" is the label name for
the "bItemID" data element, the picker title is "Cost Code Picker."
Note: After you change the picker name, ensure that you do the same in
the related column of the CSV, or Excel, import file to prevent import
failure.
Internationalizing Environments
A translated custom string can be used in the Development environment, Test environment,
and Production environment.
You can use the "XLIFF" file across the two environments using the export and import functions.
Workflow
218
Translating Custom Strings (Internationalization)
First, export the custom string (translated) using the Export option out of one environment.
Then, using the Import option, import the exported custom string (translated) into the other
environment.
Notes:
The transfer of translated custom strings can be done one language
at a time.
If a custom string does not exist in the destination environment, that
custom string cannot be used; however, the custom string will be
available in the Internationalization Log.
If you add a source string to your source type in the
Development/Test environment, but this source string does not exist
in the Production environment, upon exporting the XLIFF file to the
Production environment, the source string will carry over.
Translating Methods
There are two methods available in the system for translating custom strings:
User Interface
Use this translation method only when you add or modify a limited number of custom strings.
Export/Import
Use this translation method when you must translate a large number of custom strings. This
method is particularly useful to professional product-translators because the system provides
a file format (.XLIFF) that streamlines the translation efforts (Export). After the translations
are completed, the Company Administrator, or a User with appropriate permissions, can
access the node and import the translated file back into the system (Import). The translation
is done for one language at a time.
To use the User Interface translation method:
1) Go to the Internationalization node.
2) Select the custom string that you want to translate.
3) Click Open from the toolbar to open the Modify Translation String window. The Source Type
and Source String fields are read only.
4) In the Note field enter a description explaining the context and usage of the custom string
that you are about to translate.
5) Modify, or add to, the existing translations. You can enter multiple languages for the custom
string.
6) When finished, click Apply and then OK.
219
General Administration Guide
A designer designs a Data Element (DE) with the label: Vendors. The Business Process is
also named: Vendors. Since both the DE and BP constitute a design element, the Source
Type is: uDesigner.
Language codes
Use the following information to match the language settings:
Chinese (Simplified): zh_CH
Chinese (Traditional): zh_TW
English: en
French: fr
German: de
Italian: it
Japanese: ja
Korean: ko
Portuguese (Brazil): pt_BR
Russian: ru
Spanish: es
To use the Export/Import translation method:
1) Go to the Internationalization node.
2) Select the custom string that you want to translate.
3) Click Export from the toolbar to open the Export Options window.
4) Select values for the following fields:
Source Language
The current language of the custom string. (Example: English)
Target Language
The language that the source custom string has to be translated into. You can only select
one language. (Example: German)
Source Type
To allow you to filter the custom string for export base on a particular Source Type. The
drop-down list contains values such as: Data Structure, Reports, and so on. (Example:
Business Process Setup)
Include Translated Strings
This is an optional parameter. By default, this option is selected.
- If selected, the custom strings (source strings) that are currently translated into the
selected language will be exported, also.
- If deselected, only the custom strings (source strings) that are not translated into the
selected language will be exported.
5) Click Export to open the File Download window. The file download operation follows the
Unifier standard file download process.
220
Translating Custom Strings (Internationalization)
The exported file is in ".XLIFF" format and the file name contains "Unifier"
(Unifier+-+<Language Name>.XLIFF).
The number of characters allowed in the file name is based on Unifier standard. For
supported version of the "XLIFF" file refer to the Primavera Unifier Tested Configurations
document.
The exported file contains the following information: ID, Source String, Target Language, and
Note.
The Source String is the base for all translations, the Target Language is the language
selected, and the Note is a placeholder, which stores notes for the translators. The source
language attribute for the exported file originates from the Source language selection at the
time of export.
6) Save the file in your local folder and open the file using a program such as Notepad or
WordPad.
7) Open the saved XLIFF file, review the declaration information, and search for <source>.
Example:
<source>Assets</source>
8) Enter a new line, include the target language information, and save the file. Example:
<target>Aktiva</target>
9) Change the value of "approved" to "yes." Example:
<trans-unit id="l5ZQE6Yw9eD/h+JchexCKco1fHnswOCBQne0aR7L86IugwBoiYsRbBpmz+fhygs3"
approved="no”>
If you have exported .XLIFF file prior to 21.8, then your exported file will not be compatible
after 21.8. For new translations, on or after 21.8, Oracle recommends that you export the
strings again.
10) Proceed to import the file back to Unifier.
When the file is ready, use the Import option to bring the translated file back into the system.
1) Go to the Internationalization node.
2) Click Import from the toolbar to open the standard File Upload window.
3) Click Browse, and import the translated file (Unifier-,Language Name.XLIFF). Basic file
replacement and override apply.
At this point, the translated custom strings map to the appropriate language settings and are
ready to be used.
Note: The Oracle Database column size must not exceed the storage
size of 4000 bytes.
221
General Administration Guide
Assigning Permissions
The Company Administrator assigns access permissions to the Internationalization node, and
the permissions can be set for both Users and Groups.
There are two types of permissions available for the Internationalization node:
Configure
View
Users who have Configure permission can translate the custom strings, and Users who have
View permission can only view the translated custom strings.
To assign permissions to a User through the Company Users or Partner Users node:
1) Go to the Company Workspace tab and switch to Admin mode.
2) In the left Navigator, select User Administration, and then select either Company Users or
Partner Users.
3) Select a user from the log.
4) Go to the Permissions tab.
5) Expand Administration Mode Access, expand Configuration, and select
Internationalization.
6) Assign permissions as necessary.
To assign permissions to a User with Access Control:
1) Go to the Company Workspace tab and switch to Admin mode.
2) In the left Navigator, select User Administration, and then select Access Control.
3) In the pane on the right, expand Administration Mode Access, expand Configuration, and
select Internationalization.
4) Click Add.
5) Click Add Users/Groups.
6) Select all users to assign permissions to and click Add. Click OK when finished.
7) In the Permission Settings block, assign View or Configure permissions to all selected users.
Click OK when finished.
222
Translating Custom Strings (Internationalization)
Business Process (BP) name, Data Element (DE) label, drop-down (pull-down) values, radio
button, text in lines, navigation log names, and multi select values
System Strings are translated according to the user preferences, set in the User Preferences
window.
Custom Strings are translated according to the specifications added to the source string, set in
the XLIFF file.
When a combination of System and Custom strings are used (concatenation), for example, in a
form, the System String portion is translated according to the user preferences, set in the User
Preferences window, and the Custom String portion is translated according to the specifications
added to the source string, set in the XLIFF file. As a result, it is possible to see an object having
one field displayed in one language and another field displayed in another language.
In general, the translated Custom Strings cannot be displayed, or seen, while in the user is in
Admin mode, except for:
Translated Custom Strings for Attribute forms.
Example
If there is a Data Element (DE) called, "Building Name" in an Attribute form (Shell), and if the
German translation of the DE exists, then the details page displays the German translation in
Admin mode.
Pages that are shared between the User mode and Admin mode.
Example
If translated Custom Strings are available, then the pages display the translated Custom
Strings in Admin mode and are synchronized when switching to the User mode, as is the
case with:
Code-based Configurable Manager- sheet templates
Record-based Configurable Manager - sheet templates
Asset Class templates
Shell Dashboard templates
User Define Reports (UDRs) templates
Administration Mode
When in the Administration (Admin) mode, the contents that appear in the UI (also known as
System Strings) cannot be modified by the Users. The System Strings are available in different
languages, per user preferences.
Example
Sign In and Terms and Condition pages, Menus, Alerts, and Errors
In contrast, the content of the material created by the Users (also known as Custom Strings) can
be translated into different languages.
223
General Administration Guide
Example
Business Process (BP) name, Data Element (DE) label, drop-down (pull-down) values, radio
button, text in lines, navigation log names, and multi select values
System Strings are translated according to the user preferences, set in the User Preferences
window.
Custom Strings are translated according to the specifications added to the source string, set in
the XLIFF file.
When a combination of System and Custom strings are used (concatenation), for example, in a
form, the System String portion is translated according to the user preferences, set in the User
Preferences window, and the Custom String portion is translated according to the specifications
added to the source string, set in the XLIFF file. As a result, it is possible to see an object having
one field displayed in one language and another field displayed in another language.
In general, the translated Custom Strings cannot be displayed, or seen, while in the user is in
Admin mode, except for:
Translated Custom Strings for Attribute forms.
Example
If there is a Data Element (DE) called, "Building Name" in an Attribute form (Shell), and if the
German translation of the DE exists, then the details page displays the German translation in
Admin mode.
Pages that are shared between the User mode and Admin mode.
Example
If translated Custom Strings are available, then the pages display the translated Custom
Strings in Admin mode and are synchronized when switching to the User mode, as is the
case with:
Code-based Configurable Manager- sheet templates
Record-based Configurable Manager - sheet templates
Asset Class templates
Shell Dashboard templates
User Define Reports (UDRs) templates
Note: Number formatting is not supported for Symbols that are based on
a right-to-left language such as official languages of Afghanistan or
224
Translating Custom Strings (Internationalization)
Hebrew.
Notes:
If translation is not available for a custom error message, the source
string is displayed.
Before importing a CSV file, always check the Preferences settings
to see the allowed format and number formatting.
When importing, or exporting, a CSV file, the date format follows the
Preferences window (Region Format) Date Format settings.
225
General Administration Guide
Note: Number formatting is not supported for Symbols that are based on
a right-to-left language such as official languages of Afghanistan or
Hebrew.
226
Translating Custom Strings (Internationalization)
If a Business Process (BP) email notification contains an attachment with the record information,
the Custom Strings and number formatting in the attachment is according to the Preferences.
If a scheduled UDR is sent as a part of an email attachment, the language in the PDF
attachment is according to the Preferences of the UDR owner; however, the email text content
is according to the recipient's User Preferences.
When a UDR is generated manually and saved by a User, the language in the PDF attachment
is according to the Preferences of the User who generated, or ran, the UDR.
If a scheduled job such as Project Gates, where the "Auto-email as PDF attachment to users
and groups" option is selected, the language in the PDF attachment is according to the User
Preferences of the creator of the job (Project Gates creator).
When a manual refresh of the Gates is requested, the language in the PDF attachment is
according to the Preferences of the User who requested the refresh.
Oracle Map viewer supports internationalization for Tier 1 languages. Refer to the Oracle Fusion
Middleware User's Guide for Oracle for more details.
The language displayed in the map, and the following subsequent areas, is according to the
language selected in the Preferences of the user:
View map for BP records from log
Shell Landing Page
Map Picker in Log Find
Map Picker in Bulk Edit
View Map when invoked from the BP record
Note: eLocation services, which is used for geocoding, does not support
internationalization. As a result, the map labels are displayed in English.
If a user enters a label in a different language, the Find feature does not
provide the desired results.
227
General Administration Guide
If there are no templates available for the report, the Custom Report window (Report File tab)
displays according to the default settings.
To upload the translated XLIFF files and report layout, click Add to open the Add Template and
Files window, enter data in the required fields, and click OK.
Notes:
The non-RTF templates do not support internationalization.
You can only change the template type when the template is in
Creation stage. After you create a template, you cannot change the
template type. Use the report designer to create a template with the
desired template type and remove the template that is no longer
needed.
In the Custom Report window (Report File tab), the only editable column is the Default column,
which lets you set the default template by selecting the corresponding template.
Note: The system sets the first template, or XLIFF file, that you upload
as the default template.
Use Modify in the Custom Report window (Report File tab) to modify an existing template. After
you click Modify, the Modify Template and Files window opens, which lets you modify the
template and the translated XLIFF file for that template. When finished, click OK.
Use Download in the Custom Report window (Report File tab) to download a template and the
corresponding translated XLIFF file, in a zip file.
External Data Model Oracle Analytics Server Reports
If you want to download the data model of a template, select the template, and click Download
in the Custom Report window (Report File tab). When the download is complete for an Oracle
Analytics Server report, the data model is included.
Non-RTF type template
Oracle Analytics Server supports RTF templates and XLIFF files. If the report designer selects a
non-RTF type template, the Browse option in the Modify Template and Files window (Translated
XLIFF files for the Template section) will be disabled.
Custom Report (Query tab) window
Queries based on Data Definition (DD) support internationalization and number formatting
associated with internationalization according to the Preferences settings.
Queries based on Data Views do not support internationalization and formatting because raw
data is being used.
Queries based on Ad-Hoc support internationalization and number formatting associated with
internationalization according to the Preferences settings.
Internationalization (Dashboards)
Shell Dashboards
228
Translating Custom Strings (Internationalization)
The Shell Dashboards support Internationalization and number formatting for System Strings as
well as Custom Strings according to the Preferences settings.
Note: You can translate the Help files using a third-party translator and
display the files based on your Preferences settings. This includes
uploading a single PDF with multiple language help information.
229
General Administration Guide
YYYY/MM/DD
Time Zone formats
The Time Zone setting is based on the Coordinated Universal Time (UTC) and supports
Internationalization.
Note: The time format for all dates is: HH:mm AM.
230
Configuring and Publishing Oracle Analytics
Server Custom Templates (Custom Prints and
Reports)
Unifier integrates with Oracle Analytics Server to deliver on-demand web-based reporting.
Custom Reports, built in Oracle Analytics Server, enable the Company Administrator (or power
user) to build visually stunning, detailed reports. For example:
A report that combines information from multiple (and possibly non-linked) Business
Processes (BPs)
A report that needs professional looking graphics, charts, images, or clip art
The following sections explain how to create and configure custom prints and custom reports in
the Oracle Analytics Server.
To publish custom prints and custom reports:
1) Prepare the custom print or custom report.
2) Click Status.
3) Select Publish.
231
General Administration Guide
In This Section
Custom Templates (Custom Prints and Reports) Overview ................................... 232
Assigning Roles and Permissions to Oracle Analytics Server User to Publish and Run
Reports .................................................................................................................. 238
Creating Data Model (.XDM) File ........................................................................... 238
Custom Templates Windows Log .......................................................................... 238
Oracle Analytics Server Report Levels ................................................................... 242
Sample XML Data for Custom Templates (Custom Prints and Reports) ................ 242
Creating Oracle Analytics Server Custom Print ...................................................... 245
Creating Custom Email Template .......................................................................... 249
Publishing Oracle Analytics Server Custom Print ................................................... 253
Parameters for External Multiple Custom Print ...................................................... 254
Creating Oracle Analytics Server Custom Report .................................................. 255
Download and Install Oracle Analytics Publisher Desktop for Microsoft Office ....... 263
Building Report Template (RTF) ............................................................................ 263
Publishing Oracle Analytics Server Custom Report ............................................... 274
Making a New Custom Report Appear in Navigation ............................................. 274
Setting Permissions for Custom Reports................................................................ 275
Running a Report................................................................................................... 275
Uploading a Template for External Data Model Type Custom Report .................... 275
Downloading Sample XML Data for Designing New Templates ............................. 276
Modifying Existing XDM for Custom Report or Custom Print Configuration ............ 277
Adding a Dynamic Image in the Custom Print Template ........................................ 277
Adding a Dynamic Image in the Custom Report Template ..................................... 278
Adding a Dynamic Image in an Oracle Analytics Server Report ............................. 279
Adding Rich Text Data Element in Oracle Analytics Server Report and Custom Print280
Connect to the Database ....................................................................................... 281
The New option of the Custom Templates log (or select File and then select New) lets you
create the following:
232
Configuring and Publishing Oracle Analytics Server Custom Templates (Custom Prints and Reports)
Option Description
Custom Print with Internal Data Model When the user clicks New, selects
Custom Print, and then selects Custom
Print with Internal Data Model, the print
template window displays the Data Model
Type set as Internal Multiple.
Any new custom print templates will be of
data model Internal Multiple and can be
used for bulk printing and single-record
printing. Existing custom print templates of
data model type Internal can still be used
for single-record printing.
The tags generated for the XML data in the
Sample data tab are grouped differently
for data model type of Internal Multiple,
and the template designers must use the
new XML data structure and create layout
templates.
Custom Print with External Data Model External data models can be created
outside of the system. They can include
links to multiple tables and pull data from
multiple Business Processes. These data
models can be used to create custom print
templates. You can create a Custom Print
template based on an external data model.
The concept of creating a Custom Print
template based on an external data model
is similar to the concept of creating a
Custom Print template based on an
internal data model, except that the user
creates, uploads, and maintains the data
model needed for creating Custom Print
template based on an external data model.
When the user clicks New, selects
Custom Print, and then selects Custom
Print with External Data Model, the print
template window displays the Data Model
Type set as External Multiple.
Any new custom print templates will be of
data model External Multiple and can be
used for bulk printing and single-record
printing. Existing custom print templates of
data model type External can still be used
for single-record printing.
The external data model must contain
parameters that support printing of multiple
233
General Administration Guide
Option Description
records. The Record IDs pass as comma
separated value.
Report with Internal Data Model Create an Oracle Analytics Server Custom
Report based on the standard data model,
which is generated and maintained
internally by the system. When you save
the Custom Report, the system saves
changes applied to the following in the
data model:
Data views
Data links
Query parameters
Additional parameters
The Custom Report window contains the
following tabs and fields:
General
Name
Description
Data Model Type
The value for the Data Model Type field in
the General tab is set to Internal
(read-only).
Report Level
Main View
Views
Your selected values for the Report Level
and Main View fields (General tab)
determines the fields in the Views tab.
Description
Data Model Type
The value for the Data Model Type field in
the General tab is set to Internal
(read-only).
Report Level
Main View
- The Main View is not a required field
while creating the Report with External
Data Model.
- Users can add the Main View to a Report
with External Data Model if they want to
add query parameters for the report.
234
Configuring and Publishing Oracle Analytics Server Custom Templates (Custom Prints and Reports)
Option Description
Query
Parameters
Report with External Data Model Create an Oracle Analytics Server Custom
Report to upload the custom data model
file created using Oracle Analytics Server.
The system will not maintain the data
model file.
You can generate sample data for an
external model-based report provided that
the external model-based report is
published at least once. To do this, you
must externally modify the .XDM file either
manually or by using the Oracle Analytics
Server data model editor, and then upload
the report again.
This option has the same tabs as the
Report with Internal Data Model option.
The value for Data Model Type field in the
General tab is set to External (read-only).
The value for Main View depends on the
following conditions:
If an External Data Model was
generated by converting an Internal
Data Model report, the value for Main
View is set according to the Internal
Data Model report.
The user is allowed to clear the value
for Main View and save the report only
if there are no Query parameters
defined for the converted report.
The user is able to generate sample
data as before. Generation of sample
data is possible after the report has
been published at least once.
Custom Email with Internal Data Model Customize the emails that are sent to
bidders who are not a part of the system.
You can include any of the business
process data, and the email-related data,
in the notification that you want sent to the
bidder. This option is used to send email
notifications for the Request for Bid (RFB)
business processes.
The Custom Email window contains the
235
General Administration Guide
Option Description
following tab and fields:
General
Name
Description
Data Source
Lists the Request for Bid (RFB)
business processes so that you can
create the custom email notification.
Data Model Type
The value for the Data Model Type
field in the General tab is set to
Internal (read-only).
Email Type
Login Information
Bid Invitation
Due Date Change
After you are finished, click Apply to set
the values for your template and sample
data in the following tabs of the updated
Custom Email window:
Template File
You can upload multiple Rich Text Format
(RTF) templates. You can select any
template as the default template and
change the default when required. Click
Add to upload a template file that you want
to use to customize your email. The
system uses the parameters set in the
Add Template window to format the email,
using the Oracle Analytics Server.
Sample Data
After you add a template, go to the Sample
Data tab to select a sample data for the
custom email. You can generate the
sample data xml from the Sample Data
tab and download the sample data xml to
create the layout files.
You can export the published Custom
Emails using the Configuration Packages
feature.
All the fields available in the Custom Print
version of a Request for Bid (RFB)
business processes are available for the
236
Configuring and Publishing Oracle Analytics Server Custom Templates (Custom Prints and Reports)
Option Description
Custom Email version. In addition, the
following email-specific fields are available
as sample data:
From Requestor: The user who has
sent across the Bid invitation.
Email: Email ID of the requestor.
Phone: Phone number of the
requestor.
Sent for: This field signifies what is the
invitation for and has a value of ‘Bid'.
Username: The user name of the
Bidder (Email ID of the Bidder)
Password: The password that needs to
be sent across to the Bidder.
New Due: The changed value of the
Due Date of the Bid.
Bid URL: This is the URL which the
bidder needs to use to login into the
Bid portal.
Contact First
Name(uuu_contact_first_name):
This is the First Name of the Vendor's
Contact.
Contact Last
Name(uuu_contact_last_name):
This is the last Name of the Vendor's
Contact.
After you have configured the design of the
custom email, you can save your changes
and publish your design to the Oracle
Analytics Server. The Notification tab of
the Request for Bid (RFB) business
processes will contain all your added
options. You must select a notification
(Custom Notifications) for:
Bid Invitation
Login Information
Due Date Change
Each notification has a list of templates
that have been published at least once.
When Oracle Analytics Server Custom Print templates are created using external data model,
the system does not generate any additional data models for use in the print template.
237
General Administration Guide
If a custom print template of Internal_Multiple has been converted, the resulting data model will
be External_Multiple and will be available for bulk printing.
Copying a template will copy the data model associated with the source template.
Use the options in Find to select the data models Internal_Multiple and External_Multiple.
Assigning Roles and Permissions to Oracle Analytics Server User to Publish and
Run Reports
If you want to publish and run Unifier reports, the following roles and permissions must be
assigned to the Oracle Analytics Server user (who integrates Unifier and Oracle Analytics
Server):
Oracle Analytics Server Consumer: Open
Oracle Analytics Server Content Author: Traverse
Oracle Analytics Server Service Administrator: Full Control
Note: To create an .XDM file that works with the system, you must make
changes in the .XDM file, accordingly.
238
Configuring and Publishing Oracle Analytics Server Custom Templates (Custom Prints and Reports)
Description
Description of Print template or description of Report.
For External Reports: This field displays the description of the report populated from the
Oracle Analytics Server.
For Custom Print: The description of the print template, as entered in Unifier.
For Internal Reports: The description of the report, as entered in Unifier.
Type
Custom Print
External Reports: The reports that are created in the Oracle Analytics Server, and are
displayed here, will have a Type: External Reports.
Internal Reports: The reports that are created in Unifier will have a Type: Internal Reports.
Custom Email
Location
This column is empty and not available for use.
Data Model Type
Internal or External for both Print and Report.
Key
System-generated unique ID.
For External Reports: The key starts with "uuu_ext"
For Print or Internal Report: The key starts with "uuu_"
Report Level
The value is blank for Print and for both Internal and External reports, it shows Project,
Program, or Application (only for Internal Reports).
Status
Displays whether the report is in one of the following conditions:
Invalid (only applicable for the External Reports)
Draft
Publish
Publish Date/Synch Date
Date the record was last published, or synchronized, in the Oracle Analytics Server and
Unifier. This field will be blank when status is changed to Draft/Invalid.
For External Reports: The date when the report is synchronized (from Oracle Analytics
Server to Unifier).
For Custom Print: The date that the print template was published to the Oracle Analytics
Server.
For Internal Reports: The date the reports were published to the Oracle Analytics Server.
Last Modified By
Name of the user who last synchronized the record.
239
General Administration Guide
240
Configuring and Publishing Oracle Analytics Server Custom Templates (Custom Prints and Reports)
The system assigns the "Invalid" status if a report that has been previously imported to
the system is no longer in the Oracle Analytics Server.
You can delete an External Report that has the status "Invalid" from the log.
If the user had the permission to view an External Report at runtime and the status is now
set as "Invalid," the user cannot view the External Report at runtime.
Find
The Find option, on the toolbar, lets you search for a particular record in Custom Prints and
Reports log. The options for finding a report are:
Name
Type
Location
Data Model Type
Last Modified By
Synchronize External Reports
The Synchronize External Reports option, on the toolbar, lets you synchronize data between the
Oracle Analytics Server and Unifier.
This option allows you, the Administrator, to update the system with the reports created in the
Oracle Analytics Server. When you click Synchronize External Reports, the system connects to
Oracle Analytics Server to retrieve reports through Web Services.
You can set the level of the report (Report Level) in the Synchronize External Reports window
that opens after you click Synchronize External Reports.
After the synchronization is complete, you can set the permissions, per Report Level, in Unifier.
During the runtime, all changes to the report design, such as data model, layout, translation files,
and so forth, will be applied.
The following rules apply when you synchronize external reports:
The Synchronize External Reports window displays all the new reports that exist in the
Oracle Analytics Server.
Reports that exist in both Oracle Analytics Server and Unifier (same reports in terms of
count, name, and location), do not appear in the Synchronize External Reports window.
When you click Synchronize External Reports, the system synchronizes all reports. You
cannot select a particular report to be imported into Unifier.
If you have imported a report to Unifier and the report no longer exists in the Oracle Analytics
Server, when you click Synchronize External Reports, the status of the report is "Invalid" and
you cannot see the report at runtime.
If you change the name of a report in Oracle Analytics Server, the system treats the report
as a new report after synchronization.
The system sets the original report, in Unifier, as "Invalid" and you cannot see the report
at runtime.
If you change the location of a report in Oracle Analytics Server, the system treats the report
as a new report, after synchronization.
241
General Administration Guide
The Synchronize External Reports window displays the report and the report new
location, after import.
The system sets the original report, in Unifier, as "Invalid" and you cannot see the report
at runtime.
If multiple reports, with same names exist in Oracle Analytics Server, after synchronization,
all reports will be imported into Unifier.
After the reports are synchronized, the system updates the descriptions of the reports. There
will be a small delay for this operation.
If the report parameter (external reports) starts with "uuu_hidden_", it will not be available
for the user to edit in Unifier.
Synchronize External Reports window
The Report Name is a read-only field and lists the names in alphabetical order.
The Location is a read-only field and lists the location of the report in the Oracle Analytics
Server.
The Report Level is drop-down field and contains two values to select from: Project and
Program. The default value is Project, and you can modify the Report Level only at the time
of import. After you import the report, you cannot modify the Report Level. If you select an
incorrect Report Level, the system sets the status of that report as "Invalid." You can select
Synchronized External Reports option and set the Report Level in the Edit Report Level
window.
The Description field provides a description for the Oracle Analytics Server Report on the
Oracle Analytics Server.
Sample XML Data for Custom Templates (Custom Prints and Reports)
In case of a Custom Print, the sample data contains data elements that will be used in the layout
files to capture information about a business process.
Some data elements are specific to the business process selected as they map to the standard
and custom elements included in the business process forms.
242
Configuring and Publishing Oracle Analytics Server Custom Templates (Custom Prints and Reports)
If you have an image picker Data Element (DE) on your business process form, the sample data
includes the XML element, which provides the data for the ID that corresponds to the image as
well as the name of the image.
Example
If the image picker DE "AE_Image" is placed on the business process form, the generated
data XML will have the "AE_Image" DE, which provides value for the uploaded image name,
and the "k__AE_Image" DE, which provides value for the uploaded image ID.
You must use the image ID in the Oracle Analytics Server template for the custom print of the
business process.
There are some data elements present in the sample data for all the business processes
because they apply to all. These data elements provide information such as record attachments,
attachment comments, line item attachments, workflow steps, and so forth.
The following is a list of data elements and their descriptions:
Notes:
The top-level data set, in the Internal Multiple Data Model Type, is the
project_company_info. This must be the first grouping because the
Internal Multiple Custom Print template can be selected for multiple
business process records, from the Tasks log, Business Processes
log, or Master log. These pages display business process records
from multiple shells that the user has access to (permission). This
data set has fields providing information of the company and project
to which the Business Process record is associated with.
All other data sets are children to this data set.
Each XML Data Element Group represents a unique data set in the
data model uploaded to the Oracle Analytics Server and has a field
that its value uniquely represents the record.
The unique field in each data set is the field to be used as a group-by
field on the template for rendering the data grouped under the
business process record.
The unique fields are important to the template designers because of
the layout and the data that needs to be displayed on the Oracle
Analytics Server Custom Print output.
The unique field in each data set can be suffixed by a number. This
applies to other data sets as well as a similar field.
The number suffix is added automatically to maintain the uniqueness
of the field across the data sets. This is used by the Oracle Analytics
Server for the correct grouping of the data. For example, for multiple
ID fields in different data sets, the ID field appears as:
<ID_3></ID_3>.
The following explains the unique field value for the data set along
with a description.
<li_attachments>
243
General Administration Guide
<la_comments>
Unique Field: <. Unique Field: <COMMENT_ID_<<no>>>..<COMMENT_ID_<<no>>>
This element is a child of <li_attachments> and its sub-elements provide information on the
comments associated with the line-item attachment.
<standard_elements>
This is applicable to Custom Print of Data Model Type Internal.
The sub-elements of this group element provide information about company name, project
name, project number, and so on.
<general_comments>
Unique Field: <. Unique Field: <COMMENT_ID_<<no>>>..<COMMENT_ID_<<no>>>
The sub-elements of this group element provide information about general comments on the
business process.
<gc_attachments>
The element is a child of <general_comments>and its sub-elements provide information
about attachments linked to the general comment.
<record_attachments>
Unique Field: <ID_<<no>>>..</ID_<<no>>>
The sub-elements under this provide information about record attachments for the business
process.
<ra_comments>
Unique Field: <COMMENT_ID_<<no>>>..<COMMENT_ID_<<no>>>
244
Configuring and Publishing Oracle Analytics Server Custom Templates (Custom Prints and Reports)
245
General Administration Guide
See the Custom Templates (Custom Prints and Reports) Overview (on page 232) section for
more details.
Name
Enter a unique name for the custom print, up to 50 characters (use alphanumeric
characters, non-ASCII characters, or spaces).
Description
(Optional) Enter a brief description about the custom print up to 250 characters (use
non-ASCII characters).
Data Source
Select one of the values from the drop-down list. The list contains all the design objects
that support custom print, such as BP names, Space attribute names, CM attribute
names, and so on.
Data Model Type
This is pre-populated read-only field, based on the selected custom print type. The
values, based on the option selected at the time of creating the custom print, can be one
of the following:
Internal
External
Internal Multiple
External Multiple
Internal or External
2) Click Apply to continue.
When you click Apply, the system processes the information that you have provided and
prepares the custom print for publication. As a result of this process, two additional tabs are
added to the Custom Print window that require your input:
Template File tab
246
Configuring and Publishing Oracle Analytics Server Custom Templates (Custom Prints and Reports)
Template
The Template section contains the following fields:
247
General Administration Guide
Template Name: Enter a unique name for the template (use non-ASCII characters).
Template Type: From the drop-down list, select a template type: RTF, PDF, Excel, or eText.
A Template Type can be changed if the template is in Creation stage. After it is created, the
Template Type cannot be modified, and the custom print designer must create a template (of
the desired type) and remove the one that is no longer required.
Layout File: Browse to find and upload the layout files, based on the template type.
Translated XLIFF files for the Template
If you want to internationalize the product, the translated XLIFF files can be uploaded, for the
corresponding languages, in the Translated XLIFF filed for template section.
Note: The languages listed are the active languages selected by the
administrator in the Configuration - Internationalization log.
Template
The Template section contains the following fields:
Template Name: The unique name for the template.
Template Type: This is pre-populated read-only field, based on the selected Template Type.
A Template Type can be changed if the template is in Creation stage. After it is created, the
Template Type cannot be modified, and the custom print designer must create a template (of
the desired type) and remove the one that is no longer required.
Layout File: Browse to find and upload the layout files, based on the template type. The
original custom print file is displayed.
Notes:
You can modify an Oracle Analytics Server Custom Print template
only if the status is set as "Draft."
You cannot modify a Data Source of a Custom Print template after
the Custom Print template has been created.
You can modify the contents of the Description field at any time.
248
Configuring and Publishing Oracle Analytics Server Custom Templates (Custom Prints and Reports)
If you want to internationalize the product, the translated XLIFF files can be uploaded, for the
corresponding languages, in the Translated XLIFF filed for template section.
Click Apply when finished.
Remove
To remove a Custom Print template, select the template, and click Remove.
Note: To delete a Custom Print template, you can select the Custom
Print template from the log and click Delete. You can delete a Custom
Print template regardless of the Custom Print template status.
Download
The Download option lets you download the template and the corresponding translated XLIFF
files. You must select an existing file before you can proceed.
When you click Download, a zip file is generated. The zip file name format must be:
Template_<Numeric part of report key>_<File Type>.zip
Example
Template_483_PDF.zip
You can copy a Custom Print template to use as a base for a new Custom Print template.
Note: After copying a Custom Print template, the term, "Copy of"
appears at the beginning of the name of the new Custom Print template.
249
General Administration Guide
3) In the Configuration - Business Processes log, select your Workflow BP and click Open.
4) In the left Navigator, select Customize Email, and then select Content to open the Email
Content log.
5) Click Create to open the Create Template window.
6) Select your language and enter a name for the template in the Name field.
7) Compose your email body text, and, if applicable, double-click the necessary data elements,
from the right pane (Available Data Elements), to include them in your email. You must
manually enter the title of the DE. Use the elements of rich text editor in the body to create a
custom email format. The list of DEs can be broadly categorized as:
Workspace and Workflow Information (Shell details, Workflow information, and Task
assignee details)
Upper form details
See the List of DEs and Categories table below for details.
If the DE value is not present a blank value will be updated in the email content.
Use the Find on Page option to search for a particular DE.
The active languages appear in separate tabs, according to their order in the language log.
Select one of the following options, when finished:
Save: To save your modified email in the log and keep the Email Content log open to
conduct other operations.
Save and Close: To save your modified email in the log and close the Email Content log.
Use the Cancel option to discard your changes, if any, and return to the Email Content log.
To be able to modify a custom email template, follow the steps above to access the Email
Content log, and then open the email that you want to modify and incorporate your changes. If
there are several email templates in the Email Content log, you can use the Find on Page
option to search and find the email template that you need.
Within the Email Content log, in the upper-right corner, the system displays the value of the
maximum size of the outgoing email.
Note: Ensure that you keep the size of your emails <20% of the
maximum size of the outgoing email.
The Email Content log displays the size of the email configured under each language on the
right side of the window.
The custom email template will be available at the company-level (or global-level) when the
Business Process Setup is made available at a shell-level template, similar to the setup of the
custom email subject line. After the Business Process Setup, at the shell-level template, is
complete, the email content template will become available in the Notifications tab of the
Business Process Setup. When a task is created during the run-time, for a BP, the email
generation appears per the custom format that was defined at the customize email content
node, provided that the format is selected as default format. Email templates for multiple
languages can be created in the same window.
250
Configuring and Publishing Oracle Analytics Server Custom Templates (Custom Prints and Reports)
If the size of the configured email template, for any language, exceeds the maximum set limit, or
if the size falls between preferred size-range, an error or a warning message will be displayed
respectively.
If you modify a template name and the email is already in use, the system changes the email
name at the selection (access information by going to BP Setup, selecting the Notification tab,
and then selecting any particular task type).
After you save a custom email, the system displays the record with log containing the following
fields:
Name: Name or title of the template.
Last Modified By: Name of the user who last modified the template.
Last Modified: Date when the template was last modified.
Active Languages: Listed according to the order of the language log. If custom email
content for any language type is defined, the size of the email configured under each
language is displayed in the log.
List of DEs and Categories
DE Category Values
Task assignee Sent From/Task From
Sent To
Task To (All assigned users in the To step
of the task)
Task CC (Where all CC users are fetched
from the task assigned)
Task Status
Task Due Date
Workflow setup Workflow Step Name
Workflow Email Content
Shell Shell Name
Shell Number
Administrator
Hierarchy Path
Environment Name
Additional Information
The general comments (any comments that have been added as a part of the record
modification) are sent out as a part of the system default footer, for the email.
Also, the line items and attachments that have been added to a record will be included through a
system-generated footer for the record modification emails. The following DEs are not included:
<SOURCE_ID></SOURCE_ID>
251
General Administration Guide
<STEP_ASSIGNEE></STEP_ASSIGNEE>
<ASSIGNEE_COMPANY></ASSIGNEE_COMPANY>
<STEP_STATUS></STEP_STATUS>
<STEP_ACTION></STEP_ACTION>
<STEP_COMPLETION_DATE></STEP_COMPLETION_DATE>
<WORKFLOW_STATUS></WORKFLOW_STATUS>
<WFTEMPLATE_ID></WFTEMPLATE_ID>
<PROCESS_ID></PROCESS_ID>
<TASK_NAME></TASK_NAME>
<ACTION_NAME></ACTION_NAME>
<ASSIGNED_FROM></ASSIGNED_FROM>
<ASSIGNEE_COMPANY_1></ASSIGNEE_COMPANY_1>
<TASK_COMPLETION_DATE></TASK_COMPLETION_DATE>
<ASSIGNEE_ID></ASSIGNEE_ID>
<TASK_NOTE></TASK_NOTE>
<SUBWORKFLOW_NAME></SUBWORKFLOW_NAME>
<SUBWORKFLOW_DUEDATE></SUBWORKFLOW_DUEDATE>
<TASKNODEID></TASKNODEID>
<ACT_STEPTEMP_ID></ACT_STEPTEMP_ID>
When you click Create, the system opens the first language tab, as listed in the language log.
You can select any of the languages tabs and paste the content to be translated. You can also
save an email format in multiple languages. At run-time, the custom email is drafted for the
selected language, and if the custom email content is not present for the language, the system
uses the system default format.
The user can select any of the created records and click Delete to delete the selected custom
email format. If a selection includes a template which is being used, the system will display a
confirmation message. The user can delete multiple templates at once. After a template is
selected for deletion, the system automatically reverts the selected template to the system
default.
The header and footer section of the custom email is autogenerated by the system and
appended to the created custom email.
Use the Additional Information field that is available as one of the DEs like a note. The Additional
Information field is configured at the email content section of the BP Setup.
You (the admin) can select the customized email format under the Notification tab of a BP
Setup. Go to Notification tab, under Custom Notifications sub-section, click the drop-down
option for each email type, and select the desired format. The name of the custom template
defined is listed in the drop-down list.
If the user selects "Include both record and line item attachments" or "Include record information
as attachment," the attachments will be sent as part of custom email.
The drop-down lists all the custom email formats defined at the customize mail Content node.
The same format can be selected for all the task types. After it is selected, the user can click OK
or Apply to save the changes. The selected format email is triggered when the user:
252
Configuring and Publishing Oracle Analytics Server Custom Templates (Custom Prints and Reports)
253
General Administration Guide
Notes:
If you remove the data elements from the design of the data source
that has been used in the Oracle Analytics Server Custom Print
template, you must republish the Custom Print template to the Oracle
Analytics Server.
If you add new data elements to the upper form, or detail form, of the
BP Design, you must re-publish the Custom Print template and
download a new copy of data schema to be able to see and use
these new elements (of data schema) in the template.
You can update the Custom Print template layout by regenerating the
sample data.
When the status of a Custom Print changes from "Draft" to
"Published," the system generates the data model with respect to the
current BP Design. As a result, if the BP design has changed
between the time of first download of the Sample Data and the
publishing of the Custom Print, the developed report Template must
be tested again with the new Data XML.
254
Configuring and Publishing Oracle Analytics Server Custom Templates (Custom Prints and Reports)
See the Custom Templates (Custom Prints and Reports) Overview (on page 232) section for
details.
Name: Enter a unique name for the custom report, up to 50 characters (use
alphanumeric characters or spaces).
Description: (Optional) Enter a brief description about the custom report.
Data Model Type: This is pre-populated read-only field, based on the selected custom
report type. The values can either be Internal or External, based on the option selected at
the time of creating the custom report.
Report Level: A drop-down list that lets you select Project for a project-level custom
report, Program for a program-level custom report, or Application for an application-level
custom report.
Main View: A drop-down list that lets you select a data view to use as the main view of
the custom report. The items in the drop-down list are populated with the data views that
have been published.
Note: When you are selecting a Main View, ensure that you select a
255
General Administration Guide
256
Configuring and Publishing Oracle Analytics Server Custom Templates (Custom Prints and Reports)
Note: For External Data Model based reports, you cannot add or remove
views.
You can create only one link level; that is, you can create one "sub-link." You cannot create
another link under a sub-link.
To determine data links:
1) In the Data links section of the window, click Add to open the Add Link window.
2) In the Source Data Set field, select the name of the data set you want to link to another set.
The selection list shows the data sets you created in the upper section of the Views tab.
3) In the Source Element Name field, select the name of the field on the source data set that
you want to map to the target data set.
The element data type must match the data type of the target element; for example, you
must match an integer to an integer, a string to a string.
4) In the Target Data Set field, select the name of the data set the source data set should link
to.
5) In the Target Element field, select the name of the field on the target set that the source
element field should map to.
6) To add another link, click the Add button and repeat steps 2 to 5, or click OK to save the
links the exit the Add Link window.
7) Click Apply, and click OK to exit the Custom Report window.
Example for creating a data link:
Row View Name View Type Data Set Name Data Set Tag
0 Invoices Main View inv inv
1 InvoicesLI Sub Report LineItem LineItem
View
At this point, set the relationship between the Main View and the Sub Report View that you have
added.
1) Go to the Data Links section and click Add.
2) Link the ID field from the Invoices Data View to the RECORD_ID field from the Invoices Line
Item Data View.
Example
Source Data Set: inv
Source Element Name: INV_ID
Target Data Set: LineItem
Target Element: INV_LI_RECORD_NO
3) Click OK to add to add the link.
4) Click Apply.
257
General Administration Guide
Search Parameters
Search parameters allow the report runner to filter the data that gets sent to Oracle Analytics
Server. For example, a Contract Report may need to be filtered by Vendor or Contract Type. A
Ball-in-court report may be filtered for a specific task assignee, or task type.
At runtime, the report runner can select or multi-select from a list of values based on the search
parameters specified in the report configuration. This means that Unifier basically runs the Data
View before the report is run to give the report runner a list of the SQL results. He or she can
then select or multi-select values from this initial run to filter what will appear in the report output.
On this tab, you can add query parameters to the configuration. The query parameters are
created on the columns of the main view, selected for the Custom Report. At runtime, these
parameters appear in the Search Parameters block.
To add query parameters to the custom report:
1) On the Custom Reports window, click the Query tab.
2) Click the Add button. The Add Query window opens. Complete the window:
Element Name: Click the drop-down list and choose from the elements (all columns from
the main view).
Label: Enter a label to use for the Element Name. This label appears to the user at
runtime.
Operator: Select the appropriate operator to use for the query. The operators will depend
on the data type of the element chosen.
Source Type: This is the source of the value. Choose one of the following:
Data Definition: Lets you choose a data definition. The following field becomes
available:
Select Definition: Select from the drop-down list. The list displays data definitions
defined in the company that apply to the type of element chosen. (For example, if
you choose a drop-down [pull-down] or radio button, the data set values defined
for the data definition will be displayed to the user at runtime.) This lets you use
existing data definition values, rather than entering them manually (see Ad Hoc
below).
View: Lets you compare columns in your current view against another view
chosen here. The following fields become available:
Select View: Lists all published data views. Choose the view to compare.
258
Configuring and Publishing Oracle Analytics Server Custom Templates (Custom Prints and Reports)
Value Column: Lists the columns for view chosen in Select View. This is the
column that will be compared.
Label Column: What you choose here will be displayed to the user at runtime.
Context Sensitive: If this check box is selected, the results will automatically
apply the filter for project_id at runtime (results will be for the current project
only).
Ad Hoc: Allows user to select values in User mode from selection list. If you
choose this option, you must specify the list of values here. This is similar to
defining a data definition data set.
Click the Add button. The Ad Hoc window opens.
Click Add. A new row is added.
Enter a Value and Label.
3) You can modify the query parameters by doing the following:
Delete a row by selecting it and clicking Remove.
Modify parameter by selecting a row and clicking Modify.
Change the order of the query parameters (as they appear in User mode), by selecting a
row and clicking Move Up or Move Down.
4) When done, click Apply to save changes. You can click OK to save and exit, or click another
tab to continue to define the configuration.
259
General Administration Guide
Editable: If this check box is selected, the field will be editable in User mode. If not, the
field is read-only.
Hidden: If selected, the field will be hidden in User mode. The report may still use the
parameter at runtime, depending on the design.
Name: Double-click in the field to make it editable. The Name entered here must match
the parameter name used in the Oracle Analytics Server report. The behavior and default
values for the parameters specified here can be applied automatically to the report at run
time.
Label: Defines the label of the parameter field in User mode.
Default: You can enter a default value that will be used in User mode.
3) To delete a row, select it and click Remove.
4) Click Apply to save changes. You can click OK to save and exit or click another tab to
continue to define the configuration.
Any parameters created on the Parameters tab also need to be appropriately added into the
Parameters tag in the .XDM file.
260
Configuring and Publishing Oracle Analytics Server Custom Templates (Custom Prints and Reports)
Note: The uuu_p_* are the predefined parameters in the data model.
261
General Administration Guide
They are also the variable names defined in the RTF form fields. The
PROJECTIMAGE is the element for image file ID from Unifier.
Note: You may need to complete the General tab first and click Apply
before this tab appears.
Note: Depending on the Report Level that you have selected in the
General tab, the fields and selections in this tab change.
1) In the Sample Data tab select a sample, determine the number of rows that you want to see,
and click Generate.
2) When finished, click Download.
3) Click Apply.
4) Click OK.
262
Configuring and Publishing Oracle Analytics Server Custom Templates (Custom Prints and Reports)
Download and Install Oracle Analytics Publisher Desktop for Microsoft Office
To download and install Oracle Analytics Publisher desktop for Microsoft Office:
1) Download Oracle Analytics Publisher Desktop for Microsoft Office from:
https://www.oracle.com/middleware/technologies/analytics-publisher/downloads.html
Ensure that you choose the Oracle Analytics Publisher Desktop version (32-bit vs. 64-bit)
based on your version of Microsoft Office 32-bit or 64-bit.
Note: Alternatively, you can use a template file (for example, A Word
263
General Administration Guide
4) Click Repeating Group to generate a loop on each Invoice. The Repeating Group window
opens.
5) In the For Each field, enter a value in the Data Set Name for each of the Invoices that you
chose, when defining your Custom Report (for example, inv). This does not apply to the
Invoices Line Items.
6) In the Group By field, select a field for your Invoice loop. Use the INV_ID because it is a
unique identifier for each Invoice.
7) (Optional) Insert a page break after each Invoice to keep your report formatted.
8) (Optional) Select the Data already sorted option. You can select this option because you
have already sorted your data in your SQL statement, using: ORDER BY.
9) Click OK.
The Oracle Analytics Publisher plug-in application adds a code to the document which
includes: a start (for-each), a page break (page break), and an end (end) for your Invoice
loop.
10) Add a blank line after "for-each" operator to make room for your Invoice information.
11) Click the field icon (ab|Field) to open the field browser.
The field browser window lets you add fields from your XML sample data file.
12) After each "for-each" operator, double-click Inv_Record_No in the field browser.
13) Add a hyphen ( - ) [n-dash] after the record number.
14) Double-click Inv_Title to add the Invoice title.
Example
for-eachINV_RECORD_NO-INV_TITLE
page breakend
15) (Optional) Run the report by clicking PDF on the Word Oracle Analytics Publisher Ribbon
(Word will prompt you to save your RTF file if you have not done so).
The first report is now ready.
The report only has the Invoice record number and title for each Invoice in your sample XML (the
approved and pending ones because: WHERE inv.STATUS = 'Approved' OR inv.STATUS
= 'Pending' in our SQL statement).
You can continue to build on the generated report by adding additional fields from the Upper
Form of the Invoices BP, as well as headers, footers, formatting, and so forth.
264
Configuring and Publishing Oracle Analytics Server Custom Templates (Custom Prints and Reports)
page breakend
You must run the report to see what information is generated. While the data is correct, you
must work on formatting the data. For details, see Formatting Data.
265
General Administration Guide
Formatting Data
To format the data generated:
Provide a descriptive text (not SQL column names) for Column titles.
Adjust the Column widths.
Apply general table coloring (borders and shading, font sizes, cell alignment, and so on).
Ensure that the "dollar" format is used for the two price columns (for example, $110.00). See
the details that follow.
Add useful information, from the Upper Form of the Invoice, above the table. See the details
that follow.
Provide a "Total" for the amount column. See the details that follow.
When you are finished, generate a PDF and repeat the process if necessary.
To change the formatting of the Price & Amount columns (for example, 110.0 > $110.00):
1) Double-click INV_LI_UNIT_PRICE (the code under the Unit Price field) to launch its Oracle
Analytics Server properties.
2) Change the Formatting Type to Number.
3) Set the Formatting Format to $#,##0.00;($#,##0.00) (paste in the blue text).
4) Repeat the preceding steps for the Amount column.
To add useful information, from the Upper Form of the Invoice, above the table:
Note: Tables are an efficient formatting tool for organizing data from the
Upper Form. Include separate columns for the field name (align right)
and the field value (align left). You can also hide the borders if you
prefer.
266
Configuring and Publishing Oracle Analytics Server Custom Templates (Custom Prints and Reports)
6) Click the field icon (ab|Field) to open the field browser and add fields from your XML sample
data.
7) Click Inv_Li_Amount column to highlight.
8) Set the calculation (at the bottom) to Sum.
9) Click Insert to add the calculation into the table.
10) (Optional) Select the Total row and make the text bold.
267
General Administration Guide
Adding a Chart
Using Invoice as an example, you can include a chart in the summary page to demonstrate how
the Invoices are split.
There are several chart types available in Oracle Analytics Server. The following is for creating a
Pie-chart.
To add a pie chart:
1) Place the cursor above the summary table. The goal is to include the chart between the
Project summary table and Invoice summary table because the table can get long and
expand to the next page.
2) Click Chart on the Word Oracle Analytics Publisher Ribbon.
3) Set the Chart Type (on the right) to Pie Chart.
4) (Optional) Select one of the Chart Styles.
5) Drag Inv_Amount from the Data tree to the Values box to ensure that the size of each pie
slice is determined by the dollar amount of the Invoice.
6) Drag Inv_Title from the Data tree to the Labels box to ensure that the:
Pie slices are determined by Invoice
Invoice Title appears in the legend
7) (Optional) Click Preview (upper-right corner) to see a preview of the chart and make
changes if necessary.
8) (Optional) Use the Properties table on the right side to set Chart Title, Legend properties,
and so on.
9) Click OK. You change the chart settings by double-clicking the chart in the template.
10) (Optional) Add spacing between the chart and the two tables and center-align the chart.
Note: Microsoft Word does not support form fields in the header and
footer. If need to add an image to the header or footer of your Custom
Report and you want the image to repeat on each page, see the "Adding
BI Fields to the RTF Header or Footer" section.
To add an image (examples: Company logo, Shell image, or image picker from a BP record: jpg,
gif, or png) from Unifier into your Custom reports, use the Sample XML file (Sample Data) that
you have created and exported.
268
Configuring and Publishing Oracle Analytics Server Custom Templates (Custom Prints and Reports)
3) Using the included parameters, plus the ID of a specific image (the image that you want),
construct a URL of the format:
<uuu_p_urlF>CompanyRegistry=<uuu_p_companyRegistryF>&sessionId=<uuu_
p_sessionIdF>&id=<image_ID>
Note: If applicable, you can find the Company logo Image ID in the
companylogo column of the table sys_company_info.
269
General Administration Guide
b. Add the information as a new Data View, which you can add as a Sub-Report View to any
Custom Report. The SQL to create a Data View:
SELECT companylogo
FROM sys_company_info
WHERE companyregistry = 'unifier';
5) Define the variables:
After you have an Image ID, you must define the variables needed to build the image URL by
hiding the variables in a Data Field:
a. Add a data field somewhere at the top of your report. This can be any field. You only
need a placeholder for your variables.
b. Double-click the newly added data field and click the Advanced tab. Delete the text in the
code box, if any.
c. Add the following text into the code box:
<?variable@begin:uuu_p_urlF;(.//uuu_p_urlF)[1]?>
<?variable@begin:uuu_p_companyRegistryF;(.//uuu_p_companyRegistryF
)[1]?>
<?variable@begin:uuu_p_sessionIdF;(.//uuu_p_sessionIdF)[1]?>
<?variable@begin: image;(/DATA_DS/co/COMPANYLOGO)?>
Notes:
If you are adding a Shell image or Image Picker Data Element, you do
not need that last line. Add the last line only if you have created a
Company log Data View (If applicable, you can find the Company
logo Image ID in the companylogo column of the table
sys_company_info).
The example code presumes that you added an unlinked Sub Report
View with the Data Set Tag "co" (for Company). You can change the
Data Set Tag "co" (for Company) to the value that you have in the
last column of Company Logo row in the Views used as data sets
table on the Views tab of the Custom Report dialog.
If you want to insert the Project Shell ID, you must access that
variable. Depending on where you are in your grouping, the variable
can be: <?variable@begin:image;(SHELLIMAGE)[1]?>
270
Configuring and Publishing Oracle Analytics Server Custom Templates (Custom Prints and Reports)
Note: The last parameter ($image) was set as a variable to either the
Company logo or the Project/Shell image. You must adjust the
parameter if you want to include both images. Ensure that you use
separate variable names for each.
To test an image:
The three parameters that you used to build your URL to the image are not downloaded as part
of the sample data:
uuu_p_urlF
uuu_p_sessionIdF
uuu_p_companyRegistry
You must upload your RTF template to Unifier, publish the Custom Report, and then run the
report to ensure that your image was inserted successfully.
Importing a Template
After you have created your template, you can upload it into Unifier.
271
General Administration Guide
272
Configuring and Publishing Oracle Analytics Server Custom Templates (Custom Prints and Reports)
2) Click Conditional Format. The Oracle Analytics Publisher Properties window open on the
Properties tab.
3) From the Data field drop-down list select the data element that you want to evaluate to
determine the conditional highlighting. This does not need to be the same data field in the
cell that you are trying to highlight.
4) Specify whether that Data Field is a Number or Date/Text Field.
5) Enter the conditions for this Data Field using the pertinent drop-down list.
6) For each condition, specify the formatting that you want to be applied when that condition is
met.
273
General Administration Guide
Only two conditions can be entered by using this window. If you have more than two conditions,
you can click the Advanced tab and copy/paste the conditions already entered to create
additional conditions. Ensure that you copy an entire "if" statement, up to and including the
"<?end if?>"
Example
<?if:number(INV_AMOUNT)>10000?><?attribute@incontext:background-colo
r;'#FFB9B9'?><?end if?>
Highlighting an Entire Table Row
To highlight an entire table row, follow the preceding instructions; however, ensure that you
select Apply to Entire Table Row.
Note: If the company uses the default User Mode Navigator (that is, the
company has not defined a custom User Mode Navigator), you will be
able to see the report name under Access Control of the project.
274
Configuring and Publishing Oracle Analytics Server Custom Templates (Custom Prints and Reports)
Notes:
A user with the configure permission to the Custom Report node,
can configure custom print templates. There are no separate
permissions for performing actions on the custom print templates.
If you have a User Mode Navigator, you must include the Custom
Report in the navigator and redeploy before the user can assign
permission through Access Control.
Running a Report
To run the Oracle Analytics Server Report in Unifier:
1) Sign in to your Unifier environment.
2) Select a project/shell.
3) Ensure you are in User mode.
4) Under the Project/shell navigation tree, select Reports, [Custom node].
5) Select a report and a dialog box will open.
6) In the dialog box, enter the Template and Format, enter the Search Parameters, and click
Run Report to run the report.
275
General Administration Guide
You must upload the Data Model file (.XDM) from the custom report Template File tab, using
the following parameters:
uuu_p_project_id
Project ID
uuu_p_context_company_id
Company ID
uuu_p_process_id
Workflow process ID
uuu_p_source_id
Business process record ID
uuu_p_object_type
Business process ID as in uDesigner
uuu_p_hide_task_details
To hide the task status if the user does not have permission. The value of 0 is passed if the
user does not have permission to view the task statuses.
uuu_p_hidden_comments
To view the hidden comments if the user has the permission. The value of 1 is passed if the
user has the permission to view hidden comments.
These parameters are used to pass information from the Unifier runtime to the Oracle Analytics
Server (integration at runtime).
276
Configuring and Publishing Oracle Analytics Server Custom Templates (Custom Prints and Reports)
Any query parameters created on the elements of the main view on the query tab also need to
be appropriately mapped in the Where clause of the main view query in the XDM.
To modify an existing custom report configuration:
1) Go to the Company Workspace tab and switch to Admin mode.
2) In the left Navigator, select Configuration, and then select Custom Templates to open the
log.
3) Select a custom report and click Open to open the custom report window.
4) Modify the fields as necessary. All fields except the "Report Level" can be modified, if the
custom report has not yet been published. After the report has been published, the "Report
Name" field also becomes un-editable.
277
General Administration Guide
2) Right-click the dummy image and select Size and provide the following value in the
Description field of the AltText information for the image:
Description:
url:{concat($uuu_p_urlF,'companyRegistry=',$uuu_p_companyRegistryF,'&sessionId=',$uuu
_p_sessionIdF,'&id=',BPIMAGE)}
For example, you must replace the <BPIMAGE> data element, in the above URL value, with
the image file ID "k__<image element>" from the sample XML. See Sample XML Data for
Custom Templates (Custom Prints and Reports) (on page 242).
2) Right-click the dummy image and select Size and provide the following value in the
Description field of the AltText information for the image:
Description:
url:{concat($uuu_p_urlF,'companyRegistry=',$uuu_p_companyRegistryF,'&sessionId=',$uuu
_p_sessionIdF,'&id=',PROJECTIMAGE)}
For example, you must replace the <PROJECTIMAGE> data element, in the above URL
value, with the image element taken from your sample data XML. See Sample XML Data for
Custom Templates (Custom Prints and Reports) (on page 242).
Additional Information
In Cloud deployment, you can use the "uuu_p_tenantIdF" data element for passing the user
ID to the Oracle Analytics Server report. This will include the required URL needed for accessing
the image file, in the Oracle Analytics Server report. For legacy Oracle Analytics Server reports,
in Cloud or On-premises deployments, you can continue to use the following data elements for
passing the user ID to the Oracle Analytics Server report:
uuu_p_urlF
uuu_sessionIdF
uuu_p_companyRegistry
278
Configuring and Publishing Oracle Analytics Server Custom Templates (Custom Prints and Reports)
Note: The following instructions apply to reports that run directly on the
Oracle Analytics Server. The Oracle Analytics Server reports that run via
Unifier do not require these changes.
Note: The purpose is to get the server token from database where
"expired" is the maximum from all the rows.
In the report template that requires to have the image to be inserted, change the "Alt text" of the
image to point to image retrieval URL.
To retrieve a Unifier image, use the URL: https://unifier-server-address
/bluedoor/rest/image/<image_id>/<server_token>
The report parameter uuu_p_urlF can be created in Data Model (XDM) file with a default
value, so at the runtime the server address-part of the URL can be changed appropriately:
<parameter name="uuu_p_urlF"
defaultValue="https://unifier-server-address/bluedoor/rest/image"
dataType="xsd:string" rowPlacement="8">
<input label="uuu_p_urlF" size="100"/>
</parameter>
The report template uses this URL in the "Alt text" of the image, as in:
url:{concat($uuu_p_urlF,'/',DATA_IMAGE_ID,'/',//security_token/SEC_TOKE
N[1])}
Where: uuu_p_urlF can be the template variable, for example:
<?variable@begin:uuu_p_urlF;(.//uuu_p_urlF)[1]?>
The security token, retrieved from DB by the dataset is: //security_token/SEC_TOKEN[1]
279
General Administration Guide
uuu_p_urlF
uuu_sessionIdF
uuu_p_companyRegistry
Adding Rich Text Data Element in Oracle Analytics Server Report and Custom
Print
Unifier supports custom print and custom report for the “Rich Text” data element. You can use
the “Rich Text” data element (of your BP form) in your data model. Furthermore, the HTML
version of the “Rich Text” data element can be rendered as HTML, in the report, if the HTML
version needs to be seen in the Oracle Analytics Server template.
To include the “Rich Text” data element:
1) Go to the report template file, for “Rich Text” data element.
The Rich Text fields in the Oracle Analytics Server template file are prefixed with:
?html2fo. For example, if the DE name is RTECODE, the DE name must be wrapped as it
was in the template file as: <?html2fo: RTECODE?>. This will allow the template processor
to treat the element as HTML.
2) To view the Rich Text type DE in correct format, in the Oracle Analytics Server reports (in
the Oracle Analytics Server), go to the data model editor for the report and set the data type
of the RTECODE data element column to XML.
In the Oracle Analytics Server, the Rich Text type DEs can be found in the <model>_richtext
data model. In addition, when defining queries and Data Links in Custom Templates:
The Rich Text type DE from the BP richtext views (model_richtext) must be restricted.
The plain Rich Text type DE content, from the BP model, must be allowed.
When you add a Rich Text type DE to the custom print template:
The following HTML elements will not work in the PDF output format:
Table
The borders will not display.
Alignment
The left, right, and indent will not work.
280
Configuring and Publishing Oracle Analytics Server Custom Templates (Custom Prints and Reports)
Image
Will not display.
Code block
Will not work.
The following HTML elements will not work in the RTF output format:
Table
The borders will not display.
Alignment
The left, right, and indent will not work.
Code block
Will not work.
Block Quote
Will not work.
Note: The Rich Text Data Element does not support indentation, bullets,
or numbering, when configured in Custom Print or Custom Report.
281
General Administration Guide
9) Highlight the Data View you just created and click Data on the toolbar.
10) In the window, click Export as SQL on the toolbar to save the .sql file locally. This SQL file
includes the CREATE and INSERT commands required to get your data into your local XE
database.
At this point, you can create the table and insert the exported rows into your local XE database
using tools like SQL Developer.
Repeat the steps above for any tables that you like to access offline.
Note: You can reuse the same Data View multiple times; however, you
must perform a find and replace in the downloaded SQL to ensure that
the table names match the names that are in Unifier.
Because you have a subset of the database locally, you can use SQL Developer to write
complex queries, offline, before bringing them into Unifier.
282
Configuring Project Numbering and Status
As the administrator, you can configure the project numbering and the status of each
project/shell type. As part of the numbering scheme, you can enable and disable automatic
numbering and you can update the format and starting number. The system implements the new
settings for records created after the change is implemented and ensures that unique labeling is
maintained. If you change the value of Format or Start, the system cannot guarantee that the
selected sequence is available due to possible conflicts with existing data and might alter the
selected information to prevent a conflict. Changing this information might also create gaps in
the numbering sequence.
Example: If you specify a Format of ABC and a Start of 0001, and records ABC0001 through
ABC0015 have been created, and you then change the Format to DEF and the Start to 0001,
the system starts generating new records with DEF0001. If you change the Format to back to
the original ABC and a Start of 0001, the system will begin the sequencing of new records using
ABC0016.
To configure project numbering and status:
1) Go to the Company Workspace tab and switch to Admin mode.
2) In the left Navigator, select Configuration, and then select Shell Manager.
3) Double-click the applicable shell type, such as Projects.
4) On the General tab, complete the following fields:
Enable Automatic Numbering: To allow automatic numbering of projects based on the
specified Format and Start values, select this option. You can deselect this check box to
disable automatic numbering; it is selected by default.
Format: If you enable automatic numbering, specify the format of the numbering
schema. By default, Format is blank.
Start: If you enable automatic numbering, specify the starting number. Start
determines the starting number of the numeric schema. By default, Start is 0001.
Cost Codes: This read-only field displays the type of cost code specified in uDesigner for
the shell type.
WBS: Standard Cost Manager
Generic: Generic Cost Manager
Status: Select the applicable status, Active or Inactive. Users cannot access shell types
that have an Inactive status. The default is Inactive.
283
General Administration Guide
In This Section
View, Print, or Export the Configuration - Shell Manager Audit Log ....................... 284
284
Configuring the User Mode Navigator
You (Company administrator) can configure the User Mode Navigator (go to the Company
Workspace tab and switch to Admin mode; in the left Navigator, select Configuration, and
then select User Mode Navigator) to better suit the company business needs. The User Mode
Navigator lets you modify the appearance and organization of the modules and business
processes that are available in the left Navigator for all company users.
This functionality of the User Mode Navigator is limited to the collaborative portions of the User
mode Navigator in the Home Workspace, Company Workspace, Shells, and Projects.
Note: This configuration will affect User mode navigation for all users in
your company. Oracle strongly recommends that you fully test your
configurations in the Development/Test environment.
Within the User Mode Navigator, you can create grouping nodes, rename existing ones,
reorder items within the nodes, and even remove unused modules from the Navigator, to provide
increased flexibility to organize and view modules and business processes. The configured view
will appear for all users.
As always, access to any module or business process is strictly controlled by permission
settings. The User Mode Navigator feature does not override permission settings in any way; it
simply lets you customize the look and organization of navigator modules that a user has
permissions to access. Any changes you make to the User mode navigation tree will be
reflected in the Access Control view.
Example
If a user has permission to access at least one leaf node under a grouping node, the
grouping node will appear in the user's view of the left Navigator.
If the user does not have permission to any leaf nodes under a grouping node, the
grouping node will not appear in the user's left Navigator.
The following terminology is used with User Mode Navigator:
Grouping node: This is a container "parent" node. Grouping nodes are easy to identify
because they have a (+) next to them in the navigation tree. Clicking a grouping node in the
left Navigator expands the node to display any child nodes below it; the child nodes can be
leaf nodes, or another grouping node (also known as a functional node), for example, Project
Logs, Cost Manager, and so forth.
Actionable grouping node: This type of grouping node not only expands to display child
nodes underneath it, but also refreshes the right pane and displays an associated log or
page, for example, Projects node, which expands to display the project nodes in the left
Navigator and also opens the Project home page.
285
General Administration Guide
Leaf node: This is a child node that cannot become a grouping node. In the last node of the
navigation "tree," no further branching can take place. Clicking a child node refreshes the
right pane to display the associated module or log, for example, Cost Sheet within the Cost
Manager, or the individual business process logs under Project Logs.
The configurable navigator lets you:
Configure navigation trees for:
Company Workspace Navigator
Home Navigator
Project/Shell Navigator
Note: The settings do not take effect in your users' navigators until you
deploy them.
286
Configuring the User Mode Navigator
If the status of the navigator in the destination server is Inactive and the status of the
navigator in the package is Active, then the system deploys the navigator and changes
the status to Active in the destination server.
If the status of the navigator in the destination server is Active and the status of the
navigator in the package is Inactive, upon import of the configuration package, the
system updates the content of the navigator, but the navigator will not be deployed.
Custom Oracle Analytics Server reports can be a part of the User Mode Navigation
setup.
Internal Oracle Analytics Server reports, included in the setup, must be either a part of
the package or exist in the destination server. If the Internal Oracle Analytics Server
report is in Draft status, the import will succeed if the Internal Oracle Analytics Server
report has been published, in the destination server, at least once.
External Oracle Analytics Server reports, included in the setup, must be either a part of
the package or exist in the destination server. The External Oracle Analytics Server
report name, location, and report level that exists in the destination server must match
the attributes existing in the package.
Rename new and existing grouping nodes
Change the icons associated with the nodes
Move nodes up and down the navigation tree, or from one grouping node to another
Remove unused modules from the navigator without deleting the modules themselves
Move business process logs or other modules between new or existing grouping nodes
Store the following versions of the navigator:
Last saved version
Last deployed version
System default version,
Restore the navigator to any of the above versions at any time
287
General Administration Guide
In This Section
Create a User Mode Navigator Configuration ........................................................ 288
Create a Grouping Node ........................................................................................ 289
Rename a Grouping Node ..................................................................................... 289
Change the Icon of a Grouping Node..................................................................... 290
Move Nodes within the Navigator .......................................................................... 290
Remove Unused Nodes (Modules) from the Navigator .......................................... 291
Delete a Grouping Node ........................................................................................ 291
Deploying a Navigator Configuration...................................................................... 292
Delete a Navigator Configuration ........................................................................... 292
Restore the Navigator to Previous or Default Configuration ................................... 292
Note: You cannot hide the Tasks, Notifications, Drafts, and Mailbox
nodes in the Home workspace.
Company Workspace: Configures the navigation nodes within the Company Workspace
portion of the User Mode navigator
Project/Shell: Configures the project/shell level navigation
The Create New Navigator window opens. The left portion of the window displays the
navigation as it would appear for users. In the example below, the default navigation is
displayed, because a new configuration has not been deployed. The right pane of the
window displays available modules or business process logs that can be added to the
navigation on the left.
4) Configure the new navigator configuration as described below.
5) To save the configuration, click OK.
288
Configuring the User Mode Navigator
The configuration will be displayed in the log. There can be one configuration each for
Project, Shell, or Company Workspace. After saving, you must deploy the configuration for it
to take effect. See Deploying a Navigator Configuration (on page 292).
You can configure the new project or company workspace navigation. After deploying, the
configuration will appear in the user mode navigator for all users in your company.
Use the toolbar to configure the navigation:
New: Creates a grouping node.
Rename: Lets you rename the selected grouping node.
Expand All: Expands all grouping nodes to reveal their functional sub-nodes.
Move Up / Move Down: Moves selected nodes up or down in the navigator.
Cut / Paste: Lets you cut and paste nodes from one grouping node to another.
Restore: Restores the configuration to the system default, or the last deployed version.
Change Icon: Lets you change the icon of the selected node.
289
General Administration Guide
2) In the left Navigator, select Configuration, and then select User Mode Navigator. The User
Mode Navigator log opens. The log lists any previously created configurations.
3) Open a configuration from the log.
4) In the left box, double-click the grouping node, or select the node and click the Rename
button. The field becomes editable.
5) Enter a new name for the field, up to 32 characters. Grouping nodes under same parent
node cannot have same name.
290
Configuring the User Mode Navigator
Only leaf nodes will be moved. If you select a grouping node, only the leaf nodes underneath
it will move to the right pane. The grouping node itself will be deleted.
3) In the left pane, select the destination grouping node into which you want to move the leaf
nodes.
4) In the right pane, select the leaf node to move and click the < (left arrow) button. The leaf
node moves to the grouping node on the left. Repeat as needed with any other leaf nodes to
move.
Note: If you leave a leaf node in the right pane and deploy the
configuration, that module or business process will not appear on the
User Mode Navigator for users.
To move a node from one grouping node to another by cut and paste:
1) In the navigator window, select the node to move. You can select a grouping node or leaf
node.
2) Click the Cut button. (The selected node will not yet be removed).
3) In the left pane, select the destination grouping node in which to move the selection.
4) Click the Paste button. The node will be moved the new location. If you have selected a
grouping node, the grouping node and all leaf nodes will be moved.
291
General Administration Guide
292
Configuring the User Mode Navigator
In the configurable navigator window, click the Restore button and choose one of the following
options:
Last Saved: Restores the navigation tree to the last saved version, regardless of deployment
Last Deployment: Restores the navigator to the version that was last deployed (not
applicable for new configurations that have not yet been deployed)
System Default: Restores the navigator to the original system defaults
293
Unifier Mobile Application
The Unifier Mobile Application is built specifically for installation and use on mobile devices that
use iOS or Android operating systems. To get the mobile app, you have the following options:
Download it from the App Store or Play Store, or
Launch Unifier, click your user name in the upper-right corner, click Get Unifier Mobile App,
and follow the prompts.
After download, you can scan the QR code to set up the Server URL and user name on your
Unifier Mobile App.
Notes:
If you are in a region without access to the Google Play Store, Apple
App Store, or your organization is using a Content Security Service
or Mobile Device Management solution and requires that users do
not download from the Apple Store or Play Store, submit a Service
Request in My Oracle Support
(https://support.oracle.com/portal/) to request versions of the
Unifier Mobile Application for those scenarios.
If your iOS device does not have the Passcode feature enabled, you
can download and install the mobile application; however, the system
displays a message that indicates you must go to Settings and
enable the Passcode feature before you can use the application.
If your iOS device is jailbroken (lacks the manufacturer's restriction
that prevents installation of unauthorized software), you can
download and install the mobile application; however, the system
displays a message that you cannot use it with a jailbroken device.
You must have permission to access the Unifier Mobile App. If you
receive a message that indicates you do not have permission,
contact your Company Administrator.
295
General Administration Guide
296
Unifier and Other Oracle Applications
Unifier objects can be integrated with other Oracle applications by way of:
Web Services: Client and server applications that communicate over the World Wide Web's
(WWW) Hypertext Transfer Protocol (HTTP) and provide a standard means for operation
between software applications running on a variety of platforms and frameworks, using XML.
For more information about Web Services integration, refer to the Unifier Integration
Interface Guide.
Oracle Database Gateways: Addressing the needs of disparate data access and making it
possible to integrate with any number of non-Oracle systems from an Oracle application.
Oracle Database Gateways enable integration with data stores such as IBM DB2, Microsoft
SQL Server, and Microsoft Excel, and transaction managers like IBM CICS.
Unifier is integrated with the following enterprise applications via Primavera Gateway:
Oracle Primavera Analytics
Oracle Primavera P6
Oracle E-Business Suite (also known as Applications/Apps or EB-Suite/EBS)
297
General Administration Guide
As shown below, after all the objects are created and linked to each other, data flows to Unifier
(business flows/synchronizations) in this formation: Oracle application/external application flows
to Oracle application/external Provider, which flows to Gateway, which flows to Unifier Provider ,
which flows to Unifier
In This Section
Unifier and Primavera Analytics ............................................................................. 299
Unifier and Primavera P6 ...................................................................................... 334
Unifier and Primavera Gateway ............................................................................. 340
Unifier and Oracle Primavera Cloud ...................................................................... 384
Unifier and Oracle Integration ................................................................................ 387
Integrating a Project/Shell with Oracle Primavera Cloud........................................ 392
Integrating a System Activity Sheet or Master Rate Sheet through Oracle Integration
.............................................................................................................................. 393
298
Unifier and Other Oracle Applications
Users can use the Analytics for data input and must have permission to be able to access the
Analytics node. Permissions set in Unifier (Access Control) enable users to view the data in
Oracle Analytics Server. Users ability to access Oracle Analytics Server is also set in Unifier.
Analytics Node
The Analytics node is located under the Integrations grouping node. In the Analytics node, you
can select publication of data to staging tables, map data, and set schedule for periodic
publication of data into Analytics.
Note: A separate ETL process pushes the staging data into STAR which
then becomes available in Analytics.
When you click the Analytics node, the log displays predefined set of modules such as:
Business Processes
Cash Flow
Cost Sheet
Generic Cost Sheet
P6 Summary Sheets
Shells
Space Manager
Vendors
299
General Administration Guide
2. Select one Business Process, or select as many as you need, and click OK to add the
Business Process to the log.
300
Unifier and Other Oracle Applications
Note: After you added the Business Process, that Business Process will
no longer be available in the Select Business Processes for Analytics
list.
You can remove a Business Process that is published for Analytics. To remove a Business
Process for use in Analytics, select the Business Process from the Select Business
Processes for Analytics list and click Remove. You can delete multiple Business Processes
from the list. You can add a removed Business Process for Analytics reporting. Click Add if
you want to add a removed Business Process to the list.
If a Company Administrator inactivates a Business Process that has been used for Analytics,
this Business Process continues to remain in the Business Processes tab. If you remove a
Business Process from the Business Processes tab, data that exists in Analytics, for the
removed Business process, remains as is; however, the new data will not be published.
To save space, you can decide not to track the history of facts and dimensions, on a
Business Process.
In the Analytics - Business Processes Setup window (Business Processes tab) you can
select a business process and mark to not track the history of the business process data
elements (Track History of Data Elements? column). By default, all BPs in this tab are
selected to have their history tracked. After your initial selection in the Track History of Data
Elements? column for a BP, if you open the Analytics - Business Processes Setup
window and go to the Business Processes tab and deselect the track history option for a
BP, Unifier will notify you that the BP will no longer maintain the historical data in Analytics.
For a BP with track history option selected, all data mapping changes for the elements of the
BP will be recorded as errors in the historical data in Analytics.
301
General Administration Guide
Notes:
The Data Mapping tab is available after you have added a Business
Process, in the Business Processes tab, and clicked Apply or OK.
The Data Mapping is done per DE and not per Business Process. All
Business Processes added in the Business Processes list tab are
included and you do not need to select a specific Business Process
for mapping.
The fields from both Upper and Detail forms can be mapped in the
Data Mapping tab, and you can change mapping of the fields.
The workflow data (Steps and tasks), related to any Workflow BP, is
also sent to Analytics.
The DE of type Rich Text is not available to be mapped to the UDFs
from Analytics.
Note: In addition to the system defined fields for Analytics, you can
define additional custom fields for Analytics in the User Defined Attribute
section.
Name
The Name column is pre-populated and displays the following names:
Specification Section
Vendor ID
Contract Type
Reason
Unit of Measure
302
Unifier and Other Oracle Applications
Spend Category
Quantity
Unit Cost
The names above represent the fields used in Oracle Analytics Server. These are read-only
fields and you cannot modify them.
All the "Main Form" fields are listed first and are sorted alphabetically within the source.
All the "Line Item" fields are listed after the Main form fields and are sorted alphabetically within
the source.
Source
The Source column displays the location of the Data Element (DE) seen in the Data Source. For
Business Processes, the DEs can either be from the "Main Form" or the "Line Item."
Data Source
The Data Source column contains a consolidated list of all DEs for all the selected Business
Processes in the Business Processes tab. In addition:
The list of values displayed upon clicking the Data Source drop-down will be those that have
a matching data definition as the Name field. When you click, the Data Source drop-down list
contains a list of values that have a matching Data Definition (DD) as the Name field.
The drop-down list, which requires the Upper form mapping, contains a consolidated list of
all Upper form DEs. For example, if there are ten Upper forms from all the Business
Processes, and each Upper form has 10 DEs, the list of DEs displayed in the drop-down list
will be a consolidated and unique list of DEs from all the Business Processes.
The drop-down list, which requires the Detail form mapping, contains a consolidated list of all
Detail form DEs. For example, if there are twenty Detail forms, and each Detail form has 10
DEs, the list of DEs displayed in the drop-down list will be a consolidated and unique list of
DEs from the Detail forms of all the Business Processes.
The fields displayed in the Data Source drop-down list is a concatenation of DE Label and
DE Name, and the DE Name is displayed within parentheses. For example,
Department(contract_department)
User Defined Attributes
The User Defined Attributes section of the Data Mapping tab lists the following columns:
Name
Data Type
Source
Data Source
Label
The Label will be based on the selected DE label, but you can change it.
Use the Add, Modify, and Remove to add, modify, or remove user defined attributes.
To modify a user-defined attribute, select the attribute, click Modify, and modify the fields.
To remove a user-defined attribute, select the attribute, click Remove, and modify the fields.
To add a user-defined attribute, read the following information:
303
General Administration Guide
When you click Add, the Add User Defined Attribute window opens. This window allows you to
select the following required fields:
Data Type
Source
Name
Data Source
Label
Notes:
A value for the required Label field will be selected by the system.
The Label field is populated based on the Data Element that you have
selected from the Data Source drop-down list.
The Label field is editable and required. You will receive an error
message if you leave the Label field blank.
If you notice that the value in the Label field has changed, it means
that other fields have been updated at one point.
Analytics displays the value, if the label is absent.
Analytics displays the label, which has the Value/Label pair, in the
case of Data Elements (DEs).
The Data Type that you select impacts the Name and the Data Source of the user-defined
attribute. The Data Type field allows you to select the following attributes, only:
String (default)
Date
Numeric
For example, if you select String as your Data Type, you can:
Select from a predefined set of sources from Source drop-down list (Main Form or Line
Item).
Add up to 30 names (User Defined String Fields 1 - 30) as the Name.
Select from a predefined set of data sources from Data Source drop-down list.
The content of the Label field will be selected by the system and according to your other
selections.
Additional information
If the same DE exists in both Upper form and Detail form, the DE is displayed for the Upper
form fields, as well as the Line Item fields.
304
Unifier and Other Oracle Applications
If you map a DE for one field, you can map the same DE to another field. You can choose
the DEs, per your Company business needs, when setting up the mapping.
If you change the mapping of the fields, for the new records, the next time the data is
published to Oracle Analytics Server, the values will be as per the updated fields. To refresh
all the records, select the check box option in the Schedule tab.
If you delete a DE mapped to an Analytic field, the Data Source field displays only the DE
name.
If there are any un-mapped fields in the Data Mapping tab, the un-mapped fields appear in
the DE list, based on the updated design.
If you delete a Business Process, and click Apply, the Data Source field displays only the DE
name.
The allowed user-defined attributes is driven by the number that is set in the Custom Fields
tab.
Pickers are available for String field mappings for both canned and user defined attributes
and are as follows:
BP Data Picker
Shell Data Picker
Space Data Picker
User Data Picker
BP Picker
User Picker
Shell Picker
Space Picker
BP Creator
P6 Activity Picker
305
General Administration Guide
Note: Users can map any field that exists in the Detail form.
The values of the fields in the existing Cost allocation Line Items are retained for the fields that
are common to both the Summary and Cost allocation Line Items. The following explains the
details:
Cost Code
The value of the field in the Cost allocation Line Item is retained. The CBS Picker field does
not exist in the Detail Form design.
Cost Name
The value of the field in the Cost allocation Line Item is retained. The bi_item field does not
exist in the Detail Form design.
Short Description
The value of the field in the Cost allocation Line Item is retained.
Quantity
The value of the field in the Cost allocation Line Item is retained.
Unit Price
The value of the field in the Cost allocation Line Item is retained. The Unit price is
auto-populated from the value of the field in the Detail Form and is a read-only field in the
Cost allocation Line Item. The value of the field in the Cost allocation Line Item will match the
value of the field in the Detail Form.
Amount
The value of the field in the Cost allocation Line Item is retained.
306
Unifier and Other Oracle Applications
1) In the Analytics - Cash Flow Setup window, Cash Flow tab, click Add to open the Cash Flow
window, Select Cash Flow for Analytics.
Note: This list includes the available Cash Flow items, from all CBS
Shells with Detail Levels of CBS, Summary CBS, and Commitment in
alphabetical order.
2) Select one Cash Flow, or select as many as you need, and click OK to add the Cash Flow to
the log.
Note: After you add a Cash Flow, that Cash Flow will no longer be
available in the Select Cash Flow for Analytics list.
You can remove a Cash Flow item that is published for Analytics. To remove a Cash Flow item
for use in Analytics, select the Cash Flow item from the Select Cash Flow item for Analytics list
and click Remove. You can delete multiple Cash Flow items from the list. You can add a
removed Cash Flow item for Analytics reporting. Click Add if you want to add a removed Cash
Flow item to the list.
Note: The Data Mapping tab is available after you have added a Cash
Flow item, in the Cash Flow tab, and clicked Apply or OK.
307
General Administration Guide
The Analytic field name can be the same as the Data Source name. For example, you can map
a User Defined Curve to data source named, "Initial Baseline."
The following is a list of fields that need mapping for Cash Flow:
Initial Baseline
Current Baseline
Actuals (Spends)
Forecast
User Defined Curves (labeled 1 through 10)
308
Unifier and Other Oracle Applications
Lists a series of predefined fields which correspond to the fields used in Oracle Analytics Server.
Note: Since the fields under Name are grouped logically, the order
displayed is according to the list of fields that need mapping for Cost
Sheet.
309
General Administration Guide
Note: Asterisk (*/star symbol) does not appear for a column that has not
been mapped to a data source.
For existing mappings of user-defined Cost Sheet columns, the labels are populated based
on the data source name.
Labels support non-ISO characters (UTF-8 characters).
If there are no labels, the data source names will be sent to Oracle Analytics Server.
The first time that you select a data source, the label is populated based on the data source
name. You can modify the label according to your business need.
The maximum characters allowed in the label field is 50, same as the Cost Sheet Data
Source Name.
310
Unifier and Other Oracle Applications
Note: Only the "String" type field is supported for Cost Code Attributes
data mapping in Analytics.
You can add up to 20 String type Data Elements (DEs) from the Cost Code Attributes Detail
Form as User Defined Attributes.
The Name field is a required field and lists User Defined String Field 1 through 20.
If a name has been selected, for example, User Defined String Field 1, the list does not
include User Defined String Field 1 and starts with User Defined String Field 2.
If an existing name has been deleted, the name will appear in the list.
The Data Source field lists Data Elements (DEs) in the Cost Code Attributes Detail Form.
Only DEs with the "String" type Data Definitions (DDs) are displayed in the Data Source field.
The "String" type DDs in the list are:
Text Box
Multiple Text Lines
Pull-Down Menu
Radio Buttons
Multi-select Input
The DDs in the Data Source field include the DEs, for example, Description
(uuu_cost_description). If a DE that has already been added is deleted from the deployed
design, only the DE name will be seen.
Unifier populates the Label field based on the DE that has been selected in the Data Source
drop-down list. The Label field is a required and editable field, and it will accept non-ISO
characters (UTF-8), to support internationalization.
The maximum allowed length is the same as the DE label, and the system does not check for
label name uniqueness.
311
General Administration Guide
Note: You work with a Generic Cost Sheet in the same way that you
work with Cost Sheet (CBS Shells); however, the difference is that the
data in the Generic Cost Sheet comes from Generic Shells and
sub-shells, but the data for Cost Sheet comes from the CBS Shells.
You can access your Generic Cost Sheet from the Analytics node (go to the project/shell tab
and switch to Admin mode; in the left Navigator, select Analytics, and then select Generic
Cost Sheet) and map your Analytics fields to the corresponding Generic Cost Sheet columns.
Double-click Generic Cost Sheet to open the Analytics - Generic Cost Sheet Setup window.
The Data Mapping tab (in the Analytics - Generic Cost Sheet Setup window) enables you to
map the Generic Cost sheet Analytic fields to the corresponding Generic Cost Sheet columns.
The Data Mapping tab has the following fields:
Name
Data Source
Label
The Data Source values are the Single Sources and Logical Sources existing in the Generic
Cost Sheets of all the Generic type Shells. You can pick the same data source for multiple fields.
The Label field is required field for the user-defined columns. The system supports a total of 40
user-defined columns, for the Generic Cost Sheet.
Note: An asterisk (*) appears for columns where mapping has been
completed. The asterisk (*) does not appear if the column is not mapped
to any data source.
The system populates the Label column with the Name column for the data source, as set in the
Generic Cost sheet column definition. You can modify the values in the Label column, based on
your business needs. The Label column supports non-ISO and UTF-8 characters.
The maximum number of characters allowed for this field is 50, same as the maximum number
of characters in the Generic Cost Sheet Data Source Name.
Notes:
The system does not support Custom String translation.
The system does not perform label uniqueness verification.
312
Unifier and Other Oracle Applications
When you open P6 Summary Sheets in the Analytics node, you will see the Analytics - P6
Summary Sheets Setup window with the following tab: P6 Data Sources.
Note: The P6 Data Sources that need to send data to Oracle Analytics
Server are set up here.
Current Schedule
Customer Sign-Off Baseline
Initial Planning Baseline
Management Sign-Off Baseline
New P6 Data Source for Analytics Testing
P6 Testing datasource
These are all the published P6 data sources defined under Standards & Libraries.
When finished, click Apply and then OK.
You can select more than one data source. To select more than one data source, click one
source, click OK, and click to add additional data sources.
Note: After you add a data source, that data source will not be shown in
the Select P6 Data Sources for Analytics window.
Additional information
You can use the P6 Summary Sheets that are included in the following types of Unifier CBS
Shells for Analytics:
Duration
Resource loaded
Cost loaded
Note: The P6 Summary Sheets for the above data sources will send
data to Analytics.
If fields overlap between the CBS Shells and the existing P6 Summary Sheets, the
system-defined fields in the P6 Summary Sheets will be used.
Example:
313
General Administration Guide
Planned Start and Planned Finish are mapped fields in Unifier CBS Shells; however,
these fields will be replaced by the system-defined fields in the P6 Summary Sheets.
Data analysis can be performed on P6-Unifier integrated data. Since there is no user
interface (UI) component for the P6 Summary Sheets, when Unifier sends data to Oracle
Analytics Server, the details of the P6 Summary Sheets of the selected P6 data source is
sent to Analytics. In Analytics, views are created based on the details of the P6 Summary
Sheets and the user can see the daily-level data.
Note: When the user adds a new user-defined field on a Shell mapping
page, the "Name" field displays fields up to 100 (minus the ones used
already).
Shell Phase
Anticipated Start
Anticipated Finish
Start
Finish
Forecast Start Date
Forecast Finish Date
Planned Start
Planned Finish
Scheduled Finish
314
Unifier and Other Oracle Applications
Current Budget
Original Budget
Proposed Budget
Address 1
Address 2
City
State
State Code
Country
Country Code
Postal code
Data Source
Lists all the Data Elements (DEs), in the Shell attributes, with matching Data Definitions
(DDs).
The DEs are listed in alphabetical order.
The values listed in the drop-down list have a matching DD as in the Name field and includes
a consolidated list of all the DEs across all Shell attribute forms. For example, when you
select the "Project Start Date," the drop-down list will include all the date fields in all the Shell
attribute forms.
The bottom section of the Analytics - Shells Setup window includes the User Defined
attributes/fields presented in the following columns:
Name
Data Type
Data Source
Label
Use the Add, Modify, and Remove to add, modify, or remove user defined attributes.
To modify a user-defined attribute, select the attribute, click Modify, and modify the fields.
To remove a user-defined attribute, select the attribute, click Remove, and modify the fields.
315
General Administration Guide
Notes:
The Label field is populated based on the Data Element that you have
selected from the Data Source drop-down list.
The Label field is editable and required. You will receive an error
message if you leave the Label field blank.
If you notice that the value in the Label field has changed, it means
that other fields have been updated at one point.
The Data Type that you select impacts the Name and the Data Source of the user-defined
attribute. The Data Type field allows you to select the following attributes, only:
String (default)
Date
Numeric
For example, if you select String as your Data Type, you can:
Add up to 20 names (User Defined String Fields 1 - 20) as the Name.
Select from a predefined set of data sources from Data Source drop-down list.
The content of the Label filed will be selected by the system and according to your other
selections.
Dimension and Fact
The Data Type that you select corresponds to the Analytics fields as follows:
If the Data Type that you select is String/Date, your selection corresponds to a Dimension
object in Analytics.
If the Data Type that you select is Numeric, your selection corresponds to a Fact object in
Analytics.
Additional Information
Pickers are available for String field mappings for both canned and user defined attributes are as
follows:
BP Data Picker
User Data Picker
Planning Data Picker
User Picker
Location Picker
P6 Activity Picker
Auto-update Status Setup Picker
316
Unifier and Other Oracle Applications
When you open the Space Manager in the Analytics node, you will see the Analytics - Space
Manager Setup window with one tab: Space Types.
The Space Types tab contains a list of space type names under the Space Types for Analysis
section. You can add and remove a Space type using the Add and Remove buttons on this tab
and below the Space Types for Analysis section. When finished, click Apply and Ok to
complete the operation.
If an unpublished space type is removed from the Space Types tab, no information related to the
space type, and Level, is sent to Analytics.
The following sections explain the following tabs that appear after you add Space Types:
Data Mapping - Space Types tab
Data Mapping - Level tab
317
General Administration Guide
Date Dimension
Numeric Fact
Adding new user-defined fields (custom fields) for Data Type: String
If you select the Data Type as String, up to 20 String type Data Elements can be added from the
Space Detail Form, as user-defined attributes.
318
Unifier and Other Oracle Applications
To add new user-defined fields (custom fields) for String Data Type, click Add to open the User
Defined Attribute window and enter values in the following required fields:
Name
The Name drop-down list contains values from “User Defined String Field 1" to "User Defined
String Field 20.” If a name has already been selected, the name is not listed in the Name
drop-down list.
Example
If the "Department" field has been added as a “User Defined String Field 1," then the “Name”
drop-down list does not display the “User Defined String Field 1."
If a previously added field has been deleted, that Name is displayed in the Name drop-down
list.
Data Source
The Data Source drop-down list contains a list of Data Elements from the Space Detail Form.
If you select the Data Type as String, the Data Elements in the Data Source drop-down list are:
Strings and Integer Pull Downs
Integer and String Radio Buttons
Check Boxes
Test Data Elements
There are no Pickers listed/available. The Data Source field displays a series of interconnected
Data Element names and Data Element labels in the following format: DE Label(DE name). For
example, Project Type(prjt_type). If a previously added Data Element is deleted from the
Deployed design, only the Data Element name is displayed.
Label
The Label field is populated based on the Data Element that you select in the Data Source. You
can only modify the value of this field with non-ISO characters (UTF-8) to support
internationalization. The maximum allowed length is similar to Data Element label. The system
does not perform a label uniqueness verification.
Adding new user-defined fields (custom fields) for Data Type: Date
If you select the Data Type as Date, up to 10 "Date" Data Elements can be added from the
Space Detail Form, as user-defined attributes.
To add new user-defined fields (custom fields) for Date Data Type, click Add to open the User
Defined Attribute window and enter values in the following required fields:
Name
The Name drop-down list contains values from “User Defined Date Field 1" to "User Defined
Date Field 20.” If a name has already been selected, the name is not listed in the Name
drop-down list.
Example
If the "Project Commission Date" field has been added as a “User Defined Date Field 1,"
then the "Name" drop-down list does not display the “User Defined Date Field 1."
319
General Administration Guide
If a previously added field has been deleted, that Name is displayed in the Name drop-down
list.
Data Source
If you select the Data Type as Date, the Data Elements in the Data Source drop-down list are:
Date
Date only Picker
The Data Source field displays a series of interconnected Data Element names and Data
Element labels in the following format: DE Label(DE name). For example, Project Archive
Date(prjt_arc_date). If a previously added Data Element is deleted from the Deployed
design, only the Data Element name is displayed.
Label
The Label field is populated based on the Data Element that you select in the Data Source. You
can only modify the value of this field with non-ISO characters (UTF-8) to support
internationalization. The system does not perform a label uniqueness verification.
Adding new user-defined fields (custom fields) for Data Type: Numeric
If you select the Data Type as Numeric, up to 40 numeric data elements can be added from the
Level Detail Form, as user-defined attributes.
To add new user-defined fields (custom fields) for Numeric Data Type, click Add to open the
User Defined Attribute window and enter values in the following required fields:
Name
The Name drop-down list contains values from “User Defined Date Field 1" to "User Defined
Date Field 40.” If a name has already been selected, the name is not listed in the Name
drop-down list. For example, if the "Total Count" field has been added as a “User Defined Date
Field 1," then the Name drop-down list does not display “User Defined Date Field 1." If a
previously added field has been deleted, that Name is displayed in the Name drop-down list.
Data Source
If you select the Data Type as Numeric, the Data Elements in the Data Source drop-down list
are the Data Elements found on the Space Detail Forms and are:
Integer
Currency
Decimal Amount
There are no Integer Pull Downs, Integer Radio Buttons, and Integer Check Boxes. The Data
Source field displays a series of interconnected Data Element names and Data Element labels
in the following format: DE Label(DE name). For example, Contract Amount(con_amt). If a
previously added Data Element is deleted from the Deployed design, only the Data Element
name is displayed.
Label
320
Unifier and Other Oracle Applications
The Label field is populated based on the Data Element that you select in the Data Source. You
can only modify the value of this field with non-ISO characters (UTF-8) to support
internationalization. The maximum allowed length is similar to Data Element label. The system
does not perform a label uniqueness verification.
Date Dimension
321
General Administration Guide
Adding new user-defined fields (custom fields) for Data Type: String
If you select the Data Type as String, up to 20 String type Data Elements can be added from the
Level Detail Form, as user-defined attributes.
To add new user-defined fields (custom fields) for String Data Type, click Add to open the User
Defined Attribute window and enter values in the following required fields:
Name
The Name drop-down list contains values from “User Defined String Field 1" to "User Defined
String Field 15.” If a name has already been selected, the name is not listed in the Name
drop-down list. For example, if the "Department" field has been added as a “User Defined String
Field 1," then the Name drop-down list does not display “User Defined String Field 1." If a
previously added field has been deleted, that Name is displayed in the Name drop-down list.
Data Source
The Data Source drop-down list contains a list of Data Elements from the Level Detail Form.
If you select the Data Type as String, the Data Elements in the Data Source drop-down list are:
Strings and Integer Pull Downs
Integer and String Radio Buttons
Check Boxes
Test Data Elements
There are no Pickers listed/available. The Data Source field displays a series of interconnected
Data Element names and Data Element labels in the following format: DE Label(DE name). For
example, Project Type(prjt_type). If a previously added Data Element is deleted from the
Deployed design, only the Data Element name is displayed.
Label
The Label field is populated based on the Data Element that you select in the Data Source. You
can only modify the value of this field with non-ISO characters (UTF-8) to support
internationalization. The maximum allowed length is similar to Data Element label. The system
does not perform a label uniqueness verification.
Adding new user-defined fields (custom fields) for Data Type: Date
If you select the Data Type as Date, up to 10 "Date" Data Elements can be added from the Level
Detail Form, as user-defined attributes.
To add new user-defined fields (custom fields) for Date Data Type, click Add to open the User
Defined Attribute window and enter values in the following required fields:
Name
322
Unifier and Other Oracle Applications
The Name drop-down list contains values from “User Defined Date Field 1" to "User Defined
Date Field 10.” If a name has already been selected, the name is not listed in the Name
drop-down list. For example, if the "Project Commission Date" field has been added as a “User
Defined Date Field 1," then the Name drop-down list does not display “User Defined Date Field
1." If a previously added field has been deleted, that Name is displayed in the Name drop-down
list.
Data Source
The Data Source drop-down list contains a list of Data Elements from the Level Detail Form.
If you select the Data Type as Date, the Data Elements in the Data Source drop-down list are:
Date
Date only Picker
The Data Source field displays a series of interconnected Data Element names and Data
Element labels in the following format: DE Label(DE name). For example, Project Archive
Date(prjt_arc_date). If a previously added Data Element is deleted from the Deployed
design, only the Data Element name is displayed.
Label
The Label field is populated based on the Data Element that you select in the Data Source. You
can only modify the value of this field with non-ISO characters (UTF-8) to support
internationalization. The system does not perform a label uniqueness verification.
Adding new user-defined fields (custom fields) for Data Type: Numeric
If you select the Data Type as Numeric, up to 30 numeric data elements can be added from the
Space Detail Form, as user-defined attributes.
To add new user-defined fields (custom fields) for Numeric Data Type, click Add to open the
User Defined Attribute window and enter values in the following required fields:
Name
The Name drop-down list contains values from “User Defined Date Field 1" to "User Defined
Date Field 30.” If a name has already been selected, the name is not listed in the Name
drop-down list. For example, if the "# of Spaces" field has been added as a “User Defined Date
Field 1," then the Name drop-down list does not display “User Defined Date Field 1." If a
previously added field has been deleted, that Name is displayed in the Name drop-down list.
Data Source
If you select the Data Type as Numeric, the Data Elements in the Data Source drop-down list
are the Data Elements found on the Level Detail Forms and are:
Integer
Currency
Decimal Amount
323
General Administration Guide
There are no Integer Pull Downs, Integer Radio Buttons, and Integer Check Boxes. The Data
Source field displays a series of interconnected Data Element names and Data Element labels
in the following format: DE Label(DE name). For example, Contract Amount(con_amt). If a
previously added Data Element is deleted from the Deployed design, only the Data Element
name is displayed.
Label
The Label field is populated based on the Data Element that you select in the Data Source. You
can only modify the value of this field with non-ISO characters (UTF-8) to support
internationalization. The maximum allowed length is similar to Data Element label. The system
does not perform a label uniqueness verification.
Vendors tab
Note: You must first select the Business Processes that you want to set
as Vendor Business Processes for use in Analytics.
In the Vendors tab, click Add to open the Select a Business Process as Vendor for Analytics
window. The list of Business Processes in this window is in alphabetical order.
Note: Only one Business Process can be marked as Vendor, so the Add
option is disabled after your selection.
Select a Business Process (Company and Shell level - Active and Inactive), and then click OK.
You can only select one Business Process.
You can remove a Vendor Business Process by selecting the item and clicking Remove.
Use the Vendors tab to select the Vendors names that you want to use in Analytics. Once
selected, you can use Add to add the name or Remove to remove a Vendor.
You can remove a Vendor Business Process that is published for Analytics. To remove an item
for use in Analytics, select the item from the list in the Select a Business Process as Vendor for
Analytics window and click Remove. You can add a removed item for Analytics reporting. Click
Add if you want to add a removed item to the list.
If the Company Administrator inactivates a Business Process marked as Vendor, and if the item
is used for Analytics, this Vendor Business Process remains in the Vendors tab.
If a Vendor is removed from the Vendors tab, data that exists in Analytics (for the removed
Vendor Business Process) remains as is; however, the new data will not be published.
324
Unifier and Other Oracle Applications
Scheduling Setup
Unifier sends data from all Shells, regardless of the Shell status. If you need to filter the data
based on the Shell status, you (the Administrator responsible for setting up the Analytics
Schedule) must set up filter conditions on the data and set up a schedule to send the data to
Oracle Analytics Server.
325
General Administration Guide
You can set up Scheduling by clicking the Schedule (on the log toolbar). The Schedule Setup
window allows you to set the following:
Frequency
Filters
Note: If you change the filter setup, the change only applies to the
subsequent runs. Since the scheduled runs sends incremental data
(Data that has changed between runs) only, the filter change is
applicable to the sent incremental data.
326
Unifier and Other Oracle Applications
Upon selecting the Run Now option, Unifier displays the following message: "This action will
only publish the Unifier data for Analytics and will not update the data seen in Dashboards and
Analyses. You must run Analytics ETL to update them. Do you want to proceed?"
This option is available for the users only if the Modify permission has been granted.
When the job of data publish is already running based on the schedule setup, an alert is
displayed to inform the user that the job for data publish is already in progress: "Unifier data is
already being published based on the schedule. You must wait for this to be complete before
performing this action."
327
General Administration Guide
Analytics uses this subject area to analyze weekly historical business process facts to better
understand changes over time. Note that dimensional business process history is not
supported.
Cash Flow
Analytics uses this subject area to analyze CBS-level cash flows. You can map columns to
predefined company-level cash flow curves. Five generic columns are included to support
custom labels from Unifier. Any Cash Flow families will be designated in Unifier (based on
Cash Flow 'Name' value).
Cash Flow History
Analytics uses this subject area to analyze weekly historical cash flow facts to better
understand changes over time. Note that dimensional cash flow history is not supported.
Cost Sheet
Analytics uses this subject area to analyze cost sheets. You can map your data source to a
predefined list of cost sheet columns. Ten generic columns are included to support custom
labels from Unifier.
Cost Sheet History
Analytics uses this subject area to analyze weekly historical cost sheet facts to better
understand changes over time.
328
Unifier and Other Oracle Applications
9) Click OK.
10) Click Apply to save changes and keep the window open, or click OK to save changes and
close the window.
To grant permission for Unifier data in Analytics (User Mode Access):
1) Go to the Company Workspace tab and switch to Admin mode.
2) In the left Navigator, select User Administration, and then select Access Control.
3) In the right pane, expand User Mode Access, expand Company Workspace, expand
Non-navigational Nodes, and then select Analytics.
4) In the Permission Settings for: Analytics dialog box, click Add to open a new Permission
Settings for: Analytics window.
5) Click Add Users/Groups. The Users/Group Picker window opens.
6) Select the intended users and/or groups and click Add.
7) Click OK to return to the Permission Settings window.
8) Select the users or groups in Select Users/Groups, located in the upper portion of the
window, and select the appropriate level of access for the user or group in Permissions
Settings, located in the lower portion of the window.
View All Records: This option allows users and groups to open and view Company level
Business process data and all the available project level data in Analytics. Users with View
All Records permission cannot make any changes.
View All Company Records: This option allows users and groups to open and view only the
Company-level information from the respective level Business Processes that are enabled
for Analytics. Users with View All Company Records permission cannot make any
changes.
View All Shell Records: This option allows users and groups to open and view all the
available/mapped shell level data in Analytics, like Cost, Cashflow, and so on. Users with
View All Shell Records permission cannot make any changes.
Note: For existing users, the first check box option (View All Records) is
automatically selected, after upgrade.
329
General Administration Guide
The Cost Sheet dashboard enables you to view cost data, including a comparison of original
and revised budget details, and cost history analyses.
To access the Analytics node:
1) Go to the Company Workspace tab and switch to Admin mode.
2) In the left Navigator, select Integrations, and then select Analytics.
330
Unifier and Other Oracle Applications
Company-level dashboards
The company level access is typically provided to executive level users who want to view the
Analytics dashboards at a Company level. These users will be able to access data from all
Shells.
331
General Administration Guide
Dashboards
You can access the executive Analytics Dashboards by clicking the Analytic Dashboards icon.
Clicking the Analytic Dashboards icon, on the top left corner of the screen, allows you to open
the Analytic Dashboards in Oracle Analytics Server.
The Analytic Dashboards icon can be seen by users who have access to Company level
Analytics (for more information, see Access Control Changes for Analytics Node in User
Mode Access).
Shell-level dashboards
The Shell members can configure Shell dashboards.
In the Source Details section of the Edit Dashboard window, the Analytics option for the Block
Type supports Analytics for Shell details.
Any user with the Edit Dashboard permissions can add the Analytics option for the Block Type.
Schedule Setup
The frequency for the data publication can be Daily, Weekly or None. The default value is Daily.
You can set the frequency to Every __ hours, Daily, Weekly, or None.
The default frequency is Daily.
If you select Weekly, the system sets the day to Sunday. You can change the day.
If you select None, there will be no periodic publication of Unifier data to Analytics.
You can set the time for the publication of data.
You must set the time format to 24-hour notation in the form hh:mm, for the publication of data.
The Hour drop-down lists hours from 0 to 23 for hour and 0 to 59 for minute. The default option
for time is set to 00:00. The system displays the server time zone after the minute.
332
Unifier and Other Oracle Applications
You must select the check box for the Data Refresh option if you made changes to the DD
value or labels. By default, the check box is unchecked.
You must select the check box for the Data Refresh option if you made changes to the data
mapping fields. After the run is complete, the system resets the check box for the Data Refresh
option and the check box will be unchecked.
Run History
The Run History option allows you to see the status of the scheduled runs of the Unifier data
publication to the Analytics server. When you select the Run History option, by clicking Run
History on the toolbar, the Run History window opens and displays the following information:
Requestor: Is always "System"
Submit Date: The date entered by user
Start Date: The date entered by user
End Date: The date entered by user
Status: The run status
You can view the Run History details by opening a record in the Run History log.
The history details window includes the Start Date, End Date, and a message.
Success message: Data was sent to Analytics, successfully.
Failure message: For example, An error occurred and data was not published to Analytics
successfully. Contact System Administrator. The system then displays the actual error after
the generic failure message.
Analytics Block
The following provides detailed information about the Analytics Block window:
Block Title: This field contains the title of the Analytics Block.
Name: This field contains the name (as a hyperlink) of the Analytics Block.
URL: This field contains the URL, entered by the user, and it must match the URL specified
in the Unifier Configurator.
333
General Administration Guide
Note: The URL protocol, server path, and port must all match; otherwise,
the validation fails.
Example
If the URL is: http://slc44.us.oracle.com:7001/analytics, the Analytics URL
must be: http://slc44.us.oracle.com:7001/analytics.
Note: The system does not validate the other URL parameters, for
example, the Dashboard name.
When you post the Analytics Block, it appears in the Source Details log and provides the
following information:
Block Title: Title entered by the user.
Source Name: Same as the name entered in the Name field.
Block Type: Analytics
Result Type: Blank
Display Type: Blank
The Analytics Block is also displayed in the Shell landing page. In the Unifier Analytics pane,
you can click Analytics Dashboards to go to the shell dashboard in the Analytics server.
If a user does not have permissions to access the Shell dashboards defined in the Oracle
Analytics Server, the link is disabled and displays as plain text.
You can add Analytics block to "My Dashboards." However, the link connecting Unifier to the
Analytics server, from this "My Dashboards" is completely driven by the Access Control (for
more information, see Access Control Changes for Analytics Node in User Mode Access).
334
Unifier and Other Oracle Applications
Use the system Data Element uuu_int_schedule_type within the Integration -> Detail
section of Shell attribute form definition.
Create and Publish P6 Data Sources to pull P6 data into Cost Sheet.
Create Shell instances corresponding to each P6 Schedule that needs to be integrated with
Unifier by following these instructions:
Each Shell instance must have the same ‘Shell Number' as the corresponding P6 Project
ID.
To bring the P6 internal Project id to Unifier, add the P6 Internal Project ID field
(uuu_int_internal_proj_id) to the Attribute form and the Integration Detail form
(go to the Company Workspace tab and switch to Admin mode; in the left Navigator,
select uDesigner, and then select Shell Manager; open the applicable shell, select
Integration, and then select Detail).
Create or use separate Shell Templates for Duration Based and Resource or Cost
Loaded integrated Shells in Unifier because the Cost Sheet for Duration Based
schedules will not contain columns rolling up from P6 Summary Sheets (when the other
two types of schedules will have columns rolling up from P6 Summary Sheets).
Include the following in the Role attribute form, if the integration will be Resource or Cost
Loaded:
uuu_role_imported_from_p6
uuu_role_type, uuu_role_id
uuu_role_uom
For correct cost calculations in Resource Loaded schedules, update all imported roles with
Rate values.
If you create Unifier Roles via integration, include the Roles above the Data Elements (DEs)
in the integration detail section in uDesigner Role attribute design.
For Resource Loaded or Cost Loaded schedules:
(Recommended) Do not change or update the ID of Roles created via integration
manually because when you create Roles via integration the Role ID is used as the
identifier by means of which the integration interface maps the P6 Resource to Unifier
Role.
If you want to integrate the CBS codes with P6, do the following:
Include uuu_cost_imported_from_p6 and uuu_int_hidden_from_p6 in the CBS
attribute form
Define the default CBS segment values within Data Structure Setup -> Data Definitions
-> Cost Codes
If you want to create Cost Codes for a Shell using the P6 CBS structure, ensure that the
Cost Sheet structure in P6 is Tree.
Do not include Cost Code separators (“-”, “.”,) in P6 CBS Codes if you are creating Cost
Codes in Unifier using P6 data.
When working with P6 data sources or Cost Sheet columns:
You can create or publish P6 data sources via integration and when the "Send Summary
data" integration is used.
You can add published P6 data sources, as columns, only in Cost Sheet Templates.
335
General Administration Guide
If you create P6 data sources via integration, and not manually, you can add columns to
Cost Sheet only after the "Send Summary data to Unifier" is used.
If you create P6 data sources manually, and not via integration, create or publish P6 data
sources by:
Creating or publishing one P6 Data Source called "Current Schedule." This data
source is used by the system to define the "Type" of all Master Summary sheets
(Summary sheets which contain summary data from the main P6 project which is
integrated with Unifier).
Creating or publishing all "Baseline Type" values defined within P6 Enterprise
Data as P6 Data Sources.
After you create or publish the P6 data sources, you can use the P6 data sources to
create columns in the Cost Sheet Template and push the information to the Shell
instances.
336
Unifier and Other Oracle Applications
Edit
Delete: To delete a P6 Data Source
If the P6 Data Source has been published already, you cannot delete it.
Publish: To publish Data Source properties
View
To find a Data Source.
Help
To access online help and documents.
Find
To find a Data Source
337
General Administration Guide
Text (maximum 120 characters). This content of this field is from P6 and maps to the P6
Project Name.
Description
Editable field allowing you to enter a description (maximum 500 characters).
P6 Activity Data
If you are using both Unifier and P6, you can link the two applications using Primavera Gateway
and send data from a P6 Schedule to Unifier Projects. You can "pick" activities and
Auto-populate (AP) or Reverse Auto-populate (RAP) from the corresponding P6 project.
Corresponding P6 Project
The term “Corresponding P6 project” refers to that P6 project which has the:
Same ID as Unifier Project
or
Same ID as captured in a system element in Unifier project attributes
Note: Integration with the P6 application only applies to Unifier CBS type
Shell.
338
Unifier and Other Oracle Applications
Data Element
A drop-down list that contains all the elements (pre-defined or custom) from the P6 Activity
Attribute form. You can use the Data Element to create any query to filter out P6 Schedule
activities from the P6 Activity Picker.
Condition
To set conditions for the query.
At runtime, the system uses the data from Summary Sheets, associated with the P6 data
source, to render the Cash Flow curves.
Note: The Data Type option (under the P6 Source selection option) is a
required field, if you select Use data from P6 Sources option. Use the
drop-down list in the Data Type field to see a list of all the data types
available for the selected P6 data source.
Since the Schedule type will be blank, the Cash Flow template displays all the options available
regardless of the Schedule type.
The P6 sources in Distribution, Cost (only for Actuals), and Schedule sections are always
enabled in the Cash Flow templates.
The P6 Sources window (source selection) lists all the Published data sources, in alphabetical
order. You can click a source name to select that source. To find a source, go to Find, click the
drop-down list, and follow the prompts. Depending on the type of the Cash Flow curve, this
option is available only if you select the Distribution/Schedule/cost option as Use data/dates
from P6 Sources.
The Data type options for the Baseline curves are:
At Completion
339
General Administration Guide
Planned
The Data type options for the Forecast curves are:
At Completion
Remaining
You can copy the Cash Flow curve properties that exist in a Shell template to the Cash Flow
curves that exist in instances if:
The Shell template push is done
The Shell template is used to create instances
340
Unifier and Other Oracle Applications
Roles: You can create and update Roles using data sent over from Gateway. The exchange
of information is bidirectional, from Oracle application to Unifier and from Unifier to the
Oracle application.
CBS Codes: You can create CBS codes, within a Cost Sheet, using data sent over from
Gateway. The exchange of information is one-directional, from the Oracle application to
Unifier.
Notes:
The Oracle application must support receiving and exporting
documents.
After the documents are sent across to the Oracle application, the
system deletes the documents from Gateway.
341
General Administration Guide
Before you can use the object, you must configure the remaining information for the newly
created object:
Data related to Flow Type
Cross-reference to the Gateway object
After you complete mapping the object in Gateway, you can use the object for creating business
flows in Gateway and use the data.
Configuring Unifier Objects on Gateway
By default, the mapping of data involves the following applications in order:
1) Unifier
2) Unifier Provider on Gateway
3) Gateway Provider on Gateway
Mapping to a newly created object in Gateway requires that you match the information of that
object in Gateway to the information of the object that you deployed from Unifier. In Gateway,
after you find and select an object that you can use (that is, an object that has matching
information), you can proceed by cross-referencing the object in Unifier to the selected object in
Gateway.
Default Gateway Objects
The following table lists the object names that are available for mapping in Gateway, by default,
and provides a description:
342
Unifier and Other Oracle Applications
343
General Administration Guide
344
Unifier and Other Oracle Applications
345
General Administration Guide
346
Unifier and Other Oracle Applications
Unifier Deployment
Allows you to enter the name of the Unifier Deployment, which needs to be accessed to
exchange data with external applications
Data Definition: SYS Short Description Text 250
Integration Parameters block
Source Base Currency
Activity Sheet Synchronization
Import Synchronization (The import synchronization that is selected for Activity
and Assignment data for customers with access to the EVM feature and import
synchronization that is selected for Activity data for customers without access to
the EVM feature.)
Export Synchronization
Rate Sheet Synchronization
To see the Integration Settings, click Open from the toolbar to open the Integration Settings
window. In the Integration Settings window, you can edit fields and run tests. The Integration
Settings window contains the following blocks and fields:
Gateway block
API URL
User Name
Password
Contains the password required to log on to the Gateway URL.
Data Definition: Short Description Text
Test Connection
Enables you to run a test to verify that the Gateway URL and other credentials are
valid. See the Testing Connection section later in this topic.
Unifier Deployment
Allows you to enter the name of the Unifier Deployment, which needs to be
accessed to exchange data with external applications
Data Definition: SYS Short Description Text 250
Integration Parameters block
Select Source Base Currency for Rate Conversion
Currency
Select Synchronizations to exchange Activity data
Import Synchronization (editable drop-down (size 250 chars))
Contains the name of the Gateway Synchronization, which will be used to Import Activity
data from Unifier to P6
Using the Gateway URL and the Unifier Deployment details captured within the
Integration tab of "Company Properties," this field lists all the "Import" synchronizations
from the URL, which are applicable to the mentioned Unifier Deployment.
The synchronizations shown in the drop-down will be the ones that match the Unifier
Deployment. It lists the OOTB synchronizations provided for Oracle Primavera Cloud.
347
General Administration Guide
For customers with or without access to the EVM feature, the import synchronization that
is selected in Select Synchronizations to exchange Activity data will be the import
synchronization that is selected for EVM data, provided customer selected that prior to
upgrade to 20.7; otherwise, the synchronization selected will be from Select
Synchronizations to exchange Activity data.
For all customers, the activity import synchronization that is selected in Select
Synchronization to exchange Activity and Assignment data prior to upgrade to 20.7
is shown as selected under import synchronization Select Synchronization to
exchange Activity data. If there is no synchronization selected in Select
Synchronization to exchange Activity and Assignment data, the synchronization
selected in Select Synchronization to exchange Activity data must be selected. If
none of them are selected prior to upgrade to 20.7, the import synchronization will be
empty.
Starting from 20.7, customers with or without access to the EVM feature can get data
from P6, and the existing export synchronization and Import Synchronization selected
from Role and Resources synchronization will not have any impact.
Export Synchronization (editable drop-down (size 250 chars))
Contains the name of the Gateway Synchronization which will be used to Export Activity
data from P6 to Unifier
Using the Gateway URL and the Unifier Deployment details captured within the
‘Integration' tab of Company Properties, this field lists all the "Export" synchronizations
from the URL which are applicable to the mentioned Unifier Deployment.
The export synchronization shows additional OOTB synchronizations "Send Activity
data from Unifier to Primavera Cloud" defined for Oracle Primavera Cloud. You will be
able to push the updated activity data to Oracle Primavera Cloud, using the export
synchronization.
The Export Synchronization option "Update Activity data from Unifier to Primavera Cloud"
enable you to send updated activity data from Unifier to the Oracle Primavera Cloud.
When you are using Oracle Primavera Cloud data for scheduling a project, you can bring
the activities, schedules, and the associated WBS to the Unifier Activity Sheet. From the
Activity Sheet, Unifier pulls the activity attributes into the business processes. In the
business processes, you can update the schedules and reverse auto-populate (RAP)
data back to the Activity Sheet. In the Unifier Activity Sheet log of the projects that are
synchronized with Oracle Primavera Cloud, the Send Data option enables you to send
the updated schedules back to the Oracle Primavera Cloud. The business flow updates
the activity data in Oracle Primavera Cloud according to the activity data in Unifier.
348
Unifier and Other Oracle Applications
When you make changes in the Integration Settings window, you must click OK to save your
changes. Click Cancel to close the Integration Settings window.
Testing Connection
To run a test to verify that the Gateway URL and other credentials are valid use the Test
Connection option, in the Gateway block. If the system is unable to establish connection, you
will receive an error message. If the system is able to establish connection, you will receive a
confirmation message.
Note: The following types of BPs are not supported for integration:
Project/Shell Creation BP - Resource BP - RFB BP - Text BP.
In the Business Objects log, the columns provide detailed information about each Unifier object
that has been deployed.
349
General Administration Guide
Deploy to Gateway
When deployed to Gateway, the system appends the attributes of the objects in Unifier to the
corresponding object in Unifier Provider. You can select multiple items and deploy the selected
items to Gateway. For the selected objects, the user can create the following and synchronize
the data exchange:
Data Mapping templates
Business Process flows
If the "Integration" form of the following is set in uDesigner, you can use this option to deploy:
Activity Sheet Attributes (as captured in Unifier which flow to Unifier Provider which flow to
Gateway)
350
Unifier and Other Oracle Applications
The deploy action only sends the values that you had manually entered in the Activity
Attribute form to Gateway.
The "Activity Sheet" object in Gateway contains all the pre-defined Activity Attributes fields by
default.
If you have added bitemID field in the Activity Sheet, the P6 CBS code (P6) can then be
mapped to the bitemID in the field mappings on Gateway.
Projects/Shells (Attribute form)
Business Processes
Data Elements of type SYS Rich Text must not be sent to Gateway, when deployed.
Roles (Attribute form)
CBS Codes (Unifier CBS Shell-type only)
Project/Shell-level User-Defined Reports (UDRs)
Company-level UDRs
All the UDRs, which have been enabled for integration (that is, the Enable for Integration
option is selected), are listed in in the Business Objects node, and you can choose to deploy
those UDRs to Gateway to configure them for Data Exchange.
The Business Objects node log displays UDR types and categories.
All Project/Shell-level UDRs have Project/Shell level as their type and User Defined Report as
their category.
All company-level UDRs have company-level as their type and User Defined Report as their
category. You can search for and find a UDR Business Object by type or category.
If you deselect the "Enable for Integration" option of a UDR after it has been deployed to, and
configured in (for a Business Flow), Gateway, the system generates an error when
synchronizing.
If you delete a UDR that you have recently deployed to, and configured in (for a Business Flow),
Gateway, the system generates an error when synchronizing.
When a Line Item Type BP is deployed to Gateway, from Unifier, the system creates two objects
for that BP.
You can create different field mapping templates, according to the template requirements, and
use the templates in different Business Flows to transfer the data.
If you share documents between Unifier and any Oracle application, and the Oracle application
does not support document integration, the system completes the Business Flow but without
transferring the documents.
351
General Administration Guide
History
The system logs all the deployed Unifier objects in History. The History option allows you to
view the status of a deploy action, informing you whether the deployment was successful, in
addition to the following information:
Requestor
The name of the user who has deployed the record.
Source
If you select objects of same type and deploy, the system provides all selected objects
(including names of all objects which were chosen by you for deploy) in alphabetical order.
If you select objects of multiple types and deploy, the system provides separate history
entries for each of the objects that are getting deployed to Gateway.
Start Date
The date when the deployment action started (Unifier started to prepare the xml file for
Gateway).
End Date
The date when the deployment action ended.
Status
The status of deployment action (Finished, In Progress, Finished with Errors).
In the History window toolbar, you can:
Open
To open an item in the History log.
Similar to the Open option in other "History" windows in Unifier, this action opens the
"History Details" window.
Similar to other places in Unifier, you can take this action on one selected row only.
Find
To allow you to search the History records. You can search on all columns (Requestor,
Attribute Form, Submit Date, Start Date, End Date, Status).
Close Window
To close the History window.
History Details
If you select a row in the History window and click Open, the History Details window opens.
This window includes information about:
Business Processes
The name of the attribute form that was deployed.
Gateway URL
The Gateway API URL through which link to the 3rd party applications is established, as
defined by the user within the Integration tab of Unifier Company Properties.
Unifier Deployment Name
352
Unifier and Other Oracle Applications
The name of the Unifier Deployment as defined within the Integration tab Unifier Company
Properties.
Deploy action status details
The details of the status of the deploy action, successful or not.
Find
The Find option allows you to search for records in all the Business Objects window columns.
353
General Administration Guide
Note: You can move the Activity Sheet module under other nodes.
354
Unifier and Other Oracle Applications
Status
Location
Template Number
Business Processes (BPs): Enables you to create/update different types of BPs such as
Cost, Line Item, Document, and so forth. To correspond to the Gateway infrastructure,
separate objects are available to capture the information in the BP Upper Form and Detail
tab. To support the creation of BPs, the Business Processes object in Unifier Provider
includes the following information:
Name
Status
Detail tab Name
Roles: Enables you to create/update Roles (go to the Resource Manager and then select
Roles) if you have access to the Resource Manager feature.
Resources: Enables you to create/update Roles (go to the Resource Manager and then
select Roles). If you have access to the Resource Manager feature, you can use the
Resources object to identify whether data from Unifier Provider can create a Role.
CBS Codes (Unifier CBS Shell-type only):
Enables you to use the CBS object in Unifier Provider to import/export the CBS code data
from Unifier.
Enables you to use the CBS object in Unifier Provider to import the CBS code data into
Unifier.
The following provides more details.
Project/Shell
To create/update Project/Shell in Unifier, you can use the following attributes:
Data Dictionary
Business Flow
Synchronization
End-to-end solution
The following sections provide more details.
355
General Administration Guide
356
Unifier and Other Oracle Applications
Project/Shell Synchronization
Synchronization in Unifier Provider (Project/Shell) occurs when you set the parameters (Project
Location and Project Template Number) as "Required" or "Optional" in the Business Flow
definition.
357
General Administration Guide
Note: This is an optional step. You can skip deploying the objects from
Unifier and add manually relevant fields in Gateway Data Mapping
Templates directly.
Note: Ensure that you create one Data Mapping Template per Shell
type.
If you do not want to deploy from Unifier and want to create the Data Mapping Templates in
Gateway directly, add each Shell Attribute Form Data Element that needs to receive data from
the Oracle application Project object, manually.
If you want to deploy from Unifier, after adding the Shell Attribute Form Data Element:
If the manually added field is same as one of the fields that were deployed from Unifier, there
will be no adverse impact on the existing fields.
If the manually added field does not exist as a Data Element in Unifier, there will be no
adverse impact on the existing fields.
358
Unifier and Other Oracle Applications
The fields remain as they are when the Oracle application sends values for the fields that were
added to Unifier Provider and those values are not sent to Unifier.
Define Business Flow
Define Business Flow using the appropriate Data Mapping Template.
Create one Business Flow per Shell type.
Add the appropriate source (Source) application parameters to filter the projects that you want to
create.
Add the values of relevant destination (Destination) application parameters (Location and
Template).
Configure the Business Flow to be used for creating (Create) and updating (Update) the project.
Define Synchronizations
Define Synchronizations by using the appropriate Business Flow.
Define the appropriate parameter values for data exchange.
Define the schedule frequency so that the synchronization does not have to be run manually for
the project creation or update.
Synchronization
When a synchronization is run, Unifier Provider sends data to Unifier to:
Create or update a Shell instance (as per Business Flow configuration).
Populate the Data Element with the name of the application that is integrating with Unifier, if
the destination Shell Attribute Form contains the "uuu_integrated_with" Data Element.
Note: Gateway sends the application name value. The name is not
hard-coded by Unifier.
Gateway maintains a cross-reference table between objects of the two applications to monitor
whether to create or update the records of an object. The cross-reference table has IDs of
projects in Unifier and P6. If the cross-reference table has and entry for a Unifier project against
a P6 project, Gateway will update the Unifier project; otherwise, Gateway will create a Unifier
project.
Note: If a project exists in Unifier and does not have an entry in the
Gateway cross-reference table, when Gateway proceeds to create a
project, the create request is converted to update request and the
existing project is updated, instead of creating a new project. This
prevents creating a duplicate project.
Business Processes
To create/update Business Process records in Unifier, you can use the following attributes:
Data Dictionary
Business Flow
359
General Administration Guide
Synchronization
End-to-end solution
The following sections provide more details.
Notes:
The remaining attributes are deployed from Unifier, as Data
Elements, and will be added to relevant business processes, per
business need.
If available, the Object IDs in Gateway are noted in the corresponding
field.
The Parent Element ID is the tag in the Line Item which connects the
Line Item with the parent record in which the Line Item has to exist
in.
Create separate templates for importing data into different BPs.
360
Unifier and Other Oracle Applications
361
General Administration Guide
362
Unifier and Other Oracle Applications
363
General Administration Guide
364
Unifier and Other Oracle Applications
365
General Administration Guide
366
Unifier and Other Oracle Applications
367
General Administration Guide
368
Unifier and Other Oracle Applications
369
General Administration Guide
370
Unifier and Other Oracle Applications
371
General Administration Guide
Notes:
The parentdetailid connects the BP Line Item to its parent
Summary Line Item in the SOV.
The Data Element uuu_sovlinum is an optional field. If the value is
received by Unifier for the same field, the system will try to update an
existing row; otherwise, the update will create a new Line Item in the
SOV (based on the settings of the SOV).
372
Unifier and Other Oracle Applications
</_bp_lineitems>
Notes:
The parentdetailid connects the BP Line Item to its parent
Summary Line Item in the SOV.
The refnum is for Unifier and is used when creating the structure
within the SOV for the incoming Line Items and the Summary lines.
373
General Administration Guide
374
Unifier and Other Oracle Applications
Notes:
To avoid duplicating records, create separate Business Flows (for two
BPs of the same type) when importing data.
Do not use a single Business Flow in Gateway to import into two
Company Costs type BPs. Instead, use different Business Flows for
setting up the data flow.
If the source application sends value for either of the parameters mentioned below via data
mapping and you define the parameter value in the business flow, the value sent by way of
mapping takes precedence.
The following parameters are required for successful project creation.
375
General Administration Guide
376
Unifier and Other Oracle Applications
377
General Administration Guide
Note: This is an optional step. You can skip deploying the objects from
Unifier and add relevant fields in Gateway Data Mapping Templates
directly, manually.
378
Unifier and Other Oracle Applications
All Data Elements from the deployed business process record appear as attributes of Business
Process object (Company Costs, Project Commits, Project Invoices, and so on) in the Provider
Data Dictionary.
To configure the creation of Business Processes in Unifier Provider via Gateway:
You must:
Create Data Mapping Templates
Define Business Flow
Define Synchronizations
Synchronize
The following provides the details for each step:
Create Data Mapping Templates
Create Data Mapping Templates to map attributes of the BPs Upper Form data that needs to
integrate with Gateway to the Oracle application.
Notes:
Ensure that you create one Data Mapping Template per BP.
If the BP that needs to integrate has a Detail tab, create an additional
Data Mapping Template, one template per Detail tab, to ensure that
the map the Detail Form elements to Gateway to the Oracle
application.
After you deploy the BP from Unifier to Gateway, all the attributes of the Business Process
object Unifier Provider (Company Costs, Project Commits, Project Invoices, and so on) will be
available for you to add to the Data Mapping Template.
If you do not want to deploy from Unifier and want to create the Data Mapping Templates in
Gateway directly, you must add each BP Data Element that needs to receive data from an
Oracle application object in Gateway, manually (use the Add New Field in the Add Template
window). After you add each BP Data Element in Gateway, you must deploy the BP from Unifier.
Note the following conditions:
If the manually added field is the same as one of the fields that you deployed from Unifier,
there will be no impact on the existing field. This is similar as if you deployed the manually
added field from Unifier.
If the manually added field does not exist as a Data Element in Unifier, there will be no
impact on the existing field. When the Oracle application sends value for this field to Unifier
Provider, the value remains as is and it is not sent to Unifier.
Define Business Flow
Define Business Flow using the appropriate Data Mapping Template.
Create one Business Flow per BP Upper Form and one Business Flow per BP Detail tab.
Add the appropriate source (Source) application parameters to filter the BP records that you
want to extract for the Oracle application and create in Unifier.
379
General Administration Guide
Add the values of the following relevant destination (Destination) application parameters for the
BP Records/Line Items to be created in Unifier:
Project ID
Business Process Name
Business Process Detail Tab Name
Configure the Business Flow to be used for creating (Create) and updating (Update) BP
Records/Line Items.
Define Synchronizations
Define Synchronizations by using the appropriate Business Flow.
Define the appropriate parameter values for data exchange.
Define the schedule frequency so that the synchronization does not have to be run manually for
the BP Records/Line Items creation or update.
Synchronize
When a synchronization is run, Unifier Provider sends data to Unifier to create or update BP
Records/Line Items instance (as per Business Flow configuration).
Example
To create BP records of Base Commits type in Unifier:
1) Deploy the Base Commits BP to map to Unifier Provider object (Project Commits).
2) Log in to Gateway instance and create the following two Data Mapping Templates:
a. Using the Gateway object "Project Commits" to map the Base Commits BP "Upper Form"
information to the Oracle application.
b. Using the Gateway object "Project Commits Detail" to map the Base Commits BP "Detail"
tab information to the Oracle application.
3) Using the appropriate Gateway objects, create the following two Business Flows:
a. Using Gateway object "Purchase Orders" and selecting the corresponding Data Mapping
Template that you created (sub-step "a" above).
b. Using Gateway object "Purchase Orders Detail" and selecting the corresponding Data
Mapping Template that you created (sub-step "b" above).
4) Add the appropriate source (Source App Parameters) to filter records from the source
application and set the destination application parameters (Destination App Parameters) to:
a. Business Process Name = Base Commit
b. Business Process Detail Tab = <detail tab name>
5) Create two synchronizations:
a. For Base Commit BP
b. For Base Commit Line Item
6) Define the schedule frequency so that the synchronization does not have to be run manually
for the BP Records/Line Items creation or update.
380
Unifier and Other Oracle Applications
Roles
You can create a Role in Unifier by using both Role and Resource data from an Oracle
application. The Role object in Unifier Provider can be used to create and update Roles in
Unifier. The following sections provide details about:
Roles Data Dictionary
Roles Business Flow
Roles Business Flow (Destination App Parameters)
Roles Synchronization
Roles End-to-End Solution
Roles Data Dictionary
The Role object in Unifier Provider has the following default attributes which are the required
fields needed to create a Role object in Unifier:
As a result of the Summary Sheet integration that creates Roles in Unifier (by pulling data from
P6 Schedule Summary data, the Role ID (uuu_role_id) is a required field for creating a Role
object.
Creating a Role object in Unifier by pulling data from Gateway (Role/Resource object) does not
require the Role ID (uuu_role_id) field for creating a Role object in Unifier.
Creating a Role object in Unifier via Gateway integration (by pulling data from Gateway
Role/Resource object) requires the values of the following fields, mentioned in the table above:
Role Name
Role Status
Role Currency
381
General Administration Guide
Roles Synchronization
You can create synchronization using the appropriate Business Flow.
382
Unifier and Other Oracle Applications
Resources
You can use the Resources object to identify whether a data from Unifier Provider can create a
Role/Resource. When you map a Unifier "Resource" object to a Gateway "Resource" object, you
can create/update both the Resources and Roles object in Unifier. The following sections
provide details about:
Resources Data Dictionary
Resources Business Flow
Resources Synchronization
Resources End-to-End Solution
Resources Data Dictionary
The Resources object in Unifier Provider has the following default attributes which are the
required fields needed to create a Resources object in Unifier:
383
General Administration Guide
Resources Synchronization
You can create the Synchronization by using the appropriate Business Flow.
CBS Codes
You can create and update the CBS Codes in Unifier Cost Sheet via Gateway integration with
any Oracle application.
Note: Oracle recommends that you inspect what you expect from
connecting Unifier projects to Oracle Primavera Cloud projects because
you may experience unexpected data and results.
384
Unifier and Other Oracle Applications
2) In the left Navigator, select Integrations, and then select Primavera Cloud.
3) After you review the following information, continue to the Connect for Primavera Cloud
Integration topic for additional instructions.
385
General Administration Guide
386
Unifier and Other Oracle Applications
Notes:
The refresh token is generated before the access token expires.
If the server name and the host and scope name are different, the
Oracle Primavera Cloud connection will not be established.
The system will use the access token (which is generated based on the user name and
password) to authenticate the Oracle Primavera Cloud public API to send (push) and receive
(pull) cash flow data for selected projects. If the values of the URL or credentials have been
entered correctly, you will see this message: "The access token has been generated
successfully." Otherwise, you will see this message: "The access token cannot be generated.
Verify the credentials entered."
387
General Administration Guide
388
Unifier and Other Oracle Applications
IDCS URL: Enter a valid Oracle Identity Cloud Service (IDCS) URL hosting Oracle
Integration.
Client ID: Enter the client ID generated for adding Unifier as a trusted application
in Oracle Integration.
Client Secret: Enter the client secret generated for adding Unifier as a trusted
application in Oracle Integration.
App Scope: Enter the App Scope generated for adding Unifier as a trusted
application in Oracle Integration. It generally ends with
'urn:opc:resource:consumer::all'
b. Click Save & Generate Access Token.
This generates a token and sets the Enable Integration fields to Yes on connecting
successfully. Otherwise, recheck your Oracle Integration configuration details.
Note: For subsequent use, recheck the above field information and
complete Step 2 to connect with Oracle Integration as-needed, on
demand.
5) Select the Unifier modules that will use integrations from Oracle Integration:
a. In the Integrations tab, click Manage Modules and select/deselect any of the following
modules:
Business Processes
System Activity Sheets
Manual Activity Sheets
Master Rate Sheet
b. Click Save.
6) For each module selected in the previous step, add one or more endpoints as follows:
a. In the left pane of the Integrations tab, select a module. For example, select Business
Processes.
b. In the right pane, click Add Integration.
c. For each endpoint, enter the following information:
Integration Name: (Required) Enter a user-friendly name for the integration being
set up.
OIC Name: Enter the name of the integration created in Oracle Integration.
API Path: (Required) Copy the relative path of the endpoint URL from the POST
field on the Configure and Run page of the integration from Oracle Integration. It
usually starts with /ic/api/.
d. In the Action field, click Submit.
The Usage status of the integration defaults to Unused.
389
General Administration Guide
e. In the Activate field, slide right to activate the integration. However, if the integration is
deactivated, but being used in the BP Setup of a particular status/step, when the BP
record is submitted, the integration will not be invoked.
When the integration is triggered as part of a BP workflow event or Get Data of System
Activity Sheet, the job status can be viewed from the following locations:
OIC Integration Log under the System Information node
Integration Log of the BP record/Activity Sheet History tab
However, the progress of the integration execution is available in the OIC Integration
Log only if the integration has a call to invoke the Unifier API with a status and
corresponding error message. For more details, see the topic, Callback API to Update
Oracle integration Recipe Instance in the Unifier Integration Interface Guide.
7) Add users or groups with appropriate permissions to access and use integrations from
Oracle Integration:
a. In the left Navigator, select User Administration, and then select Access Control.
b. In the right pane, expand Administration Mode Access, expand Integrations, and then
select Oracle Integration Cloud.
c. In the Module Permission Settings window, click Add.
1. In the Select Users/Groups pane, click Add Users/Groups to add users or groups,
and then click OK.
2. In the Permission Settings pane, assign any of the following permissions to users or
groups:
Configure: Select this option to allow users or groups to configure the Oracle
Integration connection.
View: Select this option to allow users or groups to only view the Oracle
Integration connection.
3. Click OK.
d. Click Apply, and then click OK.
Proceed with Setting Up Business Processes With Oracle Integration as outlined in the
Primavera Unifier Modules Setup Administration Guide.
390
Unifier and Other Oracle Applications
391
General Administration Guide
Note:
You can use a Gateway Integration or a Primavera Cloud Integration
with Unifier; you cannot use both. While one integration remains
active, the other is unavailable.
To avoid discrepancy of dates and time between applications, the
Oracle Primavera Cloud and Unifier servers are usually located in
the same timezone.
1) Go to the project/shell tab and switch to User mode.
2) In the left Navigator, select the project/shell name (Home icon).
3) In the upper-right corner, click My Dashboard and select Details to open the Details form.
4) Select the Primavera Cloud Integration tab.
5) Click Add, and select Primavera Cloud Cash Flow or Primavera Cloud Schedule.
6) In the empty row that is added, complete the following fields:
Project ID: Enter the Oracle Primavera Cloud project ID. The ID must be unique to this
shell and to Unifier. The ID cannot include the following characters: / \ : * ? " < > | ' =
Project Name: This field is optional.
Primavera Cloud Workspace ID: Enter the Oracle Primavera Cloud Workspace ID.
The Integration Type field is completed by the system, based on the option you selected
from the Add list.
7) When you are done, click Save.
392
Unifier and Other Oracle Applications
Prerequisite
A connection between Unifier and Oracle Integration is established. For more details, see Initial
Oracle Integration Setup (on page 387),
Procedure
To integrate a System Activity Sheet or Master Rate Sheet:
1) Go to the Company Workspace tab and switch to Admin mode.
2) In the left Navigator, select Integrations, and select Oracle Integration Cloud.
3) In the Integrations tab, copy the applicable information from the POST field of the
integration from Oracle Integration to the System Activity Sheet and Master Rate Sheet
fields.
4) When you are done, click Save.
To update the System Activity Sheet from within Unifier:
1) Go to the project/shell tab and switch to User mode.
2) In the left Navigator, select the project/shell name (Home icon).
3) In the upper-right corner, click My Dashboard and select Details to open the Details form.
4) Select the Primavera Cloud Integration tab.
393
General Administration Guide
394