Customization Guide
Customization Guide
SuccessFactors®
Customizing Guide
EESU240300-CGD-EN-01
OpenText™ Extended ECM for SAP® SuccessFactors®
Customizing Guide
EESU240300-CGD-EN-01
Rev.: 2024-June-03
This documentation has been created for OpenText™ Extended ECM for SAP® SuccessFactors® CE 24.3.
It is also valid for subsequent software releases unless OpenText has made newer documentation available with the product,
on an OpenText website, or by any other means.
Tel: +1-519-888-7111
Toll Free Canada/USA: 1-800-499-6544 International: +800-4996-5440
Fax: +1-519-888-0677
Support: https://support.opentext.com
For more information, visit https://www.opentext.com
Disclaimer
Every effort has been made to ensure the accuracy of the features and techniques presented in this publication. However,
Open Text Corporation and its affiliates accept no responsibility and offer no warranty whether expressed or implied, for the
accuracy of this publication.
Table of Contents
1 What is OpenText Extended ECM for SAP
SuccessFactors? ..................................................................... 11
1.1 What is new? .................................................................................. 12
1.2 Licensing Extended ECM for SAP SuccessFactors ........................... 12
1.3 Customizing tasks that require an SAP SuccessFactors certified
consultant ....................................................................................... 13
5.6.2.2 Switching to Primary Account Model from the older user model ........ 119
5.6.2.3 Using the older user model ............................................................ 119
5.6.2.4 Switching back to the older user model ........................................... 121
5.7 Global Template Configuration ....................................................... 121
5.8 Reports ........................................................................................ 124
5.8.1 Running the Employee Insight Report ............................................. 126
5.8.2 Running the Health Check report ................................................... 127
5.8.3 Running the Role Based Permission report ..................................... 132
5.8.4 Running WebReport to retrieve missing and outdated document
counts .......................................................................................... 134
5.8.5 Displaying the number of active and inactive employee workspaces
in the Content Server System Report ............................................. 137
5.8.6 Displaying SAP SuccessFactors employee and employments
information in the Content Server System Report ............................ 138
5.9 Configuring workspaces for multiple employments .......................... 138
5.9.1 Configuration steps for new installation ........................................... 139
5.9.2 Configuration steps for existing installation ...................................... 140
5.9.3 Importing Multiple Employment configuration data packages ............ 142
5.9.4 Global Template configuration ....................................................... 143
5.9.5 Adding Assignment Type attribute .................................................. 145
5.9.6 Sample document templates for Employment workspaces ............... 146
5.9.7 Configure Workspace Types .......................................................... 147
5.9.8 Running Migration utility ................................................................ 148
Employee To make full use of the Extended ECM Platform functionality, employee workspaces
workspaces are configured for Extended ECM. From SAP SuccessFactors, users can access
Content Server items in the employee workspace without leaving the SAP
SuccessFactors application. In the employee workspace, users can also view
employee records from the SAP SuccessFactors system.
Extended ECM for SAP SuccessFactors provides a central repository for all
documents associated with HR activities. Employee associated documents are
centrally organized for instant accessibility to respond to employee inquiries.
Searching employee data to address complex legal requirements is simplified and
risk exposure is minimized, as data retention and security are inherent in the
solution.
Refer to the Extended ECM Release Notes for more information about the available
X-Plan licenses.
Note: The Extended ECM X1 license plan does not allow access to employee
workspaces from SAP SuccessFactors and is not applicable to Extended ECM
for SAP SuccessFactors.
Extended ECM licenses are fully managed by OpenText Directory Services (OTDS),
where you enter the license key, allocate users and monitor usage counts. Using an
Extended ECM license prevents license overuse and gives you full control over your
current license allocation.
For more information about the Extended ECM licensing model, see section 6.10.1.1
“Extended ECM Licenses” in OpenText Extended ECM - Installation Guide (LLESCOR-
IGD).
For more information about managing licenses in OTDS, see chapter License Keys in
the OpenText Directory Services - Web Client Help (OTDS-H-AWC) online help.
• Configuring a new service provider to enable single sign-on (SSO) between SAP
SuccessFactors and OTDS. See “SSO Related Configuration with Provisional ID
in SAP SuccessFactors” on page 23.
• Migrating an existing SHA-1 authhandler from a previous version of Extended
ECM for SAP SuccessFactors to SHA-256. See “Upgrade information: migrating
existing authhandler to SHA-256” on page 27
• Configuring the Day One Conversion job in SAP Provisioning to convert a new
hire to an internal user on their start date. See “Prerequisites for creating Central
workspaces” on page 103 and SAP Help article Configuring the Day One
Conversion Job in Provisioning (https://help.sap.com/docs/
SAP_SUCCESSFACTORS_ONBOARDING/c94ed5fcb5fe4e0281f396556743812c/
b047d17f35a34ec9bd779bd803674de6.html?locale=en-US).
• Enabling and configuring Document Management CMIS interface support. See
“Enabling and configuring Document Management in SAP SuccessFactors”
on page 210.
• Integrating Extended ECM for SAP SuccessFactors as Custom External Module
in SAP SuccessFactors, to embed the functionality in the SAP SuccessFactors. See
“Integrating Extended ECM as Custom External Module in SAP SuccessFactors”
on page 252.
Using the default configuration, Microsoft IIS returns a generic error message when
interfaces that are based on the Content Server REST API, such as the Content Server
Smart View, encounter errors. Presenting a more informative error message to users
can aid in troubleshooting any difficulties that they encounter.
Example: With Detailed errors enabled, IIS returns a message similar to An item with the
name <filename.txt> already exists, but if Detailed errors is not enabled, IIS returns
only Error: Bad Request (400).
2. On the left, expand the Content Server website, and click the Content Server
Application.
5. On the right, under Actions, click Edit Feature Settings On the Edit Error
Pages Settings, enable Detailed errors in the Error Responses section, and then
click OK.
Extended ECM supports SAP SuccessFactors tenants which have IAS or IPS enabled.
Note the following restrictions:
• Single sign-on for Extended ECM for SAP SuccessFactors users is only supported
with SAP SuccessFactors as identity provider. For more information, see
“Configuring environment for SSO authentication if using SAP SuccessFactors as
identity provider (optional)” on page 19.
• The API user configured for the SAP SuccessFactors connection (as described in
“Customizing external system” on page 51) must be a SAP SuccessFactors user
with the appropriate access rights. A user which is only available in IAS is not
sufficient. For more information on the permissions required for the SAP
SuccessFactors connection user, see “Configuring required permissions in SAP
SuccessFactors” on page 217.
• When the Primary Account Model is used, it must be set to Use Login Account.
For more information, see “Configure Module Specific Settings” on page 109.
Requirements
• You must have provisioning login access to your SAP SuccessFactors system.
2. Edit the URL according to your SAP SuccessFactors details and paste it in your
browser. Save the file as samlmetdata_<sfinstance>.xml and copy it to the
OTDS server.
5. In the User Partition section, decide if you want to set the scope of the
Authentication Handler to Global or select a dedicated user partition.
• Idp Metadata file: browse to the metadata file that you saved in step 2.
• Use AssertionConsumerServiceURL: if you use OTDS, set this to true.
7. Go to the Configuration section. In the list, select and add oTExternalID1 and
oTUserID1. Select the Enable Authentication Handler check box and enter
Priority = 0. Click Save.
– Sign-out URL:
https://<Content Server URL>?func=otdsintegration.logout
– set Sign out Method to GET
10. Go to Trusted Sites and add your SAP SuccessFactors system URL to the list.
To customize SSO:
3. To save the changes enter the web administrator password and click Save.
For integration scenarios where an Extended ECM for SAP SuccessFactors widget is
embedded in an <iframe> in the SAP SuccessFactors UI, additional settings are
required in Content Server:
• SameSite Attribute
• Secure Cookies
In SAP SuccessFactors, a user can use the Proxy function to act on behalf of another
user. For example, user A can log in to the system, change his profile to user B and
perform actions on behalf of user B. If user A accesses Content Server in the name of
user B, he can also perform actions in Content Server using the credentials of user B.
• the task history and the task properties view in the Inbox widget
• the Tasks widget
• the Activity logs widget
• the Audit tab of the Content Server classic UI.
To update in OTDS:
2. Login to OTDS and click Auth Handlers. Search for SFSF Auth Handler and
click Actions > Properties > Parameters.
Edit the following settings:
3. Click Save.
2. Login to OTDS and click Auth Handlers. Search for SFSF Auth Handler and
click Actions > Properties > Parameters.
Provide the following settings:
2. Remove the existing service provider. Create a new Service Provider with the
following details and save the settings:
Some of the configuration is only necessary if you are not importing the default
configuration or if you want to define additional settings.
For information about importing the provided templates, see OpenText Extended
ECM for SAP SuccessFactors - Installation Guide (EESU-IGD).
1. Click Enterprise > Business Workspaces, and then click Workspace Types.
2. Click Add Item > Workspace Type in the right corner of the list.
Name
Provide a name for the workspace type. The name is only visible for
administrators. This field is mandatory.
Workspace Type Names
Add a workspace type name for each language available in Content Server. The
workspace type name can be displayed in the header tile of a business
workspace. Depending on the language users have chosen, they see the
localized workspace type name.
Tip: You can define a workspace type name in several languages. For more
information, see section 10.2 “Configuring multilingual metadata
languages” in OpenText Extended ECM - Enterprise Applications Integration
and Configuration Guide (EEP-CGI).
Business Workspace Names
You can create business workspace names in each languages that is installed and
activated on Content Server. Users then see the workspace name in their
preferred language. You can create patterns for the workspace names. For more
information, see “Using patterns for location path and workspace name”
on page 37.
Workspace Icon (for Classic View)
Specify an icon, which is displayed in business workspaces of this type. Click
Select Icon to browse the available icons. The icon is visible for users in the
Classic View in business workspaces and their root folder. For Smart View, you
use the Widget Icon.
Widget Icon (for Smart View)
For Smart View settings, see “Smart View: Defining workspace type names and
icons” on page 38.
Perspective Manager
Start the Perspective Manager from this link. It opens with a reduced set of
features, which are essential for business workspaces. You can edit an existing
perspective or create a new one. For more information, see section 3.12.4
“Creating a Perspective using the Perspective Manager tool” in OpenText
Extended ECM for SAP Solutions - Customizing Guide (ERLK-CGD).
Workspace Creation Settings
Define the location where business workspaces are stored and select the
classification that is used for this new business workspace.
• Location
Define where new business workspaces of this type are created. This is only
relevant for automatic creation.
Important
For business workspaces without business object, these settings do not
apply. Business workspaces are always created in the folder from
which you start creation, regardless of the settings you specify here.
– Select Content Server Folder if you want to select a static folder. Click
Select and browse to the respective Content Server folder. All business
workspaces are created in this folder or in subfolders.
– Select From Category Attribute if you want to use a category attribute to
determine the location of the business workspace.
Click Select and select a category. Then select an attribute. The attribute
must contain the Content Server node ID of the folder. The business
workspaces are then created in a folder that corresponds to the attribute.
The folder is created if it does not yet exist.
Important
The business workspace is not moved automatically when the
attribute that determines the location is changed.
– From Business Property
Select a business property from the business application to determine the
location of the business workspace. You must enter the name of the
business property manually.
The business workspaces are then created in a folder that corresponds to
the business property’s value. The folder is created if it does not yet exist.
Important
The business workspace is not moved automatically when the value
of the business property, which determines the location, is changed.
• Sub Location Path
You can create a subfolder structure. Select From Pattern to enter a pattern
for the subfolder creation. You can use normal text, categories and attributes,
and modifiers to create subfolders, for example [2032760:Id:(3)]/
[2032760:Id:+5].
Click Insert Attribute to select a category and an attribute. If a sublocation
folder does not exist when the business workspace is created, the folder is
created. You must ensure that the category attribute is never empty.
• Use also for manual creation
Select this option if you want to use the location settings also for manual
creation of business workspaces on Content Server. Business workspaces are
then only created in the specified location, regardless of the folder where the
user started the creation. After the business workspace has been created, the
user is directed to the newly created business workspace.
Note: If you use this option in combination with a sublocation path that
is based on an attribute, you must be aware of the following behavior:
When a user creates an early business workspace manually, it does not
automatically have the required attributes. As a consequence, the
attribute that determines the sublocation path can be empty and the
business workspace cannot be created. You can prevent this by adding
the attribute for the sublocation path to the document template so that
Important
The fast bulk workspace creation option supports only Collection,
Folder, Email Folder and Related Business Workspaces item types.
Before using this option, you must therefore delete not supported item
types from your document templates. If you keep these item types in
the template, you will receive an error message.
When the check box is cleared, the speed of creating workspaces by using a
scheduled bot will not be significantly improved. For more information, see
section 12.4.1 “General settings of a workspace type” in OpenText Extended
ECM - Enterprise Applications Integration and Configuration Guide (EEP-CGI).
Search Settings
Configure how the search behaves when a user searches from a business
workspace that has related workspace:
Indexing Settings
Select if the category attributes of the business workspace should become
supplementary indexed metadata for child objects and nested business
workspaces. With this option, users can use category attributes in the advanced
search to also find other items like documents, emails, folders, or task lists,
which are located in a business workspaces. You can select which Content
Server object types will be indexed. Changing this setting takes effect only for
documents that are added after this change. Already existing documents must
be re-indexed. For more information, see section 17.2 “Indexing documents with
business workspace attributes” in OpenText Extended ECM - Enterprise
Applications Integration and Configuration Guide (EEP-CGI).
Sidebar Widgets
Configure sidebar widgets that display metadata in the business workspace in
Classic View. For more information, see section 12.4.3 “Configuring sidebar
widgets for Classic View” in OpenText Extended ECM - Enterprise Applications
Integration and Configuration Guide (EEP-CGI).
Classification
Define the classification that is also added to the resulting business workspaces
when they are created.
For more information on business workspace names and locations, see OpenText
Extended ECM for SAP Solutions - Customizing Guide (ERLK-CGD).
1. For locations: From the Sub Location Path list, select From Pattern.
Important
• Do not use a : colon to separate attributes, because the colon is also used in
Content Server syntax.
• If one of the attributes in the name pattern for multilingual workspace
names and business object names does not provide a value, this attribute is
omitted without an error message. For sublocation paths, empty values can
cause an unwanted location and are therefore handled as an error. They
must be corrected.
Offset: +0
Cut off the specified number of characters and displays the rest. Separate the
modifier from the attribute by a colon. An out-of-bound offset causes an error.
Length: (0)
Display the specified number of characters. Separate the modifier from the
attribute by a colon. An out-of-bound length causes an error.
Notes
• For business workspaces without business object types, you can specify
any name. These workspace types always have the name that is entered
during creation, independently of the settings you specify here.
Tips
1. On the global menu, click Enterprise > Business Workspaces, and then click
Workspace Types.
2. To enable or disable a workspace type, from the function menu, select Disable
Creation. You see the current status of the workspace type in the Creation
Status column.
Enabled
This workspace type is available to create new business workspaces.
Disabled
This workspace type is not available to create new business workspaces;
however, this workspace type will be used to display business workspaces
that were already created from this type.
3. To edit an existing workspace type, click the name of the workspace type.
5. To check the indexing status of the items in a business workspace, see the
Indexing Status column:
Re-indexing required
This status always occurs when you change the indexing settings of the
workspace type.
You may see this status even if no workspaces or no sub-items within
workspaces exist yet. When performing the test run and no documents are
found for re-indexing, the status will change again to Indexing is up to
date.
Up to date
All items have been passed to the index engine. However, it may still take
some time until the items are fully processed and searchable.
For more information about indexing, see section 17.2 “Indexing documents
with business workspace attributes” in OpenText Extended ECM - Enterprise
Applications Integration and Configuration Guide (EEP-CGI).
1. On the global menu, click Enterprise > Extended ECM > Business Object
Types.
2. Click Add Item > Business Object Type in the right corner of the list.
3. To define the new business object type, you need at least the information
described in “Configuring business object types” on page 41. All other
configuration sections are optional at this point and can be completed later.
General section
Tip: The open transaction link in the workspace header uses the
definition name of the business object. Consider changing the name of
the business object definition to see more meaningful information in the
open transaction link.
Tip: You can also create the business object type without connection to
the external system. The Extended ECM configuration tries to link to
each time it is opened and to check the configuration.
• Business Object Type: Select an entry from the list of all business object
types that are available. If you are not connected to the external system, you
can enter the business object type manually.
Important
You must select a business object that is not already used in a business
object type configuration. Otherwise you cannot save this business
object type.
• Workspace Type: Select the workspace type that you created for this
business object type. You can also create a new workspace type at this point.
Click New Workspace Type and define the workspace type. For more
information, see “Viewing and changing Workspace types (optional)”
on page 31.
• Default Display for Workspace Type: If you have more than one business
object type associated with the same workspace type, enable this option to
make this business object type the default type to be displayed.
– No Web URL is displayed on the Properties > General tab of the business
workspace
Whenever you select the Default Display ... option for a business object type,
it will be removed from other business object types that are linked to the
same workspace type.
• Default Search for Workspace Type: Enable this option so that users use the
search of this business object type when they create a business workspace
manually in Content Server. Whenever you select this option for a business
object type, it will be removed from other business object types that are
linked to the same workspace type.
• Display URL:
Specify the URL that is used to display the business object. The URL syntax
depends on the respective type:
– For workspaces references, this URL is used for the Display button on the
General tab of the business workspace properties (function menu
Properties > General).
– For added business objects, this URL is used when the user clicks the
Display action of an added business object in the Business Objects tab.
– sfsf.user:
$BaseUrl$/sf/liveprofile?selected_user=$BorObjectId$
– sfsf.person:
$BaseUrl$/sf/liveprofile?selected_user=
$attribute:catname=<catid>,attrname=<attribute name>$
1. On the global menu, click Enterprise > Extended ECM > Business Object
Types.
3. In the Name field, enter the name you want to display as the document context.
6. In the Workspace Type list, select the workspace type to use for this business
object type.
7. Optional Under Widget Configuration for Smart View, enter the business object
type name in any other languages that are configured.
The name you set for the business object type now appears in the Document context
list for HR administrators with the permissions to create this type of document in
Extended ECM PowerDocs. For more information, see section 4.2 “Generate
documents with Extended ECM PowerDocs” in OpenText Extended ECM for SAP
SuccessFactors - User Guide (EESU-UGD).
1. On the global Content Server menu, click Enterprise > Extended ECM >
Business Object Type. Scroll to the Property Mapping section.
Important
• Business property names are case-sensitive and you must use the exact
name as returned in the JSON response.
The attributes username, userId, and country are mandatory and must
be included in the business properties. The country attribute is used by
Mass Workspace creation and username is used by Membership
replication.
Check status is also mandatory for the Health Check report.
• Ensure that the configured business properties are available in the
OData Business Object Definition (http://<YOUR_SF_HOSTURL>/odata/
v2/User/$metadata?$format=json) or else the process abruptly exits
and the workspace cannot be created as expected.
Do not map any properties for the business object type sfsf:person.
Business Properties
• Content Server Template: Select the document template that you created for
this business object type from Content Server.
1. To enable or disable a business object type, click the respective function menu
and select enable or disable.
2. To edit an existing business object type, click the name of the business object
type.
3. To delete a business object type, click Purge in the Actions column. You
can only purge business object types that are not referenced by a business
workspace or a business attachment.
• Map business properties from the business application to the category attributes
To create a category:
1. On the global menu, click Enterprise > Business Workspaces, and then click
Categories.
2. Click Add Item > Category. Define a new category folder according to your
requirements to include all SAP SuccessFactors categories and click Add.
3. In the category folder, click Add Item > Category. Define the new category
according to your requirements and click Add.
a. Click Add Attribute and select an attribute type, usually this is Text: Field
or Text: MultiLine.
b. Define the attribute. Use a name similar to the property name. You will
later map these attributes to the business properties.
5. Click Submit.
• Classification tree
Document template
• Classification
Important
You must remove the classification inheritance while adding the
classification to a document template. Otherwise, the HR document
functions will not work properly.
To create a classification for the folder where the business workspaces are
created:
2. Open an existing classification tree or create a new one. You can name the
classification tree, for example, Workspace Types.
3. Click Add Item > Classification and define the new classification according to
your requirements. Create a classification for each workspace type.
Note: The image shows the standard configuration that comes with the
Extended ECM for SAP SuccessFactors module. You can define the
classifications according to your requirements.
Important
You must assign unique names for the document types in the DocumentType
classification. If you use duplicate document type names, uploaded documents
can be stored in the wrong folder.
1. In Content Server, go to the location where you want to create the root folder
for your business workspaces.
2. Add new folders and configure them as required. Add a name, description, and
select an icon.
Important
This classification must be the same as the one for the document template
that you will configure in “Creating a document template” on page 56.
Note: When the folder is created you can select an icon other than the default
icon. Alternatively, once the folder has been created you can use the folder’s
function menu navigating to Properties > General to select a different icon.
You can also set the folder display to Featured to show it in the upper pane of
the folder browse page.
1. At the Enterprise level, the general folder for Extended ECM for SAP
SuccessFactors contains the folder Business Workspaces.
2. The Business Workspaces folder contains the folders in which the actual
workspaces are stored.
The customizing modules can be accessed in the Extended ECM volume. You
must at least be a member of the built-in Business Administrator group to
perform the configuration tasks.
• if there is a proxy server in place between the Content Server installation and the
Extended ECM for SAP SuccessFactors instances.
Note: If the proxy server uses the Windows auto configuration, contact your
network administrator to provide the proxy server host and port for the Java
server settings.
1. In the Content Server global menu, click Enterprise and open the Extended
ECM volume. Click Connections to Business Applications (External Systems).
3. Specify the parameters for your external system according to the list below.
4. Click Add.
Connection Type
Displays the connection type.
From the list, select SFWebService.
Enabled
Select this option to enable the configuration.
Tip: You can disable a configuration, for example, if you created it only for
testing and you do not want it to be used.
Comment
Enter a comment to provide further information.
Base URL
Common URL for accessing applications via a Web browser. You can use this
base URL when configuring business object types on Content Server. The base
URL is represented by the $BaseURL$ variable for new business object types.
Schema Version
Select the interface version.
Authentication Method
For the connection type SFWebService, you can select one of the following
options:
• Basic – this option is selected by default. The user must enter a username
and a password.
– OAuth Client ID – enter the API Key created in the OAuth configuration
in SAP SuccessFactors, see “Configuring OAuth client in SAP
SuccessFactors” on page 54, step e.
– OAuth Client Secret – enter the private key you have generated in the
OAuth configuration in SAP SuccessFactors, see “Configuring OAuth
client in SAP SuccessFactors” on page 54, step c.
In your local file system, find the X.509 certificate file. Open the certificate
file in an editor, for example, Notepad. Copy and paste the section
between - - BEGIN ENCRYPTED PRIVATE KEY - - and - - END ENCRYPTED
PRIVATE KEY - - as Client Secret value.
Important
If you use the OAuth option, the deprecated jobs *** Deprecated ***
SAP SuccessFactors Permission Synchronization and SAP
SuccessFactors Workspace Creation/Update no longer work.
User Name
Enter the user that is used to access business object type information from the
external system. Note that the user name cannot be longer than 32 characters.
Ensure that this user has the required permissions in SAP SuccessFactors, see
“Configuring required permissions in SAP SuccessFactors” on page 217.
Password
Specify the password of the defined user.
Test Connection
Click Test to perform a connection check to the specified external system. After
a successful check, the message Connection test to <Logical External System Name>
was successful is displayed next to the button. The system ID will also be
retrieved and displayed.
Note: You can only test the connection after you have configured the SPI
service in the external system accordingly.
Note: If the Test Connection test fails, check also if the User Name used in the
above setting has sufficient privileges. For more information, see OpenText
Extended ECM for SAP SuccessFactors - Installation Guide (EESU-IGD).
For details, see also SAP SuccessFactors HCM Suite OData API: Developer Guide
(https://help.sap.com/doc/a7c08a422cc14e1eaaffee83610a981d/latest/en-US/
SF_HCM_OData_API_DEV.pdf)
c. Click Download to store the X.509 certificate file in your local file system.
Open the certificate file in an editor, for example, Notepad, for using it in a
later step.
d. Click Register.
e. Copy and store the API Key value for using it in a later step.
For more information about Content Server Document Templates, see the section
Document Templates Volume Administration in the Content Server online help.
Important
You need access to the Content Server administration and system
administrator access rights to change these settings.
Note: If the Business Workspace option is not available, you can enable it.
Tip: You can add a business workspace, a case or a binder. Typically, you
create a template for each workspace type.
You can define several templates for the same workspace type but with
differences in their attributes. For example, you can have Customers with a
revenue larger than one million Eurosand Customers with a revenue of less than
one million Euros represented in business workspaces based on different
templates.
Alternatively, you can copy an existing template. Select the template and
click Copy. In the Copy To field, enter a location within the Document
Templates. Then configure the new template according to your
requirements.
Important
When you copy a folder that contains a workspace template, the
workspace template is not copied.
3. Enter the settings as required.
4. From the Classifications list, select the classification that you already selected
for business workspace location.
Important
The document template and the business workspace location must have
the same classification.
6. Click Add.
8. Open the workspace template and add all relevant subfolders and documents
using the Add Item button.
9. To test the configuration, open the folder configured for this template. The Add
dialog now contains an option with the template name.
Important
Changes to the document template are not applied to existing workspaces that
have already been created from the template. They apply only to business
workspaces that will be created after you made the changes.
Note: You can also change team roles and team participants for each business
workspace.
• Roles
You create template roles and assign permissions to them. These team roles
become the defaults for the business workspaces that are created from the
templates. When you add Content Server users or groups as team participants to
roles, they inherit the permissions of the team role.
Special roles
– Team Lead
You can assign one role to be the Team Lead role. The Team Lead role
appears with a red flag icon. Participants of the Team Lead role can edit
participants of other roles. By default, the first role that you add in addition to
the Template Administrator role, becomes the Team Lead role. You can set
any role as the Team Lead role using the Set as Team Lead button. You can
also delete the Team Lead role if it is the last role in the list.
• Team Participants
You can add team participants to team roles. Participants can be users and
groups. Users and groups can be assigned to one or more roles. A role can have
multiple participants.
1. From the function menu of the document template, select Team Roles and
Permissions.
2. Create a role:
a. On the left side of the page in the Role Access section, click Add Role .
b. On the right side of the page, in the Add new role section, enter a name in
the Role box.
c. Enter a description in the Role Description box.
d. Click Add.
2. On the left side, in the Participants section, click Find & Add.
3. On the right side of the page, find the user or group that you want to add.
4. In the Role menu beside the user or group, select the role that you want to
assign to this user or group.
5. Click Submit.
The merging also applies to the items in the template. The permissions are merged
with the permissions of the location where the business workspaces is created and
not where the item is created.
Example: User MMEIER creates a new workspace for a customer using the Customer
template. For the Customer template, user MMEIER only has See access. For the folder
Customer, where the new customer workspace is created, user MMEIER also has Modify
access.
If the Merge with creation location option is selected, user MMEIER will have both See and
Modify access. If the Merge with creation location option is not selected, user MMEIER will
only have See access.
All points are applicable to entire workspaces, which includes the hierarchy of the
folders and their access permissions.
The group replacement always applies when one of the attributes that is used to
define the group is changed: when the business workspace is created, when the
attribute of a business workspace is changed later, and when an attribute is filled
manually.
You can also use this mechanism to remove groups. If you define that a group
should be removed, this group has access only to the template and not to the
business workspace based on the template.
• To remove the group, select the group name and leave the Target Group
field empty. When a business workspace is created from this template, the
group is removed and will not be granted access to the created workspace.
• To generate a group that replaces the template group, select the group name.
In the Target Group field, add the name of the group to be generated. You
can use the following replacement tags:
– Category:
<Category CategoryID AttributeID />
The Rule expression is evaluated at the time of the document upload. The validity of
a document is based on the mandatory Date of Origin attribute and the
classification assigned during upload. The document is saved to the specified
workspace folder. You can view the existing rules in your templates by selecting the
Function menu of a template and clicking Properties > Smart Document Types.
2. Edit an existing rule or create a new one. To edit an existing rule, click the
corresponding Smart Document Type name. To create a new rule:
• Click Add .
• Enter a smart document type Name and click the Browse Classification icon
to browse to and select a document type classification.
4. Click Location, and then click the Browse icon . Select the workspace folder
in which the document will be available.
5. To create conditions, click Add condition. As well as creating multiple
conditions for each smart document type, you can have multiple sections each
containing one or more conditions.
d. Click Add.
6. To configure further settings for the smart document type, select bots from the
Add bot list .
• Check completeness
To configure a completeness check, edit the following settings:
– Document Validity – turn on the switch, and enter the validity period in
the Year(s) and/or Month(s) boxes to determine how long the document
will be valid. In the Based on attribute list, select the start date for the
validity check, for example, Date of Origin. After the expiration date, a
notification about the outdated document type is displayed in the header
widget of the employee workspace.
from the suggestions. Click the Add new field icon to add more
members. Click Add to save changes.
• Review Option
Turn on the Review required switch if you want document actions to be
reviewed by the HR Administrator.
In the Members field, enter the name of the group or role and select from
the suggestions. Click the Add new field icon to add more members.
Click Add to save changes.
Note: The uploading documents action only applies when the Upload
with approval bot is not added. If this bot is added, then the bot takes
priority over the Review option. The deleting documents action is
unaffected by the bot.
• Generate a Document
Turn on the Create documentswitch to enable document generation for the
smart document type, and then click Add.
• Reminder
To set up reminders, turn on the Set reminder switch and click Add.
• Delete Control
To enable the delete workflow for selected roles, in the Members field, enter
the name of the group or role and select from the suggestions. Click the Add
new field icon to add more members. Click Add to save changes.
• Upload with approval
Turn on the Enable approval workflow for uploads switch to enable review
of uploaded documents by the members of the selected workflow role.
In the Workflow map field, click the Browse icon to select a workflow
configured in Extended ECM. Then choose a Workflow role from the list
and in the Members field, enter the name of the group or user and select
from the suggestions to make them an approver for this smart document
type. Click the Add new field icon to add more workflow roles. Click
Add to save changes.
When this bot is enabled, the upload process creates a workflow in the
MyToDo widget for the selected user role or roles, and that role user must
process the task before the document is assigned to the employee
workspace.
A document type is displayed in the Employee Self Service or Header widget under
the following conditions:
1. The logged in user must be approved to a role in the list of Team Participants of
the employee workspace.
2. All document types and classifications that are configured for a role in a smart
document type will be displayed in the Employee Self Service widget for this
role. This also applies to in process, outdated and missing documents.
Note: In the current version of Extended ECM for SAP SuccessFactors, the
Employee Self Service widget provides the following options:
When the user uploads and replaces an expired document, a new Reminder is
created for the newly added document and the old Reminder status is set as
complete.
1. Customize the default Reminder settings. For details, see “Customizing default
Reminder type” on page 115.
2. In the Viewer Server URL box, enter the server name on which Brava server is
running and click Save Changes.
You must import and configure the workflow map in Content Server.
To be able to initiate delete workflows, the user must also have global permission to
the Content Server Shortcut group.
1. On the Content Server Administration page, search and click Object Privileges.
2.
Search for the Shortcut Object Type and click Restrict to add or Edit
Restrictions to edit an existing restriction.
1. In the Workflow folder, click Add Item > Workflow Map. Enter a name and
edit the other settings.
2. In the Functions menu of the new workflow map, click Import. Click Browse...
to find and select the Map file. In Performer Options, select Maintain
Performers.
• Completion Action
• Packages
The following settings should be selected:
– Attachments
– Attributes
– Comments
6. Click Back to return to the map editor. In the map editor, double-click the
Initiate [1] step. To enable the Smart UI for the deletion workflow, select
Options > Initiate in Smart View. Click Add to Workflow Definition.
7. Click Back to return to the map editor. In the map editor, double-click the
Delete Request_<InitiatedDate/>_<initiator/>[2] step. In the Display
options, select SmartView.
8. Click Back to return to the map editor. In the Header, click Map > Attributes.
Ensure that the Attribute Items are set as shown in the screenshot below.
9. Click the name links of the Attribute items and verify the settings:
1. Select Receiver
Click OK.
2. Document(s) to be Deleted
Click OK.
3. Document Names
Click OK.
Click Add to Workflow Definition. In the Header menu, click Map > Save.
a. In the Event Scripts tab in Step Becomes Ready, select Delete Workflow
Document.
b. In the General tab, configure the SMTP settings, if Email notification has
already been configured in the Content Server administration.
11. In the Header menu, click Map > Save to save your changes.
13. In My Account > My Profile, provide Name and Email address to populate
<Initiator/> and <InitiatorMail/> for sending the notification Email.
1. In the Workflow folder, go to your deletion workflow map and in the Functions
menu, click Edit.
2. In the Header menu, click Map > Attributes. Ensure that the Select Receiver
and Document(s) to be Deleted attributes are set as shown in “Customizing
and adjusting delete workflow for document deletion (optional)” on page 69 in
step 9.
3. Click Back to return to the map editor. In the map editor, double-click the
Initiate step. In the Options section, select Initiate in Smart View.
Click Add to Workflow Definition. In the Header menu, click Map > Save.
4. Click Back to return to the map editor. In the map editor, double-click the
Delete Request_<InitiatedDate/>_<initiator/>[2] step.
a. In the Generals tab, go to the Instructions section and remove the HTML
tags from the text in the box.
b. In the Display section, select the Smart View option.
c. Click Add to Workflow Definition. In the Header menu, click Map > Save.
3. Select each attribute and click Remove. Remove all attributes from the map.
After you have removed all attributes, click Add to Workflow Definition.
4. Click Map > Attachments and then in the Attachments Function menu, click
Permissions.
5. Click Public Access and select the See > See Contents permissions. For Apply
To, select This Item & Sub-Items.
Click Update.
8. In the Workflow step configuration, edit the following settings in the General
tab:
9. Click the Assignees tab and select the User or Group option.
Click Add to Workflow Definition.
10. Click the Event Scripts tab and for the Assign Step Performer setting, select HR
Delete Workflow Performer.
12. Go back to the workflow map edit page and double-click the Delete document
and send confirmation email step.
13. In the Workflow step configuration, edit the following settings in the General
tab:
15. Go back to the workflow map edit page and double-click the Delete_Workflow:
Email : Delete request rejected email step.
16. In the Workflow step configuration, edit the following settings in the General
tab:
In Content Server global menu, click Enterprise and open the Extended ECM
volume. You can find the following configuration modules:
Note: To perform the configuration tasks, you must at least be a member of the
built-in Business Administrator group.
• In Content Server global menu, click Enterprise and open the Extended ECM
volume. Click Extended ECM for SAP SuccessFactors.
Important
The Migration Utility is not available in the Content Server administration or
in the Extended ECM volume. To access the Migration Utility, use the
following URL:
http://<CS host>/OTCS/cs.exe?func=othcm.MigrationInitiator
2. Select your External System. Provide at least one Email Address to define the
recipients of the migration report. Click Add to add another email address.
Important
To enable the migration process completion mail report, you must have
configured the notification settings in the Content Server administration.
On the Content Server administration page, click eLink Administration >
Configure eLink. Configure your email settings.
When the process has finished, the migration report will be sent to the provided
email addresses.
Upgrade information
• If you have upgraded from a previous version, first adjust the business
object configurations to enable using the central workspace concept.
• When you run the Central Workspace Creation/Update bot, existing
employee workspaces will be updated to central workspaces. For existing
candidate workspaces, documents will be automatically moved to the
central workspace of the corresponding employee when Remove Existing
Candidate Workspace has been enabled in the advanced parameters of the
bot. Note that the setting is enabled by default for newly created bots.
Afterwards the empty candidate workspace will be deleted.
• Once the configuration in Extended ECM for creating central workspaces
has been done, ensure that existing SAP SuccessFactors Workspace
Creation/Update jobs have been stopped and deleted.
• A new transport package is available for configuring central workspaces,
see “Structure of pre-defined data packages” on page 339.
These two automatic workspace creation scenarios are often used in conjunction
with each other.
A special use case is during initial Extended ECM configuration, where you may
have a large number of existing business objects that require corresponding business
workspaces. The solution for this is to create a large amount of workspaces in bulk,
ideally in a short period of time. This is known as the Initial Load Phase, and this
section contains best practices for planning that phase.
OpenText recommends the following best practices for configuring Extended ECM
for SAP SuccessFactors to reduce the creation time.
Database tuning
Ensure that your database is tuned based on the following recommendations:
Note: When this option is selected, ensure your Central Workspace Creation/
Update bot has a Block Size greater than 10. You can increase the block size
gradually (to a maximum of 50) to ensure stable system performance. Leaving
the block size as the default of 1 will not effectively make use of the bulk
method.
Selecting the Sub Location Path option may lead to multiple Distributed Agent
worker threads creating the same sub folder, and if there are multiple failures the
database table might be blocked.
Consider changing the configuration of the Distributed Agent worker threads for
the initial load task. Ideally you would have at least two worker threads
exclusively reserved for Extended ECM. The number of worker threads can be
increased on demand based on the system performance and the actual creation
speed of workspaces. A configuration of a Distributed Agent worker exclusively
running scheduled bots is illustrated here.
• User Synchronization
• Group Synchronization
• Central Workspace Creation/Update
• Permission Synchronization
database load). You can gradually increase the Block Size value, ideally to no
higher than 50.
Note: Ensure you resolve any errors in a scheduled bot’s initial run before
setting this scenario type.
An active employee can have different profiles within SAP SuccessFactors, for
example, a candidate profile, a new hire profile, and an employee profile. In each of
these different profiles, personal documents can be uploaded. These documents are
then stored and accessible separately in the respective profiles.
documents which have been uploaded in the external candidate profiles are not
available in the new internal candidate profile.
The major processes provided by Onboarding 2.0 are shown in the figure below.
Most documents are uploaded in the steps Personal Paperwork, Additional
Onboarding Paperwork, and Generate Document & Signature. Onboarding 2.0 stores
these documents in most cases with the userId.
In the Additional Onboarding Paperwork step, documents are stored by default with
the Extended ECM document type Custom New Hire. To define the correct custom
Once the Conversion to Employee step is complete, the user record becomes active,
and Extended ECM can link a central workspace created for the external candidate
to this active user record.
All new hire documents associated with this user record are then moved from the
CMIS repository to the central workspace automatically during central workspace
update.
When a workspace does not exist for this employee, documents are temporarily
stored in the CMIS repository and can only be accessed by the Extended ECM
system administrator. All employee documents associated with this user record are
only moved from the CMIS repository to the central workspace automatically
during central workspace creation.
• To convert a new hire to an internal user on their start date, configure the Day
One conversion job in Provisioning. For more information, see Onboarding
implementation guide (https://help.sap.com/viewer/
c94ed5fcb5fe4e0281f396556743812c/latest/en-US/
8a7ec004cea545749bcde20efe01c3a0.html).
Proceed as follows:
1. All documents for candidates uploaded previously to the hiring, for example, an
Offer letter, are stored either
Important
Prior to creating central workspaces using Event Action Center, you must
run the conversion job in SAP SuccessFactors Provisioning to convert hired
external candidate profiles to internal candidate profiles.
The job for creating central workspaces uses sfsf:user, the employee
profile, as reference and gets the associated candidate profile that is linked
to the sfsf:user entity. If the conversion job is not run, the central
workspace might not be set up properly. The central workspace action is
designed to work only for the sfsf:user and sfsf:candidate entities.
For details, see “Creating bots in the Event Bots configuration” on page 300 and
section 4.2 “Generate documents with Extended ECM PowerDocs” in OpenText
Extended ECM for SAP SuccessFactors - User Guide (EESU-UGD).
Extended ECM for SAP SuccessFactors provides different workspace templates for
different regions. The SAP SuccessFactors system Administrator/Consultant must
identify the correct SuccessFactors roles based on the Regions and approve all roles
applicable to the respective functional rights to each workspace template.
Example: In the SAP SuccessFactors Admin Center, we have three Roles Z1_MGR_EUR, Z1_
HR_EUR and Z1_EMP_EUR to be approved to the respective functional rights as displayed in
the below screen-shot.
2. In the functions menu of the Employee Workspace template, select Team Roles
& Permissions.
5. Click the newly created role. Set Access to See & See Contents.
6. In the Apply To list, select This Item and Sub-Items and click Update.
• HR Administrator
The HR Administrator function has access to all features provided by Extended
ECM for SAP SuccessFactors:
In SAP SuccessFactors many roles are available for each of the Functional Rights
specified above. You can identify the roles based on these Functional Rights and
map them accordingly. Use these mappings to control various permissions and
feature access.
1. Click Enterprise and open the Extended ECM volume. Click Extended ECM for
SAP SuccessFactors. Click Configure HR Functional Rights.
4. In the Enter Role Names box, start typing to open the list of available SAP
SuccessFactors roles. Select the SAP SuccessFactors role to map to this
Functional Right. Click Add.
Once you’ve edited any of the settings described below, click Submit to save your
changes.
Note: The MIME types you select apply in the Document Self Service widget
only. They do not affect uploads in the File Upload widget.
Inbox Settings
• Configure Inbox Settings – Enter the Inbox folder name maintained in the
workspace template. An uploaded document is moved temporarily to the Inbox
folder before being processed to the correct folder.
Important
When an Employee or Manager uploads the document, it is initially placed
in a staging folder within the workspace. In the Employee Workspace
templates, the 999 Inbox folder has been provided for this purpose with the
product. If you change the folder names in the workspace templates, you
must replace this name with the correct name. After task approval, the file
is finally uploaded to the correct folder.
• Purge Denied Documents – Select the number of days after which a document
uploaded as a task and denied by the HR Administrator should be deleted.
• Display Processed Documents – Select the number of days that Approved or
Denied documents should remain visible in the inbox. By default these tasks are
displayed for 30 days after being processed.
• Activation – Select a date for triggering the reminder prior to the due date.
• Escalation – From the Assignee list, select an assignee for the first notification.
From the Escalation list, select a recipient for the second notification, for
example, Manager or HR administrator. A second date selection dialog is
displayed. Select the date for the second notification. You can set the date before
or after the due date.
• Primary Account Model – Select one of the following to switch to the primary
account model.
For more information, see “Understanding and using the Primary Account user
model” on page 116.
Note: In new installations from software version 23.2, the Use Login
Account primary account model is the default user model. For upgrade
installations you must choose your user model.
Caution
Switching the user account model has consequences for user
synchronization and authentication and must therefore be carefully
planned. For more information, see “Understanding and using the
Primary Account user model” on page 116.
• OTDS partition – Enter the name of the partition that you want to use for the
SAP SuccessFactors User Synchronization bot. For more information, see “User
Synchronization bot” on page 183. Any user created or modified by the User
Synchronization bot will be saved to this partition. Users in other partitions will
be ignored by the bot. For a new installation, the OTDS partition box is initially
empty.
You can leave the OTDS partition box empty if you do not use the User
Synchronization bot to create users in OTDS. If you have previously used a
different tool for synchronizing users to a dedicated partition, you must
configure that user partition here.
Important
You must configure the OTDS partition first before running the User
Synchronization bot. If not configured, the User Synchronization bot will
report a failure and provide a link to the configuration page.
Note: The value of this parameter defines the maximum allowed OData
attribute length and will be used to override not only the username
attribute but all OData attributes to avoid failures due to mismatch in
attribute definition and OData response during bulk workspace job
creation. As administrator, you can view the errors related to workspace
creation in the Scheduled Process dashboard and choose to modify the
OData Attribute Length to a higher value in the subsequent runs if
needed.
– REST Client Timeout – enter timeout in seconds for the REST client used to
communicate with SAP SuccessFactors.
– OData $filter Query Length – specify the maximum length of the OData
$filter query option.
– OData $filter Query Values – specify the maximum number of values of the
OData IN clause of the $filter query option.
– OData Snapshot Pagination – select to activate snapshot-based pagination in
OData queries. This can improve the performance of OData queries with
large amounts of data. Clear this option if OData queries for large data sets
report timeout errors. This option is selected by default.
• Global Template Configuration for Central Workspace – Select Support
sfsf:candidate to enable extended rule evaluation for the central workspace bot
in order to use template rules for sfsf:candidate in central workspaces. For a
new installation, the setting Support sfsf:candidate is enabled. For an upgraded
system, the setting is disabled by default.
For more information, see “Global Template Configuration” on page 121.
Note: The current algorithm to determine a user functional right scans all
existing workspaces in the system and can therefore cause performance issues.
The alternative approach simulates the evaluation of the RBP rules using the
logic of the Permission Synchronization bot. The user is assumed to have a
functional right if the evaluation of any rule could add the user to a team role
used in the functional right.
All Content Server groups and SAP SuccessFactors permission roles that are
configured for the specified functional right are used to determine the correct
functional right.
The user has the correct functional right in the following cases:
• if the Content Server user is a direct member of any Content Server group
configured for the functional right.
• for non-manager rules, if the SAP SuccessFactors user is a member of any
access group used by these rules.
• additionally for rules with MY_FILTER set to SELF, if no access groups are
used in the rule and excludeSelf is FALSE.
• for manager rules, the OTHCM_USER_MANAGER/OTHCM_JOB_RELATIONSHIP
database table is used to check whether the user is a manager. If access
groups are used for manager rules, the manager has to be a member of any
of these groups.
Important
You must run the Permission synchronization and Group synchronization
scheduled bots before you use the landing page perspective.
1. Activation – Select a date for triggering the Reminder prior to the due date.
2. Escalation – From the Assignee list, select an assignee for the first notification.
From the Escalation list, select a recipient for the second notification, for
example, Manager or HR administrator. A second date selection dialog is
displayed. Select the date for the second notification. You can set the date before
or after the due date.
You can also switch from the Primary Account user model back to the older user
model.
Understanding terms
SF Person ID – is a unique ID assigned to each person in the SAP SuccessFactors
system. An employee has only one SF Person ID during their time in the company.
Login account – is the SAP SuccessFactors login account. Manage the SF username of
the login account in SAP SuccessFactors under Manage Login Accounts.
Primary username – is the SF username that has been assigned to the employee on
the initial hire.
Example: edorn-1 is the SF username for a first new employment of the employee Emma
Dorn with the Primary username edorn.
• Each employee has one single Content Server account even if the employee has
multiple employments. The CS username is identical to the Primary username or
the SuccessFactors Login account.
• For each employment, a separate Employee workspace is created in Content
Server. All workspaces belonging to one employee can be accessed with the
employee’s Content Server account signing in with the same CS username.
• The SF username in a granted group of a permission role in SAP SuccessFactors is
replaced by its CS username in the corresponding team role group of an employee
workspace in Content Server.
When the Primary Account Model is enabled, a user license is applied only for the
primary employment and its associated workspace. The license counter is not
increased if there are multiple or secondary workspaces for that user.
Example 5-1:
The employee Emma Dorn with the Primary username or Login account edorn
has 3 employments in SAP SuccessFactors and 3 corresponding Employee
workspaces in Content Server. As Content Server user edorn, Emma Dorn can
access all of her Employee workspaces in Content Server.
Example 5-2:
Emma Dorn has signed in to SAP SuccessFactors and has selected her second
employment. Her SF username is edorn-1. For accessing the corresponding
Employee workspace in Content Server, she has created a tile with a link to this
workspace. After clicking the tile, she is automatically logged in to Content
Server as user edorn via SSO.
SSO configuration:
• Emma Dorn’s Content Server user exists and her SAML claim has been set
in OTDS in the user attribute oTUserID1. The user attribute contains all her
SF usernames, for example, edorn, edorn-1, and edorn-2.
5.6.2.2 Switching to Primary Account Model from the older user model
To switch to the Primary Account Model from the older user model, you must
perform the following steps:
1. In Content Server global menu, click Enterprise and open the Extended ECM
volume. Click Extended ECM for SAP SuccessFactors > Configure Module
Specific Settings.
In theSuccessFactors Data Replication Job Settings section, select either the Use
External Person ID or the Use Login Account Primary Account Model option.
Click Submit to save the setting.
2. Click Enterprise > Extended ECM > Scheduled Bots. Run the following bots:
• Each employee has separate Content Server accounts for each of his
employments. The CS username of an account is identical to the SF username
associated to the employment in SAP SuccessFactors.
• After an upgrade installation, this user model is the default user model in
Content Server.
Important
The Content Server user which can access an employee workspace cannot
access the workspaces which belong to the other employments of the same
employee.
Example 5-3:
Content Server user edorn-1 cannot access the Employee workspace of her third
employment. Only Content Server user edorn-2 can access this workspace.
SSO configuration:
1. In Content Server global menu, click Enterprise and open the Extended ECM
volume. Click Extended ECM for SAP SuccessFactors > Configure Module
Specific Settings.
In the SuccessFactors Data Replication Job Settings section, disable Primary
Account Model.
Click Submit to save the setting.
2. Click Enterprise > Extended ECM > Scheduled Bots. Run the following bots:
a. SAP SuccessFactors User Synchronization – run the bot with
Synchronization Scenario Type = Full Synchronization .
b. SAP SuccessFactors Group Synchronization – run the bot with
Synchronization Scenario Type = Full Synchronization.
c. SAP SuccessFactors Permission Synchronization – run the bot with
Synchronization Scenario Type = Full Synchronization.
Important
• You can access the Global Template Configuration only if you have the
necessary permissions for accessing and editing the Document Templates.
• If you want to assign Employment workspace templates for Multiple
Employments using the assignmentType property in the Rule expression,
you must have implemented the Multi Assignment option first. For more
information, see “Configuring workspaces for multiple employments”
on page 138.
1. Click Enterprise >Extended ECM > Extended ECM for SAP SuccessFactors.
Click Global Template Configuration.
Note: The Rules are evaluated and executed top down. The first rule
that matches will be applied for the template pick up. In the Rule
expression, place more specific rules at the top and generic rules at the
bottom. You can reorder the rules using drag & drop.
a. From the Add New Row list, you can select the following options to
build your rule for assigning a workspace template.
Select
– Business Property
Example 5-4:
If you want to configure exclusive rules for candidates and employees, you
must add additional expressions to the rule.
External candidates for which no user has been created in SuccessFactors
yet, have the user status ext-c. To prevent a rule for sfsf:user being
applied to these candidates, you can use the additional expression status <>
ext-c. Such a rule will only apply to onboarding users, employees and
internal candidates.
If you use central workspaces and want to use template rules for
sfsf:candidate, you must have selected the Support sfsf:candidate option
in the Module Specific settings, see “Configure Module Specific Settings”
on page 109.
Important
If rules for both sfsf:candidate and sfsf:user business object types
are used in the Global Template Configuration, you must
– add an expression for the status to each rule. For rules only
applicable to onboardees and employees, you can add
status <> ext-c AND <expression> to the rule.
5.8 Reports
Content Server System Report – As Content Server administrator, you can run a
System Report in the Content Server Administration. In this report, you can display
the number of active and inactive employee workspaces. See “Displaying the
number of active and inactive employee workspaces in the Content Server System
Report” on page 137.
You can also display SAP SuccessFactors employee information, including active
employees, number of employments, and number of multiple employments. See
“Displaying SAP SuccessFactors employee and employments information in the
Content Server System Report” on page 138.
• Employee Insight Report – the report provides information about the selected
employee, for example, group memberships and roles, functional rights, and self-
service rules.
• Health Check Report – The report provides a sanity check on the existing system
level configuration for the Business Administrator user. In the current version,
the SAP SuccessFactors OData entities are checked to ensure the correct creation
of employee and candidate workspaces.
• Role Based Permission Report – the report displays the Role Based Permission
rules that two employees share. It outlines the relationship between the two
employees, for example, why one employee has certain permissions for the
other’s workspace.
4. Click Run to start the report. To remove the selected user, click Clear.
Any sanity check for a configuration section can return the status OK, Error, or
Warning.
Error – the status for a configuration section is Error if at least one test returns
an error.
Warning – the status is Warning if no errors occurred but at least one warning.
Otherwise, the status is OK.
Technical Configuration
Connections to Business Applications
– The task 'Extended ECM Scheduled Processing Job' must run at least in one
worker.
– The task 'Extended ECM Scheduled Processing Job' must run in one
dedicated Content Server instance.
– It is recommended that the task 'Extended ECM Scheduled Processing Job'
runs in dedicated workers that do not execute other tasks.
Note: You can change the Distributed Agent Workers configuration only as
system administrator user.
– The business object type sfsf:user has to map the properties userId, status and
username.
– The business object type sfsf:user has to use a workspace template, 'None' is
not allowed.
– The workspace template of the business object type sfsf:user should be set to
'From Business Property'.
– It is recommended that the workspace template property value starts with
'SuccessFactors'.
– Module Extended ECM for SAP Solutions has to be installed.
– It is recommend to create business object type sfsf:onboardee to transfer
related documents into central workspaces.
– If the business object type sfsf:onboardee exists it has to have to same
workspace type as sfsf:user.
– The name pattern should contain either the SAP SuccessFactors userId or
username in the workspace type definition of the business object type
sfsf:user.
Content Server groups that have been added to HR Functional Rights are
excluded from these tests.
– At least one template rule should be configured for the business object type
sfsf:user.
– The template IDs used by the template rules for sfsf:user are accessible.
– The templates for sfsf:user should use the same role names as configured in
HR Functional Rights.
– The templates must use the same workspace type as the business object type
sfsf:user.
– Categories assigned to a document template should enable the setting
'Disable Inheritance'.
Content Server groups that have been added to HR Functional Rights are
excluded from these tests.
Scheduled Bots
Document Generation
The following tests are performed:
• Checks for all mandatory parameters in the Create Bulk Documents bot. If any
mandatory parameter has not been configured in the bot, an error message is
shown.
• Checks for Run As user configuration in the bot. If the user has not been
provided, a recommendation to configure it is shown.
• If Run As user has been configured, it is checked if the selected document type
has smart document type rules in any of the templates related to the workspace
type mapped to sfsf:user. If no smart document type rule is available, an error
message is shown.
Completeness check
The following tests are performed:
• If the File Completeness Data Synchronization bot has not been configured, the
result will show an Error.
• If the File Completeness Data Synchronization bot has been configured, the result
will show an OK.
2. To select the users you want to run the report for, click the Select User icons
to open the Select User dialog for From User and To User, respectively.
3. In the Select User dialog, search your user. Click Select to select the user.
4. Click Run to start the report. To remove the selected user, click Clear.
You can view the workspaces available for the target user berta.
For the Manager relation chain result, a prefix denotes the following
manager types:
• EM = employee's manager
• EX = employee's matrix manager
• EH = employee's HR representative
• EC = employee's custom manager
• the WebReport checks access permissions for the configured workspaces and
smart document types.
• we recommend running the WebReport during non-working hours.
Example: Generating a report for 5000 workspaces with 8 smart document types
configured takes approximately 2 hours and 15 minutes.
You can use this example as reference to provide the input for the WebReport.
2. Click Add.
1. Click Export .
2. As Output Destination, select one of the options that support the Run in
Background option, for example, Content Server, Email, or Server.
To enable the count of the active and inactive employee workspaces in the System
Report, you must ensure that the Business Property = status for the sfsf:user
business object is properly mapped to a category attribute. If no mapping is
maintained here, you will get an error message in the System Report:
Unable to calculate number of active employees. Please ensure mapping of status attribute is
maintained in the business object sfsf:user.
Note: An active employee count will be 1 even for multiple employments. For
example, a user has workspaces corresponding to concurrent employment or
global assignment.
An inactive employee count will be 1 if there is an inactive workspace for the
user with no active workspace across employments such as global assignment
or concurrent employment in Extended ECM.
Important
Employee Anson Gao works for his company in locations in Germany and the
US.
Prerequisites
• For the Multiple Employment option to work, the Employee Central module
must be enabled in SAP SuccessFactors.
• You must have upgraded your Extended ECM for SAP SuccessFactors
installation at least to version 16.2.4.
Tip: The open transaction link in the workspace header uses the definition
name of the business object. Consider changing the name of the business
object definition to see more meaningful information in the open
transaction link.
Tip: The open transaction link in the workspace header uses the definition
name of the business object. Consider changing the name of the business
object definition to see more meaningful information in the open
transaction link.
With the imported transport packages, new sample document templates for the
Employment workspace type are available, see “Sample document templates for
Employment workspaces” on page 146.
2. Define workspace templates for Employment workspaces in the Global
Template Configuration, see “Global Template configuration” on page 143.
3. (Optional) Add Related Workspace folder to Employee workspace template.
The SAPCMIS_Categories.zip file contains the categories that have been added
after the SAP SuccessFactors 19.2 release. You have to add these categories
only if they are not available in the Categories volume:
• Workspace types
<CS_Home>\module\othcm_16_2_0\templates\Central_Workspace_
Configuration\othcm_central_wstemplates.zip
Workspace types
<CS_Home>\module\othcm_16_2_0\templates\ 04_WorkspaceTypes\ OTHCM_
Workspace_Types.zip
Important
You can access the Global Template Configuration only if you have the
necessary permissions for accessing and editing the Document Templates.
1. Click Enterprise >Extended ECM > Extended ECM for SAP SuccessFactors.
Click Global Template Configuration.
Notes
– The rules are executed top down. The first rule that matches will be
applied for the template pick up. In the rule expression, place more
specific rules at the top and generic rules at the bottom, for example,
1. Global Assignment
2. Current Employment
3. Standard assignment.
– If no rule is configured for a business object, its corresponding
template becomes the default template.
a. From the Add New Row list, you can select the following options to
build your rule for assigning a workspace template.
Select
– Business Property
Example 5-9:
If you have already installed Extended ECM for SAP SuccessFactors, you must add
the attribute manually.
4. Click OK.
• OTHCM_Employment_WS_Template_NA
• OTHCM_Employment_WS_Template_Europe
• OTHCM_Employment_WS_Template_OTHERS
View the folder structure of the Employment document templates, see Figure 5-4.
The workspace folder contains a Related Workspaces link to the workspace of the
primary assignment.
3. In the Business Workspace Names section, click Insert Attribute. Select and
insert Personal Information: Assignment Type.
1. Click Enterprise > Extended ECM > Extended ECM for SAP SuccessFactors.
3. In the Workspace Migration to IBO section, click the Run Migration Utility
link to open the Migration utility.
In the header, the tool displays the number of workspaces found for migrating.
Click Start to start processing the workspaces.
Note: Document Self Service widget deprecated: The Document Self Service
widget has been superseded by the File Upload widget. Since it is not yet
discontinued, it is still available for use.
To enable document generation, you must install and configure Extended ECM
PowerDocs. See “Configuring OpenText Extended ECM PowerDocs“ on page 309.
You can use sample document generation templates to facilitate the configuration of
generating documents with Extended ECM PowerDocs. To use these sample
templates, you must create the required classifications manually.
• Employment Contract
• Employment Letter
• Offer Letter
3. Click Add Item > Classification. Enter a Name and click Add.
Create classifications for
• Employment Contract
• Employment Letter
• Offer Letter
1. Click Enterprise > Extended ECM > Extended ECM for SAP SuccessFactors.
Click Configure Document Generation Settings.
2. On the Configure Document Generation Settings page, click and access the
following configuration dialogs:
Document Select which roles can generate documents from the Node Browsing Table widget in
Generation the Documents tab. HR_Administrator is selected by default.
Rights
Note: To customize the settings for the SAP SuccessFactors workflow steps in
Extended ECM, you must at least be a member of the built-in Business
Administrator group.
To enable the document generation option for workflow processing, perform the
following steps:
1. In the Extended ECM volume, click Extended ECM for SAP SuccessFactors >
Configure Document Generation Settings.
Click Configure Create Documents for SAP SuccessFactors Workflow to
access the Configure Create Document widget page.
2. Provide the following settings:
Important
Extended ECM finds corresponding document templates in
Extended ECM PowerDocs by name matching. Therefore the
Extended ECM PowerDocs document template must have the same
name as the corresponding Content Server document type.
3. Click Save Changes. The document template for the workflow is listed
under Edit Document Template.
3. PowerDocs Web Mode – you can define how the document to be created is
opened. You can enter the following options:
You must edit the startup.xml file according to your requirements and used
workflow types. When you click the workflow step in the Create Documents widget,
the configured variables will be replaced with the real data in the startup.xml file
and the file is sent to Extended ECM PowerDocs.
You can configure entities and properties according to your business rules
configured in SAP SuccessFactors.
Important
• In this section you configure only document generation with the Create
Document widget where you can process SAP SuccessFactors workflow
steps for HR events. The startup.xml described here is only used for this
purpose. For other document generation options, see “Configuring
Document Generation Settings for Workspace” on page 151.
• You can configure only entities supported by the SAP SuccessFactors
Pending Data API. See also SAP SuccessFactors Employee Central OData
API: Reference Guide (https://help.sap.com/viewer/
b2b06831c2cb4d5facd1dfde49a7aab5/latest/en-US/
3ebadbe1b3254857b450170ab76f1f52.html).
• You can edit the Extended ECM PowerDocs Startup XML template provided in
the Configure Create Documents widget dialog, see “Configuring document
generation settings for Create Document widget in Extended ECM” on page 153.
• You can use a Debug mode page to test and further edit the file, see “Using the
Debug mode for testing” on page 159. From the debug file, you can display and
select the data for which you want to create corresponding business objects in
Extended ECM PowerDocs for your workflow. In a later step, you can use these
data in your Extended ECM PowerDocs document template.
• You must configure the SAP SuccessFactors workflow business object and its
properties in Extended ECM PowerDocs. In the startup.xml, you must then
replace the corresponding object and property IDs with the unique IDs from
your own Extended ECM PowerDocs Content Manager.
2. Login to Extended ECM PowerDocs Content Manager and in the context menu,
click Technical settings.
3. Click Add to open the Create Business object screen and create a new
business object for your SAP SuccessFactors workflow. We recommend to
choose a name that indicates that its data are retrieved from your SAP
SuccessFactors workflow, for example, (SuccessFactors) EC Workflow
EmpEmployment.
4. Edit your newly created business object. In the Attributes section, add all
attributes of object EmpEmployment that you want to use for creating document
templates, for example, benefitsenddate.new.
5. Create a new relationship. In the tool bar, click Relations and then click
8. Open your startup.xml in the editor, find the section of your object, for
example, Pending Employment Data (EmpEmployment) and paste the value from
the clipboard as value to the corresponding boid attribute. The required value
will be directly included.
Repeat step 7 also for all attributes of your business object. Paste the attribute
name from the clipboard to the corresponding propid attribute as value.
9. Repeat steps 7 and 8 to replace all boid and propid values with the unique IDs
from your own Extended ECM PowerDocs Content Manager.
10. When you have completed editing your startup.xml file, log in to your Content
Server and copy it back to Extended ECM for SAP SuccessFactors > Configure
Module Specific Settings > Configure Create Document for SAP
SuccessFactors Workflow > PowerDocs Startup XML.
Click Save Changes.
To access and configure the Debug mode, add the following request parameter to
the URL of the Configure Create Document widget page:
func=othcm.WfConfigureParameters&advanced=true
REST Client Timeout – set the time out in seconds for the REST client
communication with SAP SuccessFactors.
Debug Create Documents – select the check box to open a debugging page
containing the startup.xml file and the Extended ECM PowerDocs parameters filled
out with the transferred information during document generation.
1. Click a workflow in the Create Documents widget with the user specified for
the debugging.
2. The Debug Create Documents page opens. You have the following options:
• startup.xml –
You can analyze and edit the startup.xml file with the filled in information
for the specified user.
• PowerDocs Parameters –
You can view and analyze the filled in Extended ECM PowerDocs
parameters.
3. Make your changes and click Open PowerDocs to view the result for the
generated document in the Extended ECM PowerDocs editor.
The Scheduled Bots framework lets you process a large number of items
automatically:
• In Classic View, click Enterprise > Extended ECM > Scheduled Bots.
• In Smart View, you can configure a shortcut widget on your home page pointing
to the Scheduled Bots page.
For more information on the Scheduled Bots page, see section 18.1 “Using the
Scheduled Bots page” in OpenText Extended ECM - Enterprise Applications Integration
and Configuration Guide (EEP-CGI).
You configure scheduled bots in Smart View. Currently, you can also configure
your scheduled bots in Classic View. To access the Scheduled Bots
configuration in Classic View, go to the Scheduled Bots page in Smart View
and click your Profile Menu > Classic view.
For more information, see section 18.10 “Configuring Scheduled Bots in Classic
View (legacy)” in OpenText Extended ECM - Enterprise Applications Integration
and Configuration Guide (EEP-CGI).
1. On the Scheduled Bots page, click the Add scheduled bot icon.
2. In the Create scheduled bot side panel, enter the following settings:
Name
Enter a name for your scheduled bot.
Description (optional)
Enter a meaningful description.
Product component
From the list, select Extended ECM for SAP SuccessFactors.
For information about scheduled bots for other product components, see
OpenText Extended ECM - Enterprise Applications Integration and Configuration
Guide (EEP-CGI).
Scheduled Bot
Select your scheduled bot from the list:
3. Click Create.
To regularly synchronize the roles and its members, you must create and schedule
the following bots:
1. User Synchronization
2. Group Synchronization
3. Permission Synchronization
4. Candidate Permission Synchronization
Before configuring the synchronization bots, you must plan and perform the
following configuration steps:
1. Identify your SAP SuccessFactors roles for synchronizing. See “Setting up Role
Based Permission in SAP SuccessFactors” on page 222.
2. Configure workspace templates mapping SAP SuccessFactors roles. See
“Mapping workspace templates with SAP SuccessFactors roles” on page 106.
3. Configure HR functional rights with identified SAP SuccessFactors roles. See
“Configure HR Functional Rights” on page 107.
4. Customize synchronization bots for performing full synchronization using the
Full Synchronization option.
5. Run the Role Based Permission diagnostic report to verify the results of the
synchronization bot. See “Running the Role Based Permission report”
on page 132.
6. Customize a second synchronization bot for performing Delta synchronization
using the Sync from a last run option. This bot synchronizes the permissions
when changes for the role members occur. See “Running the Role Based
Permission report” on page 132.
Important
These names will cause the synchronization to fail and must not be
configured in SAP SuccessFactors.
• Users must be available in Content Server
Ensure that all users for which you want to schedule Permission
Synchronization are available in Content Server. Ensure also that the user’s
Content Server user name always has the same value as the SAP
SuccessFactors user name. Otherwise, the Permission Synchronization will
not be successful. For more information, see the SAP Knowledge Base
article 2495643 - SuccessFactors User IDs - Clarifying the Different IDs
(https://apps.support.sap.com/sap/support/knowledge/preview/en/
2495643).
• The bot processes and fills the SAP SuccessFactors Recruiter, Recruiter Team,
and Hiring Manager roles based on the job requisitions for which a candidate has
applied. These roles must be defined in the template used to create external
candidate workspaces.
• Each SAP SuccessFactors user, for example, in a group or as a manager, must
have been synchronized into Content Server.
1. To configure and schedule your bot, click the bot’s name link in the Scheduled
Bots list.
• Business Application – click Select value and select your external SAP
SuccessFactors system configured in Extended ECM.
• Simulation Mode – turn on the switch to simulate the bot execution in
Content Server. Nothing will be modified in Content Server.
• Synchronization Scenario Type – click to select a scenario type to define if
the synchronization should be run completely or from a set point in time:
Note: The settings are saved together with the scheduled bot times.
The next scheduled bot will then run from the stated time and date.
– Synchronization from the given date and time – you can define a time
and date from where the synchronization bot should be run.
In Synchronization From, select date, hour, minute, and AM/PM.
Note: If you set the synchronization to run either from the last run or
from a set date and time, it will not detect changes to role members in
job requisitions. This is because job requisition changes do not modify
the candidate workspace.
Advanced parameters
Start options
3. Click Update.
1. To configure and schedule your bot, click the bot’s name link in the Scheduled
Bots list.
2. On the bot's configuration page, edit the following settings:
• Business Application – click Select value and select your external SAP
SuccessFactors system configured in Extended ECM.
• Simulation Mode – turn on the switch to simulate the central workspace/
creation in Content Server.
• User Filter – you have the following options:
Inactive users – note that inactive users are by default excluded from the
filter result. To include inactive users, add status in 't','f' to the query.
Onboardee workspaces – to create workspaces for active or inactive
onboardees, add status in 'e','d' to the user filter.
Example: For creating a workspace for the username 'aklein' the filter can be
'username eq 'aklein' and status in 't','f'.
Click Test to test the result of the OData query. You will see the first 125
matches.
Note: You can run the test only if you have specified a value in the
filter box. If the filter box is empty, the Test button is disabled.
• Candidate Filter – You can filter for external and internal candidates. If
specified, workspaces for the candidates referenced by this filter will also be
created or updated.
Click Test to test the result of the OData query. You will see the first 125
matches.
Note: You can run the test only if you have specified a value in the
filter box. If the filter box is empty, the Test button is disabled.
• Document Template – click Select > Browse icon and select a workspace
template if you want to use a template other than configured in the Global
Template Configuration.
• Update Only – turn on the switch if you only want to update existing
workspaces without creating new ones.
• Synchronize Permissions – turn on the switch if you want to synchronize
team participants for newly created central workspaces. If the switch is
turned off, the SAP SuccessFactors Permission Synchronization bot will
update the team participants if run.
• Synchronization Scenario Type – click to select a scenario type to define if
the the central workspace creation/update bot should be run completely or
from a set point in time:
Note: The settings are saved together with the scheduled bot times.
The next scheduled bot will then run from the stated time and date.
– Synchronization from the given date and time – you can define a time
and date from where the workspace creation/update bot should be run.
In Synchronization From, select date, hour, minute, and AM/PM.
Advanced parameters
• Synchronize Candidates
Keep the switch turned on if you want to synchronize candidate information
for the workspace and also if you want to use the Candidate filter.
• Full Property Synchronization
Turn on the switch if you want to update properties for cross applications,
for example, candidates for existing central workspaces.
• Remove Existing Candidate Workspace
Turn on the switch if you want to remove references for existing candidate
workspaces before a central workspace for the same candidate ID is created.
• Synchronize Assignment Class
Keep the switch turned on if you want to synchronize the assignment class
for the workspace.
• Transfer Documents
Turn on the switch if you want to transfer documents from the CMIS
repository to the central workspace when it is updated.
• For more advanced parameters, see “Configuring Advanced Parameters”
on page 186.
Start options
3. Click Update.
1. To configure and schedule your bot, click the bot’s name link in the Scheduled
Bots list.
– you can also manually edit the OData filter or replace it with another
valid filter.
Example: To create a document for the userId 802982, the filter is 'userId eq
'802982'.
Click Test to test the result of the OData query. You will see the first 125
matches.
Important
The Create Bulk Documents bot is restricted to creating documents for
500 users. If the selected filter returns more than 500 users, the bot will
return an error.
• Document Type – click Select > Browse icon and select your document
type.
• Effective Date – click the Date picker icon to select an effective date for
the created documents.
• Output Channel – from the list, select the output channel for the created
documents as configured in Extended ECM PowerDocs. To select multiple
Advanced parameters
• Execution Mode
You can run the bot either asynchronously or synchronously.
Start options
Important
This bot is designed for manual on-demand run. Scheduling the bot on
a periodic basis can result in duplicate documents.
3. Click Update.
To track the status of the Create Bulk Documents request in Extended ECM
PowerDocs:
The Create Bulk Documents bot in Content Server will initiate a request in Extended
ECM PowerDocs. After initiating the bot, all the document requests will be queued
in Extended ECM PowerDocs. You can track the status in Extended ECM
PowerDocs.
3. In the inline menu of your request with the ERROR status, click the Reprocess
icon.
1. To configure and schedule your bot, click the bot’s name link in the Scheduled
Bots list.
Advanced parameters
Start options
3. Click Update.
This bot has no configuration parameters. You can only configure advanced
parameters and the Start options.
1. To configure and schedule your bot, click the bot’s name link in the Scheduled
Bots list.
2. On the bot's configuration page, edit the following settings:
• Business Application – click Select value and select your external SAP
SuccessFactors system configured in Extended ECM.
• Simulation Mode – turn on the switch to simulate the bot execution in
Content Server. Nothing will be modified in Content Server.
• Synchronization Scenario Type – click to select a scenario type to define if
the synchronization should be run completely or from a set point in time:
Note: The settings are saved together with the scheduled bot times.
The next scheduled bot will then run from the stated time and date.
– Synchronization from the given date and time – you can define a time
and date from where the synchronization bot should be run.
In Synchronization From, select date, hour, minute, and AM/PM.
If you select this scenario, only RBPRole or DynamicGroup entities that
have been modified after the specified date are synchronized to Content
Server.
• Include Inactive Users – keep the switch turned on if you want to include
inactive users.
Advanced parameters
• Role Names
optionally, you can provide a list of role names to which you want to restrict
the synchronization. Separate the names by comma.
• User Group Limit
enter the maximum number of users to be added to a Content Server group
at once. The default value is 100.
Important
For performance reasons, the Group synchronization bot by default
only creates granted groups as Content Server groups. Target groups
are synchronized into internal tables but are not available as Content
Server groups. If you use, for example, target groups in Content Server
to grant permission to Extended ECM PowerDocs, you can enable this
option. Note that the performance may decrease significantly if large
target groups are synchronized as Content Server groups.
Start options
3. Click Update.
• The bot uses role and group information synchronized by running the Group
Synchronization bot. Therefore, the Group Synchronization bot must be run first
to provide the correct information for the team participants of workspaces.
• Note that each used SAP SuccessFactors user, for example, in a group or as a
manager, must have been synchronized into Content Server. If one user is
missing, no participants will be added to the roles for the workspace. This user
will be missing in the roles of business workspaces either as a direct member or
as a member of a group used in the role.
1. To configure and schedule your bot, click the bot’s name link in the Scheduled
Bots list.
• Business Application – click Select value and select your external SAP
SuccessFactors system configured in Extended ECM.
• Simulation Mode – turn on the switch to simulate the bot execution in
Content Server. In Content Server, nothing will be modified.
• Synchronization Scenario Type – click to select a scenario type to define if
the synchronization should be run completely or from a set point in time:
Note: The settings are saved together with the scheduled bot times.
The next scheduled bot will then run from the stated time and date.
– Synchronization from the given date and time – you can define a time
and date from where the synchronization bot should be run.
In Synchronization From, select date, hour, minute, and AM/PM.
If you select this scenario, only RBPRole or DynamicGroup entities that
have been modified after the specified date are synchronized to Content
Server.
• Primary Account Model – enabled by default. For more information, see
“Understanding and using the Primary Account user model” on page 116.
Advanced parameters
• Workspace IDs
Important
Inactive users are by default excluded from the filter result. To include
inactive users add status in ('t','f') to the query.
Click Test to test the result of the OData query. You will see the first 125
matches.
Start options
3. Click Update.
The Permission Synchronization bot updates manager roles for inactive users based
on a setting on the Advanced Job Configuration page.
• When selected, the Permission Synchronization bot will assign manager roles to
team participants for inactive users’ workspaces.
• When cleared, the Permission Synchronization bot will not assign manager roles
to team participants for inactive users.
1. To configure and schedule your bot, click the bot’s name link in the Scheduled
Bots list.
– you can also manually edit the OData filter or replace it with another
valid filter.
Active users – note that active users are by default excluded from the filter
result.
Example: To revoke the license from inactive SAP SuccessFactors user 'aklein' the
filter can be 'username eq 'aklein' and status in 'f'.
Click Test to test the result of the OData query. You will see the first 125
matches.
Note: You can run the test only if you have specified a value in the
filter box. If the filter box is empty, the Test button is disabled.
• Synchronization Scenario Type – click to select a scenario type to define if
the synchronization should be run completely or from a set point in time:
Note: The settings are saved together with the scheduled bot times.
The next scheduled bot will then run from the stated time and date.
– Synchronization from the given date and time – you can define a time
and date from where the synchronization bot should be run.
In Synchronization From, select date, hour, minute, and AM/PM.
• OTDS partition – provide the OTDS partition that is used by all the
scheduled processing bots of type SAP SuccessFactors User Synchronization.
Any user created or modified by this bot will be saved to this partition.
Users in other partitions will be ignored by this bot.
To configure the OTDS partition, see “Configure Module Specific Settings”
on page 109.
• Primary Account Model – enabled by default. For more information, see
“Understanding and using the Primary Account user model” on page 116.
Advanced parameters
Start options
3. Click Update.
For more information about licensing, see “Licensing Extended ECM for SAP
SuccessFactors” on page 12 and section 6.10.1.1 “Extended ECM Licenses” in
OpenText Extended ECM - Installation Guide (LLESCOR-IGD).
Note: When the primary account model is enabled, a user license is applied
only for the primary employment and its associated workspace. The license
counter is not increased if there are multiple or secondary workspaces for that
user. For more information, see “Using the Primary Account Model”
on page 117.
This bot has no configuration parameters. You can only configure advanced
parameters and the Start options.
The user name =username property of the User entity in SAP SuccessFactors will be
the user’s logon name in Content Server. First name, last name, full name, and email
address are also synchronized to the Content Server user.
The bot generates a random password that will not be published: that means no
email is sent and it is not stored anywhere. The password generation is required to
add a new user to Content Server.
The new users are added automatically to OTDS in the default partition Content
Server Members if not configured otherwise.
Important
Use this bot type only if SAP SuccessFactors is the Identity Provider for
Content Server logins.
1. To configure and schedule your bot, click the bot’s name link in the Scheduled
Bots list.
• Business Application – click Select value and select your external SAP
SuccessFactors system configured in Extended ECM.
Note: The filter query should include inactive users as well. Otherwise,
when a user is removed in SAP SuccessFactors, this user information
will never be replicated to the Extended ECM side.
Example: To create users from the USA with active status, the following filter can be
used: empInfo/jobInfoNav/countryOfCompany eq 'USA' and status eq 't'.
Click Test to test the result of the OData query. You will see the first 125
matches.
• Default Group – select a Content Server user group you want to use for
creating SAP SuccessFactors users.
Important
Do not use any SAP SuccessFactors group synchronized to Content
Server as the default group.
• SAML Authentication – the settings SAML Authentication Attribute Name
and SAML Authentication Attribute Value are used to synchronize
attributes required to identify users in OTDS when SAML authentication is
used for single sign-on (SSO). Currently, SAP SuccessFactors is the only
supported identity provider.
SAML Authentication Attribute Name – the authentication attribute value
is used to find the user in OTDS.
The SAML Authentication Attribute Name must match the Authentication
principal attribute configured in the SAML authentication handler in
OTDS.
From the list, select an attribute that will uniquely find a given user in
OTDS, for example, oTUserID.
SAML Authentication Attribute Value – The authentication attribute value
is used to find the user in OTDS. Select one of the following values:
Important
You can select SAP SuccessFactors User Email Address only if the
Primary Account Model option has been selected.
– SAP SuccessFactors User ID
• Synchronization Scenario Type – click to select a scenario type that defines
if the synchronization should be run completely or from a set point in time:
Note: The settings are saved together with the scheduled bot times.
The next scheduled bot will then run from the stated time and date.
– Synchronization from the given date and time – you can define a time
and date from where the synchronization bot should be run.
In Synchronization From, select date, hour, minute, and AM/PM.
If you select this scenario, only RBPRole or DynamicGroup entities that
have been modified after the specified date are synchronized to Content
Server.
• OTDS partition – displays the partition that is currently used by the user
synchronization bot to save users. Any user created or modified by the user
synchronization bot will be saved to this partition. Users in other partitions
will be ignored by this bot.
Important
You must have configured the OTDS partition first before running the
user synchronization bot. If not configured, the user synchronization
bot will report a failure and provide a link to the configuration page.
Advanced parameters
• Update User Privileges – turn on the switch if you want the bot to reset user
privileges that have been changed manually back to the standard privileges.
If you leave the check box empty, user privileges will not be changed back
by the bot.
Start options
3. Click Update.
• Keep History – enter a value to specify how many history entries will be
collected. If you enter a number, each bot run will generate one history entry
providing additional information for the bot run.
To find the history information, go to your bot entry in the Scheduled
Processing bot list, select the History tab, and click the Details link.
If you leave the box empty, no bot history will be kept.
• Keep Reports – enter a value to specify how many reports will be collected. Each
bot run will generate one report with a set of files providing additional
information for the bot run.
• Distributed Agent Priority (0–100) – you can configure the Distributed Agent
priority for your bot. You can increase the bot performance by increasing the
priority value between 0-100. If you leave the box blank, the value will be set to
the default priority value = 80.
• Block Size – defines the number of objects, for example, document templates or
workspaces, that are processed at once. The default value is 1.
• Execution Mode – you can run the bot either asynchronously or synchronously.
– On these days – select one or more days when the bot should run.
– At these times
○ Hours – click and select an hour when the bot should start.
○ Minutes – click and select the minute of the hour when the bot should
start.
○ Do not start bot if the previous run had more than the following
number of error items – enter a number. By default, the number of errors
is 5000.
• After bot – Click Select value. From the list, select a bot after which your bot will
always be run.
– Do not start if the previous bot created errors – turn the switch icon on or
off.
– Maximum number of errors in previous bot – enter a number. The bot does
not start if the previous bot had more than the provided number of error
items.
• To enable central workspace creation, you must have mapped business object
types sfsf:user, sfsf:person, and sfsf:candidate to the same workspace type.
• The migration is not available for a job when the job is running.
• If a job is configured to run after the deprecated create workspace job and the
dependent job is running, the migration will fail.
• If a candidate filter was used in the old job, the new workspace bot uses the same
filter but adds externalCandidate eq true. Workspaces for internal candidates
must be created using the user filter.
• To use central workspaces, the document template will be the same based on the
global template rule evaluation for sfsf:user. If you want to use candidates for
the central workspaces, you must add the Candidate and Candidate Information
category to the document template for the workspace type used by sfsf:user.
The inheritance option must be disabled.
• Always use the health check report to verify the system setup.
If you have Business administrator usage privileges, you can use a Perspective to
change the appearance and content of a particular component in the Smart View.
You can create a Perspective using the Perspective Manager tool or the Edit Page
tool in Smart View. For information about how to use the Perspective Manager tool,
see the Online Help available in the Perspective Manager. For more information
about how to use the Edit Page tool, see the Online Help available in Smart View.
For information about how to configure widgets, see OpenText Extended ECM -
Widget Configuration Online Help (CSAV-H-CWG).
For information about the configuration options for the different widgets, see section
7 “Widget configuration” in OpenText Content Server Perspective Manager - Online
Help (CSAV-H-PPG).
• Workspace Type ID
• Workspace Name <language code>, for example Workspace Name en
• Workspace Type
• Workspace Template
The following custom columns have already been created in the Facets volume in
the Workspace Columns folder.
• Workspace Type ID
Example: The collapsed view of the Workspaces widget displays the workspace name only.
The expanded view of the same widget displays columns for workspace name, creation date,
and owner and is sorted by creation date.
The workspace name is a default custom column. Creation date and owner are created as
system default columns during installation of Content Server.
Note: You can enable sorting by date in the Workspaces widget or the Related
Workspaces widget. For this, you create a custom column for the Workspace
Modify Date data source and configure it to be sortable so that it can be used
for sorting and filtering. No further configuration is required in the widget.
For more information about how to configure widgets, see OpenText Extended ECM -
Widget Configuration Guide (CSAV-CWG).
3. On the Facets page, browse to the folder where you want to store your custom
columns.
6. In the Data Source list, select a category attribute. Each attribute can only be
used once in a custom column. If an attribute is already used as data source for
a custom column, it is no longer listed.
7. To enable sorting and filtering, select the Sortable check box and click Add.
To only display the column in the Workspaces widget, in the Related
Workspaces widget, or in the Browse view in Classic View for on-premise
installations, clear the Sortable check box.
8. Optional While you wait for the column to be built, to monitor the status, select
Properties > Specific from the function menu.
9. Smart View: From the function menu of the custom column, select Properties >
Workspaces. Then select Used for Sorting and Filtering. When you click
Update the database index is created concurrently, which may take a few
minutes.
Notes
After the database index has been created, you can use the custom column
for filtering and sorting.
For more information about custom columns, see the help available in Content
Server.
• To create a new landing page perspective, select Create New. Enter a Title
for the page. Under Type, select Landing page.
• To use an existing template, select Edit existing. Click in the Browse box and
browse to your existing landing page template. You can then edit the Title if
required.
3. In the Rules tab, you create logical rules which control when the perspective is
used. Click Add . Add the group for which you want to configure the
landing page or container. In the first list, select SAP SuccessFactors Role. In
the third list, select the role (for example, HR_Administrator, Manager, or
Employee) for which the landing page is created.
5. In the Configure tab, you design the perspective for the Landing page. The
Widget Library pane lists widget groups and widgets from the installed
modules including the widgets for Extended ECM for SAP SuccessFactors. The
working area in the middle is where you place the widgets. The Options pane
displays configuration options of the selected widget. In the widget library
pane, click Extended ECM for SAP SuccessFactors. To edit the settings for the
specific widgets, see OpenText Extended ECM - Widget Configuration Online Help
(CSAV-H-CWG).
Important
Changes in the ActiveView code are not visible in the Perspective
Manager when you return to the design mode. You must reload the
Perspective.
6. On the Perspective Manager header, click Create for a new Perspective, or click
Update if you edited an existing Perspective.
1. On the global menu, click Enterprise > Business Workspaces > Workspace
Types > Employee.
2. In the Perspective Manager section, click the Manage Perspectives for this
workspace type link.
3. In the Perspective Manager window, do the following:
a. On the General tab, in the Create new perspective, or edit existing one?
section, select Edit existing.
b. Click Browse and browse to your Extended ECM for SAP SuccessFactors
folder.
c. Select the required template to open it in Perspective Manager, where you
will see the Title and Type of the template.
4. On the Rules tab, do the following to create logical rules to control when the
Perspective takes effect:
Important
Do not remove the workspace type rule that reflects the workspace
type from which you called Perspective Manager.
b. In the Type menu, select SAP SuccessFactors Role.
c. Ensure the Logical operator menu is set to is.
d. In the Value menu, select one of the SAP SuccessFactors Roles: Employee,
Manager, or HR Administrator.
5. On the Configure tab, design the Perspective of the Employee workspace. The
Widget Library pane contains widget groups and widget from the installed
modules, including the widgets for Extended ECM for SAP SuccessFactors. The
working area in the middle is where you place the widgets. The Options pane
displays configuration options of the selected widget. In the Widget Library
pane, click Extended ECM for SAP SuccessFactors. To edit the settings for
specific widgets, see OpenText Extended ECM - Widget Configuration Online Help
(CSAV-H-CWG).
Important
Changes in the ActiveView code are not visible in the Perspective
Manager when you return to the design mode. You must reload the
Perspective.
6. In Content Server, on the global menu click Enterprise > Facets Volume >
Workspace Columns and open the Workspace Name en item. Click the
Workspaces tab and select the Used for Sorting and Filtering check box.
7. Click Update.
2. To enter your title, click in the Title box on the Options pane.
3. In the Multilingual Values dialog, enter the titles in your required languages
and click Update.
1. My Assignments
2. Inbox
3. Employee Workspaces
4. Candidate Workspaces
5. Workflow Tracking
1. Header widget
2. Tasks widget
3. Activity Logs widget
4. Upload widget
• Inbox widget
• Tasks widget
• Reports widget
• Header widget
Extended ECM for SAP SuccessFactors can receive uploaded documents from any
SuccessFactors module that supports the Document Management interface. For this
release, the following modules are supported:
• Employee Central
• Recruiting Management
• Employee Profile
• Performance Management
• Calibration
• Career Development Planning (CDP)
• Compensation
• Onboarding 2.0 (Beta Release)
Note: From the December 2018 update, storing documents via CMIS
adaptor does not require Employee or Candidate workspaces to exist in
Extended ECM. Documents belonging to an employee who does not have a
workspace are placed temporarily in a technical staging folder in Extended
ECM. Users can access them in the SAP SuccessFactors user interface.
When a workspace is created for this employee, the documents are moved
automatically into that new workspace.
You can create and assign attachment declarations as required for your document
categories/classifications.
Important
• Category Attributes and Sets are not supported for Business Properties
and Business Properties Groups settings
In the Business Properties and Business Properties Groups sections of the
attachment declaration, Category Attributes and Category Set options are
not supported for SAP SuccessFactors as leading system because the
property information is not retrieved via CMIS.
• Existing Workspace classifications are not inherited by documents
uploaded via CMIS
The classification applied to the uploaded document is based on the
selection in the Document Classification setting. Classifications already
defined for the workspace to which the document is moved will not be
inherited.
Notes
2. In the General section, enter a Name for the attachment declaration and
optionally provide a Description.
Example 9-1:
Record Date – select Constant and select a record date from the date widget for
the RM classification.
Status – select Constant to enter the status for the RM classification. If the status
does not match an existing status for your RM Classification, the document will
not be migrated.
Status Date – select Constant and select a status date from the date widget for
the RM classification.
Mark Official – select Constant and select the Mark Official check box to mark
the RM Classification for the document as official.
7. Click Apply.
Note: Follow the procedure to add the visibility attribute after establishing the
CMIS connection.
1. Click Enterprise > Business Workspaces > Categories > SAPCMIS Types >
<Leading system name> > SF Document.
2. Click Add Attribute, and select Flag: Checkbox from the list.
Once this attribute is added, documents will be moved to the workspace only when
the visibility flag is marked as true. Documents with a visibility flag marked as
false, for example documents that are not approved in SAP SuccessFactors, should
remain only in the technical repository.
Note: If a document’s visibility flag is updated at a later point, this moves the
document from workspace to storage and vice versa.
The visibility flag is only available for all new documents uploaded after
adding the attribute. It does not apply to previously-uploaded documents.
• Document Type – from the list, select CMIS as default option and/or a SAP
SuccessFactors document category available for this business object.
• Attachment Declaration – see also “Configuring the storage folder for CMIS
documents by using Attachment Declaration (optional)” on page 204.
– CMIS default document type – select the attachment declaration for SAP
SuccessFactors/CMIS created in the previous step.
4. Click Apply.
2. Use the OAuth client credentials as CMIS credentials in the SAP SuccessFactors
Configure Document Management dialog to set up OpenText as vendor. See
“Setting up OpenText vendor” on page 214.
2. In the RBP page, grant yourself the Manage Documents > Manage documents and
Configure Document Management > Configure Document Management
permissions.
1. Log in to SAP SuccessFactors Admin Center as administrator user and use the
search box to navigate to Security Center.
2. Select X509 Certificates.
3. Click Add.
4. Enter the following settings:
• Configuration Name – enter a name for the certificate, for example CMIS.
• Certification Authority – select Self-Signed.
• Valid Until – click the calendar icon and select a suitable validity date.
• Signature Algorithm – select SHA256WithRSA.
5. Click Generate and Save.
6. Click Download, and select X509 Certificate from the options to store the
certificate file in your local file system.
You will need the public key from this certificate to set up the connection. To find
this key:
1. In your local file system open a command window and navigate to the folder
where the certificate is located.
2. Enter the following command:
openssl x509 -in <certificate file name> -pubkey -noout
3. Copy the section between - - BEGIN PUBLIC KEY - - and - - END PUBLIC KEY - - to
a location you can access later, for example a text file.
The Logical External System Name of the external connection with your
SAP SuccessFactors system is SuccessFactors. The name of the CMIS
connection user must also be SuccessFactors.
b. Select the Confidential check box.
c. For the Authentication Method, select Asymmetric JWT from the list.
d. In the Public Key field, enter the public key copied from the certificate file.
Click Next.
5. Click Save.
2. From your Content Server access role’s Actions menu, click View Access Role
Details.
6. Click Save.
Note: This step is only required when a reverse proxy is added for OTDS.
2. Select directory.auth.BaseURL and add the OTDS login URL in the Value
field.
3. Click Save.
• Endpoint – http://<TOMCAT_HOST>:<TOMCAT_PORT>/xecm-cmis/browser
Important
The TOMCAT_HOST is the server where the Extended ECM CMIS adapter
is installed.
• System User – the Client ID you entered when creating your OAuth client.
• Token Endpoint – https://<OTDS_TOMCAT_HOST>:<PORT>/otdsws/oauth2/
token
5. Select your repository from the list and then click Connect to OpenText.
If all settings have been correctly configured, only the option with the external
system connection name will be available in the Repository box.
1. Go to Employee Profile.
3. To check the results, sign in to Content Server and open the employee
workspace. Find the uploaded document in the folder created by CMIS as
configured previously, see “Configuring the storage folder for CMIS documents
by using Attachment Declaration (optional)” on page 204.
9.4 Troubleshooting
If you encounter an issue while uploading the documents from SAP SuccessFactors
to existing workspaces, refer to the following sections.
To configure permissions:
3. In the Permission Role List, click the permission role for your connection user.
In the Permission Role Detail dialog, click Permission...
• Recruiting Permissions
Other Permissions
• General User Permission
– Employee Export
– Export Extended User Information
• Metadata Framework
Note: Selecting the Allow access to this page option for this user is not
required.
You create Permission Groups and assign them to Permission Roles by customizing
Granted roles and their Target Population. For a Permission Role, you also configure
a set of permissions.
Perform the following steps:
Example: The Permission Group Human Resources in US lists all US-based employees
who work in the HR department. To define this group, you specify that users must match
the selection criteria Country=United States and Department=HR.
2. Creating Permission Roles
Create Permission roles according to your business requirements. A Permission
Role is a compilation of permissions. In a Permission Role you have
• Granted Users – users that have a Permission Role assigned for a specific
Target Population.
• Target Population – users that Granted Users can access with the applied
permissions of the Permission Role.
• Permission settings – in the Permission settings, you configure the
permission set that you want the Granted Users assigned to this Permission
Role to have.
Set Permission setting for OpenText documents – Add the Employee Views
> OpenText Documents permission to the Permission settings.
Important
The name of your Permission Roles must not contain the following
characters:
– , – comma
– ' – single quote
Important
Do not select the Allow their manager to have the same permission access
check box. This option is not supported by OpenText.
• Target population
For the Target population, you can select a Permission Group or the Everyone
option.
You can also select the Target Population of option and then select a filter based
on a Granted user’s property, for example, Granted User’s location or the
Granted User (Self) option from the drop down list.
Note: Selecting the Exclude Granted User from having the permission
access to him/herself is optional.
– All Managers
– Only the Managers in these groups below. For this option, select one or more
Permission Groups.
Important
Do not select the Allow their manager to have the same permission access
check box. This option is not supported by OpenText.
• Target population
For the Target population, select the Granted User’s Direct Reports option or
select a permission group for the Only the Direct Reports in these groups
below option.
You can also select the Include access to the Reports of the Granted User's
Direct Reports option. All hierarchy levels for manager relations are supported.
Important
Do not select the Include access to Granted User (Self) option. This will
skip processing in Content Server.
Note: Selecting the Exclude Granted User from having the permission
access to him/herself is optional.
Grant role to
Do not select the Allow their manager to have the same permission access
check box. This option is not supported by OpenText.
• Target population
Select the Target Population of option and then select the Granted User (Self)
option from the list.
Important
Do not select the Exclude Granted User from having the permission access to
him/herself check box.
Prerequisites you must have configured the SSO authentication before you can integrate the
Extended ECM tiles. For details, see “Configuring user authentication between
Extended ECM and SAP SuccessFactors“ on page 19.
The following Extended ECM for SAP SuccessFactors elements are available for the
integration:
• Personal Workspace
• Inbox widget
• Employee workspaces widget
• Document Self Service widget
• Widgets of the Business Workspaces widget library
• File Upload widget
Figure 11-4: Document Self Service tile in SAP SuccessFactors Home page
– Large
7. In the Main Content editor, click the Source icon. Paste the following code in
the editor:
Source code for the Personal Workspace tile:
<script>
function resize()
{document.getElementById('iframe').style.height =
document.querySelector(' .sapMDialogOpen ').clientHeight
- 90 - 32 + "px";}
window.addEventListener('resize', resize);
</script>
<iframe id="iframe"
onload="resize()"
scrolling="yes"
frameborder="0"
width="100%"
height="100%"
src="https://<CS_HOST>:<CS_PORT>/<CGI_MAPPING>
?func=othcm.NavigateToIntegrationHTML&type=personalws
&external_system=<EXTERNAL_SYSTEM>
&bo_type=<PERSON_BO_TYPE>
&otdsauth=saml_<IDP>"
</iframe>
• <CS_HOST> – replace with the Content Server name. Add <CS_HOST> to the
SAP SuccessFactors allow list for external sites.
• <CS_PORT> – replace with the Port number.
• <IDP> – replace with the IDP name defined at the time of SSO configuration.
• <CS_HOST> – replace with the Content Server name. Add <CS_HOST> to the
SAP SuccessFactors allow list for external sites.
• <IDP> – replace with the IDP name defined at the time of SSO configuration.
• <CS_HOST> – replace with the Content Server name. Add <CS_HOST> to the
SAP SuccessFactors allow list for external sites.
• <CS_PORT> – replace with the Port number.
• <CGIMAPPING> – replace with the CGI mapping defined at the time of
Content Server installation.
• <Workspace Type ID> – replace with the employee Workspace Type ID.
• enabledocgen=<true/false> – set to true if the Document Generation icon
should be available in the tile or set to false if the icon should be hidden.
• <IDP> – replace with the IDP name defined at the time of SSO configuration.
• <CS_HOST> – replace with the Content Server name. Add <CS_HOST> to the
SAP SuccessFactors allow list for external sites.
• <CS_PORT> – replace with the Port number.
• <CGI_MAPPING> – replace with the CGI mapping defined at the time of
Content Server installation.
• <EXTERNAL_SYSTEM> – replace with the name of the external system
connected to SAP SuccessFactors.
• <PERSON_BO_TYPE> – replace with the person business object, for example,
sfsf:user.
• <IDP> – replace with the IDP name defined at the time of SSO configuration.
• <CS_HOST> – replace with the Content Server name. Add <CS_HOST> to the
SAP SuccessFactors allow list for external sites.
• <CS_PORT> – replace with the Port number.
• <CGIMAPPING> – replace with the CGI mapping defined at the time of
Content Server installation.
• enabledocgen=<true/false> – set to false to hide the icon.
• <IDP> – replace with the IDP name defined at the time of SSO configuration.
• <CS_HOST> – replace with the Content Server name. Add <CS_HOST> to the
SAP SuccessFactors allow list for external sites.
• <CS_PORT> – replace with the Port number.
• <CGIMAPPING> – replace with the CGI mapping defined at the time of
Content Server installation.
• <IDP> – replace with the IDP name defined at the time of SSO configuration.
8. In the Assignment section, select the group for which the tile should be visible.
Prerequisites – you must have configured the SSO authentication before you can
integrate the Extended ECM tiles. For details, see “Configuring user authentication
between Extended ECM and SAP SuccessFactors“ on page 19.
The following Extended ECM for SAP SuccessFactors elements are available for the
integration:
• Personal Workspace
• Inbox widget
Figure 11-9: Document Self Service tile in SAP SuccessFactors Home page
– Large
8. URL – in the URL box, enter the Iframe source code as follows:
• <CS_HOST> – replace with your Content Server host name. Add this host
name to the SAP SuccessFactors allow list for external sites.
• <CS_PORT> – replace with the Port number.
• <CGI_MAPPING> – replace with the CGI mapping defined at the time of
your Content Server installation.
• <EXTERNAL_SYSTEM> – replace with the name of your external system
connected to SAP SuccessFactors.
• <PERSON_BO_TYPE> – replace with the person business object, for
example, sfsf:user.
• <IDP> – replace with your IDP name defined at the time of SSO
configuration.
Inbox tile
https://<CS_HOST>:<CS_PORT>/<CGI_MAPPING>
?func=othcm.NavigateToIntegrationHTML&type=
inbox&otdsauth=saml_<IDP>
• <CS_HOST> – replace with your Content Server host name. Add this host
name to the SAP SuccessFactors allow list for external sites.
• <CS_PORT> – replace with the Port number.
• <CGI_MAPPING> – replace with the CGI mapping defined at the time of
your Content Server installation.
• <IDP> – replace with the IDP name defined at the time of SSO
configuration.
• <CS_HOST> – replace with your Content Server host name. Add this host
name to the SAP SuccessFactors allow list for external sites.
• <CS_PORT> – replace with the Port number.
• <CGI_MAPPING> – replace with the CGI mapping defined at the time of
your Content Server installation.
• <Workspace Type ID> – replace with Workspace Type ID for Employee
workspaces.
• enabledocgen=<true/false> – set to true if the document generation
icon should be available in the tile. Set to false if the icon shall be
hidden.
• <IDP> – replace with the IDP name defined at the time of SSO
configuration.
• <CS_HOST> – replace with your Content Server host name. Add this host
name to the SAP SuccessFactors allow list for external sites.
• <CS_PORT> – replace with the Port number.
• <CGI_MAPPING> – replace with the CGI mapping defined at the time of
your Content Server installation.
• <CS_HOST> – replace with your Content Server host name. Add this host
name to the SAP SuccessFactors allow list for external sites.
• <CS_PORT> – replace with the Port number.
• <CGI_MAPPING> – replace with the CGI mapping defined at the time of
your Content Server installation.
• enabledocgen=<true/false> – set to false to hide the icon.
• <IDP> – replace with the IDP name defined at the time of SSO
configuration.
• <CS_HOST> – replace with your Content Server host name. Add this host
name to the SAP SuccessFactors allow list for external sites.
• <CS_PORT> – replace with the Port number.
• <CGI_MAPPING> – replace with the CGI mapping defined at the time of
your Content Server installation.
• <EXTERNAL_SYSTEM> – replace with the name of the external system
connected to SAP SuccessFactors.
9. In the Assignments section, select the group for which the tile will be visible.
Prerequisites you must configure the SSO authentication before you can include the Extended
ECM links in the Take Action menu. For details, see “Configuring user
authentication between Extended ECM and SAP SuccessFactors“ on page 19.
<CGIMAPPING> – replace with the CGI mapping defined at the time of Content
Server installation.
saml_<IDP> – replace <IDP> with the IDP name defined at the time of SSO
configuration. The IDP name is the Identity Provider name in the
Authentication Handler created for SAML 2.0 Authentication Handler Type.
objtype – workspace subtype.
Prerequisites you must configure the SSO authentication before you can include the Extended
ECM links in the Take Action menu. For details, see “Configuring user
authentication between Extended ECM and SAP SuccessFactors“ on page 19.
• nocreate: the workspace is not created if it does not exist. An error message
is shown stating that the workspace does not exist.
To configure the URL for creating a candidate workspace, use the following format:
https://<CS_HOSTNAME>:<CS_PORT>/<CGIMAPPING>/cs.exe?func=ll&objtype=848&
objaction=createcentralworkspace&system=<EXTERNAL_SYSTEM>&botype=
sfsf:candidate&boid=<candidateId>
<CGIMAPPING> – replace with the CGI mapping defined at the time of Content Server
installation.
Prerequisites you must have configured the SSO authentication before you can include Extended
ECM as Custom External Module. For details, see “Configuring user authentication
between Extended ECM and SAP SuccessFactors“ on page 19.
Important
Provisioning can only be done by certified SAP SuccessFactors consultants or
SAP SuccessFactors support.
4. In the Home page menu, the Custom External Module entry is added.
5. Click Custom External Module to open your Content Server landing page.
6. To edit the name of the entry, log in to SAP SuccessFactors, navigate to Admin
Tools > Company Settings, and search for Text Replacement.
Scroll down to the Custom External Module entry and change it to, for example,
OpenText Home Page.
Click Save.
7. In the Home page menu, the changed text OpenText Home Page is displayed.
Prerequisites
• you must have configured the SSO authentication before you can include the
Extended ECM links in the Take Action menu. For details, see “Configuring user
authentication between Extended ECM and SAP SuccessFactors“ on page 19.
https://<CS_HOST>:<CS_PORT>/<CGI_MAPPING> ?func=othcm.
NavigateToIntegrationHTML&type=personalws &external_system=<EXTERNAL_
SYSTEM> &bo_type=<PERSON_BO_TYPE>&sfuserid=@USER_ID@& &otdsauth=
saml_<IDP>
• <CS_HOST>: replace with the Content Server name. Add <CS_HOST> to the
SAP SuccessFactors allow list of allowed external sites.
• <CS_PORT>: replace with the port number.
• <CGI_MAPPING>: replace with the CGI mapping defined at the time of
Content Server installation.
• <EXTERNAL_SYSTEM>: Name of the external system that is connected to SAP
SuccessFactors.
• <PERSON_BO_TYPE>: person business object for, for example, sfsf:user.
• <IDP>: replace with the IDP name defined at the time of SSO configuration.
The IDP name is the Identity Provider name in the Authentication Handler
created for SAML 2.0 Authentication Handler Type.
In SAP SuccessFactors
• Document Management
“Enabling and configuring Document Management in SAP SuccessFactors”
on page 210
• UI configurations
If you want to import the integrations from the Extended ECM system that is
configured for the target instance, see “Configuring and registering SAP
SuccessFactors Integration Definitions“ on page 283.
In Extended ECM
In PowerDocs
Log in to PowerDocs Content Manager with the transaction user. Click Technical
Settings> Integrations > Partner Systems.
You can customize cross-application employee workspaces for SAP HCM and SAP
SuccessFactors.
You can connect Extended ECM for SAP SuccessFactors to a standalone on-premise
SAP HCM system or, if you are in the process of moving from on-premise HCM to
SAP SuccessFactors, the two HR systems can connect to the same Extended ECM
System. A cross-application Employee workspace is then shared by two systems and
documents can be managed in the centralized Extended ECM system.
The employee workspace is then linked to both business objects BUS1065 in SAP
HCM and User in SAP SuccessFactors.
In this way, you can access the employee workspace from both SAP SuccessFactors
and SAP HCM.
A single employee workspace can contain business processes from SAP HCM and
the SAP SuccessFactors system. Every user who has access to the employee in the
SAP system also has access to the workspace, and thereby to the information
provided by SAP SuccessFactors.
If customized accordingly, you have the following options to create the employee
workspace:
• in SAP HCM upon creating a new employee in the HR Master Data maintenance
transaction PA40.
• in SAP HCM in the HR Master Data transactions PA30 or PA30 by clicking the
GOS menu entry OpenText Business Content > Business Workspace > Create
Business Workspace.
• running SAP HCM report /OTX/RM_WSC_CREATE_EMPLOYEE to trigger Workspace
Bulk creation to subsequently create workspaces for existing employees.
• creating employee workspaces from the employee’s SAP SuccessFactors Public
Profile by clicking the workspace menu entry.
• creating employee workspaces directly in Content Server.
Caution
You cannot use SAP HCM authorizations for employee workspaces. You
must implement additional authorizations in Content Server. For more
information, see “Configuring access permissions from SAP HCM using
Permission Propagation” on page 270.
Caution
In the property provider /OTHCM/WSC_CL_EMPLOYEE_PP, the SAP
SuccessFactors Employee Business Object is specified in the
attribute constant C_SFSF_BOTYPE, which currently has the
value User. You must replace this value with sfsf:person or
sfsf:user.
Important
ls_iden_bus_obj-type = C_SFSF_BOTYPE.
ls_iden_bus_obj-external_system_id = C_SFSF_EXTERNAL_SYSTEM.
ELSE.
CALL METHOD /OTHCM/WSC_CL_APPL_LOG=>log_message
EXPORTING
pi_subobj = /OTHCM/WSC_CL_APPL_LOG=>c_log_subobj_rm
pi_msgty = 'E'
pi_msgid = /OTHCM/WSC_CL_APPL_LOG=>c_log_subobj_rm
pi_msgno = 075.
ls_error = text-075.
Raise exception type /othcm/cx_wsc_sfsf_user_id
exporting m_error_text =
ls_error.
ENDIF.
ELSE.
* Custom Implementation to find out if a personnel number was
previously replicated to the SAP SuccessFactors Talent Suite to get
User ID of employee used in Successfactors.
ENDIF.
ELSE.
CALL METHOD /OTHCM/WSC_CL_APPL_LOG=>log_message
EXPORTING
pi_subobj = /OTHCM/WSC_CL_APPL_LOG=>c_log_subobj_rm
pi_msgty = 'E'
pi_msgid = /OTHCM/WSC_CL_APPL_LOG=>c_log_subobj_rm
pi_msgno = 002.
ls_error = text-002.
Raise exception type /othcm/cx_wsc_sfsf_user_id
exporting m_error_text =
ls_error.
ENDIF.
PE_IDENTICALBO = ls_iden_bus_obj.
• Custom Property Name – provide the attribute defined for the Workspace
Template, for example, Employee.Template.
• Attribute – use the attributes that are defined in the property provider to
build the rule.
Example: To create a workspace for an employee with Personnel Area = 1300, the
workspace template for employees in Europe will be used.
• On the global menu, click Enterprise > Extended ECM > Business Object
Types.
General area
Name – enter a name for the new business object type, for example, Employee
SAP HCM.
Tip: You can also create the business object type without connecting to
the external system. The Extended ECM configuration then checks the
configuration and links the external system each time it is opened.
• Business Object Type – select the BUS1065 entry from the list of available
business object types. If you are not connected to the external system, you
can enter the business object type manually.
Important
You must select a business object that is not already used in another
business object type configuration. Otherwise, you cannot save the
business object type.
• Display URL – specify the URL that is used to display the business object:
– for workspace references, this URL is used for the Display button in the
Properties > General tab of the workspace.
– for added business objects, this URL is used if the user clicks the Display
button of an added business object in the Business Objects tab of the
workspace.
• Workspace Type – select the workspace type that you have created for the
SAP SuccessFactors business object. To create the workspace type if it is not
existing yet, see “Viewing and changing Workspace types (optional)”
on page 31.
• Is Default Display for Workspace Type – if you enable this option for the
SAP HCM Business Object BUS1065, this business object type will be the
default display in the cross application workspace scenario.
Notes
– If you do not select any business object type for default display:
• Business Properties
– Business Property – enter the exact name of the business property and of
the attribute.
– Mapping Method – select a mapping method from the list.
– Category and Attribute – click Select to select the category and then
select its attribute from the list.
Important
In the cross application scenario, you must use the name pattern for the
category attributes maintained in Enterprise > Business Workspaces >
Workspace types > <workspace type> > Business Workspace Names >
Name Pattern. This name pattern must be used for the attribute
mapping of both business objects BUS1065 and User.
• Business Property Groups
Select a Mapping Method:
– Business Property – in Category and Set, enter the exact name of the
business property that determines the relevant category. Then enter the
set name.
Enter a Property Name and select an attribute in the Set Attribute list to
map a business property of the group to an attribute of the set.
– Category Set – click Select to select the category and its attribute set.
Then enter the Property Name and an attribute from the Set Attribute
list.
As an SAP business administrator, you can assign the existing SAP roles to Content
Server groups to manage the documents stored in the employee workspace. In this
way, you ensure that setting up the document access permissions follows the
standard SAP authorization process.
In the Specific tab of the workspace template, you create rules based on category
attributes that define a mapping between the Content Server groups coming from
SAP HCM and existing groups created as template groups to propagate the
respective permissions. When a business workspace is created, the Content Server
group replaces the template group at the workspace level according to the
configured rules.
1. Define a list of relevant SAP roles and add the users to the roles. Use the group
mapping program provided by Extended ECM for SAP Solutions to create
Content Server groups and add users to groups using these SAP roles. For more
information, see OpenText Extended ECM for SAP Solutions - User Management
and Access Control Scenarios (ERLK-CUM).
2. In the SAP GUI, run the /OTX/RM_RO_TO_GRP transaction. To map the SAP roles,
select the Content Server group option. For details about the mapping
procedure, see OpenText Extended ECM for SAP Solutions - User Management and
Access Control Scenarios (ERLK-CUM).
Note: As a Content Server administrator, you can also add non-SAP users
to a Content Server group manually.
3. In the Content Server Document Templates folder, click the Functions menu of
your workspace template and open the Team roles and Permissions dialog.
Define the necessary template groups and edit the group permissions for each
group.
4. Before you start the group mapping in the workspace template, check the
following prerequisites:
• Content Server groups created by the Initial Load program exist and have
members assigned.
• In the workspace template, the groups that function as group permission
templates have been set up.
• Business Object type has been configured.
• Business properties have been mapped to category attributes.
5. In the Functions menu of your template, click Properties > Specific. Select the
Permission Propagation option.
To map the groups:
In SAP HCM, many roles are available for each of the Functional Rights specified
above. You can identify the roles based on these Functional Rights and map them
accordingly. Use these mappings to control various permissions and feature access
in Extended ECM for SAP SuccessFactors.
2. Open the function menu for your HR Functional Rights item, for example
Employee, or for a subgroup, and click Add HCM Roles.
3. In the Enter Role Names box, enter the SAP HCM role to map to this Functional
Right. Click Add.
Extended ECM supports bots that are triggered by events in SAP SuccessFactors
Employee Central and Recruiting Module. Extended ECM supports bots that are
triggered in Extended ECM by external events in external business applications. You
can configure bots containing a set of rule conditions and bots to be performed in
sequence. A bot is processed when the associated event is triggered. As Business
Administrator, you manage your bots in the Event Bots widget.
1. Deploying Event Handler .WAR file on the proxy web server, see “Deploying the
Event Handler .WAR file” on page 277.
2. Enabling Impersonation settings in the OTDS administration, see “Enabling
Impersonation Settings” on page 277.
3. Customizing the Event Bot widget in the Perspective Manager, see “Configuring
the Shortcut Group widget for Event Bots” on page 278.
4. Configuring Integration Definitions in SAP SuccessFactors, see “Configuring
and registering SAP SuccessFactors Integration Definitions“ on page 283.
5. Customizing bots in Event Bots, see “Configuring bots in Event Bots“
on page 299.
• server.auth.url = http://<OTDS_HOST>:<PORT>
• auth.url.base = /otdsws
• server.trans.url = https://<CS_HOST>:<PORT>
• trans.base.url = /OTCS/cs.exe
• leading.system.name = <External System Name> //example: SuccessFactors
2. Deploy the othcm-eh.war file on your Tomcat server.
To enable impersonation:
3. Click Impersonation Settings. Select the Allow this resource to impersonate its
own users check box. Click OK.
2. For your landing page, go to the Rules tab and create a rule with Group is
”Business Administrator”.
3. In the Configure tab, expand the Standard Widgets library. Select the Shortcut
Group widget and drag it to the layout area.
7. In the Target object setting, click Browse. In the Select node dialog, click
Content Server. In the list, go to Event Bots and click Select. Click Add To
Array .
Extended ECM for SAP SuccessFactors supports SAP SuccessFactors events based
on SAP SuccessFactors Integration Center. For this, you must import and register
your Integration Center file containing the event and event properties information.
Upon reading the file, the events are listed on the Event Bots center home page and
the respective event properties are available for configuring bots.
Once these steps are complete, you can create destination settings using OAuth as
the authentication type. See “Creating destination settings ( SAP SuccessFactors)”
on page 286.
4. In the Redirect URLs section, set the redirect URL to your Content Server host,
in the format http://<host>:<port>.
5. Save the OAuth client and copy the client secret key that is returned, saving it
for future reference.
6. Go to Partitions and for the OAuthClients partition, click Actions > View
Members.
7. Select the user created with the Client ID you specified above, and click Actions
> Edit Membership.
9. In Content Server, go to Enterprise > Users and Groups, and search for the
OAuth user.
10. Click Edit, and on the General tab, set the Department to Business
Administrators.
3. Click Add to create a new OAuth configuration, and provide the following
settings:
4. Click Save.
Basic Authentication: use this for all other authentication. For this option,
provide the User Name whose credentials should be used to establish the
connection to the Extended ECM system via the web server, and the
Password for the connection user.
4. Click Save.
5. Employee Hire
6. Employee Rehire
7. Employment Termination
3. Click Browse and select your file from the folder containing the ZIP file you
downloaded in “To download pre-defined Integration Definitions:“ on page 287
> step 2.
Click Upload.
Important
On the Configure Fields page, you must configure an element
OpenTextEventContext with child element EventType providing the value
of the attribute named Default Value. This is required to register the event
and execute the bots in Extended ECM. For the pre-defined events, the
integration definitions files already contains these elements.
If OpenTextEventContext or EventType are not available, event registering
and executing bots will fail.
7. Verify the Integration Name and description and then click Save. A success
message is displayed.
8. Click OK and click Go to ISC. On the Intelligent Services Center > Event
Details page, in Custom Activities, click > Integrations.
9. In the My Integrations list, select your Integration definition and click Add
Integration.
10. In your Integration definition, go to Flow Rule > Timing and select When event
is published.
Important
Registered events cannot be deleted once the corresponding integration
definition is imported. Users can only update the definition thereafter.
3. Click Create.
4. Search and select your Intelligent Service Event and click Select.
6. On the Configure Fields page, add the OpenTextEventContext element and add
the EventType child element. Provide the Default Value for your event.
Important
You must configure an element OpenTextEventContext with child element
EventType and provide the value for the attribute named Default Value.
This is required to register the event and execute the bots in Extended
ECM.
If OpenTextEventContext or EventType are not available, event registering
and executing bots will fail.
8. Click Next.
9. In the Review and Run screen, click Save > Save.
10. Verify Integration Name and description and then click Save.
11. Click OK and click Go to ISC. On the Intelligent Services Center > Event
Details page, in Custom Activities, click > Integrations.
12. In Custom Activities, click Integration.
14. For your integration definition, for Flow Rule > Timing, select When event is
published.
2. For Import modified Integration definition, click Browse to find your updated
Integration Definition file.
Important
When updating the Event Definition, the Event Name and the EventKey
property must not be modified. Otherwise, the event update will fail.
The event should also not have an active bot associated to it.
Extended ECM supports bots that are triggered in Extended ECM either by events in
external business applications or by internal events in Content Server.
As Business Administrator user, you can configure events from different sources
which include external leading systems, for example, SAP SuccessFactors or
Salesforce, and internal Content Server related events.
You can configure bots containing a set of rule conditions and bots to be performed
in sequence. A bot is processed when the associated event is triggered. As Business
Administrator, you manage your bots in the Event Bots configuration.
For more information about selecting Content Server as source and internal
events, see OpenText Extended ECM - Enterprise Applications Integration and
Configuration Guide (EEP-CGI).
5. In the Event drop-down list, select an event available for your source. Note that
for your source each event can be selected only once. You can configure
multiple bots for your event.
The Event list is populated based on the registered Integration definitions
configured in “Configuring pre-defined events” on page 287 and “Configuring
custom integrations” on page 292.
1. To create a new bot, select your event. Click Add bot in the header or click Add
You can expand the rules with the Expression values and or or. Based on the
selected value, the subsequent rows will then get a fixed expression.
To add a bot, click Edit fields . From the drop down list, select your bot.
For more details about the supported bots, see “Configuring Extended ECM for
SAP SuccessFactors bots” on page 301.
5. Process mode
Run as – You must provide a user with which the bot shall be processed. Ensure
that this user has the required permissions.
Click in the Run as box and start typing the username. Select your user from the
list.
Process mode – By default all bots are executed in asynchronous process mode.
For each event bot, a scheduled bot will be created and executed. You can check
failed jobs in the Task Error Administration of the Distributed Agent
Dashboard.
Example: For an employee, a Change in Employee Location event has been triggered in SAP
SuccessFactors. If a bot has been configured for this event containing the Create Or Update
Workspace bot, the bot will be executed updating the respective employee workspace.
1. Click the Bots tab or scroll to the Bots section. Click Edit fields .
2. From the drop down list, select the Create Or Update Workspace bot.
Edit the following parameters:
– Event property
In the Value list, the event properties available for this event are listed.
Select your property.
– Event property
In the Value list, the event properties available for this event are listed.
Select your property.
Business Object Type – this is the business object type from SAP
SuccessFactors assigned to the Employee workspace type:
Source – Content Server Object
Value – sfsf:user
Business Object Key – this is the event property specifying the Employee
workspace ID:
Source – Event property
Value – userId
Business Object Type – this is the business object type from SAP
SuccessFactors assigned to the Candidate workspace type:
Source – Content Server Object
Value – sfsf:candidate
Business Object Key – this is the event property specifying the Candidate
workspace ID:
Source – Event property
Value – candidateId
Important
This bot will be displayed only when the central workspace concept is enabled,
see “Using central workspaces” on page 93.
This bot is only supported for Employee Central, Recruiting, and Onboarding
Events.
Example: For an employee, a Change in Employee Location event has been triggered in SAP
SuccessFactors. If a bot has been configured for this event containing the Create Or Update
Central Workspace bot, it will be executed updating the respective central workspace.
1. Click the Bots tab or scroll to the Bots section. Click Edit fields .
2. From the list, select the Create Or Update Central Workspace bot.
Edit the following parameters:
Business Object Type – this is the business object type from SAP
SuccessFactors assigned to the Candidate workspace type:
Value – sfsf:candidate
Business Object Key – this is the event property specifying the Candidate
workspace ID:
Value – candidateId
Example: For an employee, a Change in Job Title event has been triggered in SAP
SuccessFactors. If a bot has been configured for this event containing the Create Document
bot, the bot will be executed generating a corresponding document.
1. Click the Bots tab or scroll to the Bots section. Click Edit fields .
2. From the drop down list, select the Create Document bot.
Edit the following parameters:
• Document Type
Specify which document type should be assigned to the document to be
generated.
From the Source drop down list, select Content Server object.
Click in the Value box and click Browse to open the target browser.
Browse and select your document type.
• Create Document for – Specify the business property to be passed for
document creation, for example, applicationId.
From the Source drop down list, select Event property.
In the Value list, the event properties available for this event are listed.
Select your property.
• Document Context – Specify the document context for which you want to
create the document in Extended ECM PowerDocs.
From the Source list, select your context. You have the following options:
– User
– Candidate
– Job Application
• Effective Date – Specify the effective date for the document generation.
From the Source list, select Event property.
In the Value list, the event properties available for this event are listed.
Select your property.
• Business Object Type – Specify the business object for the generated
document, for example, user or candidate.
From the Source list, select Content Server object.
Click in the Value box and click Browse to open the target browser.
Browse and select your business object.
• Business Object Key – Specify the business object key for the workspace the
document will be stored in.
From the Source list, select Event property.
In the Value list, the event properties available for this event are listed.
Select your property.
You want to create a document for an employee workspace with the Create
Document bot triggered by an event in SAP SuccessFactors, for example, a
Location Change event. You select the following settings:
Business Object Type – this is the business object type from SAP
SuccessFactors assigned to the Employee workspace type:
Source – Content Server Object
Value – sfsf.user
Business Object Key – this is the event property specifying the Employee
workspace ID:
Source – Event property
Value – userId
To use personalized document generation, you must install and configure OpenText
Extended ECM PowerDocs. Documents can be generated for document templates
that are configured for the current user.
When Extended ECM PowerDocs is enabled for your role, you can generate
documents from the Documents tab of your workspace using the Extended ECM
PowerDocs editor. As an HR Administrator or Manager, you can also generate
documents for your team members. Alternatively, an employee can generate
documents in the Document Self Service widget.
This chapter describes the Extended ECM PowerDocs configuration steps specific to
Extended ECM for SAP SuccessFactors. For information about the overall
configuration steps required to set up Extended ECM PowerDocs, see OpenText
Extended ECM - Document Generation Customization Guide (EEDG-CGD).
Prerequisites
As part of the configuration, you must have an API connection user for
connecting to Extended ECM for SAP SuccessFactors.
As part of the configuration process, you must configure the OAuth connection
for document generation in Extended ECM for SAP SuccessFactors. See
“Configuring SAP SuccessFactors OAuth for Document Generation”
on page 151.
%20and%20%28status%20eq%20%27inactive%27%20or%20status%20
eq%20%27active%27%29
</xsl:text>
%20and%20%28status%20eq%20%27inactive%27%20or%20status%20eq
%20%27active%27%20or%20status%20eq%20%27active_external_suite%27%29
</xsl:text>
Before creating document templates, you must perform the business model
mapping from SAP SuccessFactors to Extended ECM PowerDocs. For details,
see OpenText Extended ECM PowerDocs - Content Manager Administration Guide
(CRMCM-AGD).
1. Log in to Content Manager and click Content > Templates > Add .
3. General section
Use the General section to configure the required basic template settings.
Important
If you change the business object for an existing template, the business
object filter settings and all defined subtemplates will cease to apply or
be used.
4. Document Control
Use this section to configure the settings for managing the document.
• Send directly – Select to enable the option to send the template directly from
the Extended ECM PowerDocs Select template dialog box without having to
first generate the correspondence.
Important
If Send directly is selected, it is not possible to process bundle
documents individually.
• Shared – When the Shared check box is selected, the template is only
generated once and used for all recipients whenever implicit form letters are
generated.
• Report – The report function makes it possible to use data records from
multiple business objects in a single template. In order to process the
corresponding data, you will need to use tables.
• Show e-mail configuration – This option enables the opening of the E-mail
configuration dialog box when sending an e-mail from PowerDocs. When
this option is not selected, PowerDocs sends the e-mail without opening the
dialog box if all required information has been provided already.
• Show printer selection – Select this option to force the printer configuration
dialog box to open when you click Print in Extended ECM PowerDocs.
• Single processing – Select this option to define that the post-processing for
subtemplates is different to the defined post-processing of the main
template. You only need to select this option for the main template for it to
be active.
• Number of copies – The number of copies that will be generated by default.
The user can specify a different number of copies in the Print dialog box.
5. Process control
Use this section to define all post-processing actions in Extended ECM
PowerDocs.
• Base process – Select the process that should be run as a basic process. The
basic process is not run with Cancel, Draft, or Sign.
• Channel – Channel for which the process is defined in the table.
Right-clicking on a channel opens the context menu, which in turn can be
used to set the channel as a favorite.
• Process – Select the process for the enabled channel. For example, for the
Central print channel, you can select Save to xECM for SuccessFactors
workspace-Pdf to save the document in PDF format, or Save to xECM for
SuccessFactors workspace-Docx to save as a Microsoft Word document.
• Custom button – Custom button for the enabled channel.
• Enrich data – This option can be used to manipulate data delivered from the
partner system.
6. E-mail configuration
Use this section to manage sending a document by email.
• Recipient path – The starting business object is preselected here and cannot
be changed.
7. Click Create and design and then design your template in the Content
Designer. For more details, see OpenText Extended ECM PowerDocs - Content
Manager / Content Designer User Guide (CRMCM-UGD).
1. Log in to Content Server. In the global menu, click Enterprise > Extended ECM.
Click Extended ECM for SAP SuccessFactors > Configure Module Specific
Settings.
In the Download Integration Configuration area, click Download for
PowerDocs Save to xECM Script to download the OpenText_PowerDocs_Save_
2_xECM_script.zip file. This ZIP file contains the latest PowerDocs Save2xECM
script.
3. Search for the Save to xECM from PowerDocs script and click Change .
Note the following options:
• if the script is still unchanged as delivered out of the box, compare and if
necessary, change the Business object IDs and then replace the script block.
• if the script has already been changed, compare it with the latest Save2xECM
script you have downloaded in step 1 and merge the changes. Replace the
script block with the merged one.
1. EmployeeDataObject
Existing: e2ddea3c-756e-4045-896a-7be5b72251f3
To update the Business object ID: click Content Settings > Business Objects
> (SuccessFactors) Employee Data.
2. userIdAttr
Existing: 0d367c4b-a729-48aa-8ea0-3928019acdfc
To update the Business object ID: click Content Settings > Business Objects
> (SuccessFactors) Employee Data > userId.
3. jobApplicationObject
Existing: a977476f-1ba4-41ab-8366-2995d1b1202e
To update the Business object ID: click Content Settings > Business Objects
> (SuccessFactors) Job Application.
4. CandidateIdAttr
Existing: 27f42120-2bdc-499b-a1de-15fa761f09bc
To update the Business object ID: Click Content Settings > Business
Objects > (SuccessFactors) Job Application > candidateId.
• userId – provide the name of the technical user created in Content Server.
This user must have the required login permissions.
Note: Document generation via the Take Action menu supports capture
of the Effective Date. To fetch the effective date during document
generation, add the following parameter to your URL:
enableEffectiveDate=true&.
Example: https://<CONTENTSERVER>/cs.exe?func=othcm.
NavigateToDocumentGenerationSystem&system=<EXTERNALSYSTEM_in_
CS>&boid=sfsf:user&userid=@PERSON_USER_ID@&otdsauth=
saml_<IDP>&enableEffectiveDate=true&
7. Click Save.
To configure the URL for candidate or job application document generation, use one
of the following formats:
You can scan documents directly to the employee workspace using OpenText™
Imaging Enterprise Scan.
Prerequisites
The following software components are required:
• Content Server
Content Server with the following modules must be installed:
Figure 18-1 illustrates the necessary permissions for sample groups based on
different locations.
Note the following:
• The sample groups Scanner_IN and Scanner_DE must have approved the See
and See Contents permission for the Employee Workspaces folder including the
folders that contain the individual employee workspaces. This setting allows
the scanner user to configure the root folder in the Enterprise Scan Client.
• The sample groups Scanner_IN and Scanner_DE must have approved the See
and Add Items permissions for the folder that contains the employee
workspaces for the respective location. This allows the scanner user to see the
employee workspaces based on the location in the Workspaces Integration
widget/web control.
The Add Items permission allows the scanner user to upload documents into
the 999 Inbox staging folder.
• To import the profile, open Enterprise Scan and go to Tools > Import
Configuration. Browse to the SAP_SuccessFactors_Scan_Profile.xml file
and open it.
• To update the Content Server root folder, go to SFSF_Profile_Archiving >
Archiving > Content Server. Select the folder for which the scanner user has
permissions to see employee workspaces.
• To test the configuration, scan the documents and select the Select Business
Workspace check box.
1. Go to Extended ECM > Extended ECM for SAP SuccessFactors > Configure
Module Specific Settings. In the Select Settings for Extended ECM
Operations area and in the Scan Classification box, browse and select
the Scanned Documentation classification.
For more information, see “Configure Module Specific Settings” on page 109.
2. Add the Scanned Document classification as a rule to all templates. To create a
rule for classifications, see “Customizing document completeness check and
validation rules” on page 63.
Miscellaneous tasks
• By default, the Enterprise Scan scanning profile contains an invalid scanner
location. To update the scanner location, go to File > Configure Scanner.
• If any errors occur during processing and archiving, the logging information can
be found in the IXClient.log file located at C:\Users\<username>\AppData\
Local\OpenText\Enterprise Scan\Log.
• The WebBrowser control opens the default user’s web browser when the user
selects the Business Workspaces check box.
Important
Do not change the values specified above for the Client ID and Redirect
URL.
1. If SAML 2.0 Authentication Handler has been configured in OTDS for SAP
SuccessFactors as identity provider, you can also click the Sign in with
button and log in via SAP SuccessFactors.
4. After Enterprise Scan has restarted, click the Tools tab > Content Server Sign
In.
You can transport the following settings from one Content Server to another:
Existing settings can then be used on another system or can easily be deployed in a
cloud environment.
3. Go to the location of the settings you want to transport. In the Function menu,
click Add to Warehouse.
4. In Add to Workbench, click Browse Content Server and select the workbench
that you have created previously.
Select the Included Objects check box. Click Add to Warehouse and then click
OK.
In Add Transport Package, provide a name for the transport and click Add.
Click OK to confirm.
1. Go to Enterprise > Transport Warehouse > Transport Packages. Click Add item
and select Transport Package.
Enter a Name for the transport package. Click Choose File and select the
transport item that you downloaded from the source system. Click Add and
then OK.
2. Go back to the newly created transport package and in its Function menu, click
Unpack.
3. In Unpack to, click Create New . Provide a Name for the new workbench and
click Add.
Click Unpack and then click OK.
For more information on transporting settings, see OpenText Content Server User Help
- Transport (LLESTRP-H-UGD).
See the following sections for information specific to the settings you wish to
transport.
1. In the source system, customize the Smart Document Types for your document
template. For details, see “Customizing document completeness check and
validation rules” on page 63.
2. Follow the steps in “Summary of transport process” on page 329. In step 3 of the
export process, go back to Enterprise > Document Templates > SuccessFactors,
and in the Function menu of your template, click Add to Warehouse.
3. Once you have deployed the contents of the workbench in the target system, go
to Enterprise > Document Templates. In the Function menu of the deployed
template, click Properties > Smart Document Type and check if the required
types have been transported properly.
1. In the source system, customize the OAuth settings. For details, see
“Configuring SAP SuccessFactors OAuth for Document Generation”
on page 151.
2. Follow the steps in “Summary of transport process” on page 329. In step 3 of the
export process, go back to Enterprise > Extended ECM > Extended ECM for
SAP SuccessFactors > Configure Document Generation Settings, and in the
Function menu for Configure SuccessFactors OAuth for Document
Generation, click Add to Warehouse.
Notes
3. Once you have deployed the contents of the workbench in the target system, go
to Enterprise > Extended ECM > Extended ECM for SAP SuccessFactors >
Configure Document Generation Settings > Configure SuccessFactors OAuth
for Document Generation and check if the settings have been transported
properly.
1. Add the Permission Propagation rules to the document template. For details,
see “Configuring access permissions from SAP HCM using Permission
Propagation” on page 270.
2. Follow the steps in “Summary of transport process” on page 329. In step 3 of the
export process, go back to Enterprise > Document Templates > SuccessFactors,
and in the Function menu of your template, click Add to Warehouse.
2. Follow the steps in “Summary of transport process” on page 329. In step 3 of the
export process, go back to Enterprise > Extended ECM > Extended ECM for
SAP SuccessFactors. In the Global Template Configuration Function menu,
click Add to Warehouse.
3. Go to Enterprise > Extended ECM > Extended ECM for SAP SuccessFactors >
Global Template Configuration and check the template has been transported
properly.
2. Follow the steps in “Summary of transport process” on page 329. In step 3 of the
export process, go back to Enterprise > Extended ECM > Extended ECM for
SAP SuccessFactors. In the Configure Module Specific Settings Function
menu, click Add to Warehouse.
3. Go to Enterprise > Extended ECM > Extended ECM for SAP SuccessFactors >
Configure Module Specific Settings and check the settings listed above have
been transported properly.
1. In the source system, configure the document workflow. For details, see
“Configuring document generation settings for Create Document widget in
Extended ECM” on page 153.
2. Follow the steps in “Summary of transport process” on page 329. In step 3 of the
export process, go back to Enterprise > Extended ECM > Extended ECM for
SAP SuccessFactors > Configure Document Generation Settings, and in the
Function menu for Configure Create Document for SAP SuccessFactors
Workflow, click Add to Warehouse.
3. Go to Enterprise > Extended ECM > Extended ECM for SAP SuccessFactors >
Configure Document Generation Settings > Configure Create Document for
SAP SuccessFactors Workflow, and check the settings have been transported
properly.
1. In the source system, configure your scheduled bots. For details, see
“Configuring Scheduled Bots“ on page 167.
2. Follow the steps in “Summary of transport process” on page 329. In step 3 of the
export process, go to Enterprise > Extended ECM. In the Scheduled Bots
Function menu, click Add to Warehouse.
3. Once you have unpacked the transport package in the target system, open the
selected workbench. At this stage you can select a workbench item and check
the options in the exported bot have equivalent values in the target system.
In this example, possible matches for the workspace IDs have been
identified in the target system, as indicated by the Possible match found
icon . You can accept these possible matches and deploy the bot, or you
can click Edit for each object and search for a more suitable match.
If no match is found for an object in the target system, as indicated by the
No match icon under Exists in instance. click Edit to configure the bot.
4. Go to Enterprise > Extended ECM > Scheduled Bots and check the bots have
been transported properly.
Categories
• SAP SuccessFactors
– OTHCM_DOC_Metadata_Categories
Document Categories
○ Date of Origin
○ Archive Date
○ Created By
○ Archived By
○ Task Number
– OTHCM_WS_Candidate_Categories
Address
○ Street
○ House Number
○ City
○ Postal Code
○ State
○ Country
Administration
○ Payroll Administrator
○ Payroll Administrator Description
○ Administrator for HR Master Data
○ Administrator for HR Master Data Description
○ Administrator for Time Recording
○ Administrator for Time Recording Description
Application Information
○ Date of Application
○ Deletion Date of Application
○ Keep record
○ Application Status
○ Region
Candidate Information
○ Candidate Id
○ Address
○ Address2
○ Anonymized
○ Anonymized Date
○ Candidate Locale
○ Second Name
○ Primary Phone
○ City
○ Consent to marketing
○ Contact Email
○ Country
○ Creation Date
○ Current Title
○ Data Privacy Id
○ External Candidate
○ First Name
○ Home Phone
○ Last Login Date
○ Last Modified Date
○ Last Name
○ Middle Name
○ Partner Member Id
○ Partner Source
○ Primary Email
○ Privacy Accept Date
○ Public Intranet
○ Share Profile
○ System User Id
○ Visibility Option
○ Zip
○ Job Application
• Job Application Id
• Job Requisition Id
• Job Title
• Last Modified
– OTHCM_WS_Employee_Categories
Address
○ Street
○ House Number
○ City
○ Postal Code
○ State
○ Country
Administration
○ Payroll Administrator
○ Payroll Administrator Description
Employment
○ Start of Employment
○ End of Employment
○ Work Contract
○ Work Contract Description
○ Reason For Leaving
○ Employment Status
Job Information
○ Company Code
○ Company Code Description
○ Personnel Area
○ Personnel Area Description
○ Employee Group
○ Employee Group Description
○ Employee Subgroup
○ Employee Subgroup Description
○ Organizational Key
○ Business Area
○ Business Area Description
○ Personnel Subarea
○ Personnel Subarea Description
○ Legal Area
○ Payroll Area
○ Payroll Area Description
○ Cost Center
○ Cost Center Description
○ Organizational Details
• Organizational Unit
Personal Information
○ User ID
○ Assignment Type
○ User Name
○ Last Name
○ First Name
○ Second Name
○ Name at Birth
○ Title
○ Gender
○ Date of Birth
○ Country of Work
○ Birthplace
○ Nationality
○ Number of Children
○ Personnel Number
○ Personnel ID Number
○ E-Mail
○ Phone Number
○ Mobile Number
○ Location
○ Profile Type
• SAPCMIS Types
– cmis.type
– SAP Base
– SF Candidate
– SF Company
– SF Document
– SF Email Template
– SF GDPR Info
– SF Job Application Interview
– SF Job Application
– SF Job Offer
– SF Job Requisition
– SF Library
– SF Mentoring Program
– SF Offer Letter
– SF Onboardee
– SF Person
– SF Session
– SF Transcript
– SF User
Classifications
• DocumentType Classifications
– Accident
– Accident Insurance
– Accident Insurance Beneficiary
– Acting/Up Allowance
– Address
– Advanced/Off-cycle Payment
– Annual Payroll Report
– Application Documents
– Appraisal
– Background Check
– Bank Account Details
– Birth/Adoption Certificate 24 AM
– Child Allowance
– Clothing, Shoes
– Company Car - Allowance
– Company Car - Correspondence
– Company Car - Invoice
– Company Car - Tax Treatment
– Company Credit Card
– Company Pension Annual Confirmation
– Company Pension Contribution Calculation 24 AM
– Company Pension Correspondence
– Company Pension Individual Arrangement
– Company Pension Performance Information
– Company Policy Agreement
– Company/Personal Car - Policy Agreement
– Criminal Record
– Daily Allowance (Sales Force)
– Data Protection/Confidentiality
– Dental Insurance
– Dependent Care
– Developmental Assignment/Secondment
– Disability Classification
– Disability Correspondence
– Disability Leave
– Disability Subsidy (Application/Conf.)
– Disciplinary/Grievance Documentation
– Downgrade
– Driver License
– Employee Death
– Employee Referral Bonus
– Employee Separation Terms & Conditions
– Employment Contract
– Employment Contract/Offer Letter
– Employment Letter
– Entry/Orientation Checklist
– Exit Checklist/Leaver Request
– Exit Interview
– Expat - Balance Sheet
– Expat - Children Schooling
– Expat - Intl. Assignment Per Diem
– Expat - Net Payout Calculation/Gross up
– Expat - Payroll Instruction
– Expat - Permanent Housing
– Expat - Relocation
– Expat - Spousal Support
– Expat - TAF/LOU
– Expat - Temporary Housing
– Expat - Utilities Reimbursement
– Family Events (Wedding, Funeral, etc.)
– Flexible Benefits Correspondence
– FMLA/Qualified Leave
– Garnishment
– Home/Teleworking Arrangement
– Incentive/Equity
– Interview Documents/Notes
– Lateral Move
– Law Case Documentation
– Legal Entity Change (only)
– Legal Representation
– Life Insurance
– Life Insurance Beneficiary
– Loan Agreement
– Local Employee - Children Schooling
– Local Employee - Relocation
– Long Term Incentive
– Manufacturing-related Compensation
– Marital Status/Name Change
– Maternity/Paternity/Parental/Adoption
– Medical Check Confirmation
– Medical Insurance
– Merit/Union Salary Increase
– Military/Civilian Leave
– Mobile Phone Policy Agreement
– New York State Wage Notification
– Off Cycle Change in Pay (PiR, Graduate)
– Off Cycle Equity Award
– Offer Letter
– Optical Aid
– Other Benefits
– Other Leave (Bereavement, Jury, etc.)
– Other One-off Payments
– Other Recurring Payments (Funct. Allow.)
– Overtime Compensation
– Parental Part Time “parental leave ”
– Parking
– Passport/ID Card
– Payroll Deduction
– Pension Deferral Program Correspondence
– Performance Award
– Performance Conversations (YE, MY)
– Performance Improvement Plan
– Vacation
– Warning Letter
– Work Permit/Eligibility/Visa
– Workers Comp/Occupational
– Working Time/Pay Adjustment
– Working/Shift Pattern Change
– Works Council Documentation
• WS_Employee_Classification
–
Folders
– Business Workspaces
○ Employee Workspaces
– Workflows
○ Delete Workflow
Workspace Types
• Employee
• sfsf.candidate
• sfsf.person
• sfsf.user
• sfsf.onboardee
20.1.1.2 othcm_central_wstemplates.zip
Pre-defined package of objects that facilitates creation of sample workspace
templates with relevant document folder structure for the Central Workspace
design. This package also includes application interface perspective for HR
personas.
Document Templates
• OTHCM_Employee_WS_Template_Europe
010 Hiring & Onboarding
030 Employment
– 040.010 Disciplinary/Grievance
– 040.020 Union
– 040.030 Works Council
– 070.010 Transportation
– 070.020 Mobile Phone
– 070.030 Non-statutory Insurance
– 070.040 Other Benefits
– 070.050 Company Credit Card
– 080.010 Training
– 080.020 Policies
090 Pension
999 Inbox
– –
Employment Workspaces
– –
• OTHCM_Employee_WS_Template_NA
010 Hiring & Onboarding
030 Medical
– –
040 Employment
– 050.010 Disciplinary/Grievance
– 050.020 Union
– 080.010 Transportation
– 090.010 Training
– 090.020 Policies
999 Inbox
– –
Employment Workspaces
– –
• OTHCM_Employee_WS_Template_OTHERS
010 Hiring & Onboarding
030 Medical
– –
040 Employment
– 040.080 Performance
– 040.090 Reference Letter
– 040.100 Payroll
– 040.110 Time & Attendance
– 050.010 Disciplinary/Grievance
– 050.020 Union
– 050.030 Works Council
– 0050 40.040 Law Cases & Information
– 080.010 Transportation
– 080.020 Mobile Phone
– 080.030 Non-statutory Insurance
– 080.040 Other Benefits
– 080.050 Company Credit Card
– 090.010 Training
– 090.020 Policies
100 Pension
Employment Workspaces
– –
• OTHCM_Employment_WS_Template_Europe
010 Employment Contract
– –
– –
– –
– –
– –
– –
– –
080 Performance
– –
– –
100 Payroll
– –
– –
– –
• OTHCM_Employment_WS_Template_NA
010 Employment Contract
– –
– –
– –
– –
– –
– –
– –
080 Performance
– –
– –
• OTHCM_Employment_WS_Template_OTHERS
010 Employment Contract
– –
– –
– –
– –
– –
– –
– –
080 Performance
– –
– –
100 Payroll
– –
– –
– –
Perspectives
20.1.2 saphcm.zip
Pre-defined package of objects that facilitates sample integration with SAP HCM.
• Employee (BUS1065)
Document Templates
• OTHCM_Employment_WS_Template_Europe
OTHCM_Employment_WS_Template_NA
– 080 Performance
– Primary Assignment
OTHCM_Employment_WS_Template_OTHERS
– 080 Performance
– 100 Payroll
– Primary Assignment
• sfsf.user
20.1.3.2 SAPCMIS_Categories.zip
Pre-defined package of objects that includes the CMIS Categories relevant for
business integration with SAP SuccessFactors, intended for customers upgrading
from old versions to SAP SuccessFactors 1902 and later.
Categories
• SF Company
• SF Mentoring Program
• SF Onboardee
• SF Session
• SF Transcript
• SF User
SFSF Candidate
SFSF Candidate business object is used to get the Candidate entity data.
Work Schedule
SFSF PerPersonal
The SFSF PerPersonal Information business object is used to get the PerPersonal
entity data.
20.3.2 Relations
Employee Data to Employment Information
This relation is used to fetch employment data using the User entity.
20.3.3 Templates
Employment Contract
The Employment Contract template is built on the User context. An employment is a
contract between the employee and the employer. All employees have at least one
regular employment contract with the organization which has hired the employee
and where the employee goes through the employee life cycle until termination.
Employment Letter
The Employment Letter template is built on the User context.
Offer Letter
The Offer Letter template is built on the Candidate context.
Note: This template can be used only if the candidate has one application and
offer released.
Field Test – EC
This template is a sample template containing several text blocks which contain
multiple attributes. It will return the data using the SAP SuccessFactors User entity.
Payment Compensation
Download Docx
This process is used to download MS Word documents.
Name Operator
Document Ready DocumentReady
Download PDF
This process is used to download a document as PDF file.
Name Operator
DocumentReady DocumentReady
PDF Convert
Name Operator
Convert PDF Document Processor
PDF Merge
This process is used to merge PDF documents.
Name Operator
Merge PDF Document Processor
Name Operator
PDF Convert Document Processor
Save to xECM from Document Processor
PowerDocs
Send Email
Name Operator
Convert mhtml EnterpriseConverter
Send Email MessageSender
Name Operator
Create HTML EnterpriseConverter
Convert PDF EnterpriseConverter
Name Operator
LoggedIn User Data Processor
20.3.6 Scripts
Enrich Logged In User
This script is used to get the user details from partner system SAP SuccessFactors.
PDF Convert
This script is used to convert documents to PDF format.
PDF Merge
This script is used to merge PDF documents.
WS Request URL
This script is used to prepare the OData API to fetch the data for the main entity.
WS Response Previous
This script is used to format the response.
WS Response Many
This script is used to format the response.