OpenText Extended ECM For SAP Solutions CE 21.4 - Customizing Guide English (ERLK210400-CGD-En-03)
Topics covered
OpenText Extended ECM For SAP Solutions CE 21.4 - Customizing Guide English (ERLK210400-CGD-En-03)
Topics covered
Solutions
Customizing Guide
ERLK210400-CGD-EN-03
OpenText™ Extended ECM for SAP® Solutions
Customizing Guide
ERLK210400-CGD-EN-03
Rev.: 2021-Dec-13
This documentation has been created for OpenText™ Extended ECM for SAP® Solutions CE 21.4.
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
One or more patents may cover this product. For more information, please visit https://www.opentext.com/patents.
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 Solutions .......... 15
1.1 What is new .................................................................................... 15
1.2 Related documentation .................................................................... 16
Business A business workspace in Content Server contains content that is relevant for a business
workspaces, object. From Content Server side, users can easily view the data of this business
cases and
binders
object. From the business application, users can access Content Server items in the
business workspace without leaving their system. To make full use of the Content
Server functionality, not only business workspaces but also cases and binders can be
configured for Extended ECM for SAP Solutions.
Business In addition to the content that is stored in a business workspace for a business object,
attachments users can connect additional documents as business attachments to a business object.
Business rela- Extended ECM for SAP Solutions provides tools to illustrate a relationship between
tionships business workspaces. For example, a hierarchical relationship between business
workspaces can be displayed in a sidebar widget of a business workspace.
“SAP: Declaring SAP DMS documents using batch operations”, page 478
You can now use batch operations to declare large numbers of SAP DMS
documents.
OpenText Extended ECM for SAP Solutions - Installation and Upgrade Guide (ERLK-IGD)
The Installation Guide describes the installation and upgrade of Extended ECM
for SAP Solutions up to the point where the connection between SAP and
Content Server is established.
OpenText Extended ECM for SAP Solutions - Customizing Guide (ERLK-CGD) (this
guide)
The Customizing Guide describes how to customize SAP and configure Content
Server for Extended ECM for SAP Solutions functionality.
OpenText Extended ECM for SAP Solutions - User Management and Access Control
Scenarios (ERLK-CUM)
This guide discusses user management and access control scenarios.
OpenText Extended ECM for SAP Solutions - User Guide (ERLK-UGD)
The User Guide describes how to use Extended ECM for SAP Solutions
functionality in both SAP and Content Server. This guide is also available as
online help.
OpenText Extended ECM for SAP Solutions - Installation Guide for Microsoft Windows
with Microsoft SQL Server (ERLK-IWS)
This specific Installation Guide describes the setup of one architecture scenario
for Extended ECM for SAP Solutions with Microsoft SQL Server as database.
OpenText Extended ECM for SAP Solutions - Installation Guide for Microsoft Windows
with Oracle Database (ERLK-IWO)
This specific Installation Guide describes the setup of one architecture scenario
for Extended ECM for SAP Solutions with Oracle as database.
OpenText Extended ECM for SAP Solutions - Installation Guide for SAP HANA (ERLK-
IWH)
This specific Installation Guide describes the setup of one architecture scenario
for Extended ECM for SAP Solutions with SAP HANA as database.
OpenText System Center Manager - Installation and Configuration Guide (SYSCM-IGD)
OpenText™ System Center simplifies the installation, configuration, patching,
and updating of supported OpenText software applications.
OpenText Extended ECM for SAP Solutions eBook
The eBook describes the key concepts and capabilities of Extended ECM for SAP
Solutions.
Release Notes The Release Notes describe the following aspects in detail:
The Release Notes are continually updated. The latest versions of the Extended ECM
for SAP Solutions Release Notes is available on OpenText My Support: Extended
ECM for SAP Solutions (https://knowledge.opentext.com/knowledge/llisapi.dll/
Open/67811874).
2.1 Concepts
2.1.1 Business objects
A business object is the representation of a real-life entity in a business application.
For example, a business application for Enterprise Resource Planning (ERP)
maintains business objects for products, orders, deliveries and so forth. Every
business object is defined by a set of attributes and by its relations to other business
objects.
Content is visible in the Documents tab. You can have a dedicated folder structure
for each workspace type.
The layout of this business workspace is defined by a perspective, which you can
design for each business object. A perspective can also be specific to a role or to a
device.
Relationships are created and maintained in the SAP system and transferred to
Content Server through the property provider, thus, additional coding may be
required.
Composite business workspaces are used for complex business objects in an SAP
system, which contain dependent entities that cannot stand alone. For example, in
the SAP Plant Maintenance module, a task list operation can only exist in the context
of a task list. This mandatory relation can be mirrored by composite business
workspaces where each sub-entity has a separate business workspace inside its parent
business workspace. This feature is recommended for cases where dependent
business objects are involved.
Example: When a business workspace for a maintenance task list is created from SAP side,
either manually or automatically, business workspaces for all operations are created
automatically inside the task list’s business workspace.
Note: For the composite business workspace scenario, you need a property
provider that supports composite business workspaces. For more information,
see the SAP Extended ECM Solution Accelerator for SAP PM which is available
in OpenText My Support (https://knowledge.opentext.com/knowledge/cs.dll/
Open/SAP_PM__Plant_Maintenance__Blueprint).
For more information, see Section 3.26: “Enabling composite business workspaces”
on page 165.
From Content Server perspective, a user adds a business object to an item in Content
Server. Users can then view the business object information in Content Server
without the extra effort of accessing the SAP system and logging on to it.
From the SAP system, the document is a business attachment in the Business Content
window of the business object. SAP user can access the document without leaving
the SAP system.
Your company maintains several different oil pumps. All oil pumps share the
same manual. You store the oil pump manual in Content Server and add this
document as business attachment to the pumps’ business objects.
In Content Server, you see all oil pumps that use this manual. In other words,
you see which business objects are added to this document.
In SAP, you see the manual attached to each pump business object in the
Business Content window.
In Content In Content Server, business objects are displayed in a tab in the properties of
Server Content Server item. With sufficient permissions, you can display the business
object, edit it or remove the link. If available, you can access the related business
workspace.
In SAP GUI, business attachments are displayed in the Business Content window.
Types of creation
• Manually created on the SAP system, either with the SAP GUI or the Web UI by
adding a business attachment
On an SAP system, users have different options, depending on the system and the
user interface, for example the Business Content window (Figure 2-5), or a button in
the Web Client UI (Figure 2-6).
Automatic adding is triggered when a certain category attribute has a defined value.
You configure, which attribute triggers the creation, and which attributes determine
the target business object.
The category attribute that triggers the automatic adding must deliver true or
false (Boolean). You can reach that by creating an attribute with type Flag:
Checkbox. This provides the information checked or unchecked. In addition,
another attribute contains the business object ID to which the Content Server item
will be attached to automatically. The business object type is defined in the business
object type configuration where you define the automatic adding.
A Content Server item has got the category that contains both attributes: Attribute
for triggering and attribute with business object key. The automatic attach function
will be executed, if this trigger attribute has got the value true or checked. This
Content Server item is now automatically attached to the business object instance
that was defined by ID & type.
For more information, see “Content Server: Configuring the automatic adding of
business objects” on page 196.
SAP ArchiveLink is a standard SAP service, which links archived documents to the
respective document object in SAP. With OpenText Extended ECM for SAP
Solutions you also create a record in Content Server, where you can apply additional
document management features like Records Management.
Print lists are generated by reports in the SAP system. They can be archived using
the standard ArchiveLink functionality.
SAP DMS is the document management system of an SAP system. With OpenText
Extended ECM for SAP Solutions you also create a record in Content Server.
Note: If you plan to make documents and print lists available in business
workspaces, you also must configure the system for the use of business
workspaces before you can configure document declarations. For more
information, see section 23.18 “Preparing document declaration” in OpenText
Extended ECM for SAP Solutions - Installation and Upgrade Guide (ERLK-IGD) and
“Configuring business workspaces“ on page 49
Records Management
Records Management ensures that content is under a formal program that provides
consistent control and lifecycle management rules. This includes capabilities to
define content retention policies in addition to formalizing the procedures to classify
(ensuring appropriate metadata), retain, destroy or archive content in Extended
ECM for SAP Solutions.
As you add a document to Content Server, the object and its content can be classified
and managed as a record, based on metadata, retention schedule, or vital record
status. In addition, administrators can set up the metadata fields desired for
population during record declaration. This can be accomplished through categories
and attributes. Categories and attributes are additional metadata that are applied
based on the specific business needs and processes.
Extended ECM for SAP Solutions allows you to declare an SAP ArchiveLink
document and print lists as records that are under control of Records Management.
For more details on declaring records in OpenText DocuLink for SAP Solutions, see
OpenText DocuLink for SAP Solutions - User Guide (DC-UGD).
• Its own home page called Departmental Page as starting point, which is related to
a department.
• Business workspace types and templates for the respective business domain.
• Specific categories and attributes.
• A Smart View configuration.
• Predefined domain specific workflows, for example, an approval workflow.
• Roles and groups with scenario-specific permissions.
Business Scenarios are part of the OpenText Cloud offering starting with version
21.4. If you want to use a Business Scenario on your existing system, you can obtain
the transport files and deploy them with Transport Warehouse.
1. Upgrade your Content Server to version 21.4. For more information, see
OpenText Content Server - Upgrade Guide (LLESCOR-IUP).
2. From OpenText My Support download the transport packages.
3. Use Transport Warehouse to deploy a Business Scenario.
5. Connect a user directory and add your users to the Business Scenario groups.
For more information, see the technical specification.
6. Provide a link from the users’ landing page to the departmental page of their
Business Scenario.
The Enterprise Asset Management Business Scenario is prepared for two separate
maintenance processes which you can use with the delivered sample business
application. As well, these processes are aligned to processes in your existing SAP
business application:
• Corrective Maintenance
• Preventive Maintenance
• Employee
The employee requests a maintenance task. Maintenance notifications to
document an issue and notify maintenance department about an abnormal or
exceptional situation(s) in technical objects at the plant is provided.
• Maintenance planner
The maintenance planner plans inspections and maintenance operations. Task
lists to standardize the maintenance process and create maintenance orders with
the documentation that is required are provided to perform the maintenance for
example, for recurring activities.
• Maintenance technician
The maintenance technician performs routine maintenance and helps to
troubleshoot. Maintenance orders with operations that contain important
information about spares, procedures and tools required for the work are
provided. Results of the maintenance can be filed in the operations.
• Business administrator for Enterprise Asset Management
You configure the Enterprise Asset Management scenario in Extended ECM
according to the needs of the process. You maintain the departmental page for
Note: In the Enterprise Asset Management Business Scenario, all users can
access DMS originals in the related business workspaces folder of the
maintenance notification.
Departmental This page is created especially for each role in the Enterprise Asset Management
Page Business Scenario. It is the starting point for the roles employee, maintenance
planner, and maintenance technician.
For more information about the sample application, see “Enterprise Asset
Management Business Scenario sample application” on page 31. For more
information on how to integrate the Enterprise Asset Management Business Scenario
into your SAP system, and how to configure it, see “Setting up Business Scenarios“
on page 251.
• Material (BUS1001006)
• Equipment (EQUI)
2.2.2 Teamspaces
The Teamspaces Business Scenario is easy to use for all kinds of collaboration within
teams. The business workspaces of Teamspaces help you cooperate effectively.
Teams can share knowledge and content, discuss, and collaborate.
Departmental Page
This page is the starting point. Users can create a new Teamspace here and find
other Teamspaces, for which they have the permission, and the documents they
contain.
Teamspaces
Teamspaces are sharing spaces. Users can upload files from their local hard
drive or their personal cloud to the Teamspaces folders. They can add folders or
rename them.
Discussions
Users can use the Discussions in their Teamspace. They can ask questions, get
answers, and all team members are informed as well.
File Sharing
Users can share files with people outside your company through OpenText Core
Share.
Team Roles
Teamspaces keep it simple: A team member has full access to all content. A
guest can only read the information, but not edit or delete it.
2.2.3 Projects
The Projects business workspaces support your project management in each project
phase.
Departmental Page
This page is the starting point. Users can create a business workspace for their
project here. They find other projects and the documents they contain. They also
get an overview over existing projects and their project managers.
Projects
Projects are sharing spaces. Users can upload files from their local hard drive or
their personal cloud to the business workspace. They can add folders or rename
them.
Phases
Phases structure a project. You can have any number of Phases business
workspaces in a Projects business workspace. They are located in the folder
named "09 Phases" and can only be created here. Users can maintain milestones
in a Phase.
Discussions
Users can use the Discussions in their Project. They can ask questions, get
answers, and all team members are informed as well.
Team Roles
Projects keep it simple: A team member has full access to all content. A guest can
only read the information, but not edit or delete it.
2.2.4 Agreements
The Agreements business workspaces support your contract management. They
help you to keep track of contracts and master contracts.
Departmental Page
This page is the starting point. Users can create a business workspace for
business partners, contracts, and master contracts here.
Business Partner
The business partner is the central point of the Agreements Business Scenario. In
the business partner workspace, users see all contracts and master contracts that
they have signed with the business partner.
To create a business workspace for an agreement with this business partner,
users start a workflow here.
Contract
You can have different types of contracts: Sales or purchase contract, non-
disclosure agreements, or other types. A contract can be part of a master
contract, it can also stand alone. In either way, it is related to the business
partner.
Master Contract
The master contract sets the framework for a business relationship. It is related
to the business partner and to other, more detailed, contracts.
Discussions
Users can use the Discussions in their business workspace. They can ask
questions, get answers, and all team members are informed as well.
Team Roles
Agreements keeps it simple: Roles include Legal staff and Administrative staff.
They have full access. A guest can only read the information, but not edit or
delete it.
Business Scenario transport packages are available in your Content Server after
installing version 21.4 or later.
1. Use the following URL structure and replace the <name> variable with the
Business Scenario name.
2. https://otcs.example.com/cssupport/xecmpf/transport/<Transport_
Name>
Tip: You can also download the ZIP file that contains the transport
packages from OpenText My Support.
1. Extract the ZIP file that you downloaded from My Support and import each of
the transport packages that it contains separately.
2. In Content Server, navigate to Enterprise > Transport Warehouse.
3. Click Add Item and select Workbench.
4. Provide a name and click Add.
5. Click the Transport Packages folder.
6. Click Add Item and select Transport Package.
7. Click Choose File, select the package, and click OK.
1. On the Transport packages screen, click the transport package ZIP file.
2. Click Unpack to workbench.
3. In the next screen, click Browse Content Server and select the workbench you
added before.
4. Click Unpack, and in the next screen, click OK.
5. Click Deploy workbench to deploy all objects.
6. Click Deploy and confirm your selection.
Note: The following instruction applies to all Business Scenarios. Replace the
<BusScen Name> variable with the Business Scenario name.
1. Sign in to Extended ECM as a Business Administrator, and import all the above
packages into Transport Warehouse.
• The <BusScen Name> Setup WebReport creates the required user Scenario
Owner and the groups Scenario Owner Group, Background Processing,
OT Teamspaces User and OT Business Administrators (Teamspaces).
• The Basic Setup WebrReport is called by the WebReport <BusScen Name>
Setup. Do not start the Basic Setup WebReport directly.
5. Click the <BusScen Name> Setup WebReport, provide the password for the
Scenario Owner user, and then click Run Report.
• Folder structure
• Team roles
• Folder permissions
• Categories and attributes
• Group replacements
• Classifications
To help users find sub-items of a business workspace, not just the business
workspace, you index these sub-items with the same metadata as the business
workspace. This setting is located in the workspace type. For more information,
see “Indexing documents and other items with business workspace attributes”
on page 417.
You should have a clear picture who needs access to what and what kind of access
before you set up the permissions in Content Server. The permission concept ideally
is simple to implement and simple to maintain. It should follow some basic rules
and ideally does not contain exceptions.
Extended ECM adds the following access control concepts to the standard Content
Server permission concept:
You can only use attributes on business workspace level for group replacement
definition.
For more information, see “Defining group replacement settings” on page 124.
Enable indexing
Indexing applies the category attributes of the business workspace to all sub-
items in the business workspace and makes them findable. For more
information, see “Indexing documents and other items with business workspace
attributes” on page 417.
• Use a meaningful grouping criteria and descriptive folder names. Users need
to understand to which folder they have to navigate.
• Although there are no hard limits for how many workspaces can exist in a
single folder, you should ensure that the folder size is not adversely affecting
performance while adding or accessing workspaces. It depends on the
system resources. Storing millions of workspaces inside one single folder
may cause a performance decrease for the workspace creation, and
subsequential higher efforts for database tuning.
• You can avoid performance loss and make better use of different threads, if
you created workspaces in different folders rather than only one.
• While latest Content Server versions have improved the performance for
handling large folders, there are still scenarios where the performance of
large folders have negative impact on system performance. For example,
when pagination is enabled, and if a user wants to access sequential pages
the performance of a very large folders will not be ideal.
You can create your sub-folder structure based on attributes. In the workspace type,
you can create a pattern for the sub-folder name, and it can contain values of an
attribute. For more information, see “Using patterns for the location path”
on page 84.
If you use a pattern with attributes, you must mind the following:
1. Define an SAP event to the business object, which triggers the workspace
creation. You can, for example use the CREATE event, to create a business
workspace when a business object is created. Extended ECM provides function
modules for this method for use in real-time and in asynchronous mode.
For business objects that have frequent changes, it is probably better to use the
asynchronous receiver function module, whereas business objects, which are
rarely changed, for example business partners, can be updated in real-time. For
more information, see “Configuring events for business workspaces and
business attachments“ on page 199.
2. Plan regular batch reports in the SAP system to create business workspaces
periodically and in bulks.
You can use these two techniques side by side: Create business workspaces for new
business object in off hours to reduce the system workload, and use the CHANGE
event to update changes in the metadata immediately to Content Server.
– Best Practices Oracle for OpenText Content Server 10.5 and 16 ( http://
knowledge.opentext.com/knowledge/cs.dll/Overview/64127492)
– Best Practices SQL Server for OpenText Content Server 10.5 (http://
knowledge.opentext.com/knowledge/cs.dll/Overview/61019094)
• The Content Server threads might need to be increased based on the number
of parallel SAP threads you are scheduling. Make sure you have increased
the number of threads of the Content Server instance, which consumes the
ECMLink web service requests.
• Disable category inheritance on template level unless you have decided
otherwise for good reasons.
• Reduce auditing during creation: On the Administration page, click Core
System - Feature Configuration > Event Auditing > Set Auditing Interest
and disable the option Audit an "Attributes Changed" event for Category
Attributes modified during item creation
If you are using group replacement, you can also clear the event Permissions
Changed for the initial load phase.
• Disable the Recommender Agent: On the Administration page, click
Recommender Administration > Configure Recommender System Settings.
Clear the checkbox in the Enable section.
• If you are running the initial load before productive users work on it, you
can disable the index processes during the initial load phase: On the
Administration page, click Search Administration > Open the System
Object Volume > Enterprise Data Source Folder. From the function menu of
the Enterprise Data Flow Manager, select Suspend. Remember to resume
the process.
• If Content Server instances are also used for running agent processes, you
can consider disabling agent processes, especially the distributed agent,
which is used for processing facets and custom columns. To disable the
agent, edit the following section in the opentext.ini file:
[loader]
load=sockserv;agents;notify;wfagent;wrscheduleagent;wrcollectionagent
load_daagent=daagent
load_distributedagent=distributedagent
load_relagent=relagent
load_verify=verifyAgent
changed into
[loader]
load=sockserv
#load_daagent=daagent
#load_distributedagent=distributedagent
#load_relagent=relagent
#load_verify=verifyAgent
• Run the scheduled background job for the initial load of business workspaces
• Using the asynchronous queue to create and update business workspaces
• If the workspace creation and update requests are triggered by an SAP event,
you may consider to create a new logical destination with this technical user to
receive the events.
The technical user must have the required SAP roles and Content Server
permissions to create or update business workspaces. Business workspaces that are
created by background jobs with a technical user, will have this user as owner of the
business workspace.
3. Navigate to the OpenText Extended ECM for SAP Solutions structure and
open it.
If an SAP system displays a different IMG structure rather than standard reference
IMG, the Extended ECM for SAP Solutions customizing is not visible. You have the
following options to access the Extended ECM for SAP Solutions customizing
structure:
• Use transaction SIMGH, save the Extended ECM for SAP Solutions IMG structure
as a favorite and call it from there.
• Add the Extended ECM for SAP Solutions customizing to the existing
customizing structure of transaction SPRO.
2. In the IMG structure field, open the search help and search for the search term
OpenText*. With this search term, you also find IMG structures for other
OpenText products.
3. Double-click on entry.
5. In the Favorites list, select one entry, and then click to access the IMG
structure.
a. In the IMG structure field, select the IMG structure that is currently
displayed in the SPRO transaction and which you want to enhance.
For example, in SAP Extended Warehouse Management, select the IMG
structure SAP - Implementation Guide.
b. Click Favorite to add the IMG structure to your favorites.
c. Select the IMG structure in the Favorites list by double clicking.
d. If not already done, in field Enhancement ID, select the enhancement ID
created in Step 1.
e. Click Enhance Structure.
f. Select the root node of the IMG structure.
g. From the menu, select Edit > Nodes > Insert IMG Structure > As Subnode.
h. Enter the node name for the customizing, for example OpenText Extended
ECM for SAP Solutions.
i. Click Find structure to search for the Extended ECM for SAP Solutions
customizing IMG structure. Search for OpenText - Extended ECM for SAP
Solutions.
j. Click Copy.
k. Click Save.
3. Enhance the SAP IMG structure for Archiving and Document Access:
Repeat the steps described in Step 2 for the OpenText Archiving and Document
Access customizing with the corresponding data:
• Name of the node: OpenText Archiving and Document Access for SAP
Solutions
• Name of the IMG structure: OpenText Archiving and Document Access for
SAP Solutions
1. On the global menu, click Enterprise > Extended ECM, and then click
Connections to Business Applications (External Systems).
3. Specify the parameters for your business application according to the list below.
4. Click Add.
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 give further information.
Base URL
Enter the common URL for accessing the business 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.
For example, https://r3d5g.example.com:44300
Application Server Endpoint
Specify the URL that will be called to obtain business object information.
– The Content Server user who is assigned to this user needs reading
permission on the unique names.
– Based on the customizing, the property provider in the SAP system
needs to resolve one or more unique names.
Note: You can only test the connection after you have configured the SPI
service in the business application accordingly and have saved the
configuration.For more information, see section 22.2.4 “Configuring the
Service Provider Interface service” in OpenText Extended ECM for SAP
Solutions - Installation and Upgrade Guide (ERLK-IGD).
System Name
Enter localized names for the business application if required.
This chapter explains how you customize your system so that business workspaces
can be created, manually or automatically.
• Business administration access to Content Server. The rare cases where you need
system administration access are indicated.
• Customizing access to the SAP system.
Note: Other optional steps, like the automatic creation of business workspaces,
are not listed in this short list.
2. SAP IMG – The business object declaration defines an SAP business object for
Extended ECM. Create a business object declaration for a business object type,
and activate it.
For more information, see “Creating a business object declaration in SAP”
on page 54.
3. Content Server – Create a classification and the root folder for business
workspaces.
Requires access rights to the classification volume and to the folder, in which
business workspaces will be created.
For more information, see “Creating a classification for workspace templates
and location” on page 63 and “Creating a root folder for the business
workspaces” on page 64.
4. Content Server – Create categories for the metadata of the SAP business object.
Requires Business Administration Data Policies usage privilege and Category
object privilege.
For more information, see “Creating a category for workspace type and
business object type” on page 61.
6. Content Server – Create a workspace type, which controls the layout of the
business workspaces of this type.
Requires Business Administration Business Workspaces usage privilege.
For more information, see “Creating a workspace type” on page 65.
7. Content Server – Define the document template for the workspace type. The
workspace template name is what users see in the Add dialog when they create
a new business workspace.
Requires system administrator’s access to define that a template can be created
for the Content Server subtype business workspace (type 848). Requires access
to Document Templates volume to create new templates.
For more information, see “Defining a workspace template” on page 111 or
“Defining a workspace template in Smart View” on page 131.
9. Optional SAP IMG – For automatic workspace creation and update when SAP
business objects are created or changed: In the SAP system (IMG), maintain the
receiver modules.
For more information, see “Configuring events for business workspaces and
business attachments“ on page 199.
10. Optional Content Server – Define general access restrictions for workspaces.
For more information, see “Granting usage privileges to users” on page 150
and section 6.1 “Defining general restrictions on Content Server” in OpenText
Extended ECM for SAP Solutions - User Management and Access Control Scenarios
(ERLK-CUM).
12. Optional SAP IMG – Customize the search help in SAP. For more information,
see “Customizing the search help in SAP” on page 153.
• “Configuring how users can copy or move business workspaces” on page 191
• “Checking the appearance of the SAP integration” on page 167
4. Add the Business Administrators group and grant the required permissions up
to and including the Delete permission. Make sure the Delete permission is
only for sub-items not for the root folder, for example for the categories but nor
for the Categories volume.
• ActiveView
• Appearance
• Category
• Category Folder
• Classification
• Custom View
• LiveReports if you want to configure widgets, which use LiveReports
• WebReports if you want to configure widgets, which use WebReports
• License metering if you want to run the License report.
• If you do not plan to map SAP fields to Content Server attributes, for instance
because you do not need metadata in your business workspace, then you do not
need to write your own property provider. In this case, use /OTX/RM_WSCI_CL_
WSPROV_DEFAULT, the default property provider.
Tip: When you create a category for the workspace type, you should use
attributes according to the properties that property provider provides. For
more information, see “Creating a category for workspace type and business
object type” on page 61.
You can use all fields of the reference table as attribute of a workspace.
2. Later, create a category and single-value attributes for the business properties
that you want to use.
3. Later, in the business object type definition, map the business properties to the
created attributes.
2. To enhance the basic metadata, you derive a new class from the default business
property provider class. All the elements needed for this implementation are
collected in the package interfaces of the /OTX/RM package and the /OTX/RM_
WSCI package.
Tip: Property providers for composite business workspaces must also provide the
workspace location for the child business workspaces, which is the location of
the hierarchically closest parent. Any customizing of a static or dynamic
location ID for child business workspaces in the IMG is overruled by the
property provider.
1. In the IMG, navigate to the Extended ECM > Maintain Business Object
Declarations activity and click Execute.
Object Type
Select the business object type for which you want to create the declaration.
Connection ID
Enter the ID of the connection that you created during installation. For more
information, see section 22.2.6 “Maintaining Extended ECM connections” in
OpenText Extended ECM for SAP Solutions - Installation and Upgrade Guide
(ERLK-IGD).
Note: You can use Elementary Search help, and search help using CDS
entities (e.g., MEKKD). Collective search help is not supported.
For more information, see “Using the Content Server Integration Widget“
on page 283.
Activation
Select the check box to activate the business object declaration.
Important
Only after you activated the declaration, you can continue with the
definition of the business object on Content Server. For more
information, see “Configuring business object types” on page 133.
Tips
The value of the custom attribute to be added is defined as a unique name. This
unique name must be defined in Content Server. For more information about
defining unique names, see “Creating unique names for Content Server items”
on page 142.
Note: If you use this customizing, the generic property provider needs to be
able to access the Content Server to resolve the unique names referenced in the
customizing. Therefore, the Content Server user needs read permission on the
unique names.
Typically, you define at least two conditions to cover all possible values.
Notes
• The conditions are evaluated from top to bottom. The first condition that is
met for a custom property determines the value of the custom property. The
next conditions for the same custom property are not processed anymore.
• The logic of minimum and maximum values follows standard SAP rules:
1. In the IMG, navigate to the Extended ECM > Maintain Business Object
Declarations activity and click Execute .
2. Select a business object declaration from the available list; then double-click
Generic Property Provider Custom Properties in the Dialog Structure area.
Config ID
Enter a numeric ID. The ID defines the order in which the conditions are
processed.
Attribute
Enter the attribute that is used to define the condition.
Operator
Enter the operator. You can use the following operators:
• =, <>, <, <=, >, >= to define a value that is equal, greater or less than the
value defined in the Value / Min Value field.
• Between, Not Between to define a range within which the value is or is
not. Enter both a minimum and a maximum value
• Pattern, Not Pattern to define a pattern that is met or is not met, for
example Z* for all entries starting with Z. Use plus + as wildcard for one
character and asterisk * as wildcard for 0 to n characters.
Max Value
Enter a maximum value.
Active
Select to make the condition active.
Custom Property
Enter the name of the custom property, for example TEMPLATE_ID or
LOCATION_ID.
Unique Name
Enter the unique name that you defined. The unique name refers to a
Content Server item. For more information, see “Creating unique names for
Content Server items” on page 142.
Important
Administrators need Business Administration Business Workspaces and
Business Administration Extended ECM usage privileges to configure
Extended ECM.
Few tasks require access to the Content Server administration pages, see
“Configuration steps, which need system administrator’s permissions”
on page 51.
The Business Workspaces volume and the Extended ECM volume are your entry
point to configuration. To access the volumes, on the global menu, click Enterprise >
Business Workspaces or Enterprise > Extended ECM.
Categories
Requires Business Administration Data Policies usage privilege and Category
object privilege.
“Creating a category for workspace type and business object type”
on page 61
Classifications
“Creating a classification for workspace templates and location” on page 63
Facets
Requires Business Administration Columns and Facets usage privilege and
Column object privilege.
“Smart View: Creating custom columns” on page 90
Outlook Add-in Configuration
Requires Business Administration Business Workspaces usage privilege.
“Allowing users to save MS Outlook emails to business workspaces”
on page 170
Perspectives
“Smart View: Creating a perspective with Perspective Manager” on page 92
Workspace types
Requires Business Administration Business Workspaces usage privilege.
“Creating a workspace type” on page 65
Unique names
Requires Business Administration Extended ECM usage privilege.
“Creating unique names for Content Server items” on page 142
Attachment Declarations
Requires Business Administration Extended ECM usage privilege.
Used in Extended ECM for SAP Solutions only in combination with S/4HAHA
Cloud. Other solutions, see “Configuring document declarations“ on page 213.
Scheduled Processing
Requires Business Administration Extended ECM usage privilege.
“Using Scheduled processing“ on page 275
Licensing
Requires Business Administration Extended ECM (for count method
configuration) and License Metering (for the license report) usage privileges.
Not used in Extended ECM for SAP Solutions, instead see“Performing license
measurement“ on page 439.
Tip: To create a category, you need the Business Administration Data Policies
usage privilege and Category object privilege.
Categories and attributes can be used for the following in the workspace type or the
business object type:
• Map business properties from the business application to the category attributes
• Trigger automatic creation of business attachments based on the value of an
attribute
For more information about categories, see the Content Server Administration help.
To create a category:
1. On the global menu, click Enterprise > Business Workspaces, and then click
Categories.
2. 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.
Notes
OpenText recommends that the attribute field length is the same for
both Content Server and the business application.
b. Define the attribute.
OpenText recommends that you use a name similar to the business
property name. You will later map these attributes to the business
properties.
c. Click OK and repeat the steps for all other attributes.
Tip: OpenText recommends that you have an attribute that you can
use to uniquely identify the business workspace, for example an ID.
You can also use the Text:Reference to uniquely identify the
business workspace. For more information, see “Using the Reference
attribute” on page 86.
4. Click Submit.
To create a classification for the folder where the business workspaces are
created:
1. On the global menu, click Enterprise > Business Workspaces, and then click
Classifications.
2. Open an existing classification tree or create a new one. You can name the
classification tree, for example, Workspace Types. The classification tree must
be set in the Document Template settings. For more information, see
“Configuring document template settings” on page 112.
3. Click Add Item > Classification and define the new classification according to
your requirements. Usually, you create a classification for each workspace type.
For example, customers are classified by their sales districts “South” or “North”.
You can use the sales district attribute to determine if the business workspace is
stored in the South or the North folder. For more information, see “General settings
of a workspace type” on page 67.
1. In Content Server, go to the location where you want to create the root folder
for your business workspaces.
2. Add a new folder and configure it as required: Add a name, description. For
Classic view, you can also select an icon.
3. From the Classifications list, select the classification that you created in
“Creating a classification for workspace templates and location” on page 63.
Important
This classification must be the same for folder and template, which you
will configure in “Defining a workspace template” on page 111.
Note: System administrator rights are required for this task. Please ask
OpenText Professional Services for assistance.
2. Add an entry for each language that you want to support, and enable it.
Important
Select languages whose Language Code matches the value of the Lng ISO
field in the SAP system, for example en.
You can have more languages in Content Server than you have
customized in the business application, but you must not have less.
Note: You can use cross-application business workspaces if you want to display
similar business objects from different business applications in one type of
workspace. For this, you use one workspace type for several business object
types. For example, a person is stored as a customer in Salesforce® and as a
vendor in SAP ERP, both of these roles are displayed in the same workspace
type.
Example: The workspace type for “Equipment” has been configured to display
workspace names in English and French.
Kate has set her preferred metadata language in Content Server to English; she sees the
business workspace for equipment 1000476 under its English name “Equipment Truck
12”. Monique, whose metadata language is French, sees the same workspace under its
French name “Équipement Camion 12”.
Generate names also for workspaces without business object: Select this
option if you want to use the name pattern also for business workspaces that do
not have a business object, which could provide the metadata for the name
pattern. If you use this option, OpenText recommends that you use mandatory
attributes for the name pattern. So, when creating a workspace, users must
provide metadata required for the name generation.
Workspace Icon
Specify an icon, which is displayed in business workspaces of this type in
Classic View. Click Select Icon to browse the available icons. The icon is visible
to users in the Classic View on business workspaces and their root folder. For
Smart View, you use the Widget Icon.
Widget Icon
Select an icon for widgets. The icon is used in the Header widget, in a Related
Workspaces widget, the Workspaces widget, and in the expanded view of the
Team widget. For more information, see “Widget icon” on page 73.
Perspective Manager
The Perspective Manager is a tool with which you design different layouts. If
you start the Perspective Manager from this link, it opens with a predefined
layout template for business workspace perspectives. You can edit an existing
perspective or create a new one. For more information, see “Smart View:
Creating a perspective with Perspective Manager” on page 92.
Workspace Copying
Select this option to prevent users from copying business workspaces of this
type.
• Location
Define the root folder where business workspaces of this type are created
and stored. Root folder and template must have the same classification. Only
business workspaces based on templates with the same classification as the
location can be created in this location. For more information about the root
folder, see “Creating a root folder for the business workspaces” on page 64.
Select one of the following options:
Important
The business workspace is not moved automatically when the value
of the business property, which determines the location, is changed.
– From Category Attribute
A category attribute determines 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 node that corresponds to
the attribute.
Important
The business workspace is not moved automatically when the
attribute, which determines the location, is changed.
Note: If the workspace location, both root folder and sub location
path, is calculated from a category attribute, which does not
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 might be left empty, and
the business workspace will be created in a location that is not quite
wanted. You can prevent this by adding the category attribute for the
sublocation path to the workspace template so that the attribute is
displayed in the workspace creation wizard. In addition, you make it
required, so that the user is forced to provide a value for the attribute
that determines the sublocation path.
For more information about multilingual properties, see the SDK Guide on
OpenText My Support (https://knowledge.opentext.com/knowledge/cs.dll/
Open/63007681).
– Location
Only folders and business workspaces are supported. If you configure
From Business Property or From Category Attribute, and the business
property or category attribute contains the ID of a business workspace,
any workspace hierarchy configuration of the parent business workspace
is ignored.
– Sub-items
A business workspace template can only contain the following items:
○ Date Created
○ Date Modified
○ Modifier
○ Owner
○ Subtype (Content Type)
○ Classification
○ Created By
○ Creation Date
○ ID
○ Modified
○ Modified By
○ Name
○ Owner
○ Size
○ Type
Important
Business workspaces are created in batches. If one business workspace
of a batch with fast bulk method fails to be created, the whole batch call
is ended and no business workspace of that batch is created.
Files must not be larger than 1 MB. For best results, use a square image with the
recommended size of 128x128 pixels.
You can select from sample icons, which are in the following folder on your Content
Server installation: <Content Server Home>\support\otsapxecm\business_
object_icons, for example \\mycontentserver\C\OPENTEXT\support\otsapxecm
\business_object_icons.
Note: If no icon is configured for the workspace type, a default is taken. Users
with sufficient permissions can change the icon for an individual business
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 items like documents, emails, folders, or task lists, which are
located in a business workspace. 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 “Indexing documents and other items with business
workspace attributes” on page 417.
Sidebar Widgets
Configure sidebar widgets that display metadata in the business workspace in
Classic View. For more information, see “Classic View: Configuring sidebar
widgets” on page 75.
Classification
Optionally, select a classification for this particular workspace type. This
classification is not added to business workspaces and not related to the
classification that links storage location and template.
Records Management
Enable Records Management for the creation of business workspaces. You can
view RM Classification information in the business workspace properties.
Changing this option immediately effects business workspaces of this type.
Roles
Adds the creator of a business workspace to the Team Lead role, if this role
exists.
This option is enabled by default. During upgrade, it is automatically enabled
for existing workspace types.
Example: A user has the authorization to see customers in the SAP ERP system,
but no authorization to see the same customer in the SAP CRM system. In Content
Server, policies created from authorizations both in the SAP ERP system and in the
SAP CRM system restrict access to the created workspaces. The user can see the
business workspace because the policy created from the SAP ERP system gives
access.
• RM Classification
Define if and how an RM classification is added to the document.
Note: You must save or apply the settings of the workspace type before you
can configure sidebar widgets.
Tip: You can drag the sidebar widgets configuration to change their order.
Each sidebar widget type requires characteristic configuration parameters. You can
configure each sidebar widget individually. You can also use the same sidebar
widget type several times with a different configuration.
You manage and configure sidebar widgets for each workspace type.
5. To configure each sidebar widget, click Detailed Configuration. For details, see
the following sections.
Attributes
Defines which attributes are displayed. Click Browse Content Server to select
the category; then select the attribute. It depends on the selected category which
attributes are available.
Categories Tab
Defines if a link is displayed in the sidebar widget that opens the Categories tab.
All categories and attributes of the business workspace are displayed on the
Categories tab.
Date to Use
Defines which date field is used to determine if an item is displayed in the list.
You can either use the date when the latest version was added (Version Added)
or the date of the last modification (Modify Date).
Oldest Change
Changes older than the defined number of days are not displayed. If you do not
enter a number, all changes are displayed.
Items to Display
Number of items that you want to be displayed in the list. If the number of
recent changes is higher than what you defined here, only the latest changes are
displayed.
Relationships are defined in the SAP system and delivered by the property provider.
They can also be added manually.
Display Style
Defines if the related items are displayed as list (List) or as tree view (Tree).
Show Parent Relationships
Displays the business workspaces that are defined as parent workspaces for the
current workspace.
Show Child Relationships
Displays workspaces that are defined as child workspaces for the current
workspace.
Workspace Types Shown
Restricts the related workspace types.
Children Shown / Relationships Shown
For the display style Tree: Defines how many child workspaces are displayed.
For the display style List: Defines how many relationships, parents and children,
are displayed. Default is 7.
Show Related Workspaces Folders
Defines if a link to the Related Workspaces folder, which is defined in the
template, is displayed. Select When not all items shown if you only want to
show the link when the number of workspaces exceeds the number defined for
Children Shown.
Show Ahead
Only work items with a due date before the specified number of days from
today are displayed.
Task Lists
A workflow can be started for the business workspaces and items inside a
business workspace with the function menu entry Initiate Business Workflow.
The sidebar widget displays all tasks in the My Assignments tab of the current
user for these workflows.
Reminders
Displays all follow ups of the current user for any Content Server item in the
business workspace. The follow ups are also displayed in the My Assignments
list of the user. Only reminders with status Active or In Progress are displayed.
Initiated Workflows
Defines if workflow steps related to the business workspace are displayed and if
steps without due date are also displayed.
Personal Assignments
Defines if a link to the personal assignments is displayed. These are all personal
assignments, not only those related to the business workspace.
You can use the multilingual texts option for master data business objects.
Note: For business workspaces without business object types, you can specify
any name here. These workspace types always have the name that the user
entered during creation, independent of the settings you specify here.
You can use the multilingual texts option for master data business objects.
Example: The workspace type for “Equipment” has been configured to display workspace
names in English and French.
Kate has set her preferred metadata language in Content Server to English; she sees the
business workspace for equipment 1000476 under its English name “Equipment Truck 12”.
Monique, whose metadata language is French, sees the same workspace under its French
name “Équipement Camion 12”.
Tip: Users can change their preferred metadata language in Content Server:
Tools > Settings > Metadata Language.
3. Add workspace name patterns for each language in the workspace type
configuration. You can use category ID and attributes, business properties, free
text as well as modifiers for the name pattern.
Important
You must at least enter a pattern for the default language. Other languages
are optional.
4. Generate names also for workspaces without business object: Select this
option if you want to use the name pattern also for business workspaces that do
not have a business object, which could provide the metadata for the name
pattern. If you use this option, OpenText recommends that you use mandatory
attributes for the name pattern. So, when creating a workspace, users must
provide metadata required for the name generation.
Important
Multivalue attributes are not supported for business workspace names or
business object names.
Important
Offset: +0
Cut off the specified number of characters and displays the rest. The offset must
not be greater than the actual attribute length. Otherwise, an out-of-bound error
is displayed. Separate the modifier from the attribute by a colon.
Length: (0)
Display the specified number of characters. The length value may be greater
than the original attribute length. Separate the modifier from the attribute by a
colon.
Combination
Combine all pattern modifiers.
• Location where business workspaces are stored. For more information, see
“General settings of a workspace type” on page 67.
• You can use multivalue attributes. This creates a folder path in the order of the
values in this multivalue attribute. Empty values may only be at the end of the
multivalue attribute.
• Location where external documents are stored in a business workspace. For more
information, see External Document Storage on page 74.
Important
– Colon : cannot be used as Content Server does not allow colon in a node
name
– Square brackets [ ] cannot be used as those are used in the pattern
syntax to indicate category attributes or business properties
• The forward slash (“/”) separates subfolders.
• If one attribute of many attributes used for a subfolder is empty, the
business workspace is not created. Empty attributes can cause an unwanted
location and are therefore handled as error. OpenText recommends that
you define attributes, which are used for the location in manual creation, as
mandatory.
• If a multivalue attribute contains empty values, which are not at the end of
the multivalue attribute, the business workspace is not created. Empty
attributes can cause an unwanted location and are therefore handled as
error.
• If all attributes for a sub location are empty, the business workspace is
created in the location folder. This applies to both single-value and multi-
value attributes.
3. Enter text or syntax elements to form your pattern. The forward slash (“/”) is
used to separate folders.
Tip: You can also use the reference number attribute for a more elaborate
number schema. For more information, see “Using the Reference attribute”
on page 86.
Offset: +0
Cut off the specified number of characters and displays the rest. The offset must
not be greater than the actual attribute length. Otherwise, an out-of-bound error
is displayed. Separate the modifier from the attribute by a colon.
• Pattern – [2032760:Id:+4]
• Result – 0123
Cut off the first four digits of the ID.
Length: (0)
Display the specified number of characters. The length value may be greater
than the original attribute length. Separate the modifier from the attribute by a
colon.
Combination
Combine all of those pattern modifiers.
You can also use the reference attribute to create the name. If you use the reference
attribute for the workspace name, you must be aware of the following behavior: If
you change the reference number schema in a category and update all existing
objects with the changed category, only the attribute changes. The generated name
of the business workspace does not change.
Notes
Reference [241162:CustomerName]-%fileplan%/%sequence%
schema
Result Brown Lawnmowers-FS01/0015
Variable Description
241162:CustomeName Attribute CustomerName. In this
example, the category has the ID 241164.
%fileplan% Folder name.
%sequence% Serial number. It is formatted as a four-
digit number 000N. In this example, it
creates the number 0015.
1. Open the category that you use for the workspace type.
2. Add the Text:Reference attribute to this category.
3. Define the attribute:
• Name: Name as it displays for the user, for example, file number or
reference number.
Variable Description
%sequence% Consecutive number within the
schema
%parentFileId% Reference of the parent business
workspace
%fileplan% Name of the folder in which the
business workspace is stored
%rm-classification% Name of the RM classification which
the business workspace uses
%rm-filenumber% File number of the RM classification
used by the business workspace
%a% Abbreviated weekday with three
characters. The characters depend on
the Content Server language settings.
For example, Mon or Tue for English
%b% Abbreviated month name with three
characters. The characters depend on
the Content Server language settings.
For example, Jan or Mar for English
%c% System date
%d% Day in the month with two digits from
01 to 31
%j% Day in the year with three digits from
001 to 366
%m% Month with two digits from 01 to 12
%w% Weekday in one digit from 1 to 7,
where 1 stands for Sunday
Variable Description
%y% Year with two digits. For example, 18
for 2018
%A% Full weekday name. The characters
depend on the Content Server
language settings. For example,
Monday
%B% Full month name. The characters
depend on the Content Server
language settings. For example, March
%H% Hours in two two-digit hours on a 24-
hour clock, from 00 to 23
%I% Hours in two two-digit hours on a 12-
hour clock, from 01 to 12
%p% AM or PM on a 12-hour clock
%M% Minutes in an hour from 00 to 59
%S% Seconds in a minute from 00 to 59
%P% Years marked as AD or BC
%U% Week number in the year, with
Sunday as the first day of the week
%W% Week number in the year, with
Monday as the first day of the week
%Y% Year with four digits. For example,
2019
%% A percentage sign
• Attribute number format: Number of digits and leading zeros that are
added to a serial number created with the %sequence% variable. The entry
only adds digits if you use the variable in the Attribute number schema.
4. Click OK.
1. On the global menu, click Enterprise > Business Workspaces, and then click
Workspace Types.
2. To enable a workspace type, from the function menu, select Enable 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, or
from the function menu, select Edit.
4. To rename an existing workspace type, from the function menu, select Rename.
6. 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 “Indexing documents and other items
with business workspace attributes” on page 417.
With Business Workspaces enabled, the following custom columns have already
been created in the Facets volume in the Workspace Columns folder.
• Workspace Type ID
• Workspace Name in each language that is configured on Content Server, for
example Workspace Name en.
If you added another language after enabling Business Workspaces, you must
create the respective column manually and prepare it for sorting and filtering.
Tip: To create custom columns, you need the Business Administration Facets
and Columns usage privilege and Column object privilege.
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. It is sorted by creation date.
The workspace name is a default custom column, which is created during enabling. 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 and used for sorting
and filtering. No further configuration is required in the widget.
1. On the global menu, click Enterprise > Business Workspaces, and then click
Facets. Then navigate to a folder, where you want to store your custom
columns.
4. Select a Data Source from the list of available category attributes. 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 not displayed anymore.
6. Wait for the column to be built. To monitor the status, select Properties >
Specific from the function menu.
7. Smart View: From the function menu of the custom column, select Properties >
Workspace. Then select Used for Sorting and Filtering. When you click Update
the database index is created concurrently, which may take a few minutes.
After the database index has been created, the custom column can be used for
filtering and sorting.
Notes
For more information about custom columns, see the Content Server help.
Note: Opentext recommends not to modify the basic structure and to leave the
font size, the heigth of headers and widget headers, margins, and paddings as
they are defined.
For more information, see OpenText Content Server - Smart View (CSSUI-UGD).
Important
• This chapter only covers perspectives for business workspaces. For more
information about the full functionality of Perspective Manager and
perspectives, see the online help of Perspective Manager.
• Changes in perspectives take effect immediately. If you need testing, create
the perspective on a test system first.
Some widget parameters support multilingual text. You recognize them by the globe
icon . When you click into one such box, a pop-up opens with text boxes for each
installed language.
Note: In each business workspace, you can have only one Node Browsing
Table widget, regardless of how many tabs you have.
1. On the global menu, click Enterprise > Business Workspaces, click Workspace
Types, and then open a workspace type.
3. In the Perspective Manager, on the General tab, click Create new, and then
enter a title for the perspective.
4. On the Rules tab, you create logical rules, which control when the perspective is
used.
5. On the Configure tab, you design the perspective of the workspace type.
• The widget library pane on the left contains widgets from installed modules,
one of which being Business Workspaces.
• The working area in the middle is where you place the widgets.
• The options pane on the right shows configuration options of the selected
widget.
• The tabs are configurable. You can create new tabs or edit them. Double-click
a tab name to rename it. To remove a tab, select another tab, and then drag
the tab, which you wanted to delete, out of the picture.
6. When you are done, click Create.
7. To edit a perspective, open it in Perspective Manager and make the required
changes. Perspectives for Business Workspaces are stored in the following
location: Perspectives volume > Business Workspaces > <Folder named after the
workspace type with workspace type ID> . The folder name changes when you
change the workspace type name, the ID remains the same.
Note: When you transport perspectives using the Transport Warehouse, you
must follow a certain order to keep dependencies. For more information, see
section 6.4 “Transporting the configuration” in OpenText Business Workspaces -
Configuration Guide (CSCWS-CGD).
With version 20.2, all ActiveView perspectives use a new “Perspectives” node type
and must be converted, therefore all rule-based workspace perspectives must be
manually migrated to type-based perspectives.
Important
If you have more than one perspective for the same workspace type, you must
follow a certain order for the conversion of these perspectives.
c. Take a note of the order in which these perspectives are listed on the Global
Perspectives page. You must follow this order when you convert these
perspectives.
4. Open the workspace perspective that you want to convert, click Edit
Perspective and convert it. Stick to the order that you noted in Step 2.c.
a. On the General tab, click Edit existing and select the perspective you want
to migrate.
b. As Type, select Workspace.
c. Select the corresponding workspace type. If you are unsure, which
workspace was associated to this perspective, check the rule in the Rules
tab.
d. On the Rules tab, delete the rule with the workspace type.
e. Click Update.
For more information, see the online help for Perspective Manager.
You can also embed another widget in the Header widget, currently only the
Activity Feed widget.
Workspace Properties
Workspace properties are displayed in the left part of the Header widget in the
following top-down order, with the font becoming smaller. You can use the
suggested properties, add others, and combine attributes and properties with
text.
Property Description
Title Name of the business workspace, prefilled
with the {name} node property.
Type Name of the workspace type, prefilled
with the {business_properties.
workspace_type_name} business
property.
Description Description of the business workspace,
prefilled with the {description} node
property.
Widget
You can embed another widget in the header widget. It depends on your
system, which widgets are available.
Property Description
Embed Widget Select one of the available widgets to
embed it into the header widget. It is
displayed in the right half of the header
widget. Currently available is the Activity
Feed widget, which displays all activities
in relation to this business workspace and
its related child workspaces. You see
comments or recently added documents.
If you want to use the Activity Feed
widget, you must enable Content Server
Pulse and, optionally, create activity
manager objects. For more information, see
section 5.7 “Creating an activity manager
object for the Activity Feed” in OpenText
Business Workspaces - Configuration Guide
(CSCWS-CGD).
General
Property Description
Title Title of the widget, typically the
workspace type name in plain text.
Workspace type Workspace type of the related workspaces.
Relation type Child or Parent.
Collapsed view
Property Description
Message for empty result Custom message if no business
workspaces of this type are available.
Property Description
Preview pane The preview pane is a window that opens
when you hover with the mouse over a
related workspace in the widget. The
preview pane contains additional
information as well as team members of
this business workspace.
• Preview title – Title of the preview
pane, for example the workspace type.
The title is displayed in small font
above the display name of the related
workspace.
• Message for empty metadata – Custom
message if there is no metadata to
display.
• Name of role – Name of the role whose
members are displayed in the preview.
• Message for empty role – Custom
message if there are no roles or team
members to display.
Message that is displayed if the
specified role has no members. The
default text is No role members
assigned.
Metadata in preview pane The preview pane uses data from category
attributes. You select a category or single
attributes. To group attributes, enter a
group name and then select the categories
and attributes. Leave the group name
empty to add a category or attribute
without a group. Drag attributes or groups
to change the order.
• Group name – Name of a group of
attributes or categories
• Category or attribute – Category or
single attributes. You can use the
following data sources: A single
attribute or a complete category with
all its attributes.
Property Description
Order by Orders the list of related workspaces by a
custom column and defines the sort
direction. The default sorting is ascending
by the name of the business workspace.
If you have not selected a custom column
in the Order by option, the workspaces are
ordered by the custom column configured
in Related workspace title. And in this
case, you can only use custom columns
that are configured for ordering. If you
selected a custom column that is not
configured for ordering, an error message
is displayed when the widget is loaded.
For more information about configuration
of custom columns, see section 5.6
“Creating custom columns for Content
Server Smart View search and widgets” in
OpenText Business Workspaces -
Configuration Guide (CSCWS-CGD).
If you want to have the workspaces sorted
by another order than by name, you must
explicitly define the column and the sort
order in the order by section.
• Default is an order ascending by name.
• Sort ascending by the column that you
want to display as Title: Select that
column as Title, do not specify
anything in the Order by field.
• Sort descending by the column that
you want to display as widget title:
select that column as Title, additionally
select this column in the Order by field,
and select the sort order Desc.
Related workspace title Name of the related workspace. You can
use the following:
Variables: {name}. It uses the name of the
business workspace, which may already be
assembled from several attributes.
{modify_date}. For this, the custom
column for Workspace Modify Date
must be configured and have the Used for
Sorting and Filtering option enabled.
Custom columns if they have the Used for
Sorting and Filtering option enabled.
Property Description
Related workspaces description Description of the related workspace. You
can use the following:
Variables: {name}, {description},
{type_name}, {modify_date},
{create_date}
System Default Columns: {id}, {size},
or {type}
Custom columns if they have the Used for
Sorting and Filtering option enabled.
Metadata fields Additional fields to display metadata in
the widget. Enter a label and the value,
which can be a custom column or one of
the following variables: {name},
{description}, {type_name},
{modify_date}, {create_date}. The
{name} variable uses the name of the
business workspace, which may already be
assembled from several attributes.
To format a custom column to be
displayed in currency format,
add :currency within in the brackets, for
example: {wnf_att_fl14_
5:currency}. With this format, zeros are
displayed and thousands separators are
added.
Expanded view
Property Description
Order by Orders the list of workspaces by a custom
column and defines the sort direction.
Custom columns Custom columns to be displayed in the
expanded view. Select a custom column,
and then click Add to array. You can drag
the columns to change the order.
You can enable sorting by date in the
Related Workspaces widget. For this, you
create a custom column for the Workspace
Modify Date data source and configure it
to be sortable and used for sorting and
filtering. No further configuration is
required in the widget. For more
information, see section 5.6 “Creating
custom columns for Content Server Smart
View search and widgets” in OpenText
Business Workspaces - Configuration Guide
(CSCWS-CGD).
Property Description
Title Title of the Team widget. Default is Team.
Property Description
Title Title of the Metadata widget. Default is
Metadata.
Hide empty fields Hide metadata fields that have no value.
Default is False.
Metadata The Metadata widget uses data from
category attributes. You select a category or
single attributes. To group attributes, enter a
group name and then select the categories
and attributes. Leave the group name empty
to add a category or attribute without a
group. Drag attributes or groups to change
the order.
• Group name – Name of a group of
attributes or categories. You can use this
option to visually group attributes.
• Category or attribute – Category or
single attributes. To add an attribute,
select the category and then select the
attributes that you want to display.
General
Property Description
Title Title of the Workspaces widget, typically
the type of business workspaces listed
here. Default is My workspaces.
Workspace type Type of business workspaces that you
want to display.
Collapsed view
Property Description
Title Title of the Workspaces widget, typically
the type of business workspaces listed
here. Default is My workspaces.
Message for empty result Custom message if no business
workspaces of this type are available.
Expanded view
Property Description
Title Title of the Workspaces widget, typically
the type of business workspaces listed
here. Default is My workspaces.
Order by Orders the list of workspaces by a custom
column and defines the sort direction.
Property Description
Custom columns Custom columns to be displayed in the
expanded view. Select a custom column,
and then click Add to array. You can drag
the columns to change the order.
You can enable sorting by date in the
Workspaces widget. For this, you create a
custom column for the Workspace Modify
Date data source and configure it to be
sortable and used for sorting and filtering.
No further configuration is required in the
widget. For more information, see section
5.6 “Creating custom columns for Content
Server Smart View search and widgets” in
OpenText Business Workspaces -
Configuration Guide (CSCWS-CGD).
Notes
Set notifications
To support the Follow feature in the Discussion widget, you must configure
notifications just as you would for a Forum in Classic View. For information
about how to configure the frequency of notifications if a user chooses to follow
Parameter Description
Width Choose the size that you want for the Discussion widget.
For the Overview tab of a business workspace, the recommended size is
single width.
Forum object To associate the widget with the Forum object in the business workspace,
leave this parameter empty and the widget will automatically link to the
forum. Typically, the administrator creates a new Forum object in the
business workspace or in the business workspace template.
Notes
• The Forum objects must be available in the root folder of the
business workspace. If the root folder does not include a Forum
object, the Discussion widget will display a message that no
discussion is configured. If you later add a Forum to the root
folder, the Discussion widget will automatically link to it.
• If there is more than one Forum object in the root folder of the
business workspace, the Discussion widget automatically links to
the oldest Forum.
For information about how to create a Forum, see section 1.1 “Creating
and Configuring Forums” in OpenText Content Server - Forums (LLESFOR-
H-UGD).
Users can create a snapshot for all business attachments displayed in the widget.
Snapshots are folders in Content Server, which contain a Generation of the latest
version of each business attachment that is a document. A Generation is a copy of a
document, which is separated from the original document, unlike a version. For
more information, see the Content Server help. The snapshot contains a shortcut to
objects other than documents. The name of the folder starts with a prefix, which you
configure for the widget.
In the expanded view, you see additional information for each business attachment
such as description, location and version.
General
Property Description
Title Title of the Business Attachments widget.
Default is Business attachments.
Snapshot folder name prefix Prefix that is added to the snapshot folder
when you create a snapshot from this
widget. A snapshot freezes the current
version of all business attachments of the
business object and stores them in a folder.
Business attachment
Property Description
Business object ID Category attribute that contains the ID of the
business objects for which you want to
display business attachments.
Business object type Category attribute that contains the business
object type.
Business application ID Category attribute that contains the ID of the
business application where the business
object type resides.
If you want to use attribute sets in these fields, you must use the following format:
{categories.<category ID>_<set number>_<attribute ID>}, for example,
{categories.37275_33_1_34}. If the attribute picker does not provide this format,
you must enter it manually.
• Set: 33
• Line of set: 1
• Attribute ID number: 34
To retrieve the attribute ID, run the following report: <URL of content server>?
func=attributes.dump.
Collapsed view
Property Description
Message for empty result Custom message if no business attachments
are available.
Order by Orders the list of business attachments by a
column. The default sorting is ascending by
the name of the business attachment.
Expanded view
Property Description
Order by Orders the list of business attachments by a
column and defines the sort direction.
Snapshot
Property Description
Parent folder name Folder in business workspace, where
Snapshots are created.
Snapshot name prefix The name of a snapshot consists of the prefix
and a timestamp.
Property Description
Default group by criterion Groups the documents by their creation date
or a classification.
Hide group by criterion dropbox Provides an option for users to hide certain
groups of documents. The default settings
display the dropbox.
Hide metadata Provides an option for users to hide
metadata of documents. The default settings
display the metadata.
Hide empty fields Hide metadata fields that contain no data.
The default settings display empty metadata
fields.
Note: Do not use multivalue attributes and multi-row set attributes in the
header widget. You can only use text attributes.
Workspace Properties
Property Description
Title Name of the business workspace, prefilled
with the {name} node property.
Type Name of the workspace type, prefilled with
the {business_properties.
workspace_type_name} business
property.
Description Description of the business workspace,
prefilled with the {description} node
property.
Workspace properties are displayed in the left part of the Header widget in the
following top-down order, with the font becoming smaller. You can use the
suggested properties, add others, and combine attributes and properties with text.
• Category attributes
Click Add Attribute to Field and select attributes from the categories that
contain information for this business workspace. You cannot use attribute sets for
this. Only text attributes are allowed.
Widget
You can embed another widget in the header widget. It depends on your system,
which widgets are available.
Property Description
Embed Widget Select one of the available widgets to embed
it into the header widget. It is displayed in
the right half of the header widget. Currently
available is the Activity Feed widget, which
displays all activities in relation to this
business workspace and its related child
workspaces. You see comments or recently
added documents.
Metadata settings
Property Description
Hide metadata Provides an option for users to hide
metadata of documents. The default settings
display the metadata.
Hide empty fields Hide metadata fields that contain no data.
The default settings display empty metadata
fields.
Metadata The Header widget uses data from category
attributes. You select a category or single
attributes. To group attributes, enter a group
name and then select the categories and
attributes. Leave the group name empty to
add a category or attribute without a group.
Drag attributes or groups to change the
order.
Favorite
You can hide the Favorite button in the Header widget.
In the configuration of this widget, select one or more business object types. The
business object type must have a configuration for the category attribute, which
contains the barcode value.
If you want to also monitor attribute changes, you must create an activity manager
object. An activity manager object is linked to one category attribute. When the
value of the attribute changes, it creates an activity, which is then shown in the
Activity Feed widget.
Note: System administrator rights are required for this task. Please ask
OpenText Professional Services for assistance.
Example: You add the category attribute Amount of a Sales Order to an activity manager
object. When the amount changes, it is displayed in the Activity Feed.
For detailed information about the activity manager object and Pulse, see the online
help for Content Server Pulse.
Notes
• Each activity manager evaluates its rules by the order in which they are
listed.
• The Activity Feed message supports localization and starts with a default
activity string message. Optionally, you can customize the activity string
with substitution placeholders for the attribute value.
Tip: To create activity manager objects, you need the Business Administration
Facets and Columns usage privilege and Activity Manager object privilege.
To enable activity monitoring with Content Server Pulse, you need access to
the Content Server administration pages.
To enable Pulse:
2. From the Select Object Types to Manage list, select the Business Workspace
object type and click the Add Object Type button .
4. Click Update.
1. From the global menu bar, select Tools > Facets Volume.
5. Click Add.
3. Enter a rule name and select an option from the Rule Criteria list, for example,
Value Changed.
4. The Activity String is populated with a template string. You can edit the string
and also add multilingual versions.
The standard string looks like the following: [ObjName] [AttrName] changed
from ' [OldVal] ' to ' [NewVal] '.
Example: If you created an activity manager object that monitors the status of a sales
order workspace, the string would then produce the following activity message: Sales
Order 123 status changed from ‘pending’ to ‘closed’.
5. Edit the list of Included Object Types. Remove object types that you do not
want to monitor.
6. Click Submit.
Tips
2. In the Managed object types section, click Configure and make sure that at
least the Business Workspace (subtype 848) item is configured.
3. For the Classification tree for document types, select a classification tree for
business workspaces.
4. Set the other options as required. For more information, see the Content Server
online help for that page.
Note: If the Business Workspace option is not available, you must enable
it. For more information, see “Configuring document template settings”
on page 112.
Tips
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
Volume. Then configure the new template according to your requirements. You
must create the copy only within the Documents Templates Volume, though,
and not in the Enterprise workspace.
Important
When you copy a folder that contains a workspace template, the
workspace template is not copied.
Important
Users will see the name of the template in the Add menu of Content
Server Smart View when they create a business workspace in Content
Server, for example Add > Customer or Add > Material.
4. From the Classifications list, select the same classification that you selected for
business workspace location. For more information, see “Creating a root folder
for the business workspaces” on page 64.
Important
The workspace template and the business workspace location must have
the same classification if you want to create them manually.
6. Click Add.
8. Open the workspace template and add subfolders and documents as needed
using the Add Item button. You can use placeholder, which represent data,
such as a user name or a reference number, whose value is determined when an
instance of the template is created.
You can use the following placeholders when creating business workspaces.
For a complete list of all available placeholders for cases and binder, see Section
6.2.4 “Using placeholders in template contents” in OpenText Content Server
Admin Online Help - Template Workspaces (LLESCSB-H-AGD).
9. To test the configuration, open the location folder, which is configured for this
template. The Add dialog now contains an option with the template name.
Important
Changes to the workspace template are not automatically 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.
Tip: If you want to organize your templates in folders, you can move them.
You can move them within the Document Templates volume but not to a
folder outside the volume, for example the Enterprise workspace.
Example: In a Human Resources scenario, birth certificate and diploma are required
documents in a personnel business workspace. You create classifications Birth Certificate and
Diploma and assign them to the respective documents when uploaded. You create a
document validation rule that check the existence of one birth certificate in a specific folder.
For a manager level, two diplomas are required, one from high school and one from college,
which you can distinguish using category attributes.
Tip: Extended ECM Platform provides a Header widget for Smart View, which
displays the number of missing documents based on your validation rules.
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. The Document Type rules are customized in the document
templates.
• Document Type – click in the box and then browse and select your
document type from the list. You can also start entering a document type
name to get your required document type more quickly.
d. Click Submit.
• Location – click in the box and from the list, select the workspace folder in
which the document is expected to be available. You can also start entering a
location name to get your required folder location more quickly.
• Groups and Roles – click Select to open the Select Groups and Roles dialog
box.
Select the Grant Access check box for the roles that you want to grant access
and click Save Changes. The selected roles are then displayed in the text
box.
The merging also applies to the items in the template. The permissions are merged
with the permissions of the location where the business workspace is created.
Notes
Example: User AMILLER creates a new business workspace for a customer using the
Customer template. For the Customer template, user AMILLER only has See access. For the
folder Customer, where the new business workspace is created, user AMILLER also has
Modify access.
If the Merge with creation location option is selected, user AMILLER will have both See and
Modify access. If the Merge with creation location option is not selected, user AMILLER will
have only See access.
1. From the function menu of the workspace template, select Properties > Specific.
Prerequisites You fully configured all workspaces types for what will later be parent workspaces
and child workspaces.
If parent workspace template and child workspace template have differing roles,
you can map a parent role to a child role. The role of the child workspace will then
be replaced by the mapped role of the parent workspace with all the access rights of
the child workspace role. With this mechanism, users with roles of the parent
workspace can access the child workspace even if their specific role was not initially
assigned to the child workspace. On the other hand, members of roles of the child
workspace do not automatically gain access to the respective parent workspace.
With this role mapping, you reduce the number of roles to maintain.
To create a hierarchy:
2. From the Classify ... list, select the classification, which is assigned to the
template that you want to be a child template.
The selected classification is listed in the Child Classifications area. The list in
the Select Child Template box now contains all templates that have this
classification.
4. Optional Map the roles of the parent template to the roles of the child template:
Select the appropriate role from the Child Roles list. You can map each role
only once.
5. On the Classifications tab of the parent workspace template, clear the Inherit
check box.
The Inherit option must be deactivated, so that the child workspace does not
have the same classification as its parent and can be configured differently from
its parent.
6. Click Save.
7. Repeat steps 3 to 6 for each template that is listed in the Select Child
Template ... list.
You can define these settings for new and for existing workspace templates.
As an alternative, users can share single items manually. For more information, see
Section 15 “Share items to OpenText Core Share” in OpenText Content Server - Smart
View User Help (CSSUI-H-UGD).
Prerequisites A connection to an OpenText Core server must be set up. For more information, see
OpenText Content Server - Content Sharing Administration (LLESEFS-AGD).
5. Click the Add new item to share button and select at least one folder from
the workspace template.
6. Add Recipients who can view the shared items in OpenText Core:
• Select Core Share User or Core Share Group and type their name.
• Select Category if you want the recipients be determined based on a
category attribute. The category attribute must contain the email address
with which the user logs in to OpenText Core. You can use categories that
have multivalued set attributes.
Select the permission the recipient has for the shared content. The permissions
that are displayed are based on the Available Roles in the Core Share Settings
administration page. For more information, see also the Core Share
documentation.
You can select from the following:
7. Select when you want to start the OpenText Core sharing and when you want it
to stop. Select the Initiate Core Share Trigger and the Stop Core Share Trigger.
You can either select the creation or deletion of a business workspace. Or you
can select a category attribute with the trigger information. This can be, for
example, a status or a date. You can also use the expression builder to create a
more complex condition. You can use categories that have multivalued set
attributes.
If a stop setting is in place and the respective expression will be true, the content
sharing is not carried out.
You can use all expressions that are applicable for the selected attribute’s data
type.
If you change these triggers later in the workspace template, already existing
business workspaces remain unchanged. They keep their original settings.
Important
Once a folder is shared automatically you must not update the share process
manually again as this may lead to problems in the process.
You can also define team participants directly in the Team widget of a business
workspace.
Note: You can change team participants for each business workspace
separately.
• Team Roles
You create team 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
– Template Administrator
The Template Administrator role is added automatically to templates for
business workspaces. It has full access permissions for the template. The
Template Administrator role is not copied to business workspaces that are
created from the template.
– Template Editor
The Template Editor role is added automatically to templates for business
workspaces. This role has the access permissions See, See Contents, Modify,
Edit Attributes, Add Items, and Reserve for the template. The Template
Editor role is not copied to business workspaces that are created from the
template.
– Template User
The Template User role is added automatically to templates for business
workspaces. This role has the access permissions See and See Contents for
the template. The Template User role is not copied to business workspaces
that are created from the template.
– 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, Template Editor, or Template User role, becomes the Team
Lead role. However, you can set any role as the Team Lead using the Set as
Team Lead button. You can also delete the Team Lead role if it is the only 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 team can have
multiple participants.
1. Switch to Classic View: Click your profile image and click Classic View.
2. From the global menu, select Enterprise > Document Templates and find the
template that you want to edit.
3. From the function menu of the workspace template, select Team Roles and
Permissions.
4. Create a role:
a. On the left side of the page in the Role Access section, click the Add Role
button .
b. On the right side of the page, in the Add new role section, enter a name in
the Role box.
c. Optional Enter a description in the Role Description box.
d. Click Add.
5. Assign permissions to the role:
b. On the right side of the page, enable the permissions that you want to
assign to the role.
c. Click Update.
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.
• Merge with creation location option on the Specific tab of the template.
• Always inherit the permissions from target destination option on the Core
System – Feature Configuration > Access Control page.
The following handling applies when business workspaces are created and moved:
– All team roles and team participants except for the Template Administrator
are copied to the created workspace.
– If the new business workspace is created within a business workspace, the
team roles and team participants that are assigned to the destination are
copied to the created business workspace. This applies only if the merging of
permissions is enabled.
• A business workspace is moved to a destination with team roles, for example
into another business workspace:
– Team roles and team participants that are assigned to the new destination, are
copied to the business workspace. This applies only if the Always inherit the
permissions from target destination option is enabled.
– Team roles assigned to the business workspace directly are still there.
• A business workspace is moved to a destination without team roles:
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.
If you want to remove a group, which was created by the group replacement, from
the business workspace, you clear the category attribute used in the group
replacement configuration. For a detailed description of the complete process, see
Section 6.2.2.1 “Using generated groups to define permissions for workspace
folders” in OpenText Extended ECM for SAP Solutions - User Management and Access
Control Scenarios (ERLK-CUM).
Prerequisites
• You use groups to restrict access to the template or parts of it. The groups are
used for the template and for the business workspace instances when the
category attribute is empty.
• You grant the groups direct access instead of adding them as team participants to
a team role.
• If you want to use variables, you have already defined them. For more
information, see “Defining and using variables” on page 126.
• If you want to use a category and an attribute, retrieve their ID.
1. From the function menu of the workspace template, select Properties > Specific.
The Group Replacements section lists all groups that are granted access to the
template or items within the template.
2. 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.
3. To generate a 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:
The replacement tags are replaced with actual values when a workspace is
created from the template.
Error handling
If you use category attributes for group replacement, OpenText recommends that
you make these category attributes mandatory. However, there are mechanisms in
place, which cover empty attributes:
• If the attribute is still empty when the business workspace is created, the group
replacement uses the permissions of the document template.
To define variables:
4. Click the Add variable button to add a row. Click the Remove variable
button to delete a row.
Example: A customer workspace can have relationships to all sales orders, which this
customer placed. Or a product workspace can have relationships to all customers who bought
this product.
Tip: Alternatively, you can use the Related Items sidebar widget to display
relationships of a business workspace. For more information, see “Related
Items sidebar widget” on page 78.
In the SAP system, you have defined relationships between customers and
products. In the Customer workspace template, you can add a Related
Business Workspaces folder for products and call this folder Products. Every
created customer business workspace then contains a specific Products folder
with links to the related products ordered by this specific customer.
• The property provider for this business object provides the relationships.
Prerequisites
Manual relation- Users can manually create relationships between business workspaces. This option
ships is only available in folders of the type Related Business Workspaces in Classic View.
Manually added relationships always are in child relation to the containing business
workspace. Only manually added relationships can be removed again.
• Simple Search forms must be set up. For more information, see “Configuring a
simple search for Classic View” on page 422.
• The Related Business Workspaces folder is configured to display child business
workspaces. Only in this case, the Add manual Business Relationships menu
option is available.
Tip: You can use several Related Business Workspace folders for different
types of related items.
4. If you want to display specific information in a Related Business Workspaces
folder, you define custom columns for that folder:
Custom columns configuration must be enabled. You need system
administrator rights in Content Server to enable this.
a. From the function menu of the Related Business Workspaces folder, select
Properties > Columns.
b. In the Local Columns add all columns to the Displayed Columns field that
you want to be displayed in the Related Business Workspaces folder.
c. Click Update.
Tip: For more information about the user experience of this search option, see
Section 4.1.4 “Searching related items” in OpenText Extended ECM for SAP
Solutions - User Guide (ERLK-UGD).
• Status
Defines if related workspaces are not followed, always followed, or, if
following workspaces is provided as a selectable option, the user then can
select the Follow Contained Workspaces option in the Search From Here
menu.
• Limit
Sets the maximum number of business workspaces that are searchable. If the
content of the Related Business Workspaces folder exceeds this number, the
business workspaces that have been recently modified are searched first.
1. Go to the volume, where the templates for your folder are kept:
• Cases and Binders – Document Templates volume. From the Global menu,
select Enterprise > Document Templates.
• Folders – Document Templates volume. From the Global menu, select
Enterprise > Document Templates.
• Communities – Community templates volume. On the Content Server
Administration page, click Communities Administration > Open the
Community Templates Volume
3. From the function menu of the item template, select Copy to Workspace
Template.
4. On the following page, select the workspace type and enter a name for the new
template. Some templates may require additional information.
5. Click Save Changes.
The new workspace template is created in the Document Templates Volume. It
contains all subfolders and content of the original item template. The original
item template remains unchanged. You could use it again to create other
workspace templates.
For more information about Scheduled Processing in general, see “Using Scheduled
processing“ on page 275.
You can chose from the following actions to existing business workspaces:
• Add folder
• Update team roles and permissions
1. On the global menu, click Enterprise > Extended ECM > Scheduled Processing.
• Keep history
• Simulation Mode: Select to not actually run the job but simulate your
selections.
• Workspace IDs: Select one or more business workspaces to be processed. If
you leave this empty and enter a Document Template ID, all business
workspaces for this template will be processed. If you enter IDs and a
Document Template ID is given, the workspaces IDs will be ignored.
• Document Template IDs: Select from a list of templates. Leave empty to
synchronize all templates.
• Keep Reports
• Folder structure
• Team roles
• Access permissions
Create a template:
When you assign permissions to an item, you can grant users different permissions.
When you grant a higher level permission, such as Full control, the lower level
permissions, such as Write – Reserve, are automatically granted. If you want to
grant permission for specific functions, you can select Custom and then choose the
individual permission.
Edit permissions:
1. Click the More actions button on the Action Bar of a document and select
View permissions.
2. To add a user or group, proceed as follows:
Note: You can use cross-application business workspaces if you want to associate
similar business object types from different business applications with one type
of workspace. For this, you use one workspace type for several business object
types. For example, a person is stored as a business partner in one system and
as a vendor in a different business application, both roles are displayed in the
same workspace type. For more information, see “Cross-application business
workspaces for identical business objects” on page 22.
3. Click the Add Item button and select Business Object Type.
4. To save the new business object type, you need at least the information
described in “Configuring a basic business object type” on page 135. All other
configuration sections are optional at this point and can be completed later.
Name
Name of the business object type. This is an internal name and only visible to
administrators. OpenText recommends that you use the name under which the
business object is known in the business application. You can also add the name
of the business application.
Business Application
Business Application: Select one of the business applications that is connected
to Content Server. If a connection could be completed, you see a green
checkmark and you can then select the business object type from the business
application.
Tip: You can also create the business object type without connection to the
SAP system. The Extended ECM configuration tries to link to the SAP
system.
Business Object Type
Business Object Type: Enter the name of the business object type in the
business application. If a connection to the business application is active, click
Select From Business Application and select the required business object type
from the list of all business object types that are available in the SAP system. If
you are not connected to the SAP 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.
The business object type can be displayed to the end user, for example in the
Smart View header widget. Therefore, you can edit the business object type
name, also in different languages. The Widget Configuration for Smart View is
located at the end of the configuration page.
Display URL
The URL which displays business object information on the business application
server. For more information, see “Creating the display URL” on page 144.
Tip: You can later change this with an option in the function menu of a
business object type.
• No Web URL will be 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.
Workspace Template
When users create a business workspace from the business application, they
cannot select the document template manually. With these options, you select
the method how the document template is determined:
• Content Server Template: Select the document template that you created for
this business object type from Content Server. For more information, see
“Defining a workspace template” on page 111.
• From Business Property: The business property provides the ID of the
template. This method is used when a dynamic template determination is
needed. To use this method, the property provider must be implemented
accordingly.
You must also map business properties to category attributes. For more information,
see “Mapping business properties to category attributes” on page 138.
If no mapping is configured here, the document will neither be filed nor migrated to
Content Server using native attachment archiving.
• External Document Type: Select an external document type from the list that
displays all document types configured for the business object in the
business application. A document type may be specified at most once.
Notes
• Map all fields of the business object type that you want to display in
Content Server. Make sure that you also map all fields that are required
for the determination of the workspace name and the location. If you
need attributes for Content Server policies that are generated from SAP
authorizations, you must map them as well. For more information, see
“Mapping authorizations in SAP” on page 151.
Business Properties
Configure Barcode
Select From Category Attribute and provide the respective category and
attribute.
In Perspective Manager, you configure this business object type in the widget with
which users scan the code. For more information, see “Scan barcode widget”
on page 109.
For more information about OpenText™ Content Server Mobile, see OpenText
Content Server Mobile App - Installation Guide (CSMOB-IGD) and OpenText Content
Server Mobile - Configuration Guide (CSMOB-CGD)
3. Select the function menu option Disable so that this business object type cannot
be used to create business workspaces, neither can it be used to add business
objects to a Content Server item, regardless of whether the Can be Added as
Business Object option is selected or not.
The business object type will still be available to display previously created
business workspaces or added business objects.
The business object type cannot be used for the search or display of the
corresponding workspace type.
4. To delete a business object type, select the business object type and click the
Delete button .
Service URL
Name of the Core Data Service (CDS) in SAP S/4HANA. Each business object
has one CDS, which you copied into your Z namespace to make it available.
Collection
Name of the collection associated with this business object
Search Form Attributes
Attributes displayed in a search form with which users search for business
objects to add them to a business workspace, as well as in the resulting result
list. Click to move attributes from the list of Available Attributes to the list of
Displayed Attributes.
Important
You must not use attributes with the same label in the Displayed
Attributes. If you cannot rename the label, you must remove the attribute.
Events
Event that triggers an automatic creation, usually the CREATE event.
Business Relations
Manually set relations between properties modelled in the CDS view and
business object types of the business application.
Cross-Application Relations
In this section you can configure the automatic creation of a cross application
relation. The selected business property needs to contain the ID of the business
object in the other business application. Select the business application of the
business object that you want to link and the corresponding business object type
that you want to link in that business application.
3.17.7.1 Restrictions
For the integration with S/4HANA Cloud, the following restrictions apply:
• When searching for a business object, the input given for non-string fields
must be complete. Partial input or wildcards do not yield a result.
• You must not use attributes with the same label in the search form, with
which you search business objects while creating a business workspace. The
Displayed Attributes list must not contain the same name twice. If you
cannot rename the label, you must remove the attribute.
2. S/4HANA adapter
The S/4HANA adapter supports those business objects, which are having
keyfields of type STRING.
3. Scheduled Processing
A Scheduled Processing job created for “Listen to S/4HANA Events” does not
consider the input given for the Business Object Type field. The job processes
all business objects found in the event queue and which are registered.
4. Versioned documents
Content versioning is not supported by SAP CMIS. Documents must not be
versioned.
Note: After you created all relevant items on Content Server and before you
create the document declarations or policy definitions, you must define unique
names for all Content Server items that are relevant for your document
declarations or policy definitions.
3. To add a unique name, click the Add Item button and then click Unique
Name.
a. You can rename a unique name, however you must then change the unique
name in all places where it is used.
b. You can move a unique name from one group to an other group.
c. You can delete a unique name.
Notes
• If you delete a unique name, you must make sure that it was not
used anymore.
Notes
• If you delete a unique name group that contains unique names, the
unique names are deleted as well.
• If you delete a unique name, you must make sure that it was not used
anymore.
• You cannot restore a unique name.
• You cannot delete the default groups General and Appearances.
• For workspace references, this URL is used for the Display button on the
General tab of the business workspace's 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.
The following sections provide example display URLs for selected business
applications.
<Cat ID> Category ID which you find in the URL of the category in
Content Server: ...&objId=1234567&...
<attribute name> Name of the attribute
<set name> With attributes grouped in a set, you must also use the set
name followed by a colon and the attribute name.
$attribute:catname=<Cat ID>,attrname=<set name>:<attribute name>$
$BaseUrl$/sap/bc/gui/sap/its/webgui?~logingroup=SPACE&~transaction=%2fOTX
%2fRM_WSC_START_BO+KEY%3d$attribute:catname=1234567,attrname=LastName$%3bOBJTYPE%3d
$BorObjectName$&~OkCode=ONLI
To identify the SAP SRM business object, you can use the BorObjectID or a category
attribute. Business partners (BUS1006), however, are handled differently.
The following provides URL templates that you can fill with the values from the
table below.
$BaseUrl$/?NavigationTarget=OBN://BOSystemAlias=SAP_SRM/
BOTechnicalName=<Technical Name>/Operation=<Operation>&NavMode=3&
SAPSRM_BOID=$attribute:catname=<Cat ID>,attrname=<Attr Name>$&
SAPSRM_MODE=DISPLAY
&crm-object-action=B&crm-object-value=$BorObjectId$
Substitute <Object Type> with values from the respective column in “CRM business
objects that are supported by Extended ECM” on page 367.
&crm-object-action=B
&crm-object-value=$BorObjectId$
Example URL for Business Partner displayed for Business Role “Sales
Professional”
$BaseUrl$/sap/bc/bsp/sap/crm_ui_start/default.htm?crm-object-type=BP_ACCOUNT
&crm-object-action=B&crm-object-value=$BorObjectId$
&crm-object-keyname=PARTNER&saprole=SALESPRO
&node=Root&operation=OnExtInspect¶m.InternalID=$BorObjectId$¶m.Type=<item type>
The Lead business object is not yet mentioned in the official list, though.
Alternatively, you can also use the GUID. To do so, however, the GUID must be
stored in a category attribute.
&node=Root&operation=OnExtInspect¶m.InternalID=$BorObjectId
$¶m.Type=COD_ACCOUNT_TT
bo=COD_GENERIC&node=Root&operation=OnExtInspect¶m.InternalID=$BorObjectId
$¶m.Type=COD_OPPORTUNITY_THINGTYPE
node=Root&operation=OnExtInspect¶m.InternalID=$BorObjectId
$¶m.Type=COD_SRQ_AGENT_TT
&sap-language=<language>#<semantic object>-<action>
&sap-language=EN#<Semantic Object>-Action
&/newdetail/SalesOrders(\'$attribute:catname=6377616,attrname=Sales Order ID
$\')/$attribute:catname=6377616,attrname=Customer ID
$/$attribute:catname=6377616,attrname=Ship To$/1000/10/00
Note: This sample URL contains line breaks for better readability.
For more information, see “Integrating Extended ECM for SAP Solutions into
SAP Fiori apps“ on page 317.
• Business Administration:
Content Server Document Templates
Business Workspaces
Extended ECM
Extended ECM for SAP
• Move Business Workspaces: Only users with this privilege can move a business
workspace to a different folder.
• Edit attributes relevant for group mapping: This privilege is relevant if you use
group replacement in the template. It restricts the editing of attributes that are
used to define the groups that have access to a business workspace. For more
information, see “Defining group replacement settings” on page 124.
• Regenerate Reference Attribute: This privilege allows to generate a new
reference number. This may be necessary if the reference number contains
attributes and these attributes have changed. For more information, see “Using
the Reference attribute” on page 86.
• Change/Remove Workspace Reference: This privilege allows users to change
the business object of a business workspace, or remove the business object from
the workspace.
• Access Business Workspaces (<Product Name>): This privilege is provided by
each installed Extended ECM product. It necessary to access a business
workspace. It is also the basis for license measurement. .
• Display Business Objects: This privilege allows users to display the data of a
business object in the business application.
• Add/Edit/Remove Business Objects: This privilege allows users to add business
objects to Content Server items.
For more information about permissions and privileges in Content Server, see
Section 4.3 “Permissions on Content Server” in OpenText Extended ECM for SAP
Solutions - User Management and Access Control Scenarios (ERLK-CUM).
Important
The Content Server category attributes used for policies must be defined in the
metadata mapping configuration.
For information about the complete configuration, see Section 7 “Using SAP
authorizations to restrict workspace access (optional)” in OpenText Extended ECM for
SAP Solutions - User Management and Access Control Scenarios (ERLK-CUM).
1. In the IMG, navigate to the Extended ECM > Maintain Business Object
Declarations activity and click Execute.
2. Select a business object declaration from the list and double-click Workspace
Authorization.
3. Click New Entries and provide the following information:
4. Select the entry from the list of available authorizations and double-click Field
Mapping.
Object Type
SAP business object type related to the workspace.
Object
Authorization object in SAP which is related to the SAP business object
type.
Field name
Field name of authorization object in SAP which is related to the SAP
business object type.
Category unique name
Unique name configured for the Content Server category. For more
information about configuring unique names, see “Creating unique names
for Content Server items” on page 142.
Search help for business objects assists you to manually create business objects, to
add a Content Server item to a business object or to automatically create business
workspaces in batch reports. For more information, see “Creating a business object
declaration in SAP” on page 54 and “SAP: Creating or updating business
workspaces using batch operations” on page 472.
Note: You can use Elementary Search help, and search help using CDS entities
(e.g., MEKKD). Collective search help is not supported.
You define the search help in the business object declaration. For more information,
see “Creating a business object declaration in SAP” on page 54.
1. In the IMG, navigate to the Extended ECM > Maintain Business Object
Declarations activity and click Execute.
2. Select a business object declaration from the available list; then double-click
Search Help F4 Support in the Dialog Structure area.
3. Enter or modify the following parameters:
Exact Search
If active, the search looks for values that exactly equal the search criteria
(value = search criteria). If not active, the search will look for values that
contain the search criteria (search for values with pattern
*search criteria*) .
1. In the IMG, navigate to the Extended ECM > Business Object Declarations
activity, select a business object declaration from the available list and double-
click Search Help Business Object Key.
Object Type
Business object that is used as workspace reference or as a business object
that is added to a Content Server item.
Key field
Key field of the business object.
SearchHelpParam
Parameter of the search help.
Key inactive
If active, the key field of business object will not be filled. This setting is
used in cases where a key of a business object is composed of several key
fields, but not all fields should be filled.
For example, the business object WBS Element (BUS2054) has a key with two
key fields; but only one is actually used by SAP, for example when storing a
document with ArchiveLink.
To be consistent with SAP, deactivate the key field that is not used by
setting this parameter.
Note: To use search help for specific business objects, you must regenerate the
respective business object declaration reports.
Example: You decided to create a business workspace for each one of your customers.
Instead of creating the workspace manually when you created a new customer, you customize
Extended ECM for SAP Solutions to automatically create a business workspace for each new
customer.
For this, you use the SAP event CREATED that triggers the creation of a workspace.
In addition to the steps you take to enable manual workspace creation, you must
customize the events that trigger the automatic creation.
Extended ECM for SAP Solutions provides the following function modules for the
automatic update and creation of workspaces. To use the asynchronous queuing,
use the respective function module that end with _ASYNC or _ASY. For more
information, see “Creating business workspaces and declaring document
asynchronously” on page 156.
For more information, see “SAP: Using change documents for the automatic
creation and updates when events are missing” on page 208.
• /OTX/RMSRM_CL_EVT_UPD method for SAP SRM. This method creates and
updates workspaces in SAP SRM.
For more information about the Maintain Receiver Module Events IMG activity,
see “SAP: Linking events to receiver type function modules” on page 200.
Parallel You can use parallel processing for the asynchronous queue. In order to increase
processing speed, you can define that several processes run in parallel for a defined number of
items. You can define the settings for the program when you schedule the
background job.
Monitoring You can monitor the queue, check errors and re-start a queued item manually. You
can also control the queuing process by locking writing to or reading from the
queuing database table or locking the process itself. For more information, see
“Setting queue properties” on page 159.
Queue processing
API functions The Extended ECM for SAP Solutions contains function modules for Create or
and function Update events to be processed either synchronously or asynchronously. For
modules
workspace creation that is not event-based, you can use the new API methods. The
API is described in the SDK documentation, which you find in OpenText My
Support (https://knowledge.opentext.com/knowledge/cs.dll/Open/63007681).
Note: OpenText recommends that you first analyze the rate of the workspace
creation and update operations and the time one operation consumes. In most
cases, the manual queue processing can deliver the best system response time
and resource consumption rate. So according to the results of the analysis
schedule the queue processing manually to run in periodically.
If you want to process manual workspace creation via the asynchronous queue, you
must address the BOR API. For more information, see the SDK documentation,
which you find in OpenText My Support (https://knowledge.opentext.com/
knowledge/cs.dll/Open/63007681).
1. In the IMG, navigate to the Extended ECM > Maintain Receiver Module
Events activity and click Execute.
2. Configure events with a function module that is designed for the asynchronous
queue. For more information, see “SAP: Linking events to receiver type function
modules” on page 200.
• For the /OTX/RM object, for the /OTX/RMACT field, set the value to 03.
• For the J_6NRL_WSC authorization object, for the /OTX/RMWAC field, set the value
to 01.
1. In the IMG, navigate to the Extended ECM > Maintain Declaration Queue
activity and click Execute.
2. Set the following options according to your requirements:
• Lock queue filling: Writing to the queue is disabled. No more items can be
added.
• Lock queue reading: The queue processing background process is disabled.
Reading from the queue is disabled and thus, no business workspaces will
be created. This attribute is checked regularly by a running background
process and if set to true the process quits.
• Max processing count: Number of times an item is processed before it enters
the status Persistent Error. For more information, see “Re-processing or
deleting failed items” on page 162.
3. Define the settings of the queue processing program /OTX/RM_WSC_Q_
CONSUMER_BGJOB.
e. Save your entries. These settings are used when the program is executed.
4. Use the SAP background job scheduler (transaction SM36) to plan the queue
processing program /OTX/RM_WSC_Q_CONSUMER_BGJOB.
Select a user with which the business workspaces will be created. This user
must have the authorizations defined in “Setting up asynchronous queueing for
event-based creation” on page 158 and all necessary permissions in Content
Server. This user is also the owner of the business workspaces in Content
Server.
2. Optional Click Queue status to view the current settings of the asynchronous
queue and the number of items that are currently processed.
3. Select a an option: either view a simple count of failed items or view a detailed
list of failed items. For more information about the other options, see “Re-
processing or deleting failed items” on page 162.
4. Provide filter criteria as required. You can enter your filter criteria for document
declarations separately.
In the Max. Nr. of Displayed Rows field, enter the number of rows you want to
see. You can later browse to the other rows.
6. If you selected Display list of failed items, the detailed list displays all failed
items, which match your filter criteria.
7. Click the link in the Application log error column to see more information from
the application log.
For a failed business workspace creation, select the item and click Display
Object to view the business object
For a failed document declaration, select the item and click Display
Document to view the document in the archive.
9. To re-process failed items, select one or more rows, then click Re-process
selected items.
To re-process items:
3. Provide filter criteria as required. You can enter your filter criteria for document
declarations separately.
In the Max. Nr. of Displayed Rows field, enter the number of rows you want to
see. You can later browse to the other rows.
The asynchronous queue now uses a number range. You can view the current state
of the number range interval.
Any user who has access to one of the business objects in one of the SAP system also
has access to the workspace, and thereby to the information provided by both
systems.
• Property providers
At least one property provider must contain information about the other related
business object type. OpenText My Support (https://knowledge.opentext.com/
knowledge/cs.dll/Open/63007681).
• Template and categories
Create a template and categories with attributes. You can either create a category
that fits both business object types, or create separate categories for the two
business object types.
• Business object types
Create business object types for each of the business objects. The business object
types must have the same document template and the same workspace type.
Also define, which of the business object types should be leading by default for
displaying the business object in the respective enterprise application.
For the mapping of business properties to category attributes, you have the
following options:
– Map the properties of the business object to the same category attributes on
Content Server.
If information changed for one business object in one of the enterprise
applications, the business workspace is updated. If two business objects map
their properties to the same attribute on Content Server, the last update wins.
– Map the properties of all business objects to attributes of different categories
on Content Server. With this, attributes are displayed on different tabs of the
business workspace.
• Workspace types
You must use the same workspace type for both business object types.
• Access to workspaces and to functions related to the SAP system
If access to the business workspace is based on policies take into consideration
the following: If users have access to at least one of the business objects in one of
the SAP systems, and the policies are created accordingly, the users will have
access to the workspace on Content Server.
For displaying the search help, the SAP user that you used in the Connections to
Business Applications (External Systems) must have the corresponding
authorization in the SAP system that is defined as default (Default Search for
Workspace Type in the business object type definition on Content Server). For
more information, see Section 23.3 “Connecting SAP as the business application”
in OpenText Extended ECM for SAP Solutions - Installation and Upgrade Guide
(ERLK-IGD).
• For some SAP versions, the SAP logon ticket seems to contain the target system
and client, so there might be restrictions concerning the use of cross-application
business workspaces together with SAP logon tickets.
Example: The following BOR objects are examples for a composite business workspace
scenario in SAP Plant Maintenance:
Tip: A sample property provider for SAP ERP task lists and operations is part
of the SAP Extended ECM Solution Accelerator for SAP PM (https://
knowledge.opentext.com/knowledge/cs.dll/Open/37717526).
• You need a business object declaration for both the parent and the child
business object.
For more information, see “Configuring business object types” on page 133.
Workspace type
You only need to specify the Workspace Location for the workspace type for the
topmost parent business object. For a child business object, the location is always
the business workspace of the parent, regardless what you specify in the
workspace type.
Policies
Child business workspaces cannot have their own policies; they inherit policies
from their parent.
Creation
SAP – When you create a business workspace for a parent business object
automatically or manually, business workspaces for all according child business
objects are created.
Content Server – When you create a business workspace for a parent business
object, no business workspaces for child business objects are created.
Deletion
When you delete a parent business workspace, all child business workspaces are
deleted, too.
Search behavior
Documents that are indexed with the metadata of their business workspace,
inherit also the metadata of all parent business workspaces.
For more information, see “Indexing documents and other items with business
workspace attributes” on page 417.
Sidebar widgets
When the business workspace is restored from the Recycle Bin, it is not re-connected
to the original business object. Users must manually assign a business object as
workspace reference again.
The object types Business Workspaces (848) and Related Business Workspace (854)
are mandatory restorable object. This means, that they are always restorable and
cannot configured otherwise.
After installation, unique names for standard SAP themes already exist. You can edit
these unique names and their assignment. Changes take effect immediately. The
following SAP themes are already configured: content_server, default, sap_
tradeshow, sap_tradeshow_plus. Unique names for appearances must use the
prefix theme_ and they are always expected in lower-case, even if SAP sends the
parameter in upper-case. For more information, see “Creating unique names for
Content Server items” on page 142.
Note: System administrator rights are required for this task. Contact OpenText
Professional Services for assistance.
3. Check if the following settings are present according to Figure 3-7 or Figure 3-8.
These settings will turn off certain standard Content Server UI components such
as header and footer; an additional JavaScript will be added to the appearance
to manipulate the breadcrumb navigation.
By default, the add-in allows users to browse to and search for business workspaces
and select a folder in which to save an email. If needed, you can also force users to
save emails to a specific regular folder or Email folder in a business workspace.
Tip: For more information about Outlook add-ins, see Add-ins for Outlook
(https://technet.microsoft.com/EN-US/library/jj943753(v=exchg.150).aspx).
You must download the latest manifest file for the Business Workspaces Outlook
add-in from the Content Server system you want to use to store emails. During the
download process, information about that Content Server system is saved to the
manifest file. You can then use the downloaded manifest file to install or upgrade
the add-in in Microsoft Exchange or Microsoft Exchange Online.
When users subsequently open the add-in in Outlook, the add-in automatically
connects to the Content Server system you used to download the manifest file.
If you upgrade the Business Workspaces Outlook add-in, downloading the manifest
file, as documented in “To download the latest Outlook add-in manifest file:“
on page 171, allows you to see all functionality of the upgraded module.
Tips
Note: You must use the manifest file you downloaded to install the Business
Workspaces Outlook add-in in Microsoft Exchange or Microsoft Exchange
Online. During the installation process, when you are prompted to select the
location from which to install the add-in, select Add from file and then select
the manifest file you downloaded.
For more information, see Install or remove add-ins for Outlook for your
organization (https://technet.microsoft.com/en-us/library/jj943752(v=exchg.
150).aspx).
For more information about configuring a web server for Content Server, see
OpenText Content Server - Installation Guide (LLESCOR-IGD).
1. On the Content Server system you want to use to store emails, browse to the
Content Server Administration page, and click Business Workspaces > Set up
Outlook Add-in.
2. On the Set up Outlook Add-in page, in the Outlook Add-in Manifest File area,
do the following:
a. The File name field cannot be edited. This field contains the filename of the
manifest file, BusinessWorkspace.Manifest.xml.
b. The File version field cannot be edited. It displays the Outlook add-in
manifest file version that is available to be downloaded.
c. In the Content Server URL field, confirm that the value in this field
displays the URL for the Content Server system you want to use. The URL
must start with https.
By default, the URL of your current Content Server system is pre-populated
in this field. In most cases, you can keep the default URL. However, you
can edit the URL if, for example, the pre-populated URL does not contain
the correct protocol value or if your Content Server system requires a
different URL for external access.
Notes
• If the pre-populated URL starts with http, you must map Content
Server to a web server that has HTTPS enabled. You must then
confirm that the new URL, that starts with https, appears in the
Outlook Add-in Manifest File area.
• If you edit the URL, and you are using a port other than 443 for
HTTPS connections, you must add your server port number to the
URL. For example, if you are using port 4430 for HTTPS
connections, the URL must have the following form:
https://MyHost.example.com:4430
3. Click Download.
3.29.1.3 Migrating custom settings to the new Outlook add-in manifest file
If you are upgrading the Business Workspaces Outlook add-in, you must migrate
settings from your old manifest file to the new manifest file you downloaded if you
previously edited your old manifest file to add custom settings, for example, image
URLs.
Note: If you did not add custom settings to your old manifest file, you can skip
this task.
To migrate custom add-in settings to the new Outlook add-in manifest file:
2. From your old manifest file, copy the custom settings you want to migrate and
paste them to the corresponding locations in the new manifest file.
Tip: For more information about installing Outlook add-ins, see Install or
remove add-ins for Outlook for your organization (https://
technet.microsoft.com/en-us/library/jj943752(v=exchg.150).aspx).
1. In Microsoft 365 admin center, open the Services & add-ins page.
4. Select I have a manifest file (.xml) on this device and click Choose File to select
the BusinessWorkspace.Manifest.xml file you downloaded.
1. Create and configure the business workspaces and folders in which you want
users to save emails. For more information about the types of folders you can
create and the guidelines for creating the folders, see “Creating Content Server
folders for the add-in” on page 173.
2. Grant users the Add Items permission, or higher, on the business workspaces to
which they will save emails.
3. Optionally, if you want users to specify metadata values when saving emails to
folders, assign any of the following categories to those folders:
You must create one or more regular or Email folders in each business workspace
based on the functionality you plan to configure.
• If you plan to allow users to browse to, and then select, folders in which to
save emails, you can create as many regular folders as you want in each
business workspace.
• If you plan to force users to save emails to a specific, regular folder, you must
create an instance of the same folder in each business workspace. The
spelling and capitalization of each folder instance must match in all of the
business workspaces.
Example: If you want to allow users to save emails to a business workspace called
BW1, and also save emails to a second business workspace called BW2, create a regular
folder called Email communication in BW1, and a separate folder with the same name
in BW2.
• If you plan to allow users to browse to, and then select, folders in which to
save emails, you can create as many Email folders as you want in each
business workspace.
• If you plan to force users to save emails to a specific Email folder, you must
create an Email folder in each business workspace. You can choose to create
an Email folder with a different name in each business workspace or create
an instance of the same Email folder in each business workspace.
If you create an Email folder with a different name in each business
workspace, each folder that you create must be the first Email folder that
appears alphabetically in each business workspace. When a business
workspace has multiple Email folders, emails are saved only to the first
Email folder that appears alphabetically in that business workspace.
If you create an instance of the same Email folder in each business
workspace, the spelling and capitalization of each folder instance must
match in all of the business workspaces.
Tip: Regular folders and Email folders are specific types of folders that you can
create in Content Server. For more information about each folder type, see
Section 4.7 “Adding and Configuring Folders” in OpenText Content Server - Get
Started (LLESRT-H-UGD).
If you want to display a different set of search forms in the Select a search form list,
you can add search forms, or shortcuts that point to search forms, to the Search
Forms folder in the Business Workspaces volume. You must also configure each
search form as a custom view search.
1. For more information about creating search forms and configuring them as
custom view searches, see Section 5.15.4 “Classic View: Configuring a
• Create a search form in the Search Forms folder. Browse to the Search
Forms folder, click Search on the Tools menu, and then configure the search
fields for the form.
• Create a search form in any other Content Server location, and then add a
shortcut that points to that search form in the Search Forms folder.
Tip: When you create a search form, consider setting its Content Type
system attribute to Business Workspace. When this attribute is set, only
business workspaces are returned in the search results.
2. Configure the search form as a custom view search. On the Make Custom View
Search page of the search form, select the Show check box for one or more
search fields, and then click Save.
Before Outlook Add-in version 20.3, single sign-on (SSO) was disabled by default.
Beginning with version 20.3, for new installations, SSO is enabled by default. You
can change this setting in Step 6. Single sign-on requires configuration, the
instructions can be found in Section 5.17.5 “Configuring your environment for SSO
authentication” in OpenText Business Workspaces - Configuration Guide (CSCWS-CGD).
1. On the global menu, click Enterprise > Business Workspaces, and then click
Outlook Add-in Configuration.
2. Click General Configuration. On the Configure Outlook Add-in page, do the
following:
3. In the Email Saving Options area, if you want to specify the folders and folder
types to which users can save emails, configure the following options:
• In addition, if you want to restrict users, so that they can only save
emails to Email folders, select Save emails only to email folders. Clear
this box if you want to allow users to save emails to any type of folder.
This box is cleared by default.
When this box is selected, the Save icon appears only when users place
their pointer on Email folders in the add-in. When this box is cleared,
the Save icon appears when users place their pointer on any type of
folder in the add-in.
b. Optional If you want users to save emails to a specific folder in a business
workspace, select Save emails to a pre-configured folder. This box is
cleared by default.
Clear this box if you want to allow users to save emails to any folder in a
business workspace. If you clear this box, you must select and configure the
Allow users to expand workspaces and browse workspace folders option
in Step 3.a instead.
If you select this box, you must choose one of the following options:
• If you want users to save emails to the first Email folder that appears
alphabetically in a business workspace, select Save emails to the first
email folder in the workspace.
You can use this option if, for example, you want to allow users to save
emails to Email folders with different names in each business
workspace (for example, an Email folder called MyFolder in one
business workspace and an Email folder called Communication in
another business workspace).
If you select this option, you must create an Email folder in each
business workspace that users can access in Content Server. Each folder
you create must be the first Email folder that appears alphabetically in
each business workspace.
• If you want users to save emails to the workspace root folder, select
Save emails to the workspace root folder. For information about the
workspace root folder, see Section 1.11 “Creating a root folder for the
business workspaces” in OpenText Content Server User Online Help -
Business Workspaces (LLESCWS-H-UGD).
• If you want users to save emails to a specific regular folder or Email
folder, select Save emails to the following workspace folder. You can
use this option if, for example, you want users to save emails to a
specific folder that has the same name in each business workspace.
If you select this option, in the associated box, you must specify the
name of the folder to which users will save the emails. You must also
create an instance of the folder in each business workspace that users
can access in Content Server.
By default, this option is selected, and users can use search forms to search for
business workspaces. You can specify which search forms are available in the
add-in. For more information, see “Creating search forms for the add-in”
on page 174.
When this option is cleared, the Custom search button is hidden from the add-
in and users can search for business workspaces only by name and type.
6. Optional In the Single Sign-on area, clear Enable if you do not want the add-in to
use single sign-on (SSO) authentication to access Content Server. By default, this
option is selected and SSO authentication is used.
You must configure your environment for SSO authentication. For more
information, see Section 5.17.5 “Configuring your environment for SSO
authentication” in OpenText Business Workspaces - Configuration Guide (CSCWS-
CGD). If your environment is not configured for SSO authentication, users will
still be able to sign in, although the sign-in time will be delayed.
7. In the Trusted Exchange Servers area, specify the name of each Exchange
Server system that will be used to save emails. Users will be permitted to save
emails only from the Exchange Server systems you add to this list.
You must specify each Exchange Server name on a separate line. By default, the
Office 365 Exchange Server name, outlook.office365.com, appears in the list.
In this example, users can browse to and select any folder in which to save
emails. The Save icon appears whenever users place their pointer on any folder
in any business workspace.
Folders to create
Any number of regular folders or Email folders in each business
workspace.
Folders to create
An Email folder in each business workspace. Each folder can have a
different name in each business workspace. Make sure that each folder you
create is the first Email folder that appears alphabetically in each business
workspace.
In this example, users can expand business workspaces to browse the folder
structure; however, they are permitted to save emails only to Email folders. The
Save icon appears whenever users place their pointer on an Email folder. The
Save icon does not appear when users place their pointer on regular folders.
Folders to create
Any number of Email folders in each business workspace.
Folders to create
An instance of a regular folder called Folder1 in each business workspace.
Email saving options to configure
1. Clear the Allow users to expand workspaces and browse workspace
folders option.
2. Select Save emails to a pre-configured folder.
3. Select Save emails to the following workspace folder, and then specify
Folder1 as the name of the folder to which users can save emails.
Example 3-7: Requiring users to save emails to the workspace root folder
Folders to create
You do not need to create any folders. You need to designate the
workspace root folder. For more information, see Section 1.11 “Creating a
root folder for the business workspaces” in OpenText Content Server User
Online Help - Business Workspaces (LLESCWS-H-UGD).
Email saving options to configure
1. Clear the Allow users to expand workspaces and browse workspace
folders option.
2. Select Save emails to a pre-configured folder.
3. Select Save emails to the workspace root folder.
Whenever a user opens the add-in to save an email, the add-in performs the
following steps to determine which business workspaces to display in the Suggested
workspaces list:
1. The add-in uses the rules you configured to search for business workspaces
based on whether the email that is open contains a specific term or pattern in one
of its properties, for example, its subject line.
2. The add-in uses the email search settings you configured to search for business
workspaces containing emails that have the same sender and similar recipients
as the email that is open.
3. After performing both search processes, the add-in assigns the numeric weight
values that are specified within the rules and email search settings to each
business workspace. An overall weight value is calculated for each business
workspace based on the combined results of both search processes.
The business workspaces that have the highest overall weight values are then
displayed in the Suggested workspaces list. By default, up to five business
workspaces can appear in the list.
For more information about how the add-in performs each of these steps, see
“Understanding how rules and email search settings are applied” on page 181.
3.29.4.1 Understanding how rules and email search settings are applied
You can configure rules and email search settings on the Suggested Workspaces
Configuration page in the Business Workspaces volume. For more information, see
“Configuring Rules and Email Search Settings” on page 184.
Whenever a user opens the add-in to save an email, the following actions take place:
1. The add-in uses each rule that you configured to search for business workspaces.
When a rule is applied, the following actions take place:
a. The add-in uses the Matching Condition pattern and email property
specified within the rule to determine whether to apply the rule to the email
that is open. Specifically, the add-in checks whether the email property in the
opened email contains the pattern.
b. If the email that is open contains that pattern, the add-in searches for
business workspaces based on the Workspace Type value and Extraction
Term pattern specified within the rule.
The add-in uses the Extraction Term pattern to extract a value from the
email property you specified within the rule, and then uses the extracted
value to search for business workspaces by name.
Example: If you select Order as the Workspace Type value, and if the Extraction
Term pattern extracts 1234 from the email property, the add-in retrieves all business
workspaces that have the type Order, and have names that contain 1234.
d. The add-in assigns a numeric weight value to each business workspace that
is retrieved. These weight values are added to the overall weight value of
each business workspace.
By default, the Default Weight value specified on the Workspace Rules tab
is assigned to each business workspace that is retrieved.
Example: If the Default Weight value is set to 20, a value of 20 is assigned to the
overall weight value of each business workspace that is retrieved.
However, if a Weight value is specified within the rule itself, the Weight
value overrides the Default Weight value.
Example: If you set the Weight value to 100, but set the Default Weight value to 20,
a weight value of 100 is assigned to each business workspace that is retrieved by that
rule specifically.
2. The add-in then uses email search settings you configured to search for relevant
emails. The following actions take place:
a. The add-in searches within all business workspaces to find previously stored
emails that contain the same sender or similar recipients as the email that is
open. In the email search settings, you can specify whether the add-in
performs searches based on the sender, recipients, or both.
Example: If you configured the add-in to perform searches based on both the sender
and recipients, and if the email that is open lists jdoe@domain.com as the sender
and jsmith@domain.com as a recipient, all previously stored emails that list
jdoe@domain.com as the sender or jsmith@domain.com as a recipient are
returned in the search results.
b. When such emails are found, the emails are sorted based on the Sort Emails
by option specified in the email search settings. For example, you can sort
the emails based on their last modified dates.
c. The add-in retrieves emails from the top of the sorted set. The add-in
retrieves a maximum of 50 emails and any emails that appear after the first
50 emails are excluded from the set of retrieved emails.
d. The add-in assigns a numeric weight value to each business workspace that
contains emails that were retrieved in the previous step. The weight values
are assigned based on the number of retrieved emails that each business
workspace contains.
These weight values are added to the overall weight value of each business
workspace and are calculated using the Weight of each Email value
specified in the email search settings.
Example: If the Weight of each Email value is set to 5, and a business workspace
contains 3 of the retrieved emails, a value of 15 is added to that business workspace’s
overall weight value.
3. To calculate an overall weight value for each business workspace, the add-in
uses the weight values that are assigned as a result of applying the rules and
searching for emails.
Example: If a business workspace is assigned a value of 20 after the rules are applied and
a value of 15 after the email search takes place, that business workspace’s overall weight
value is 35.
4. The business workspaces that have the highest overall weight values are then
displayed in the Suggested workspaces list.
Tips
• For more information about rules and email search settings, see “Testing
your rules and email search settings” on page 184.
If a user opens an email that has this type of subject line in Outlook, the Business
Workspaces Outlook add-in automatically applies a default rule to determine which
business workspaces to display in the Suggested workspaces list. Specifically, the
add-in uses both the workspace type name and workspace name from the subject
line to search for relevant business workspaces to display in the Suggested
workspaces list.
The add-in assigns a numeric value of 30 to each business workspace that is found,
and then displays the relevant business workspaces in the Suggested workspaces
list.
If you configure rules and email search settings, the default rule is applied in
conjunction with the configured rules and email search settings.
You must first configure and save the rules and email search settings you want to
test on the Workspace Rules and Email Search tabs on the Suggested Workspaces
Configuration page. On the Test tab, you can then specify the properties to include
in a simulated email you want to test.
When you run the test, the add-in applies the rules and email search settings you
configured to the simulated email and displays the actions that would occur if a user
were to open an email containing the properties you specified. For example, the test
results show which values would be extracted from email properties and which
values would be used to search for emails and business workspaces when specific
rules are used.
If the test does not produce the intended results, you can edit the rules and email
search settings and run the test again. You can also run the test with different
simulated email properties.
1. On the global menu, click Enterprise > Business Workspaces, and then click
Outlook Add-in Configuration.
a. Optional Select the Show Suggested Workspaces Section option if you want
to display the Suggested workspaces list in the Business Workspaces
Outlook add-in. Clear this option to hide the list from the add-in. By
default, this option is selected.
b. In the Number of Suggested Workspaces field, select the maximum
number of business workspaces to display in the Suggested workspaces
list. By default, up to five business workspaces appear in the list.
a. Select the Default Weight value you want to assign to each business
workspace that is found by any of the rules you configure. By default, this
value is added to the overall weight value of each business workspace that
is found by a rule.
b. Optional If you want to configure a rule, in the Rules area, click Add a Rule,
and then configure the following settings.
• Subject: allows the add-in to search for patterns within the subject
line of the opened email.
• Sender: allows the add-in to search for patterns within the Sender
field of the opened email.
• To: allows the add-in to search for patterns within the To field of
the opened email.
• Cc: allows the add-in to search for patterns within the Cc field of
the opened email.
Note: You can specify only one capturing group within the
regular expression. If you specify multiple capturing groups,
only the first capturing group is used to extract the value
from the email property.
v. In the Weight field, if needed, select the weight value you want to
assign when business workspaces are retrieved by this rule
specifically. This value is added to the overall weight value of each
business workspace that is found by this rule.
By default, this value is set to Default, meaning that the value that is
selected in the Default Weight list in Step 4.a is assigned to business
workspaces that are found by this rule. If you select a value other than
Default, the Weight value overrides the Default Weight value.
c. Click OK.
Note: Clicking OK adds the rule to the rules list; however, the rule is
not saved until you click Save Changes or Apply.
d. You can now configure additional rules, as needed, by following the steps
in Step 4.b.
Once you are finished configuring your rules, you will see the rules list.
The rules are sorted by weight and then by name. Rules are applied in the
order they are listed.
Tip: In the rules list, you can click the Edit button to edit a rule, or
the Delete button to delete a rule. You can also enable or disable a
rule by selecting or clearing its check box in the Enabled column.
5. On the Email Search tab, configure the following settings:
a. In the Sort Emails by field, select one of the following options to specify
how to sort the emails that are returned in the search results:
• Last modified date: sorts the emails by the last modified date in
descending order.
• Relevance: sorts the emails according to the relevance rules that are
defined in Content Server. For more information about relevance rules,
see the Content Server Administration Online Help.
The Sort Emails by option specifies which emails are retrieved if more than
50 emails are returned in the search results. The add-in retrieves only the
first 50 emails from the search results and excludes all emails that appear
after the first 50 emails. If more than 50 emails are returned in the search,
the sort order specifies which emails are included in the set of retrieved
emails and which emails are excluded from that set.
b. In the Weight of Each Email field, if needed, specify a numeric value that is
added to the overall weight value of a business workspace whenever an
email is found by the search. By default, the weight value is set to 1;
however, you can specify any positive integer.
For example, if the Weight of Each Email value is set to 5, and if 3 emails
are found in a business workspace, a value of 15 is added to that business
workspace’s overall weight value.
c. Optional Select Search Email Sender if you want to allow the add-in to find
previously saved emails that have the same sender as the email that is
open.
d. Optional Select Search Email Recipients if you want to allow the add-in to
find previously saved emails that include similar recipients as the email
that is open.
6. Click Save Changes to save the rules and search settings and return to the
Outlook Add-in Configuration folder.
Tip: You can also click Apply to save the rules and search settings without
leaving the page.
1. On the Test tab, in the Outlook User area, specify an Outlook email address to
represent the user who saves emails in Outlook.
2. In the Email Properties area, specify one or more email property values to
include in the simulated email you want to test.
• Sender: specify the email address of the sender to include in the simulated
email.
• To: specify one or more email addresses to include as the recipient in the
simulated email.
• Cc: specify one or more email addresses to include as additional recipients in
the simulated email.
• Subject: specify a phrase or term to include in the subject line of the
simulated email.
3. Click Test.
When the rule is applied, the add-in searches the subject line of the opened
email for the term customer. If the subject line contains that term, the add-in
uses the extraction term pattern to extract the characters that appear after
customer in the subject line.
For example, if the subject line is customer ABCD, the add-in extracts the value
ABCD. The add-in then retrieves all business workspaces that have the type
Customer and whose names include ABCD.
When the rule is applied, the add-in searches the subject line of the opened
email for the pattern order[\s|-]+\d+, that is, the term order, followed by
one or more spaces or hyphens, followed by one or more numbers. If the
subject line contains this pattern, the add-in uses the extraction term pattern to
extract the numbers that appear after order in the subject line.
For example, if the subject line is order - 1234, the add-in extracts the value
1234. The add-in then retrieves all business workspaces that have the type
Order and whose names include 1234.
When the rule is applied, the add-in searches the Sender field of the opened
email for the pattern equipment_[\d]+@server.com, that is, the term
equipment, followed by an underscore, followed by any combination of
numbers, followed by @server.com. If the Sender field contains this pattern,
the add-in uses the extraction term pattern to extract the numbers that appear
between equipment_ and @server.com.
2. In the Extractable Email Fields area, confirm that the following email fields are
selected:
• OTEmailSenderAddress
• OTEmailRecipientAddress
For more information about configuring security parameters, see the OpenText
Content Server Administration Online Help.
If you are configuring SSO authentication in your environment, you must also add
the URLs of all servers that provide access to Content Server (for example, the
OpenText Directory Services server, ADFS server, and any proxy servers).
3. Click Sites, add the required URLs to the list of trusted web sites, and then close
the Trusted sites dialog box.
4. Click OK.
Per workspace You can inhibit copying for each workspace type.
type
Usage You can grant the Move Business Workspaces usage privilege to a group of users.
Privileges You need administrator permissions for this.
Classification As default, users can copy or move business workspaces only to folders, which have
independent the same classification as their original folder. However, you can disable this check
and allow users to copy or move business workspaces wherever they want to. This
is a system-wide setting and you need administrator permissions for it.
Business attachments are links between an item in Content Server and a business
object.
• From the SAP perspective, you open your business object; then you add a
Content Server item as a business attachment. Business attachments are displayed
in the Business Content window. Typically, this a document, a folder or an URL.
• From the Content Server perspective, you add a business object to the Content
Server item.
A business object that is added to a Content Server item is displayed in the
Business Objects tab of that item. They are also indicated by the Business
Objects icon.
1. SAP Property Provider – Write your own property provider or use the default
property provider which is part of Extended ECM for SAP Solutions.
For more information, see “Implementing a property provider in SAP”
on page 53.
2. Content Server – Enable a business object type so that it can be used as business
attachment, and select which Content Server object types can be used for
business attachments, typically folders or documents.
For more information, see “Configuring the adding of business objects to
Content Server items” on page 194.
3. Create a search form to find business objects in the business attachment widget.
For more information, see “Creating a search form for business attachments”
on page 420.
4. Optional Content Server – Configure the automatic adding of business objects.
For more information, see “Content Server: Configuring the automatic adding
of business objects” on page 196.
5. Optional For an automatic update of the attributes when business objects are
changed: In the SAP system (IMG), maintain the receiver modules. For more
information, see “SAP: Linking events to receiver type function modules”
on page 200.
Options
Important
If metadata mapping is configured for added business objects, you can
only create one business attachment per workspace type for a business
object.
• Enable Callback Interface Before Adding Business Objects (SAP only):
Optional execution of additional Business Add-Ins (BAdIs), which enhance
the SAP functions; these are executed prior to the process of adding a
business object.
• Enable Callback Interface Before Removing Business Objects (SAP only):
Optional execution of additional Business Add-Ins (BAdIs), which enhance
the SAP functions; these are executed prior to the process of removing a
business object.
Select the URL object if you want users to view shortcuts in the Business
Objects tab of the business workspace. For more information, see Section 4.6
“Adding a shortcut to a Content Server item using a Simple Search” in OpenText
Extended ECM for SAP Solutions - User Guide (ERLK-UGD).
Tip: You must first save a business workspace before you can click the
Manage Object Types button.
Automatic Adding of Business Object
Select this option to configure automatic adding of business objects.
Trigger Automatic Creation by
These options are only relevant if you want a configuration that adds business
objects automatically to Content Server items. For more information, see
“Content Server: Configuring the automatic adding of business objects”
on page 196.
Specify a category attribute; this attribute must be of the checkbox type
(Boolean).
When the user enables this attribute checkbox in the Category properties tab of
the document, the business object is added automatically.
Retrieve Business Object Key from
Specify the attribute that contains the key of the business object.
Note: The available parameter values are the key fields of the selected
business object type.
1. Open the business object type that you want to use to automatically add
business object to Content Server items.
2. Add a category to the business object type that contains a boolean attribute
(“true” or “false”) which you can use as a trigger.
Note: The available parameter values are the key fields of the selected
business object type.
For more information about the automatic handling, see “Configuring events for
business workspaces and business attachments“ on page 199.
For more information about permissions and privileges on Content Server, see
Section 4.3 “Permissions on Content Server” in OpenText Extended ECM for SAP
Solutions - User Management and Access Control Scenarios (ERLK-CUM).
For more information, see “SAP: Linking events to receiver type function modules”
on page 200.
You can customize the system so that whenever a business object is changed or
created, an action is triggered in Content Server. For example, when a business
object is created, a business workspace is created. Or when metadata is changed, this
change is transferred to the Content ServerExtended ECM.
Typically, this is based on CREATED and CHANGED events which are triggered by
the business object. However, if a business object does not provide events, you can
use change documents as an alternative method. This chapter explains how to find
out which method is appropriate and how you customize it.
Important
The following describes only roughly how to find event methods for a business
object type. For a detailed description, see the SAP NetWeaver help (http://
help.sap.com/saphelp_nw70/helpdata/EN/c5/
e4aeef453d11d189430000e829fbbd/frameset.htm).
To find out which event method the business object type requires:
1. Find out if your business object type provides the CREATE and CHANGE
events:
c. Check if the business objects provides the required events. If so, you can
maintain the events in the IMG for Extended ECM for SAP Solutions. For
more information, see “SAP: Linking events to receiver type function
modules” on page 200.
2. If the business object type does not provide events, check which change
documents it writes that you can use to trigger events:
a. Run transaction SE16 to view table TCDOB which maintains the change
documents.
b. In this table, the TABNAME is the name of the table, and the OBJECT is
the name of the change document object. For example, the business object
type KNA1 (Business Partner) writes a change document DEBI.
For more information, see “SAP: Using change documents for the automatic
creation and updates when events are missing” on page 208.
You define entries for every relevant business object event and link them to the
respective function modules.
Tip: For composite workspaces, you might need a custom function module
with additional logic.
To use the asynchronous method via queuing, use the respective function module
that end with _ASYNC or _ASY. For more information, see “Creating business
workspaces and declaring document asynchronously” on page 156.
Important
The SAP Workflow System must be set up and running correctly for events to
be created (SWU3 transaction). For more information, see the SAP
documentation.
Table 5-1: Receiver type function modules and events for business
workspaces
Table 5-2: Receiver type function modules and events for added business
objects
1. In the IMG, navigate to the Extended ECM > Maintain Receiver Module
Events activity and click Execute.
2. Click New Entries.
3. It depends on the object type if you define settings for a BOR Object Type or a
ABAP Class.
• Object Type: Name of the object type, for example, EQUI. For print lists,
enter PRINTLIST.
• Event: Event of the SAP business object type, for example CHANGED,
CREATED, ASSETTOBECREATED. The name depends on the object type.
• Event: Event of the SAP business object type, for example READY_FOR_
WORKFLOW. The names depend on the object type.
5. Click Save.
For examples of possible entries for the different scenarios, see “Configuration
examples for business workspace and business object updates” on page 205.
Tip: To find out if a business object writes the documents, see “Preparing
events implementation” on page 199.
Note: You can use only one of the function modules. If you need both the
update of business workspaces and of business objects, contact OpenText
Professional Services for assistance.
1. In the SWO1 transaction, derive a new subtype for the business object that does
not have the required events. For example, create a subtype Z_KNA1 for the KNA1
supertype. As program, enter Z_KNA1.
2. In the SWO1 transaction, for the created subtype, add the /OTX/RMWSC interface.
This interface creates the relevant events for the derived business object.
4. Link the function module to the event of the new subtype as described in “SAP:
Linking events to receiver type function modules” on page 200. In the Receiver
Type field, enter the name of the supertype of the derived business object, for
example KNA1.
• For business object types that do not have the required events to create or update
a business workspace or business objects. For more information, see “SAP: Using
change documents for the automatic creation and updates when events are
missing” on page 208.
For example, you can define that when the DEBI change document is created, for
the Z_KNA1 business object type, the CREATED event is triggered.
• For the update of policies when role assignments are changed or deleted. For
more information, see Section 7.5 “Enabling automatic policy assignment for
changed role assignments” in OpenText Extended ECM for SAP Solutions - User
Management and Access Control Scenarios (ERLK-CUM). You define two entries for
the PFCG change document object. If the PFCG change document object is changed
or deleted, for the /OTX/PFCG object type the USER_CHANGED event is triggered.
Tip: For more information about the creation of events when change
documents are written, see the SAP Help portal (http://help.sap.com/
saphelp_nw70/helpdata/EN/c5/e4aeef453d11d189430000e829fbbd/
frameset.htm).
1. In the IMG, navigate to the Extended ECM > Maintain Change Document
Events activity and click Execute.
• Change doc. object: Enter the change document object, for example DEBI.
• Object Category: BOR Object Type
• Object Type: Derived business object type, for example Z_KNA1.
• Event: Enter CHANGED or CREATED.
• Trigger Event: Select On Create or On Change.
For the update of policies when role assignments are changed or deleted, create
two entries. For more information, see Section 7.5 “Enabling automatic policy
assignment for changed role assignments” in OpenText Extended ECM for SAP
Solutions - User Management and Access Control Scenarios (ERLK-CUM).
• Event: USER_CHANGED
• Trigger Event: Select once On Change and once On Delete.
3. Click Save.
With Extended ECM for SAP Solutions, you can make SAP ArchiveLink and print
lists as well as SAP DMS documents available on Content Server.
In addition, you can set the declared SAP ArchiveLink documents and print lists
under the responsibility of OpenText Records Management by assigning an RM
Classification.
Record B
Multiple links to You can link one archived document to multiple business objects in the SAP system.
an ArchiveLink The business objects point to one document in Archive Server. At the same time,
document
Content Server creates multiple records with links to the archived document. You
can store the records in a business workspace or any other location in Content
Server.
Deleting With Records Management, you defined retention periods, which control when a
documents and record must be deleted. You can delete each record for the same document
records
independently of each other. However, the archived document is only deleted when
the last record has been deleted.
SAP
Business Business Business
Object 1 Object 2 Object 3
1 2
Content Server
Record A Record B
Archive Server
Archived
document
1. Record A is deleted:
Link between Business Object 1 and the Archived document is deleted. The
archived document is not deleted, though, as there is still another record linked
to the document.
2. Record B is deleted:
Link between Business Object 2 and the Archived document is deleted. The Archived
document is deleted because the last record was deleted.
Link between Business Object 3 and the Archived document is deleted.
Prerequisites
Installation and Upgrade Guide (ERLK-IGD). After this the following must be
available:
The following steps in this order are required to configure document declaration:
Steps overview
Prerequisites The system is set up for document declaration according to Section 23.18 “Preparing
document declaration” in OpenText Extended ECM for SAP Solutions - Installation and
Upgrade Guide (ERLK-IGD).
1. In the SAP system, create a new business property provider if the default
property provider is not suitable for you. For more information, see “SAP:
Implementing a property provider for document declaration” on page 218.
2. On Content Server, create categories.
The categories are used to store metadata of the ArchiveLink document, such as
the ArchiveLink document type.
Your SAP system creates daily reports that you want to store on Content
Server. You can define a root folder for print lists created by the same report
and create subfolders for every day the report runs.
Prerequisites The system is set up for document declaration according to Section 23.18 “Preparing
document declaration” in OpenText Extended ECM for SAP Solutions - Installation and
Upgrade Guide (ERLK-IGD).
1. In the SAP system, create a new business property provider if the default
property provider is not suitable for you. For more information, see “SAP:
Implementing a property provider for document declaration” on page 218.
2. On Content Server, set up categories.
The categories are used to store metadata of the ArchiveLink document, such as
the ArchiveLink document type.
3. Optional On Content Server, set up Records Management classifications (RM
classifications).
The RM classification is mandatory to enable the Records Management
capabilities. The RM classification is typically part of an overall file plan. For
more information, see “Content Server: Setting up RM classifications for
ArchiveLink documents and print lists” on page 219.
4. Define unique names for all Content Server items, for example categories and
folders, that you want to use in your document declaration. For more
information, see “Creating unique names for Content Server items”
on page 142.
5. In the SAP system (IMG), define a declaration for the defined Content Server
location, categories and a classification. For more information, see “SAP:
Creating a document declaration” on page 219.
For the Document Location setting, keep the following in mind:
• If you select Constant and leave the field empty, the Extended ECM
operations root folder becomes the root folder and the documents are not
accessible for users.
The Operations root folder stores business documents from the SAP system
in Content Server. There is a folder for each business application with the
same name. You need administration rights to access the folders.
• The Workspace option is only relevant in special scenarios, for example if
the property provider associates the print list with a specific object.
If you want to use Records Management for the Records Management settings,
specify an existing RM classification and all additional fields as required.
6. Optional In the SAP system, define the names of declared documents in
additional languages. For more information, see “SAP: Providing multilingual
document names” on page 228.
7. In the SAP system (IMG), assign a declaration ID to the document type and SAP
object type. For more information, see “SAP: Assigning a document declaration
to a business object and a document type” on page 230.
8. Optional For automatic declaration when print lists are created: Select the
Automatic check box if any new print list entry matching the given object type
and document type should be declared as record automatically.
For automatic declaration when print lists are created: In the SAP system (IMG),
maintain the receiver modules events. For more information, see “Maintaining
receiver modules for automatic declaration of print lists” on page 234.
• /OTX/RM_CL_PP_ALINK
This provider class allows storing documents with all the ArchiveLink properties
like Document ID, Business Object Type, etc.
• /OTX/RM_GEN_PP_CL_ALINK_DOC
Generic property provider for document declaration. You can use this property
provider without further enhancement and development. You may also derive it
to change its behavior. This version of the generic property provider replaces
the /OTX/RM_GEN_PP_ALINK_DOC property provider, which is obsolete with
version 16 EP4 (16.2.4.).
• /OTX/RM_CL_PP_PRINTLIST
This provider class allows storing print lists.
Note: These interfaces may change with the next version of Extended
ECM for SAP Solutions. Therefore, be aware that possible upgrade tasks
will not be covered by Extended ECM for SAP Solutions.
For more information about property providers, see the SDK in OpenText My
Support (https://knowledge.opentext.com/knowledge/cs.dll/Open/63007681).
OpenText My Support (https://knowledge.opentext.com/knowledge/cs.dll/Open/
63007681).
To define classifications:
For the document declaration, you need the following information; some of them
must be configured before you begin this procedure.
1. In the IMG, navigate to the OpenText Extended ECM for SAP Solutions >
Extended ECM > Document (ArchiveLink) ... > Maintain Document
Declarations activity and click Execute.
• Declaration ID
Enter a unique name for this declaration.
• Description
Enter a description that states the purpose of the document declaration.
• Business Property Provider
Select one of the available property providers from the value list.
Extended ECM for SAP Solutions includes the following default property
providers:
Click Next.
Connection ID
Select one of the configured connection to Content Server from the value
list. For more information about the connected Content Server, see Section
22.2.6 “Maintaining Extended ECM connections” in OpenText Extended ECM
for SAP Solutions - Installation and Upgrade Guide (ERLK-IGD).
System Category Unique Name
Select an existing unique name of an Extended ECM for SAP Solutions
system category. The category will store the system properties coming from
the property provider. For more information about unique names, see
“Creating unique names for Content Server items” on page 142.
Categories (optional)
You can add more categories that store the non-system properties coming
from the property provider specified before. Click Insert Category to add
a row and select an existing Content Server category by its unique name.
Note: The category that has been specified under System Category
cannot be selected.
– Unique Name
Unique name of an existing folder within Content Server. However,
if the field is empty, the Enterprise Library Services Application
folder becomes the root folder. In this case, the document will not be
accessible to users.
– Workspace
By using the fields Object and Key, the business workspace where
the document will be located can be specified explicitly. If the fields
Object and Key are empty, the document or print list will be located
according to the workspace definition for the associated business
object.
○ Object
Optional: SAP object type (e.g. EQUI)
○ Key
Optional: Property of the property provider with the key of the
business object for the workspace where the document is stored.
– Business Property
ID of an existing folder within Content Server provided by a
property of the assigned property provider. If the value of the field is
0, the Content Server application folder becomes the root folder.
• (Optional) In the Sub Folder field, you can define a pattern to specify
the sub folder name using normal text, document property values and
modifiers.
Modify the default document location according to your storage
strategy. Insert the property placeholder using the Insert Placeholder
button. For more information, see “Creating a name pattern for record
declaration” on page 227.
Document Name
ArchiveLink documents and print lists declared as records are stored in the
defined document location; the record name is defined in the Document
Name field. You can create a name pattern with normal text, placeholders
and modifiers similar. For more information, see “Creating a name pattern
for record declaration” on page 227. Modify the default document name
according to your storage strategy. Insert the property placeholder using
the Insert Placeholder button.
Note: The URL, with which users will open the document, consists of
the host name, the port, and the document name. This URL may not
be longer than 1024 ASCII characters. With URL-Encoding, a single
non-ASCII character, for example, from the Cyrillic alphabet, uses
three and more ASCII characters, thus, the maximum length can easily
be reached.
Tips
Click Next.
4. Categories Mapping
The Categories Mapping dialog always displays a tab for the system category
and a tab for each additional category.
Click Search help in the respective rows to define the mappings between
SAP business properties and category attributes.
Business properties with the same type and name as a category attribute are
suggested as default mapping. For each mapping pair, the F4 value list displays
all business properties with the same type as the corresponding category
attribute.
5. If the mapping table has property groups, click the respective Map button to
define the mappings of the subproperties.
Click OK to close the Property Group Mapping dialog.
Click Next.
• RM Classification (optional)
If you select Unique Name, you refer to the RM classification using the
unique name you defined for it. For more information about unique names,
see “Creating unique names for Content Server items” on page 142.
If you select Template, a template mechanism with placeholders is provided
similar to the one for Document Location field. You can create a pattern to
define the RM Classification template using normal text, document property
values and modifiers.
Insert the property placeholder using the Insert Placeholder button. For
more information, see “Creating a name pattern for record declaration”
on page 227.
• Record Date
• Status
• Status Date
• Mark Official
Notes
Tip: These parameters correspond to the fields on the Records Detail tab
for a declared document in the Content Server Web UI.
Offset: +2
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: (8)
Displays the specified number of characters. Separate the modifier from the
attribute by a colon. An out-of-bound length causes an error.
Combination
You can combine all of those pattern modifiers.
The first two digits of the date are cut off and only six are displayed. The
word , archived was added.
An out-of-bound offset or length will cause an errors during the creation of the
record.
You can compose a name of several attributes. However, if one of those attributes
does not provide a value, this attribute is omitted without error message.
Example: You define the path with the following attributes: [Country]/[City]/
[MaterialType]. If the [City] attribute delivered no value the subpath would consist of
only [Country]/[MaterialType].
Note: To separate folders, use the forward slash (“/”). The colon (“:”) cannot be
used in Content Server paths. It is replaced by a space.
Customizing overview
1. In the IMG, navigate to the OpenText Extended ECM for SAP Solutions >
Extended ECM > Document (ArchiveLink) ... > Maintain Multilingual
Document Declaration Templates activity and click Execute.
• Declare ID: Select the document declaration that you created in Step 2 of
“SAP: Creating a document declaration” on page 219.
• Lng ISO: Select a language ISO code.
• Title template: Enter naming schema for this language.
You can use variables for the document names. For more information, see
“Creating a business object declaration in SAP” on page 54.
1. In the IMG, navigate to the Extended ECM > Document (ArchiveLink) ... >
Assign Declaration ID to Object Type and Document Type activity and click
Execute.
b. Select Automatic if any new ArchiveLink document or print list entry that
match the given object type and document type should be declared
automatically. For manual declaration via report and GOS menu, leave the
check box deselected.
Note: For automatic declaration of print lists, the CREATED event for
print lists must be linked to the respective receiver module; for details
see “Maintaining receiver modules for automatic declaration of print
lists” on page 234.
c. Select Async. if you want to put the processing in the asynchronous queue.
You can only use the asynchronous queue if you also selected Automatic.
If the process creating the document declaration is a batch or workflow
process, the declaration will always be processed by the asynchronous
queue, regardless of this setting.
d. Optional You can select Auth.Check if you want to perform an additional
authentication check on display and delete access of declared ArchiveLink
documents or print lists.
Caution
Do not select the Auth.Check check box when the GOS
enhancement /OTX/RM_BF_GOS_ATTACHMENT is activated; as it also
performs an authentication check, performance will be impaired.
For more information, see “Customizing the GOS Attachment list
for Records Management” on page 307.
4. Click Save .
The following explains how you configure each field of the respective sections.
Tip: See Section 6.6.1 “Declaring records” in OpenText Extended ECM for SAP
Solutions - User Guide (ERLK-UGD) for detailed explanations on how to use the
declare dialog.
2. Define, which record detail fields are visible and which of the visible ones are
mandatory
From the global menu, select Enterprise > Records Management > Records
Management Administration > System Settings > RM Fields. Notice that the
Update Cycle Period field and the Next Review Date field are only mandatory
if the Essential field is mandatory and the user selects a vital essential code. The
Records Management Configuration page (see Content Server Administration
> Records Management Administration > Enable and Configure Records
Management) defines which essential codes are vital.
3. The Records Management Fields configuration also defines whether the Cross
Reference field is visible or not. Selecting a cross reference is never mandatory.
a version, a check box appears to let users choose whether the selected cross
reference should be a version or not.
5. The Categories field is always visible. This field is only mandatory if the MIME
type of the current document has been associated to one or more categories.
To configure the MIME types, go to Content Server Administration > System
Administration > Administer MIME Types and Categories.
Asynchronous To use the asynchronous method via queuing, use the respective function module
queue that end with _ASYNC or _ASY. Also document declarations initiated by the workflow
processing
user are processed via the asynchronous queue. For more information about the
asynchronous queue, see “Creating business workspaces and declaring document
asynchronously” on page 156.
For ArchiveLink documents and printlists, the following function modules are
relevant:
Tip: The _ASYNC events are for using the asynchronous queue. For more
informations, see “Creating business workspaces and declaring document
asynchronously” on page 156.
For more information, see “Maintaining receiver modules for CHANGED events
(optional)” on page 237.
Table 6-1: Receiver function modules and events for document declaration
You must activate the creation of the PRINTLIST.CREATED event. After activation, a
receiver module must be linked to the CREATED event of the PRINTLIST Object Type.
Note: The SAP Workflow System must be set up and running correctly for
events to be created (SWU3 transaction). For more information, see the SAP
documentation.
1. Navigate to the Extended ECM > Activate Receiver Module Events activity and
click Execute.
3. Click Save.
Figure 6-3:
• Destination of Receiver: Enter NONE to use the context of the user that runs
the functions. If you leave this field empty, the background workflow user,
usually WF-BATCH, is used. It must exist in your system.
• Linkage Activated: Select this option.
4. Click Save.
Example 6-2:
ArchiveLink documents linked to the finance business object BKPF are declared
as records. Some metadata like the reference number are stored at the record
item type during declaration. At a later stage, the reference number changes;
this should automatically update the reference number in the item type.
Depending on the SAP version used, the following screens might look different on
your system.
1. Navigate to the Extended ECM > Maintain Receiver Module Events activity
and click Execute.
• Event: Changed
• Destination of Receiver: Enter NONE to use the context of the user that runs
the functions. If you leave this field empty, the background workflow user,
usually WF-BATCH, is used. It must exist in your system.
• Linkage Activated: Select this option.
4. Click Save.
Notes
A technical user in the SAP system is now required to delete DMS references
(Content Server shortcuts) in Content Server.
Users can now filter in folders that contain SAP DMS documents.
Note: The simultanious physical deletion of declared DIRs at the same time
when they are deleted from SAP is currently not supported.
The document business object is called DRAW. In this integration, it can be linked to
the following business objects:
Note: The number of object links is restricted to 150 per object type. Exceeding
links will not be created in Content Server. SAP log SLG1 will contain a
warning if the limit is exceeded.
If you need another limit, or if you need additional linked objects, you have
two options:
Overview With the support of SAP DMS documents in a business workspace, users have
immediate access to all originals that are linked to the same business object as the
workspace references. The business workspace lists all originals in a DMS
Documents folder. Technically, this is a virtual folder, which grants access to the
originals. These originals remain on the archiving system, where they were initially
stored from the SAP system.
The documents in the business workspace have the same metadata as the
corresponding SAP DMS Document (DRAW). Users can filter the document list by
Status, Parts, Type, and Version and further attributes.
You configure document declarations for SAP DMS, step by step. After you linked
the events to a receiver function module in the SAP system, the document
declaration proceeds automatically for each change of an DMS original. For more
information, see “Configuring the SAP DMS integration” on page 242 and “SAP:
Linking events to a receiver function module” on page 246.
You can use the error queue /OTX/RMERP_DMS_PEQ to check the SAP DMS
synchronization. For more information, see “Using the Error Queues” on page 488.
You can also use a batch operation for the initial declaration of already existing DMS
documents. DMS originals with multiple versions can be declared as documents
using the batch operation as well. For more information, see “SAP: Declaring SAP
DMS documents using batch operations” on page 478.
Note: If you updated OpenText Extended ECM for SAP Solutions to the
current release, you have to run the batch operation to declare already existing
versions of DMS originals.
SAP is the leading system for DMS, DMS originals and DMS references. If it is
necessary to delete a DMS reference (Content Server shortcut) by using the SAP
system, special rights are needed. For this, a technical user with the appropriate
permissions has to be created. For more information, see “Creating a technical user”
on page 247.
• OTEXRLE
Here, we can add a new document as an attachment. The document is stored in the
DMS system, you see the details here.
Note: For correct event handling in the SAP attachment service, you must
implement SAP Note 3008752 – Change event is not triggered after uploading
originals in File Uploader(PLMWUI) and FIORI apps.
Content Server In Content Server, the same Purchase Requisition has a business workspace with a
special folder for SAP DMS documents. This folder contains the attached document
of the Purchase Requisition.
Configuration overview
Content Server
SAP System
1. In the Business Object Declaration dialog, create and configure the following
business object declaration for the document business object:
2. Create business object declarations for other business objects you need that
should be linked to the document business object DRAW. For example,
Functional location, Equipment or Material.
For more information, see “Creating a business object declaration in SAP”
on page 54.
1. After the installation, the transport files are located in the Content Server
support directory. By default, the support directory is the img\ directory.
Download the files from URLs like the following:
https://otcs.example.com/img/xecmsap/transport/SAP%20DMS%20Configuration%20EN
%201.zip
https://otcs.example.com/img/xecmsap/transport/SAP%20DMS%20Configuration%20EN
%201.zip
2. Use the Content Server Transport Warehouse to deploy the transport files.
Important
You must deploy the transport files in two steps, because there are
dependencies between the objects: First deploy SAP DMS Configuration EN
1.zip, which contains the categories, then deploy SAP DMS Configuration
EN 2.zip.
For more information about the Content Server Transport Warehouse, see
OpenText Content Server - Transport (LLESTRP-UGD).
3. Resolve missing dependencies which prevent the OK to deploy status. For non-
exact matches in the target system, confirm the matches or correct them.
4. The folder where the SAP DMS documents are located may be missing. If
necesssary, create the folder and edit the workbench item accordingly.
5. After the deployment, check if you have the following objects present:
6.2.2.3 Content Server: Preparing the workspace template for the related
business objects
The workspace template for the related business objects, like the Material or the
Equipment, must contain a special folder for SAP DMS documents. You can
configure the name but you must use a folder with SAP DMS Folder type.
Important
With an DMS integration, the SAP system is the master system. Therefore,
Content Server documents that are related to DMS must not be changed or
deleted. You must set the permissions for business users in Content Server so
that they only have read access. When setting the permissions, also consider
Content Server hierarchies and permission inheritance. For instance, the
deletion of a folder must be forbidden when it contains folders with DMS
artifacts.
1. Open the template for the respective workspace type in Classic View.
2. Add a new item SAP DMS Folder.
3. Enter a name, description and location for the folder.
4. Click Add.
The following parameters are already preset during the creation of a SAP DMS
document declaration:
For more information about the standard procedure, see “SAP: Creating a document
declaration” on page 219.
1. In the IMG, navigate to the Extended ECM > DMS Document Declarations >
Maintain Document Declarations activity and click Execute.
2. Create a new document declaration with the following parameters:
• Declaration ID
• Description
• Connection ID: a Content Server connection
• System Category Unique Name: the unique name you configured for the
SAP DMS Original category.
• Sub Folder
For more information about the standard procedure, see “SAP: Assigning a
document declaration to a business object and a document type” on page 230.
1. In the IMG, navigate to the Extended ECM > DMS Document Declarations >
Assign Declaration ID to Document Type activity and click Execute.
2. Create a new entry with the following parameters:
For more information, see “SAP: Linking events to receiver type function modules”
on page 200.
1. In the IMG, navigate to the Extended ECM > Maintain Receiver Module
Events activity and click Execute.
3. Create two entries, one for the CREATED and one for the CHANGED event of
the DRAW object type.
4. Click Save.
To create this technical user, you have to configure both, Content Server/OTDS and
the SAP system.
Configuration Overview
Content Server
SAP
• Create a technical user and a technical user role on the SAP system
• Create the RFC destination for a technical user
• Customize the RFC destination
Note: If you updated OpenText Extended ECM for SAP Solutions to the
current release, you also have to create a technical user.
Note: You can change the technical user name DMS_RM_TECH to a name of your
choice and use it accordingly.
For more information, see Section 23.7 “Managing users and permissions” in
OpenText Extended ECM for SAP Solutions - Installation and Upgrade Guide (ERLK-
IGD).
• ICF_FIELD – DEST
• ICF_VALUE – <value of field Authorization for Destination during
creating the RFC destination, that you will use for user impersonation>.
Enter, for example, CHECK_IMP.
For more information, see Section 22.1.2 “Assigning SAP roles” in OpenText Extended
ECM for SAP Solutions - Installation and Upgrade Guide (ERLK-IGD).
3. Open the Logon & Security tab and specify the following settings:
– User – DMS_RM_TECH
– Password – <password>
3. Navigate to the OpenText Extended ECM for SAP Solutions > Extended ECM
> DMS Document Declarations > Maintain Technical User activity and click
Execute.
4. Enter the Conn. ID and the RFC destination for tech. user you created before,
and click Enter.
A business object may have SAP DMS documents as well as ArchiveLink documents
related to it. Therefore, it might be convenient to see all documents displayed side
by side in the DMS Documents folder.
To achieve this, you configure the document declaration for the ArchiveLink
documents so that they are stored in the business workspace of the corresponding
DRAW business object. You provide a separate folder for ArchiveLink documents
within the DRAW business workspace. For more information, see “Configuring
document declarations“ on page 213.
Being located within the DRAW business workspace, the ArchiveLink documents
are now automatically displayed in the DMS Documents folder of the related
workspace.
The Enterprise Asset Management Business Scenario is prepared for two separate
maintenance processes which you can use with the delivered sample business
application. As well, these processes are alligned to processes in your existing SAP
business application:
• Corrective Maintenance
• Preventive Maintenance
The Enterprise Asset Management Business Scenario predefines settings for these
processes. With the delivered sample business application, you can start without
changes. Using SAP as a business application needs additional configuring.
5. Assign the document types to the document declaration. For more information,
see “SAP: Assigning a document type to the document declaration”
on page 246.
6. In the IMG, navigate to Cross-Application Components > Document
Management > Additional Settings – Simplification > Attachment Service –
Storage Repository Activation. Here, the storage category is activated, which is
used for attachment uploads in SAP Fiori apps. Make sure that you use a
storage category to an OpenText archive.
Note: If the change event is not triggered after uploading originals in File
Uploader (PLMWUI) and Fiori apps, consider applying SAP Note 3008752.
• Equipment
• Functional Location
• Maintenance Notification
• Maintenance Order
• Maintenance Task List
The business workspaces will appear as actions for semantic objects in menus of
Smart Links or Related Apps buttons.
For more information, see “Using intent-based navigation” on page 333, and
“Integrating SAP Fiori Apps (SAP S/4HANA)” on page 269.
The category IDs in the table above, for example, 192189, derive from the original
Content Server. While you import the transports with the business object types, the
IDs are mapped to the current category IDs of your Content Server. The targets, like
MaintenanceOrder-displayFactSheet, correspond to the SAP Fiori Apps, used for
the Extended ECM for SAP Enterprise Asset Management Business Scenario.
For more information, see “Integrating SAP Fiori Apps (SAP S/4HANA)”
on page 269.
Note: The base display URL ($BaseUrl$) defined in the connection to the
business application and the base display URL to access the SAP Fiori
Launchpad need to be identical. If required, replace $BaseUrl$ with the base
display URL of your Fiori Launchpad portal. Use the relative path to access the
SAP Fiori Launchpad portal: /sap/bc/ui2/flp.
If you do not use S/4HANA or Fiori Launchpad, change the display URL back to the
generic URL to start the SAP GUI for HTML transaction for the business object:
$BaseUrl$/sap/bc/gui/sap/its/webgui?~logingroup=SPACE&~transaction=
%2fOTX%2fRM_WSC_START_BO+KEY%3d$BorObjectId$%3bOBJTYPE%3d
$BorObjectName$&~OkCode=ONLI
For more information how to create business object declarations, see “Creating a
business object declaration in SAP” on page 54.
Equipment
Object type EQUI
Property provider /OTX/RLSA_PM_CL_PP_
EQUIPMENT
Search help name /OTX/RLSA_PM_SH_
EQUIPMENT
Activation selected
Generic Property Provider Config ID 1
Custom Properties
Attribute OBJKEY
Operator <>
Active selected
Custom Property TEMPLATE_ID
Unique Name ot_templ_equipment
Functional Location
Object type BUS0010
Property provider /OTX/RLSA_PM_CL_PP_
FUNC_LOC
Search help name /OTX/RLSA_PM_SH_FUNC_
LOC
Activation selected
Functional Location
Generic Property Provider Config ID 1
Custom Properties
Attribute OBJKEY
Operator <>
Active selected
Custom Property TEMPLATE_ID
Unique Name ot_templ_func_
location
Maintenance Order
Object type BUS2007
Property provider /OTX/RLSA_PM_CL_PP_
ORDER
Search help name /OTX/RLSA_PM_SH_ORDER
Activation selected
Generic Property Provider Config ID 1
Custom Properties
Attribute TASK_LIST_KEY
Operator <>
Active selected
Custom Property TEMPLATE_ID
Unique Name ot_templ_maint_order_
prev
Generic Property Provider Config ID 2
Custom Properties
Attribute OBJKEY
Operator <>
Active selected
Custom Property TEMPLATE_ID
Unique Name ot_templ_maint_order_
corr
Notification
Object type BUS2038
Property provider /OTX/RLSA_PM_CL_PP_
NOTIFICAT
Search help name /OTX/RLSA_PM_SH_
NOTIFICATION
Notification
Activation selected
Generic Property Provider Config ID 1
Custom Properties
Attribute OBJKEY
Operator <>
Active selected
Custom Property TEMPLATE_ID
Unique Name ot_templ_notification
Task List
Object type BUS1019
Property provider /OTX/RLSA_PM_CL_PP_
TASK_LST
Search help name /OTX/RLSA_PM_SH_
TASKLIST
Activation selected
Generic Property Provider Config ID 1
Custom Properties
Attribute OBJKEY
Operator <>
Active selected
Custom Property TEMPLATE_ID
Unique Name ot_templ_task_list
2. Navigate to Plant Maintenance and Customer Service > Master Data in Plant
Maintenance and Customer Service > Technical Objects > Functional
Locations > Define Category of Functional Location.
2. Navigate to Plant Maintenance and Customer Service > Master Data in Plant
Maintenance and Customer Service > Technical Objects > Equipment >
Equipment Categories > Maintain Equipment Category.
2. Navigate to OpenText Extended ECM for SAP Solutions > Extended ECM >
Maintain Change Document Events.
Notification: Change
Change doc. object MELDUNG
Object Category BOR Object Type
Object Type /OTX/RLNOT
Event CHANGED
Trigger Event On Change
1. Enter transaction BSVW and click Customer Settings to maintain status change
events.
2. Click New Entries to create a new entry for the Maintenance Order Operations
deletion event.
6. Click Status restrictions. In System Status enter I0013 (DLT). Enter a space in
Inactive.
For more information, see “SAP: Linking events to receiver type function modules”
on page 200.
This setting is optional. It only needs to be enabled if the SAP system does not
trigger the CHANGED event in case of address changes for a functional location. For
example, a special case is that the address is changed and inherited to a sub-
equipment or a functional location.
Task List and Task List Operation: Automated workspace update and automated
workspace deletion
Object Category BOR object type
Object Type /OTX/RLTLI
Event CHANGED
Receiver Type BUS1019
Receiver Call Function module
Receiver Function Module /OTX/RLSA_PM_EVENT_TLI_ASYNC
Destination of Receiver NONE
Linkage Activated selected
Note: For Task List and Task List Operation automated workspace deletion is
allowed. Upon deletion a CHANGED event is triggered by the system. Therefore,
the same setup as for automated workspace update is used. The function
module logic determines the correct action. The objects are just flagged for
deletion, but not physically deleted. Therefore, the corresponding workspaces
as well are not deleted. A !, added to the workspace name, shows that the
business object was flagged for deletion in the SAP system.
For more information, see SAP Fiori Apps Reference Library (https://
fioriappslibrary.hana.ondemand.com/sap/fix/externalViewer/).
This business scenario defines the display URL of business object types to call these
Fiori Apps. For more information, see “Defining the display URL” on page 253.
Furthermore, this business scenario delivers the custom Fiori catalogs /OTX/RLSA_0_
S4_APPS and /OTX/RLSA_PM_APPS which define target mapping definitions to call
the business workspace integration app for each object.
1. Apply the implementation steps for each SAP Fiori App relevant for your
business scenario. For more information, see SAP Fiori Apps Reference Library
(https://fioriappslibrary.hana.ondemand.com/sap/fix/externalViewer/).
2. Activate OData service and ICF nodes for business workspace. For more
information, see “Customizing the Fiori Launchpad for the OpenText Test
Launcher” on page 324
Note: Content Server and SAP Fiori Launchpad URL are expected to run
under the same origin to avoid cross-origin resource sharing (CORS)
issues. You need a reverse proxy to set this up. For example, you can use
the SAP Web Dispatcher. Alternatively, you can use the URL parameter
UseClassicConfig=true. If you use it, make sure that you can resolve
any cross-origin resource sharing (CORS) issues imposed by SAP Fiori
Launchpad shell otherwise. For more information, see the Extended ECM
and SDK Guide in OpenText My Support (https://
knowledge.opentext.com/knowledge/llisapi.dll?func=ll&objId=63007681&
objAction=browse&viewType=1).
3. Add the Fiori catalog /OTX/RLSA_PM_APPS to an (PFCG) authorization roles
and assign the role to your Fiori Launchpad users. Users assigned to the role
will then see the action to open the OpenText business workspace in the Related
Apps menu of the Fiori apps listed above. For more information, see “Defining
catalogs, target mapping, groups and tiles” on page 328.
The category Print Control is attached to documents which are uploaded into
following folders:
GET_WSPS_PRINT_DOCUMENTS
Retrieves node IDs of documents from workspaces for a list of business object
IDs where the category Print Control is assigned and attribute Selected for Printing
is selected.
Relevant objects are filtered by a facet query. As the objects are not filtered by
document type on Content Server, the method GET_WSPS_PRINT_DOCUMENTS
filters by documents (node type=144) and document shortcuts. For each business
object ID, duplicate node IDs are removed from the resulting document list.
Prerequisites
• If the category Print Control is assigned to a folder and the folder is tagged
with attribute Selected for Printing, then child objects newly added to this
folder inherit the category assignment and attribute setting.
GET_WSP_PRINT_DOCUMENTS
Like GET_WSPS_PRINT_DOCUMENTS, but just retrieves the node ID of documents
from workspaces for one business object IDs where the category Print Control is
assigned and attribute Selected for Printing is selected.
GET_WSPS_DOCUMENTS
Retrieves node IDs of documents (node type=144) and document shortcuts
(node type=1) from workspaces for a list of business object IDs.
Relevant objects are filtered by a facet query. With optional parameter PI_
EXCLUDE_SHORTCUTS shortcuts can be excluded. For each business object ID
duplicate node IDs are removed from the resulting document list.
Prerequisite – Make sure that the unique name ot_facet_content_type is
pointing to system default facet Content Type.
GET_WSP_DOCUMENTS
Like GET_WSPS_DOCUMENTS, but just retrieves node IDs of documents (node
type=144) and document shortcuts (node type=1) from workspaces for one
business object ID.
GET_DOC_CONTENT
Gets the binary content of a document for a specific node ID.
Note: By default, objects are retrieved from the workspace and all its sub-
workspaces (composite workspaces). With parameter PI_EXCLUDE_
SUBWORKSPACE this behavior can be changed.
For more information, see Section 2.3.2 “Add an item” in OpenText Content Server -
Smart View (CSSUI-UGD) and Section 8.2.4 “Choose a layout” in OpenText Content
Server - Smart View (CSSUI-UGD).
5. In the Shortcut popup in Target object browse to select Enterprise > OpenText
Business Scenarios > Enterprise Asset Management.
The Scheduled Processing framework lets you process a large number of items.
Using Content Server Expression Builder, you can select ranges of items. You can
suspend a running job and resume processing. The error handling functionality lets
you view error items and schedule them to be processed again.
Depending on your scenario and the installed modules, you can use the framework
to perform the following tasks:
• Create or update large numbers of business workspaces for the initial creation of
business workspaces from an SAP C/4HANA Sales Cloud and SAP C/4HANA
Service Cloud integration.
• Create or update large numbers of documents from a business application
integration
• Only with Extended ECM for Microsoft Office 365: Create Office 365 groups,
connect them to a business workspace, and send email notifications when
business workspaces are connected to groups.
You can schedule jobs to run periodically and during off-hours with a low server
workload.
1. On the global menu, click Enterprise > Extended ECM > Scheduled Processing.
4. In the Product list, select the product for which you want to create a scheduled
job.
The list displays all external system connections and Content Server.
Note: You can use Create or Update Workspaces job type for the
scheduled processings SAP C/4HANA Sales Cloud and SAP C/
4HANA Service Cloud.
For more information, see Section 15.4 “Creating Extended ECM for Office
365 scheduled jobs” in OpenText Extended ECM for Microsoft Office 365 -
Installation and Administration Guide (EEMSO-IGD).
• Other products –
Options will vary depending on the products installed.
6. The following settings are relevant for job types of Other products only.
a. From the Business Application list, select the business application. The
connection to the business application must have been configured before.
b. Select one Business Object Type that is available on the selected system.
You will later be able to set filters for the business object type.
7. Click Add.
In the next step you filter the business objects and create a schedule.
2. On the Specific tab, in the Configuration section, you have several options.
They will vary depending on the job type of the scheduled job you selected.
For example, you can select a Business Application or you can define the
number of objects to be processed in Block Size.
4. In the Run Options section, you select options for processing the scheduled job.
a. Click Save and Run Now to save the settings start the scheduled task
immediately.
b. Click Save to save your settings.
a. Click Save and Run Now to save the settings start the scheduled task
immediately.
b. Click Save to save your settings.
Note: You can monitor the progress of your scheduled jobs on the overview
page. You see the number of scheduled and progressed objects. If there is an
error, you can click on Error to see the log file. You may have to update the
page from time to time.
1. On the overview page search for your scheduled job. If the job has history
entries, the Details link is shown in the History column.
2. Click the Details link. On the History tab, all job runs are listed. In the
overview you see, for example, information about the number of jobs run, and
job run durations.
3. Expand the list of a specific job execution to get job reports.
4. To view or download the history of a single step in the job run, click .
5. To view or download the complete history of this job run, click Download
All.
6. If you want to download the job history for all job runs as a CSV file, click on
Export All History.
7. If you want to download the job reports for all job runs as a ZIP file, click on
Download History Reports.
Note: You can download the job reports for the following job types:
8. If activated, you see specific error messages on the Error items tab,
3. To start the job again, from the function menu, select Resume.
4. To stop the job altogether, from the function menu select Cancel.
• Logical OR
The logical OR only works when used for the same property:
Supported: ...$filter=PartyID eq '1001' or PartyID eq '1002'
Not supported: ...$filter=PartyID eq '1001' or TerritoryID eq 'CA'
Each OR segment can be executed as a separate query, and the results can be
collated:
• Failed Items
If there were failed items that could not be processed, you see the number of
these items in the Error Items column.
3. If you fixed the error cause, click Queue all to reprocess the error items.
The Content Server integration widget provides JavaScript libraries, which you can
use to display business workspaces and other Content Server functionality in a
modern and more flexible way.
User When a user starts creating a new business workspace, the integration widget first
experience offers business workspaces without business object. Users can then decide if they
want to complete one of the available early workspaces or create a new on. This
integration widget is also called “Create and Complete” widget.
You can use the “Create and Complete” integration widget for the following SAP
Systems:
With SAP CRM Web Client or S/4CRM, you can still use only the classic folder
browse integration widget.
9.1 Prerequisites
Browser
Browser must be HTML5-compliant, which is any recent version of Firefox,
Safari, Chrome, and Internet Explorer starting from version 10.
As of Extended ECM for SAP Solutions 20.4 you can also use Microsoft® Edge.
Note: If you are using Internet Explorer, ensure that it starts in Standard
mode.
If you are using Microsoft Edge with SAP GUI 7.70, currently the following
limitations occur:
SAP System
Web Dynpro, for example SAP ERP, SAP SRM
• SAP_BASIS 731
• SAP_UI 740 (see SAP Note 1742528)
• Class CL_WD_HTML_ISLAND must exist on your system. Use transaction SE24
to check.
Configuration
• In the IMG activity OpenText Extended ECM for SAP Solutions >
Infrastructure > Maintain Extended ECM Connections, the Support
Directory field must contain the directory on Content Server where the files
for the Content Server integration widgets are stored.
• In the IMG activity OpenText Extended ECM for SAP Solutions > Extended
ECM > Maintain Business Object Declarations, the Use Widgets for UI
field must be selected. For more information, see “Creating a business object
declaration in SAP” on page 54.
SAP Notes
1746385 - Main WEBCUIF Browser Support Note
1753544 - Web Dynpro - HTML standards mode
1737445 - Internet Explorer standards mode rendering for EP
1742528 - Web Dynpro HTML integration: HTMLIsland, Container, Fragment
Microsoft IIS
If you want to use the integration widget and if you use Content Server on
Microsoft IIS, you must configure detailed errors messages on local and remote
requests. For more information, see “Configuring Microsoft IIS to return
meaningful REST API error messages” on page 300,
• 1956448 - Unequal rendering for NWBC and Web Dynpro ABAP – Prerequisite
for SAP Note 1963267 - SAP NWBC ABAP Runtime Patch 36
• 1963267 - SAP NWBC ABAP Runtime Patch 36 – For SAP NetWeaver Business
Client (NWBC) for HTML: Enables Web Dynpro applications to be started as
defined in the WdPreferredRendering application parameter. For this, the SAP
See also SAP Note 1753544 - Web Dynpro - HTML standards mode
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.
You can allow users to report incidents directly from Smart View to your local SAP
Solution Manager. For more information about SAP Solution Manager, see https://
help.sap.com/viewer/p/SAP_Solution_Manager.
1. On the Content Server Administration page, click Extended ECM for SAP >
Configure SAP support integration.
2. Click Enable and provide the connection parameters to the server, which hosts
the SAP Solution Manager: Server, Port Number and Protocol. Make sure, that
you have no spaces at the end of the server name or the port number. The URL
to the SAP support portal is https://support.sap.com/en/index.html.
3. Fill in the required information in the incident report and save your data.
To view a repository:
1. On the Content Server Administration page, click Extended ECM for SAP >
SAP CMIS Repositories.
2. Click the repository you want to view. The repository name is the same as the
name of the SAP system you configured as business application.
You have several customizing options when integrating Extended ECM for SAP
Solutions into SAP GUI:
You can make business workspaces and business attachments available for users in
SAP GUI via Generic Object Services (GOS). The user can then create workspaces,
display existing ones and display, create and delete business attachments in SAP
GUI. For this, you customize the GOS table.
Tip: For a detailed description of the Business Content window, see Section 8
“Working with the Business Content window” in OpenText Archiving and
Document Access for SAP Solutions - User Guide (ER-UGD).
1. Start the SM30 transaction, and then enter SGOSATTR in the Table/View field.
Click Maintain.
3. Customize the new entry according to the following list. The OTX_ATTACH
service displays the Business Content window: business workspaces, business
attachments and business documents (ArchiveLink documents). From the
Business Content window, users can access the complete functionality.
Name of service
Enter OTX_ATTACH.
Description
Provide a description, for example, Business Content. This description is
displayed in the GOS menu.
Quick Info
Provide a quick info, for example, Business Content. This information is
displayed for the icon.
4. You must define the position of the new service in the General Object Services.
In the Next service field, enter the name of the service that should follow after
this service. If the service is the last, leave the field empty.
Important
If you do not define the position correctly, it might not be displayed at all.
• You want to add the new service at the beginning of the existing services:
Enter the name of the first existing service in the Next service field of the
new service.
• You want to add the new service at the end of the existing services: Enter the
name of the new service in the Next service field of the last existing service.
Leave the Next service field of the new service empty.
• You want to add the new service in between the existing services: Enter the
name of the new service in the Next service field of the predecessor of
existing services. Enter the name of the successor existing service in the Next
service field of the new services.
5. Click Save.
Note: For more information about maintaining the SGOSATTR table, see the SAP
documentation (https://www.sdn.sap.com/irj/scn/index?rid=/library/uuid/
a0139058-ef9d-2b10-598c-9e23dc6f44fc).
For problems when displaying services in GOS, see SAP Note 961713 -
Structure of table SGOSATTR.
1. In the IMG, navigate to the Extended ECM > Business Content Window >
Maintain Business Content Window Display Options, and then click
Execute.
3. Select a business object type and then select the options that you want to be
displayed:
• Full page: Uses the whole Business Content window to display the business
workspace in Smart View
• Bus. Wrks: Display a node for the business workspace
• Wrks thumbs: Business workspace thumbnails
• Drag Drop: Enable Drag and Drop in business workspaces
• Attachment: Display a node business attachments
• Documents: Display a node for business documents
• Doc. thumb: Display thumbnails for business documents
• Notes: Display a node for notes
• Files: Display a node for local files
Tip: For general settings of the Business Content window, which are also
placed in this dialog, see “Enabling the integration widget in the Business
Content window” on page 299.
• Remove Content Server menu entries that are not relevant and add specific menu
items that are available on Content Server, for example when a new module was
installed. The added menu items are displayed in the context menu only if they
are available for the item type. For more information, see “Customizing the
Business Content window context menu with Content Server menu entries”
on page 297.
• In addition to the available Content Server menu entries, you can add new
entries and implement custom functionality. For more information, see “Adding
Note: The customizing applies only to Content Server Classic View. It does not
apply if the integration widget is used as described in “Enabling the
integration widget in the Business Content window” on page 299.
1. In the IMG, navigate to the Extended ECM > Business Content Window >
Maintain Business Content Window Menu, and then click Execute.
Code ID
Enter the code ID. Use the F4 help to retrieve the code ID.
BROWSE Open
COPY Copy
DELETE Delete
DOWNLOAD Download
FETCH Open
MAKEFAVORI Add to Favorites
TE
MOVE Move
PRINT Print
TEXTEDIT Edit
Add/Remove
Click Add or Remove. When you add an entry, it is added according to the
sequence in the Content Server menu. You cannot add already existing
entries.
Description
Enter a description. This description is displayed in the context menu. You
can use && to display the & character.
If you want to add the entry in other languages, use the standard SAP
mechanism clicking Goto > Translation.
Example: In the following example, the new menu item Zip & Download is added to
the menu.
1. In the IMG, navigate to the Extended ECM > Business Content Window >
Implement Business Content Window Menu BAdI, and then click Execute.
2. Implement your code. For detailed information, see the sample code provided
with the BAdI definition (menu Goto > Sample Code > Display).
To copy files, users can drag between different nodes in the Business Content
window. To download files, they drag a file to the Local Files node.
For this functionality, users must have the S_GUI authorization object with the
ACTVT=60 parameter. This authorization object is part of the /OTX/RM_USER role.
Important
If you want to use the integration widget and if you use Content Server on
Microsoft IIS, you must configure detailed errors messages on local and remote
requests. For more information, see “Configuring Microsoft IIS to return
meaningful REST API error messages” on page 300.
1. In the IMG, navigate to the Extended ECM > Maintain Business Object
Declarations activity, and then select Use Widgets for UI for the business
objects for which you want to enable the integration widget in Business Content
window, Web Dynpro or CRM UI.
For more information about the activity, see “Creating a business object
declaration in SAP” on page 54.
2. Optional To define the theme, in the IMG, navigate to the Extended ECM >
Business Content Window > Maintain Business Content Window Display
Options, and then click Execute.
Note: You can now use the new belize theme for the integration
widget integration. However it is currently not recommended for
page view.
Tip: For more customizing options for the Business Content window, see
“Selecting items to be displayed in Business Content window” on page 296.
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.
All Content Server items that can be targets for a copy/move operation are
maintained in the /OTX/RM_STWL table. This table is part of Extended ECM for SAP
Solutions and it is filled with a predefined set of subtypes. The new table /OTX/RM_
STWL_C is available to maintain new entries.
Important
As soon as /OTX/RM_STWL_C has one entry, the /OTX/RM_STWL is not used
anymore. If you intend to use /OTX/RM_STWL_C, you must copy the entries of /
OTX/RM_STWL into the custom table.
1. Copy all entries from the /OTX/RM_STWL table to the Subtype column of the /
OTX/RM_STWL_C table.
• Conn. ID: Connection ID. You find this information in the IMG > OpenText
Extended ECM for SAP Solutions > Infrastructure > Maintain Extended
2. Find the relevant role and add the J_6NRL_LFS authorization object.
Security settings – When a user accesses a local folder from the Business Content
window, an SAP security alert informs the user about the risk. Users can confirm the
message per access attempt or they can set the security options for their client.
• If you want to use OpenText Viewing or Intelligent Viewing, enable this viewer
in Content Server Administration. For more information, see Section 2
“Configuring OpenText Viewing” in OpenText Content Server Admin Online Help -
Viewing and Transformation Administration (LLESVWX-H-AGD).
• If you want to use one of these viewers, define the relevant settings in Content
Server Administration.
• Configure the mime types. For more information, see “Customizing MIME types
for preview” on page 306.
• Configure the viewer settings in the SAP system. For more information, see
Section 17.2 “Configuration for Web Viewer” in OpenText Archiving and Document
Access for SAP Solutions - Scenario Guide (ER-CCS).
2. In the Document Function section, for the Open function, select Disabled.
Note: If you do not want to disable the Open document function on Content
Server, the FETCH function will be used instead of the defined VIEWDOC function
when users double-click a document in Business Content window. You can
circumvent this by defining a description that is alphabetically before the
description of the FETCH action, for example FETCH with description Open and
VIEWDOC with description Display.
The /OTX/RM_GOS_DD table keeps a default list of MIME types for which Internet
Explorer add-ons enable an in-place rendition. If this list is not sufficient, you can
maintain a custom list in the /OTX/RM_GOS_DD_C table.
Important
Also add the MIME types from /OTX/RM_GOS_DD if you want to keep the
behavior of these MIME types as well.
Restrictions Web Viewer can only render documents that are archived to an OpenText archive.
For example, if you want to display a Microsoft Word document, Internet Explorer
starts Microsoft Word, but leaves an empty browser window open.
Important
Also add the MIME types from /OTX/RM_GOS_DD if you want to keep the
behavior of these MIME types as well.
Note: This customizing step is not necessary if you are using Business Content
window. For more information, see “Customizing the Generic Object Services
(SAP GUI)” on page 293.
With business functions, you integrate the following into the GOS Attachment list:
Business functions
• /OTX/RM_BF_GOS_ATTACHMENT
Integrates Records Management functions into the GOS Attachment list.
• /OTX/RM_DOL_BF_GOS_ATT_LIST
Integrates business attachments into the GOS Attachment list.
• /OTX/RM_BF_DISP_PRINTLIST
Integrates Records Management functionality into the OADR and OADD
transactions.
1. In the IMG, navigate to the Extended ECM > Activate Business Functions
activity and click Execute.
Extended ECM for SAP Solutions provides an integration solution for SAP C/
4HANA Sales Cloud and SAP C/4HANA Service Cloud. You can display the
business workspace of a business object along with the structured data. Integration
points are the business objects Account, Lead and Opportunity for SAP C/4HANA
Sales Cloud, and Service Request (ticket) for SAP C/4HANA Service Cloud.
Prerequisites
• Content Server module Extended ECM for SAP (xecmsap) must be installed
• You must have access to Content Server administration pages
• You must have access to SAP C/4HANA Sales Cloud and SAP C/4HANA Service
Cloud administration pages
SAP C/4HANA Sales Cloud and SAP C/4HANA Service Cloud use an Identity
provider (IdP) for authentication. For a single sign-on scenario, you set up a
connection between OpenText Directory Services and the corporate IdP using
Security Assertion Markup Language (SAML). For more information, see Section 4.1.4
“Configuration and use of SAML authentication” in OpenText Directory Services -
Installation and Administration Guide (OTDS-IWC).
• account
• lead
• business opportunity.
• service request (ticket)
If you need other business objects, you can write your own SPI adapter. For more
information, see Extended ECM Platform 16.2 - SDK and API documentation and
the SPI Java SDK (https://knowledge.opentext.com/knowledge/cs.dll/Open/
66215224).
1. Security Parameters
Make the C4C domain a trusted domain.
2. Business Application
Create a connection to the SAP C/4HANA Sales Cloud and SAP C/4HANA
Service Cloud system:
Important
SAP Cloud for Customer OData API V1 is deprecated and therefore
the previous SPI version is depricated as well.
c. For more information, see Section 23.3 “Connecting SAP as the business
application” in OpenText Extended ECM for SAP Solutions - Installation and
Upgrade Guide (ERLK-IGD).
3. Business workspace
Create workspace types, categories, classifications, and business object types for
the following business objects:
• CorporateAccount
• Lead
• Opportunity
• Service Request (Ticket)
– treeView gives priority to the navigation tree and the navigate back
function in full page view.
– navigateUp gives priority to the navigate up and the navigate back
function.
1. Open the screen, in which you want to create a new tab to display the business
workspace: CorporateAccount, Lead, Opportunity, or Service Request (Ticket).
3. Select the tab bar until it gets a frame and a yellow background.
a. In the new tab, click the main area. When it is yellow, click Select Parent
.
• Download the SAML Service Provider (SP) metadata file from SAP C/4HANA
Sales Cloud and SAP C/4HANA Service Cloud and upload it to your identity
provider.
• Create a metadata XML file from your identity provider and upload it to SAP C/
4HANA Sales Cloud and SAP C/4HANA Service Cloud.
• Configure OTDS to use the same identity provider. For more information, see
Section 4.9 “Configuring SAML” in OpenText Directory Services - Installation and
Administration Guide (OTDS-IWC).
3. Use this file to register the SAP C/4HANA Sales Cloud or the SAP C/4HANA
Service Cloud system as a Service Provider with your identity provider, for
example SSOCircle.
1. Create a SAML metadata.xml file from your identity provider. Consult the
provider's documentation for details.
2. In SAP C/4HANA Sales Cloud or SAP C/4HANA Service Cloud, open the
Identity Provider tab.
1. In Google Chrome, open the chrome://flags/ page, and make sure that all
flag settings are set to Default.
• An SAP Fiori app as delivered by SAP. For a list of all apps, see https://
fioriappslibrary.hana.ondemand.com.
• An SAPUI5 app following the SAP Fiori Design Guidelines
• Any browser app hosted on an SAP Fiori Launchpad server.
In any case, the techniques presented in this chapter refer to apps implemented with
SAPUI5 and typically hosted on an SAP Fiori Gateway server with SAP Fiori
Launchpad. For information on how to integrate DocuLink UIs into SAP Fiori
Launchpad, see “Customizing the Fiori Launchpad for the OpenText Test Launcher”
on page 324.
Recommended reading
In addition, the UI apps are deployed on a central SAP ABAP NetWeaver server,
which also contains the UI Service Add-on for the shell services and the Gateway
Add-on for the OData enablement of the ABAP-based Suite system.
Fiori apps are created using HTML5 and SAPUI5. For some extensions, the
underlying jQuery JavaScript library may be used. All supported form factors and
operating systems are supported with one development project and a single code
line per user interface app.
Additional resources
• Release notes for Archiving and Document Access for SAP Solutions (https://
knowledge.opentext.com/knowledge/llisapi.dll/Overview/67835278): list of
required Add-Ons and versions for building a custom Fiori app for business
object brower.
• OpenText Vendor Invoice Management for SAP Solutions - Configuration Guide for
Foundation (BOCP-CGD): detailed information about the Foundation component
of Vendor Invoice Management for SAP Solutions
• Base functionality for Extended ECM for SAP Solutions in the backend
• Specific OData Services as extension of the Gateway layer in the backend
• SAPUI5 integration for business workspace functionality in the frontend
• Test application OpenText Test Launcher in the frontend
• Integration into existing SAP Fiori apps, for example Find Maintenance Order (a
SAP Fiori elements based app) or Stock – Single Material (a SAPUI5 freestyle
app)
– Base functionality for Archiving and Document Access for SAP Solutions
including the optional Add-On OTEXBASB.
Prerequisites
• You have installed and configured the SAP Fiori system landscape. For more
information about the system landscape, see SAP Help Portal at Setup of SAP
Fiori System Landscape with ABAP Environment (http://help.sap.com/
fiori_bs2013/helpdata/en/ba/f61f533f86ef28e10000000a4450e5/frameset.htm).
• SAPUI5 version as stated in the Release Notes.
• You have done the initial configuration of SAP Gateway.
Important
The connection between the backend system and the frontend system must
be configured as a trusted connection.
• You have set up the SAP Fiori infrastructure.
• Search for SAP Fiori Implementation Information and then open the guide for
your SAP release
• Search for UI Technology Guide for SAP S/4HANAand then open the guide for
your SAP release.
The following steps are relevant to enable the Extended ECM for SAP Solutions
functionality in the different systems:
For more information, see SAP Help Portal at https://help.sap.com, search for one of
the topics below and open the guide for your SAP release:
After you have enabled the functionality in general, further steps are necessary to
integrate a specific application.
Example:
http://mucr3d5o.opentext.net:8000/sap/bc/ui5_ui5/otx/RMF_LAUNCH/version.html
Configuration overview
• The application comes with its OData services. You check if they are available
after installation and activate them if necessary.
• In the Fiori Launchpad, users work with their apps. You configure the Fiori
Launchpad to show the OpenText Test Launcher for relevant users such as
administrators who test the integration. For this, you create a tile catalog and a
tile group.
• The PFCG role defines, which users can access a specific tile catalog and tile
group. For the test user, you define a specific role and assign a catalog and a
group to it.
4. In the Technical Service Name field, enter the technical name of the relevant
OData services. The following services are relevant:
11. On the Activate and maintain services screen, check if the system alias is
maintained correctly. If not, delete the alias and add the correct one.
To activate the service select it and on the menu, click Service/Host > Activate.
Each application within the launchpad has a resource locator (URL) by which it can
be loaded. Instead of encoding the technical name of the target application into the
URL hash, the launchpad performs an redirection through the intent.
You must configure the application targets in the target mapping as a combination
of a semantic object and an action mapped to the navigation target. Since target
mappings are assigned to users as part of a catalog, they are assigned to PFCG roles.
An intent is independent of a role, therefore it can be resolved differently based on
the role of the user that triggers the navigation.
For more information, see also “Using intent-based navigation” on page 333.
• The user who performs the customizing must be assigned the composite role
SAP_UI2_ADMIN or its related sub roles, and the SAP_UI2_USER_700 role.
Table 14-5 list all values that are needed in different configuration contexts. Define
meaningful values and make a note of them as you need them later in the process.
1. In the IMG, navigate to the SAP Netweaver > UI Technologies > SAP Fiori >
Configuring Launchpad Content > Adding Apps to SAP Fiori Launchpad >
Define Semantic Objects for Navigation activity and click Execute.
2. Click New Entries and add a semantic object, for example ZZXECM_SO.
4. Click Save.
The navigation target is defined in the LPD_CUST transaction. There, you create a
new launchpad and add applications to it. Alternatively, you can add the OpenText
Test Launcher application to an existing launchpad, for example, if you already have
a launchpad for testing.
• A catalog that contains target mapping, groups and tiles. Later, you assign the
catalog to the PFCG role.
• A target mapping for the catalog. For each application you define an intent
(semantic object) and a target (defined by the launchpad).
• A tile for each of your apps, for example the OpenText Test Launcher.
• A group within the catalog. Later, you assign the group to the PFCG role.
You can add tiles to the group.
• in the IMG, navigate to SAP Netweaver > UI Technolgies > SAP Fiori >
Configuring Launchpad Content > Adding Apps to SAP Fiori Launchpad
(Using SAP Fiori Launchpad Designer > Configure Target Mappings and
Tiles > SAP Fiori Launchpad Designer (Current Client).
Alternatively, start the /UI2/FLPD_CONF (cross-client) or /UI2/FLPD_CUST
(client-specific) transaction.
Note: Maintain catalogs and groups either only in current client or only
across clients. Maintaining catalogs and groups mixed in current client
and across clients can lead to inconsistencies.
To create a catalog:
1. In the Launchpad Designer, on the Catalogs tab, in the footer, click + Add.
2. Add a title, for example Extended ECM Test, and an ID, for example XECM_
TEST_CAT.
3. Click Save.
• Semantic Object: Enter the ID of the semantic object that you defined
previously, for example ZZXECM_SO
• Action: Define a unique name in the context of the semantic object, for
example launcher.
4. Define the following in the Target section:
To create a tile:
• Title and Subtitle: Enter the titles of the tile that are displayed for the user.
• Icon: Specify an icon that is displayed in the tile.
• Use semantic object navigation: Select.
• Semantic Object: Enter the ID of the semantic object that you defined
previously, for example ZZXECM_SO.
• Action: Define a unique name in the context of the semantic object, for
example launcher.
4. Click Save.
To create a group:
1. In the Launchpad Designer, on the Groups tab, in the footer, click + Add.
• ID: Enter an ID, for example XECM_TEST_GROUP. You use this ID later when
defining the PFCG role.
• Title: For example OpenText Test Group
3. Click Save.
5. Click the search icon. In the window, enter the title of the tile that you defined
before, for example OpenText Test Launcher and filter the list for it.
6. The catalog list displays all catalogs that contain the tile. Click the catalog.
7. In the list of contained tiles, select the tile that you want to add, for example
OpenText Test Launcher.
• Add the catalog and group that you created before to the role menu.
• Add Start authorizations for the OData services
• Assign users to the role.
4. On the Menu tab, open the menu of the button for adding objects and click SAP
Fiori Tile Group.
6. On the Menu tab, open the menu of the button for adding objects and click
Authorization Default.
7. In the Service window, in the Authorization Default list, click Tadir Service.
Specify the following values:
8. In the table, enter the name of the OData service you have activated. Enter the
name as follows: technical name_<four-digit version number with leading
zeros>:
Service for business workspaces: ZRM_WSC_ODATA_SRV_0002. Relates to the
OData services of Fiori control for business documents of Archiving and
Document Access: ZALDS_ODATA_SRV_0001.
9. On the User tab, assign the role containing the catalogs, groups, and OData start
authorizations to a user by specifying the user ID.
Thereby, the user has UI access to the apps in the catalogs and the start
authorizations for the respective OData services on the frontend server.
10. On the Authorization tab, click the button next to Profile Name to generate the
authorization profile for the role.
3. On the Menu tab, open the menu of the button for adding objects and click
Authorization Default.
4. In the Service window, in the Authorization Default list, click TADIR Service.
Specify the following values:
5. In the table, enter the name of the OData service you have activated. Use the F4
value help to get the name in the correct spelling
/OTX/RM_WSC_ODATA_SRV 0002
/OTX/ALDS_ODATA_SRV 0001 0001
This relates to the OData services of Fiori control for business documents of Archiving
and Document Access.
6. On the Authorization tab, click the button next to Profile Name to generate the
authorization profile for the role.
After you have edited the authorization data, click Save and then Generate.
8. On the User tab, assign the role containing the catalogs, groups, and OData start
authorizations to a user by specifying the user ID.
The Business Documents app of Archiving and Document Access for SAP Solutions
and the Business Workspace app of Extended ECM both support this concept.
The SAPUI5 functions for intent-based navigation can also be implemented in your
own custom app. Furthermore, the SAPUI5 functions sap.ui.comp.navpopover.
SmartLink and sap.ui.comp.navpopover.NavigationPopoverHandler make use
of target mappings and semantic navigation.
Note: If you followed this guide, you have already created intent-based
navigation for the OpenText Test Launcher. This section explains how to
configure intent-based navigation especially for OpenText apps for business
documents or business workspaces.
Figure 14-2 shows the standard SAP app “Manage Sales Orders” with intent-based
navigation using SmartLink. It lists link targets of the semantic object SalesOrder.
You are free to add your own target mappings in the customizing of the Fiori
Launchpad Content.
• In some SAP Fiori Elements applications, the Related Apps button is already
enabled: only configuration in the Fiori Launchpad Content is required.
• Many SAP Fiori Elements apps use smart fields with UI annotations or the
@Consumption.semanticObject, which automatically creates SmartLink
controls at runtime: only configuration in the Fiori Launchpad Content is
required
• Even if metadata extensions are not allowed, new attributes may be appended to
an existing Core Data Services (CDS) view, this way allowing to use annotations.
Further reading:
• SAP Fiori Elements-based apps: “Example: “Sales Order” app for S/4HANA”
on page 339.
• Older apps not based on SAP Fiori Elements: “Example: “Manage Journal
Entries” app” on page 340.
For a distinct business object, for example a sales order, a semantic object
SalesOrder is used to make a list of actions available. For this, SAP already defined
several target mappings in Fiori UI tile catalogs. If the corresponding authorization
role is assigned to a user, the user can see and use the target mapping.
1. Semantic object
Choose an existing semantic object, for example SalesOrder, or alternatively,
create a new semantic object:
a. In the IMG, navigate to SAP Netweaver > UI Technolgies > SAP FIori >
Configuring Launchpad Content > Adding Apps to SAP Fiori Launchpad
> Define Semantic Objects for Navigation.
b. Create a new semantic object, for example, ZZMySalesOrder.
2. Catalog
In the Launchpad designer select a catalog or create a new one:
Now the new target mappings can be access with the URL's like:
The Business Documents and Business Workspace apps require the startup
parameters SapObject and ObjectId or SapObject, kp and kv1, kv2, … to define
the SAP BOR object instance for which the business documents or business
workspace are displayed.
For the example of SAP business object type BUS2032 and object ID 0000011660 the
intent-based URL's with parameters look like:
Notes
Application The application parameter length including SemanticObject/Action should not
parameter exceed 512 bytes when serialized as UTF-8.
length
Security The transfer of the SAP business object type and SAP business object ID are not
security critical: The OData services of Archiving and Document Access for SAP
Solutions and OpenText Extended ECM for SAP Solutions check the user's
authorization to see contents of the business documents and business workspaces or
call services, which do such an authorization check. The business object ID does not
reveal any specific data.
As mentioned above, the Archiving and Document Access for SAP Solutions and
OpenText Extended ECM for SAP Solutions applications perform no sanity check of
the values entered for SAP business object type and object ID.
What happens with mistakenly added or used data, for example, ?SapObject=
BUS2032&ObjectId=11660?
• If the user can do so on the OpenText Content Server, a business workspace with
this reference can be created. Any data or files added to this business workspace
are not lost because they are stored on the Content Server. In the case any
business data shall be transferred, like category attributes filled by a property
provider, the mistake can be discovered.
• If the user can add documents with the wrong object ID to ArchiveLink, then
data is not lost. In the case, such wrongly assigned data is discovered, it can be
still moved to link entries with the correct object ID.
• The kv1, kv2, … and kp parameter can be used to map to more than one key
value.
Parameters
With this configuration, an action with the title “Display Sales Order Business
Documents” will be available in the list of related apps and at other areas, where
actions for SemanticObject = SalesOrder are used.
Important
The combination of semantic object and action must be unique.
Intent-based navigation lies in the mapping of one or more parameters for key
values as populated by the calling app to the list of key values kv1, kv2. The default
value for SapObject is set to BOR object type BUS2032. And the value of kp is used
to set the leading zeros of the 10 digits long BOR-key.
In this example, you can create your own Fiori UI catalog in the Fiori Launchpad
Designer. Use transaction PFCG to create an authorization role to expose the target
mappings of your catalog to users.
Then an action with the title “Display Accounting Business Workspace” will be
available in the list of related apps and at other areas, where actions for
SemanticObject = AccountingDocument are used.
Important
The combination of semantic object and action must be unique.
Intent-based navigation lies in the mapping 1 or more parameters for key values as
populated by the calling app to the list of key values kv1, kv2, kv3, … The default
value for SapObject is set to BOR object type BKPF. And the value of kp is used to
concatenate the three sorted and formatted values as expected for BKPF:
In the case of a freestyle SAPUI5 app, you implement either directly in the original
app or extend the app.
The main difference is that the apps are not integrated as single UI elements, but are
called via link as other apps.
Recommended readings:
• In the case SAP Fiori Elements-based apps this navigation concept of app to app
navigation can also be used. But then, it may be more elegant to use UI
annotations, instead.
Below is a code snippet to give you an idea how this integration method can be used
programmatically:
/*
* Your application needs the right ID's
* of the semantic object and action
* Here the values are referring to the
* target mapping definition which was
* defined for the xECM business workspace app
* in the previous chapter
*/
var sSemanticObject = "ZZXECM_SO";
var sAction = "businessworkspace";
/*
* Your application needs to calculate the
* parameters in the right format
*/
var sSapObject = "BUS2032";
var sObjectId = "0000011660";
var oCrossApplicationNavigation =
sap.ushell.Container.getService("CrossApplicationNavigation");
/* Navigate to the external target
* of our xECM business workspace app
*/
oCrossApplicationNavigation.toExternal(
{ target:
{ semanticObject : sSemanticObject,
action: sAction
},
params :
{ SapObject : sSapObject,
ObjectId : sObjectId
}
}
);
1. Design your workflow in Content Server. For more information, see xxx
Resources
Prerequisites
• You have installed the following development tools: ABAP Development Tools
for SAP NetWeaver, SAPUI5 Application Development Tool for Eclipse.
• For offline development, ensure the local Tomcat web server is configured to
work with SAPUI5 Eclipse.
• You have installed the relevant Extended ECM for SAP Solutions Add-on
packages for Fiori integration and customized the system for the SAP Fiori
integration.
– If you want your original app unchanged, use the extension techniques as
already mentioned in previous section. This means you create a new custom
app that integrates the business workspaces UI control of OpenText Extended
ECM for SAP Solutions.
– Alternatively, you directly insert the code into your original application to
integrate the business workspaces UI control of OpenText Extended ECM for
SAP Solutions.
Read the usage restrictions listed in the Release Notes of OpenText Extended ECM
for SAP Solutions. Always follow supported customizing options and enhancements
as described in OpenText Vendor Invoice Management for SAP Solutions - Configuration
Guide for Foundation (BOCP-CGD).
Additional resources
• Release notes for Archiving and Document Access for SAP Solutions (https://
knowledge.opentext.com/knowledge/llisapi.dll/Overview/67835278): list of
required Add-Ons and versions for building a custom Fiori app for business
object brower.
• OpenText Vendor Invoice Management for SAP Solutions - Configuration Guide for
Foundation (BOCP-CGD): detailed information about the Foundation component
of Vendor Invoice Management for SAP Solutions
Prerequisites
See the Release Notes for the latest supported or recommended versions.
• SAPUI5 plug-ins
• Archiving and Document Access for SAP Solutions Add-on packages for
integration are installed and properly configured
• You customized the system for the SAP Fiori integration
• You have installed the relevant Foundation component of Vendor Invoice
Management for SAP Solutions add-on packages for Fiori integration
• You have installed the OTEXBASB add-on package.
• On the SAP frontend, the Fiori apps of Document Access, Extended ECM and the
Foundation component of Vendor Invoice Management for SAP Solutions are
active. The OData services of these products are also registered. Trusted system
connections and system aliases to SAP backend systems are also defined.
License restrictions
The license for Extended ECM for SAP Solutions includes a subset of the Foundation
component of Vendor Invoice Management for SAP Solutions functionality. With
the installation of the OTEXBASB add-on package, you see all transactions required
for Business Object Browsers in the IMG branch of Archiving and Document Access
for SAP Solutions. If you have sufficient licenses, you can also access the
configuration of the Foundation component of Vendor Invoice Management for SAP
Solutions with transaction /OTX/PF00_IMG.
• General Settings
• Workplace Configuration
• Add-In Customizing
• Fiori App Customizing (called Web Services in the Foundation component of
Vendor Invoice Management for SAP Solutions configuration)
Basic information
• In the IMG, in OpenText Archiving and Document Access > Business Object
Browsing > General Settings > Logical Systems, you must have an entry with
Logical system = LOCAL. For more information, see Section 3.2 “Configuring
logical systems” in OpenText Vendor Invoice Management for SAP Solutions -
Configuration Guide for Foundation (BOCP-CGD).
• The Foundation component of Vendor Invoice Management for SAP Solutions
provides the specific Fiori task app /sap/bc/ui5_ui5/otbcwui/pf07_bc_ui_03,
which renders the pattern of a Master-Detail app. For more information about
the Master-Detail app, see SAP Fiori Design Guidelines ( https://
experience.sap.com/fiori-design-web/v1-30/master-detail-app/).
The following URL parameters determine which data records and business
objects are displayed:
– Work object type wobjType is an abstraction of the business object and how it
is displayed
– Node nodeId is an abstraction of an item to navigate to usually an business
object instance or a list of instances of a specific business object
– Work center or Workplace workplaceId is an abstraction for navigation to
group access to several nodes which are related to each other
• J_6NPF_NAV restricts users to specific work centers and thus to specific nodes
assigned to those work centers. The value of the authorization object is the Work
Center ID.
• J_6NPF_WTY restricts permissions to specific actions on specific nodes and work
objects.
• If you must restrict access to your business data, for example to table KNA1, you
use the code enhancements as described in the BC configuration guide.
• In the Menu tab, you must have TADIR Services
Depending on what the user shall be able to see in Extended ECM the related
permissions must also be assigned.
– Create a data binding to fill variables in a perspective with data from the
business object
– Define, which properties you want to display in the detail section of an item.
– Change the perspective labels and texts
14.8.2.1 Preparing the data and navigation structure for the app
1. Start the SPRO transaction and navigate to OpenText Archiving and Document
Access > Business Object Browsing.
a. Go to Workplace Configuration > Work object types > Work object types.
b. Define a work object type, for example work object type OTX_EX_CUST01.
c. Set at least a handler class, similar to the default handler class /OTX/
PF03_CL_DATA_HANDLER_DYN.
d. Define a display structure and a data selection structure. In the simplest
case it is a database table, for example KNA1.
3. Data selection
Define the table and the field from which the data is taken:
4. Nodes
Define the nodes that you use in a navigation structure:
6. Work center
Define the work center that can be selected in the navigation bar:
a. Go to Web Services > Work Object Types > Work Object Types.
b. Define a web item handler class for your work object type, for example /
OTX/CL_AL_EX_BOBCUST_ITEM for the work object type OTX_EX_CUST01.
Such a class must implement the interface /OTX/PF62_IF_ITEM_HANDLER.
For more information, see Section 9.12.2.28
“CHANGE_RELATED_BUS_OBJECT” in OpenText Vendor Invoice
Management for SAP Solutions - Configuration Guide for Foundation (BOCP-
CGD).
Do not implement methods, which are indicated as OBSOLETE or NOT
RELEASED.
c. Set a Key definition for the work object type, for example KUNNR at field
position 1.
d. Define the Related business object, for example Object Type = KNA1 and
Field List (Key) = KUNNR, because at runtime this information is
conveyed from the Foundation component of Vendor Invoice Management
for SAP Solutions app to the Fiori controls of Extended ECM for SAP
Solutions.
If you want to use this layout template, continue with “Using the perspective
template _OTEB_BC_TEMPLATE_01 for the app layout” on page 351.
If you do not want to use this layout, “Alternative: Creating a perspective without
template” on page 354.
Prerequisites
• The user who does the customizing needs authorizations to use the perspective
editor. For more information, see Section 9.3 “Editing perspectives and layouts”
in OpenText Vendor Invoice Management for SAP Solutions - Configuration Guide for
Foundation (BOCP-CGD).
• If you installed the transport Administration – /OTBCWUI/PF07_BC_ADMIN –
Perspective Manager as suggested by the Foundation component of Vendor
1. Use the SE09 transaction to create a customizing transport request. You will
need it when editing perspectives and perspective view bindings.
2. Start the Fiori Launchpad and click the Perspectives Maintenance tile. On the
start page of the Perspective Editor, you have access to all available perspectives
and layouts.
Note: Do not change this layout. In future support packages this layout
may be changed without further notice.
• Root Work Object Type: Use the search help to select a valid work
object type, which you defined beforehand in the Foundation
component of Vendor Invoice Management for SAP Solutions
customizing on the backend server.
• Select Layout: Select the layout with the help of the search help. Select
layout with _OTEB_BC_TEMPLATE_01.
• Enter a description to make it easier for you to recognize the purpose of
the perspective and app.
e. Click Create.
The perspective is created.
5. You can now adapt it if you want to. For more information, see Section 9.3
“Editing perspectives and layouts” in OpenText Vendor Invoice Management for
SAP Solutions - Configuration Guide for Foundation (BOCP-CGD) and a document
about the template’s details in OTDN (https://knowledge.opentext.com/
knowledge/llisapi.dll/Open/63009526).
• otx.alplus.doc4otbcwui02.view.item.BusinessDocuments:
renders the list of business documents. A click a document opens it in
an overlay over the existing web page.
• otx.alplus.doc4otbcwui02.view.item.BusinessDocumentsSplit:
use together with view DocumentDisplay. It renders the list of business
documents. A click a document opens the document display in the view
DocumentDisplay.
• otx.alplus.doc4otbcwui02.view.item.DocumentDisplay: use
together with BusinessDocumentsSplit. Displays opened documents.
• otx.ecmlink.bws4otbcwui02.view.item.BusinessWorkSpace:
renders the business workspace by opening the integration widget from
Content Server.
c. You can place a view by drag and drop to the tree of the perspective.
d. With the perspective editor, you can adjust the layout of the Fiori app.
Where applicable you are free to choose display texts and icons. At text
fields with globe icon, you can define a text ID in upper case and angle
brackets. These are maintained in configuration OpenText Business Center
for SAP Solutions > Fiori App Customizing > Perspectives > Perspective
Texts. For more information, see the BC configuration guide and the ECM
for SAP Solutions – SDK and API documentation (https://
knowledge.opentext.com/knowledge/llisapi.dll/Open/68222307).
2. Perspective ID
For each pair of node ID and work object type define a perspective ID:
> Business Object Browsing > Fiori App Customizing > Workplace >
Assignment of Nodes to Work Center.
b. Create an entry for each assignment of work center, node ID and work
object type, for example OTX_EX01_WP – OTX_ALCUST_NODE – OTX_EX_
CUST01.
The Node position is currently not used in Fiori UI.
4. Data binding
Define the data binding of a perspective in the Fiori app. For more information,
see Section 9.8.1 “Input helps” in OpenText Vendor Invoice Management for SAP
Solutions - Configuration Guide for Foundation (BOCP-CGD):
Define the data binding of a perspective in the Fiori app.
For more information, see sections see the following:
5. Perspective texts
Maintain and translate the perspective texts. For more information, see Section
9.3.4 “Maintaining perspective texts” in OpenText Vendor Invoice Management for
SAP Solutions - Configuration Guide for Foundation (BOCP-CGD):
c. At sub node Texts, you define the texts of every text ID, which is defined in
the perspective. With menu Goto > Translation, each text can be translated
into target languages.
2. Open the Launchpad Designer to define a Fiori catalog for your app navigation.
The Launchpad Designer opens in a browser with the following URL:
https://[sapsystem].example.net:[port]/sap/bc/ui5_ui5/sap/arsrvc_upb_admn/
main.html
3. Create a target mapping for each of your browsing apps. The content consists of
the semantic object, which you defined earlier, and an action.
Notes
4. In the same Fiori catalog, define a tile for each target mapping with the URL
parameters according to the target mapping.
5. After you have created or edited your Fiori catalog, use the PFCG transaction to
change or create an authorization role on the SAP frontend system to assign the
Fiori catalog to that role. This is done in the Menu tab as a item of type SAP
Fiori Tile Catalog.
Related to personalization:
You also need access to the SAP Fiori Tile Catalog(s) and perhaps also to SAP
Fiori Tile Group, if you want to also have default tile group.
The following authorization objects are used:
For more information about further frontend basis authorizations, see the SAP
documentation (http://help.sap.com).
Scan Business OpenText exposes ArchiveLink attachments enriched with ArchiveLink PLUS
Document attributes in an SAPUI5 based control Business Documents, to integrate in all kinds
of SAP Fiori apps. Users release scanned documents and the “Business Documents”
app stores and assigns them using ArchiveLink.
• Nick, the SAP business specialist uses the SAP Fiori Sales Order app to
maintain and browse business data.
• The app is extended with the OpenText Business Documents control. The
control has now the new action to scan documents with Imaging Enterprise
Scan Web Scanning
• Imaging Enterprise Scan Web Scanning exchanges data with the OpenText
Business Documents control through the SAP web plug-in.
• When released, scanned documents are stored and get ArchiveLink entries
On the server where Archive Center is installed or any other host with Apache
Tomcat
– The Web Scan WAR (Web Application Resource) file. You can get it from the
download area on OpenText My Support.
Customizing prerequisites
For more information on how to use Web Scanning in a Fiori app, see Section 2.2
“Using OpenText Imaging Enterprise Scan Web Scanning in a Fiori app” in OpenText
Archiving and Document Access for SAP Solutions - User Guide (ER-UGD).
2. Create a semantic object OTADA, for example with English description “Special
Intents for OpenText Archiving and Document Access”.
5. In the Fiori catalog in tab Target Mappings, create a new Target Mapping:
3. In the Captiva Cloud Runtime dialog box, click Download, and then save the
setup.exe file.
4. In the SHA-256 dialog box, you can copy the checksum to verify the checksum
of the downloaded OpenText Captiva Cloud Runtime setup file. Click Close.
5. Run setup.exe.
8. In the Configure Remote Access dialog box, select if you want to disable
remote access or allow remote access for users from the group “Captiva Cloud
Toolkit Users”, and then click Next.
OpenText Captiva Cloud Runtime uses ports to communicate with Web Scanning. It
chooses the first available port for each protocol in following range:
If none of the listed ports is available, then an error is logged in the Microsoft
Windows System event log.
To use the Extended ECM for SAP Solutions functionality in SAP CRM or S/4HANA
for Customer Management (S/4CRM), you add Extended ECM for SAP Solutions
specific views, for example, for business partners, opportunities, or leads.
Tip: Extended ECM for SAP Solutions also provides a Content Server
appearance that provides an SAP-like skin for business workspaces in Content
Server. For more information, see “Checking the appearance of the SAP
integration” on page 167.
• OTEXBAS
• OTEXRL
• OTEXRLC
Table 15-1 contains a list of all CRM business objects that have been identified by
OpenText. If you require other business objects, you can extract the necessary
information from the system:
• Component Name and View Set can usually be found in the Web Client UI by
clicking the header of the view and pressing F2.
• The Main Context can usually be found in the code of the IF_BSP_WD_HISTORY_
STATE_DESCR~GET_MAIN_ENTITY method of the Main Window of the UI
component.
Important
CRM Lean Order (LORD) with all its business objects and UI components, for
example ERP_H, are not supported.
Table 15-1: CRM business objects that are supported by Extended ECM
To display business workspaces and business attachments in the SAP CRM Web
Client UI or in S/4CRM as assignment blocks, perform the following steps.
Note: If you are completely new to the way the SAP CRM Web UI framework
works, see the documentation and literature on Web UI development for a
better understanding.
To edit the component for Extended ECM for SAP Solutions integration:
1. You need an enhancement set active in the client that you want to use. If there is
no active enhancement set, create one. For information on how to create an
enhancement set, see the respective SAP documentation.
3. If your component has not been enhanced yet, create an enhancement for it
using the Enhance Component button.
4. In the Runtime Repository Editor, switch to the edit mode and add a new
component usage with the name CUECMLink. The new component usage should
use the /OTX/RMCRM_GS_ECMLK component and the /OTX/RMCRM_GS_ECMLK/
WrkSpceWindow interface view for business workspaces.
On the ComponentUsages context menu, click Add Component Usage.
6. In the Runtime Repository Editor, open the ViewSets node, select the view set
you want to enhance, and add the /OTX/RMCRM_GS_ECMLK/WrkSpceWindow
view for business workspaces and the /OTX/RMCRM_GS_ECMLK/BusRefWindow
view for business attachments to the respective view area.
For example, for business partners, go to the BP_HEAD\BPHEADOverview view
set. To the OverviewPage view area, add the /OTX/RMCRM_GS_ECMLK/
WrkSpceWindow view for business workspaces and the /OTX/RMCRM_GS_ECMLK/
BusRefWindow view for business attachments.
8. Open the Configuration tab for the view set and edit the Customer
Configuration. If there is no customer configuration, open the standard
configuration and click Copy Configuration to create a new one.
a. Move the newly added interface views to the list of displayed assignment
blocks and enter a title for each of them.
For example, for business partners, open the configuration tab for the BP_
HEAD\BPHEADOverview view and move the /OTX/RMCRM_GS_ECMLK/
WrkSpceWindow view for business workspaces and the /OTX/RMCRM_GS_
ECMLK/BusRefWindow view for business attachments to the list of displayed
assignment blocks
b. Enter a title for each of them, for example Business Workspace and
Business Attachments.
Important
You must use the enhanced component controller. Do not use the
original component controller.
ENDMETHOD.
For more information, see the respective SAP documentation in the SAP Help Portal
(http:\\help.sap.com):
Special cases
DATA:
ls_static_view TYPE bsp_dlc_ovw_dyn_views_list,
ls_view TYPE crmc_pril_uiu.
LOOP AT ct_static_views INTO ls_static_view WHERE component EQ '/OTX/
RMCRM_GS_ECMLK'.
ls_view-bsp_appl = ls_static_view-component.
ls_view-viewname = ls_static_view-viewname.
To display business workspaces and business attachments in the SAP CRM IC Web
Client UI as additional tabs, perform the following steps.
Note: If you are completely new to the way the SAP CRM Web UI framework
works, refer to the documentation and literature on Web UI development for a
better understanding.
To edit the component for Extended ECM for SAP Solutions integration:
1. You need an enhancement set active in the client you want to use. If there is no
active enhancement set, create one. For information on how to create an
enhancement set, see the respective SAP documentation.
3. If your component has not been enhanced yet, create an enhancement for it.
4. In the Runtime Repository Editor, start the edit mode and add a new
component usage with the name usageECMLink.
The new component usage should use the /OTX/RMCRM_GS_ECMLK component
and the /OTX/RMCRM_GS_ECMLK/WrkSpceWindow interface view for business
workspaces.
6. In the Runtime Repository Editor, open the ViewSets node, select the view set
you want to enhance, and add the /OTX/RMCRM_GS_ECMLK/WrkSpceWindow
view for business workspaces and the /OTX/RMCRM_GS_ECMLK/BusRefWindow
view for business attachments to the respective view area.
For example, for the overview page for business partners in IC Utilities, go to
the IUICOVW/BottomVS view set. To the view area BottomVA, add the
usageECMLink./OTX/RMCRM_GS_ECMLINK/WrkSpceWindow for business
workspaces and the usageECMLink./OTX/RMCRM_GS_ECMLINK/BusRefWindow
view for business attachments.
* Super method
super->fill_table( ).
* OpenText Links
ls_link-id = 'AccWrkSp'.
ls_link-text = 'Business Workspace'.
ls_link-onclick = 'WORKSPACE_CLICKED'.
APPEND ls_link TO links_tab.
ls_link-id = 'AccBusRef'.
ls_link-text = 'Business Attachment'.
ls_link-onclick = 'BUSREF_CLICKED'.
APPEND ls_link TO links_tab.
ENDMETHOD.
a. From the context menu of Outbound Plugs, select Create and create the
following outbound plugs:
Tip: The OP_ prefix is added automatically. You only need to provide
the plug name.
b. Double-click the OP_ACCWRKSPACE outbound plug to implement it.
Implement it with the following coding:
METHOD op_accwrkspace.
view_manager->navigate( source_rep_view = rep_view
outbound_plug = 'NavToAccWrkspace' ).
ENDMETHOD.
11. On the View Structure tab in the right pane, navigate to Event Handler.
a. From the context menu of Event Handler, select Create and create the
following event handlers:
Note: The name of the event is case sensitive. Provide the name of the
events exactly like stated in uppercase.
b. Double-click the EH_ONWORKSPACE_CLICKED event handler to implement it.
Implement it with the following code:
METHOD eh_onworkspace_clicked.
selected_index = 'AccWrkSp'.
op_accwrkspace( ).
ENDMETHOD.
Important
You must use the enhanced component controller. Do not use the
original component controller.
ENDMETHOD.
Note: If the predefined SAP mapping of SAP CRM objects to BOR objects is
not suitable for your needs, you can implement a BAdI using the IMG activity
CRM Settings > BAdI: Business Object Binding.
One example of a Fact Sheet is the Collection Fact Sheet in the S/4CRM Utilities
Interaction Center.
All Fact Sheets of SAP CRM or S/4CRM are supported with a default business object
for the business workspace and business attachments.
For more information about SAP CRM and SAP S/4CRM Factsheets, see the
following resources on the SAP Help Portal:
Table 15-2: CRM business objects that are supported by default for Fact
Sheets by Extended ECM
Fact Sheet ID Fact Sheet Title Object BOL Object BOR Object
BP_ACCOUNT_ Account Fact Business Partner BuilHeader BUS1006
FS Sheet
ETC_ACCOUN Electronic Toll Business Partner BuilHeader BUS1006
T_FS Collection -
Account
Overview
Fact Sheet ID Fact Sheet Title Object BOL Object BOR Object
FCC_ACCOUN Financial Business Partner BuilHeader BUS1006
T_FS Customer Care -
Account
Overview
FCC_BUAG_FS Financial Business BuAg BUS1006130
Customer Care - Agreement
Business
Agreement
Overview
FCC_COLLECTI Financial FI-CA Work FicaWLIHeader CA_WLI
ON_FS Customer Care - Item
Collection Fact
Sheet
FCC_DUNNIN Financial FI-CA Work FicaWLIHeader CA_WLI
G_FS Customer Care - Item
Dunning Fact
Sheet
IBASE_FACTSH Fact Sheet for Installed Base IBComponent BUS20151
EET_COMP Installed Base Component
Component
IBASE_FACTSH Fact Sheet for Installed Base IBHeader BUS20150
EET_HEAD Installed Base
ICCMP_AFS Account Fact Business Partner BuilHeader BUS1006
Sheet
ISU_BICONS_FS Billing Overview Business BuAg BUS1006130
Agreement
ISU_BUAG_FS Business Business BuAg BUS1006130
Agreement Agreement
Overview
ISU_BUPA_FS Account Business Partner BuilHeader BUS1006
Overview
IU_ACCOUNT_ Account Fact Business Partner BuilHeader BUS1006
FS Sheet
OBJECT_FACTS Object Factsheet Object Product BUS1278
HEET
PROV_ACCOU Provider - Business Partner BuilHeader BUS1006
NT_FS Account
Overview
PROV_FCC_AC Provider - FCC Business BuAg BUS1006130
COUNT_FS Account Agreement
Overview
c. Add the Extended ECM Fact Sheet Views for business workspace and
business attachments:
2. Configure the Workspace and Business Attachment Views in the Fact Sheet:
h. Optional Click in the title column to change the title of the Business
Workspace or Business Attachment view.
i. Click Save.
If the default business object supported by a Fact Sheet (“CRM business objects that
are supported by default for Fact Sheets by Extended ECM” on page 383), is not
suitable for your needs, you can implement a BAdI to return a custom business
object.
Configure custom business objects for the business workspace and business
attachments:
1. In the IMG, navigate to the CRM Settings > BAdI: Fact Sheet integration
activity and click the Execute button.
4. Set the Fact Sheet ID as Filter value for the BAdi Implementation. For the Fact
Sheet IDs, see in the IMG branch Customer Relationship Management (CRM)
or Customer Management (S/4CRM) > UI Framework > UI Framework
Definition > Fact Sheet > Maintain Fact Sheet.
Both methods must return a CRM BOL object. The input for both methods are
the Fact Sheet ID, the CRM BOL Collection passed to the Fact Sheet (might be
empty) and the Workspace or Attachments Window.
Extended ECM provides default BAdI implementations for all Fact Sheets, which are
called when no custom BAdI definition exists:
You can use this default BAdI implementations as example code and as reference for
you own custom BAdI implementation.
To enable this function, you add a button to the email creation pages of SAP CRM
Web Client UI or SAP CRM Interaction Center Web Client UI. The user can click this
button to select a document from a business workspace and attach it to the email.
For more information about the user experience, see Section 9.5 “Adding a business
workspace document to an email” in OpenText Extended ECM for SAP Solutions - User
Guide (ERLK-UGD).
For more information about SAP CRM and the Web Client UI framework, see the
respective SAP documentation in the SAP Help Portal:
1. You need an active enhancement set in the client that you want to use. If there is
no active enhancement set, create one. For information on how to create an
enhancement set, see the respective SAP documentation.
4. In the Runtime Repository Editor, switch to the edit mode. From the
ComponentUsages context menu, select Add Component Usage to add the
new component usage CUCSTargetTree with the following parameters:
• component /OTX/RMCRM_TARG_TREE
7. On the View Structure tab in the right pane, navigate to View Controller. To
open the view controller class, double-click the implementation class of the
view controller.
• Attribute: MH_ADDATTACHMENTCS_HELPER
• Level: Instance Attribute
• Visibility: Private
• Typing: Type Ref To
• Associated Type: /OTX/RMCRM_CL_BT126H_MAIL
8. On the View Structure tab in the right pane, navigate to Event Handler.
a. From the context menu of Event Handler, select Create and create the
following event handlers:
Note: The name of the event is case sensitive. Provide the name of the
events exactly like stated in uppercase.
IF mh_addattachmentcs_helper IS INITIAL.
CREATE OBJECT mh_addattachmentcs_helper
EXPORTING
pih_view_controller = me
pih_component_controller = me->comp_controller.
ENDIF.
mh_addattachmentcs_helper->open_target_tree_popup(
pih_view_context = me->typed_context ).
ENDMETHOD.
ENDMETHOD.
9. On the View Structure tab in the right pane, navigate to View Layout.
1. You need an enhancement set active in the client you want to use. If there is no
active enhancement set, create one. For information on how to create an
enhancement set, see the respective SAP documentation.
4. In the Runtime Repository Editor, switch to the edit mode. From the
ComponentUsages context menu, select Add Component Usage to add the
new component usage CUCSTargetTree with the following parameters:
• component /OTX/RMCRM_TARG_TREE
• interface view /OTX/RMCRM_TARG_TREE/TargetTreeWindow
7. On the View Structure tab in the right pane, navigate to View Controller. To
open the view controller class, double-click the implementation class of the
view controller.
• Attribute: MH_ADDATTACHMENTCS_HELPER
• Level: Instance Attribute
• Visibility: Private
• Typing: Type Ref To
• Associated Type: /OTX/RMCRM_CL_CRMCMP_CCS_EML
8. On the View Structure tab in the right pane, navigate to Event Handler.
a. From the context menu of Event Handler, select Create and create the
following event handlers:
Note: The name of the event is case sensitive. Provide the name of the
events exactly like stated in uppercase.
IF mh_addattachmentcs_helper IS INITIAL.
CREATE OBJECT mh_addattachmentcs_helper
EXPORTING
pih_view_controller = me
pih_component_controller = me->comp_controller.
ENDIF.
mh_addattachmentcs_helper->open_target_tree_popup(
pih_view_context = me->typed_context ).
ENDMETHOD.
mh_addattachmentcs_helper->target_tree_popup_closed(
pih_view_context = me->typed_context ).
ENDMETHOD.
9. On the View Structure tab in the right pane, navigate to View Layout.
To use the Extended ECM for SAP Solutions functionality in SAP SRM, you add
Extended ECM for SAP Solutions specific Web Dynpro components for business
objects like suppliers, purchase orders or shopping carts.
• OTEXBAS
• OTEXRL
• OTEXRLS
Tip: Extended ECM for SAP Solutions also provides a Content Server
appearance that provides an SAP-like skin for business workspaces in Content
Server. For more information, see “Checking the appearance of the SAP
integration” on page 167.
You can use Extended ECM for SAP Solutions, for example, in the following
component configurations:
3. Find the component configurations that you want to enhance and repeat the
following steps for each of it.
Double-click the component configuration to open and edit it.
4. Click Start Configurator to open the Editor for the Web Dynpro ABAP
Component Configuration in a browser window.
5. Click Other Functions > Create Enhancement.
7. Click OK and make sure you get the verification message that the enhancement
was created successfully.
In the next steps, you modify each component configuration to show tabs for
business workspaces and business objects.
Important
Make sure, you use the enhanced configuration and not the original.
1. In the Editor for the Component configuration, click Change for the enhanced
version and not the original.
2. Click Add Main View. A new main view is added to the Hierarchy area.
Note: If you are using multiple languages, log on in each language and
define the title in the corresponding language.
4. In the Hierarchy area, open the node of the newly created main view and click
the user-interface building block (UIBB).
The browser view for your business object now contains the new tabs.
For SAP SRM business objects that do not respond to the BBP_DOC_SAVE_BADI BAdI,
for example, BUS1006 for Supplier or Bidder, see “Configuring events for business
workspaces and business attachments“ on page 199.
3. Double-click /OTX/RMSRM_DOC_SAVE.
• ume.logoff.redirect.silent: false.
5. Maintain the white list to ensure that the log out is only possible from the
specific URL:
To circumvent this, you can define that instead of the original version-dependent
business object, a version-independent object is used for Extended ECM. With this,
changes in the business object may create a new version of the business object but do
not create a new business workspace but update the metadata of the existing
business workspace.
Tip: To customize if SRM business objects are versionable in your SRM system,
use IMG activity SAP Supplier Relationship Management > SRM Server >
Cross-Application Basic Settings > Switch On Version Control for
Purchasing Documents.
The sample property providers for version-independent business object types are
available in OpenText My Support (https://knowledge.opentext.com/knowledge/
llisapi.dll/Overview/25089410).
1. In the IMG, navigate to the Extended ECM > SRM Settings > Maintain Version
Independent Objects activity and click Execute.
2. Create a new entry for the business object that you want to use version-
independent and select Version Independent Object.
You can complement SAP S/4HANA Cloud Essential Edition with the business
workspaces of Extended ECM for SAP Solutions.
Attachments, which are added as GOS or DMS documents or which are updated in
SAP S/4HANA Cloud Essential Edition will be stored in business workspaces in
Content Server. This makes them also available to users who primarily work in
Content Server. SAP users can work with the attachments in SAP S/4HANA Cloud
Essential Edition like before.
The business workspaces are automatically created and relevant metadata is kept in
sync with the business objects in SAP S/4HANA Cloud Essential Edition. You can
add relationships between business workspaces to build up a network of business
workspaces and navigate along the business process in Content Server to find the
right document.
Important
SAP S/4HANA Cloud Essential Edition stores documents in a single
repository. If you want to use this scenario, you must switch the SAP standard
repository to Content Server. However, a migration of documents from the
SAP standard repository to Extended ECM is currently not available.
Therefore, OpenText strongly recommends that you use this integration for
SAP S/4HANA Cloud Essential Edition only in a scenario where no
attachments at all have yet been created.
If you use SAP S/4HANA Cloud Essential Edition with Advanced Compliance
Reporting, you cannot use Extended ECM as CMIS repository in this version.
• The CMIS interface used to store attachments coming from SAP S/4HANA Cloud
Essential Edition in Content Server. Content Server understands the SAP profile
of CMIS to store SAP specific information.
• Content Server listens to events of SAP S/4HANA Cloud Essential Edition, then
creates business workspaces and updates them with metadata and relations of
the business objects in SAP S/4HANA Cloud Essential Edition.
• To retrieve metadata and relations of the business objects in SAP S/4HANA
Cloud Essential Edition, Content Server calls back through OData APIs.
Using the SAP S/4HANA Cloud Essential Edition APIs, you can configure the
following:
Figure 17-1: Side by side approach with SAP S/4HANA Cloud Essential Edition
and Content Server
This overview contains all steps that you must do for the integration. They are
explained in greater detail in the following sections.
1. Create a subscriber ID
2. Create a business application in Content Server.
3. Create a technical user for the CMIS repository.
4. Create Communication User, Communication System and Communication
Arrangement in the S/4HANA Cloud system.
5. Open the APIs on the S/4HANA Cloud system: one for the business events and
at least one for a business object.
6. Switch the repository from the SAP standard repository to Content Server
2. Click the Manage your solution tile and configure your solution:
1. On the global menu, click Enterprise > Extended ECM, and then click
Connections to Business Applications (External Systems).
3. Specify the parameters for your business application, The following parameters
are characteristic to S/4HANA Essential:
• Logical System Name: Any name. Take a note of this name. You will later
need to create a user of the exact same name.
• Connection Type: Select S/4HANA SPI Adapter.
• Application Server Endpoint: for example, https://<tenant-
name>.s4hana.ondemand.com/sap/opu/odata/sap
• User Name and Password: Enter a name for a user and its password. The
user does not yet exist, you will create it in a later step, but you must enter a
value now to be able to save the connection settings.
You will find the CMIS repository in the Content Server Administration. For more
information, see “Viewing the CMIS repository in Content Server” on page 414.
• System ID
Important
SAP S/4HANA Cloud Essential Edition stores documents in a single
repository. If you want to use this scenario, you must switch the SAP standard
repository to Content Server. However, a migration of documents from the
SAP standard repository to Extended ECM is currently not available.
Therefore, OpenText strongly recommends that you use this integration for
SAP S/4HANA Cloud Essential Edition only in a scenario where no
attachments at all have yet been created.
If you use SAP S/4HANA Cloud Essential Edition with Advanced Compliance
Reporting, you cannot use Extended ECM as CMIS repository in this version.
Prerequisites In your tenant, you activated the Cloud Foundry Environment and create a Space
for Extended ECM.
Note: For more information, also see the S/4HANA Cloud documentation on
help.sap.com (https://help.sap.com/viewer/
f6e70dd4bffa4b65965b43feed4c9429/Cloud/en-US/
21bd2788d7c74c43a399dc13cf452f0c.html).
Prerequisites You configured the standard items for your specific scenario, like categories or
workspace types. For more information, see “Configuring business workspaces“
on page 49. The category attributes, of course, must correlate with the business
properties the API returns.
Limitations Only a limited number of business objects can be used to create business workspaces
from the OpenText Extended ECM user interface. This selection of business objects
of sales, procurement and finance processes were identified by SAP based on cloud
customer needs. If you need additional ones, please contact SAP.
1. On the global menu, click Enterprise > Extended ECM > Business Object
Types.
3. Enter the S/4HANA API webservice name in your business object type:
• Service name. On the Details page, it is the last part of, for example,
the production URL. In our example of the Product Master API, it is
API_PRODUCT_SRV.
• Collection. On the API Referenced page, find the collection that suits
your purposes.
b. On the Business Object Type page, open the SAP S/4HANA Cloud tab.
c. In Service URL field, enter the service name, you just copied into the .
d. In the Collection field, enter the collection name.
e. Click Apply.
Attachments stored based on the DMS document model don’t require an extra
document declaration. Those documents are displayed via the DMS virtual folder
inside a business workspace. For more information, see “Content Server: Preparing
the workspace template for the related business objects” on page 245.
Important
Do not use attachment declaration to define you own document names. The
document names must remain unchanged, otherwise they may become
inaccessible.
2. Map your attachment declaration to the business object type in the business
object type configuration in the section Assignment of external document types
to attachment declaration. For more information, see “Assigning external
document type to attachment declaration” on page 137.
1. Configure the business workspace type which you want to use in a cross-
application scenario.
3. Map the business properties from your S/HANA Cloud system to a business
object in another business application. This business application and the
business object must be configured on your Content Server.
Important
You must not change the content or structure of the CMIS repository.
Administrators can view it for informational purposes.
1. On the Content Server Administration page, select Extended ECM for SAP >
SAP CMIS Repositories.
The volume contains repositories for each S/4HANA Cloud system that is
connected.
Extended ECM for SAP Solutions indexes metadata, which is stored for business
workspaces and added business objects. To make this information available via the
search, Extended ECM automatically creates index regions.
To simplify the search for Content Server items, you can define search slices and
saved queries for a business workspace search or the search for business objects.
To support users in effectively reduce their search to only one specific workspace
type, you create a search slice for each workspace type.
• In Smart View: A selection list contains all search slices. The selected search slice
filters the search accordingly.
• In Classic View: The Search dialog contains a Slices list, which contains, for
example, a slice for the workspace type Customer. Users can reduce the search to
business workspaces of type Customer.
Searchable fields are called index regions within Content Server. The module
automatically creates the respective index regions as soon as the first business
workspace or the first business attachment are created and indexed.
2. From the function menu of the Enterprise Search Manager object, select
Properties > Regions.
Attributes that were changed in the business workspace are propagated to the sub-
items to ensure clean data. Because of this feature as well as for performance reasons
you should prefer indexing over metadata inheritance in document templates.
You enable indexing for each business workspace type, and you select which items
are to be indexed. After changing the indexing setting, it may be necessary to re-
index documents.
• Folder
• Shortcut
• Generation
• URL
• Task List
• Task
• Email
• Document
• Business Workspace
4. From the function menu of the workspace type, select Schedule for Re-
indexing.
5. Select Run in test mode without indexing to see how many documents need re-
indexing.
Tip: Run the test mode first to estimate the impact of the indexing process
on Content Server performance.
6. To start the re-indexing, clear the Test run option and click Start.
The re-indexing process is scheduled. You can monitor the actual indexing
progress on the Content Server System page.
Click the respective link on the current window to go to Content Server
System, then click Enterprise Data Source Folder > Enterprise Data Flow
Manager. You can monitor the processing in the Interchange Pools section.
c. The URL in the browser’s address field now shows a string that contains
the parameter ID_CFG, for example, ReferenceTypeEdit&ID_CFG=1.
3. From the Look For list, select Complex Query. Then create a complex query
and specify as search criterion: XECMWkspLinkRefTypeID:<ID_CFG value>.
5. Click Save as Slice and enter a name. The slice is saved to the Slice Folder.
6. Set the permissions for the created slice to make it available for the respective
users.
2. In Classic View, from the global menu, select Tools > Search.
3. Design your search. You can use categories, locations, or system attributes, for
example, only a certain Content Server item type. If you reduce the search to a
certain Content Server item type, this item type must be enabled for business
attachments. For more information, see “Configuring the adding of business
objects to Content Server items” on page 194.
4. Click Save Search Query. Enter a name and a description and save the search
form to the Content Server Saved Queries Volume.
5. From the menu, select Enterprise > Business Workspaces > Saved Queries
Volume and find your new search form.
6. From the function menu of the search form, select Make Custom View Search.
7. Click Save.
Users with sufficient permissions can now use the simple search.
Users can use those templates where they have sufficient permissions.
Smart View
Classic View
• On the global menu with menu option Business Workspaces > Search.
• In the target browse window when users copy or move a Content Server item.
• Extended ECM: When users add a business relationship and search for the
related business workspace. For more information, see Section 4.7 “Creating a
relationship between business workspaces” in OpenText Extended ECM for SAP
Solutions - User Guide (ERLK-UGD).
Tips
• Simple searches are based on the Content Server concept of Custom View
Searches.
• Simple searches can be multilingual, so a search form can have different
names per language.
1. Go to Tools > Search to create an advanced search. For more information about
advanced search options in Content Server, see the Content Server online help.
Tips
• To find only business workspaces, you can use the system attribute
Content Type.
• To find only business workspaces of a specific template, you can use
the system attribute Business Workspace Template ID.
2. Click Save Search Query. Enter a name and a description and save the search
form to the Content Server Saved Queries Volume.
Tip: You can define multilingual names and descriptions. Click the Click
to edit multilingual values button to add the names.
3. From the menu, select Enterprise > Business Workspaces > Saved Queries
Volume and find your new search form.
4. From the function menu of the search form, select Make Custom View Search.
5. Configure the search as desired. In the Options section, add the title and a
description for this simple search.
Click Save.
Users with sufficient permissions can now use the simple search.
Permission definitions on Content Server can either apply to the whole Content
Server system or to individual Content Server items.
Important
For a detailed discussion of authorization concepts on different levels, see
OpenText Extended ECM for SAP Solutions - User Management and Access Control
Scenarios (ERLK-CUM).
• System wide: Object privileges define who can create items of a specific type;
usage privileges define who can perform specific actions. For more information,
see Section 6.1 “Defining general restrictions on Content Server” in OpenText
Extended ECM for SAP Solutions - User Management and Access Control Scenarios
(ERLK-CUM).
• On item level: Content Server permissions, security clearance. Content Server
permissions define access to each item, typically using groups. Permissions can
be inherited. For more information, see Section 6.2 “Defining item level
permissions on Content Server” in OpenText Extended ECM for SAP Solutions -
User Management and Access Control Scenarios (ERLK-CUM).
• On workspace level: Business policies are generated from SAP authorization
profiles. They restrict access to a workspace and its subitems.
Note: For general information, see OpenText Extended ECM for SAP
Solutions - User Management and Access Control Scenarios (ERLK-CUM).
For information on detailed subjects, see the following:
Before you export the SAP authorization objects, you must create an appropriate
field mapping; each field of the authorization object that should be included in the
policies must be mapped to a Content Server category attribute. For more
information, see Section 3.17.2: “Configuring the creation of business workspaces”
on page 136 and “Mapping authorizations in SAP” on page 151.
For information about the overall process and all relevant activities, see Section 7
“Using SAP authorizations to restrict workspace access (optional)” in OpenText
Extended ECM for SAP Solutions - User Management and Access Control Scenarios
(ERLK-CUM).
Notes
Example: A user has the authorization to see customers in the SAP ERP system, but
no authorization to see the same customer in the SAP CRM system. In Content
Server, policies created from authorizations both in the SAP ERP system and in the
SAP CRM system restrict access to the created workspaces. The user can see the
business workspace because the policy created from the SAP ERP system gives
access.
• Error handling has changed. When multiple SAP users are impersonated to
the same Content Server user in the impersonation BAdI, the following
applies:
– The policy report accepts the first SAP user and ignores all the remaining
users
– The policy report contains detailed information about the SAP user to
which the policy is applied along with its corresponding Content Server
user and the policy details
– The policy report shows the details of ignored SAP users.
To export roles:
1. Make sure that in the Business Object Declaration activity of the SAP IMG the
fields that are used to restrict access are mapped to corresponding attributes of
a Content Server category, for example Sales Organization. For more
information, see “Mapping authorizations in SAP” on page 151.
2. Enter /n/OTX/RM_WSA_POL to start the report.
Tip: If you want to assign the policies to users with the Grant Policies
option, set the filter so that only users which also exist in Content
Server are included.
Delete existing Policies
Select this checkbox to delete all existing Content Server policies and
assignments to users before setting new ones.
Caution
Select the Delete existing Policies option only if you want to reset
all policies and assignments.
Grant Policies
Select this checkbox to assign the generated policies to Content Server users.
As an alternative, you can assign policies to Content Server users manually
in Content Server.
Overwrite granted Policies
Select this checkbox to combine the prior deletion of policy assignments
with the creation of new assignments.
4. Click Execute.
The authorization mapping is transferred to the Content Server.
Note: For the respective business objects, you must enable the use of policies
for the workspace type in Content Server (Policies Enabled checkbox); see also
“Creating a workspace type” on page 65.
1. On the Content Server Administration page, click Extended ECM > Open
Policies Volume.
The Content Server Policies page displays the global policies volume with the
SAP policies that are applied to the business workspaces. The policies are
grouped in folders; there is one folder for each business object declaration.
2. To display the properties for each policy using the Properties functions menu:
1. From the Content Server main menu, select Enterprise > Users & Groups.
2. Find the user to which you want to grant policies and click Edit in the Actions
column.
3. On the General tab, in the Policies granted field, add the policies you want to
grant the user.
You can fill OTDS groups with users from the SAP system depending on their role
assignment. The OTDS users and groups are synchronized to the Content Server
groups.
For the mapping, you create the OTDS groups in a separate non-synchronized
partition. You configure the Content Server resource in OTDS, define the partition
and a mapping in the SAP system, run it and configure events. Permissions for
groups in Content Server must be defined separately by the Content Server
administrators. For information about all relevant settings, see Section 8 “Mapping
SAP roles to groups” in OpenText Extended ECM for SAP Solutions - User Management
and Access Control Scenarios (ERLK-CUM).
Note: For earlier versions, a Solution Accelerator was available for the
mapping of SAP roles to Directory Services groups. If you have been using this
Solution Accelerator, you can either stay with your former implementation or
switch to the new implementation. If you want to switch to the new
implementation, copy the mapping from the Solution Accelerator table to the
product table.
For more information about setting up user mapping, see Section 3.2.3.1 “One-to-one
user mapping without impersonation” in OpenText Extended ECM for SAP Solutions -
User Management and Access Control Scenarios (ERLK-CUM).
Note: The OTDS group can be in a different partition which must be non-
synchronized.
Content Server For Content Server groups, the partition is only appended if OTExternalID2,
groups OTExternalID3, or OTExternalID4 is defined as _NAME_ attribute. In this case,
define the partition.
1. In the IMG, navigate to the OpenText Extended ECM for SAP Solutions >
Infrastructure > Maintain Extended ECM Connections activity, and then click
Execute.
• When synchronizing SAP roles to OTDS groups, enter the partition name.
• When synchronizing SAP roles to Content Server groups or business
policies, do the following:
Tip: To find the OTDS attribute value for the _NAME_ resource
attribute, go to Directory Services Integration Administration >
Configure Directory Services > Resources > Properties (for
Content Server) > User Attributes Mappings.
Note: For information about all relevant settings, see Section 8 “Mapping SAP
roles to groups” in OpenText Extended ECM for SAP Solutions - User Management
and Access Control Scenarios (ERLK-CUM).
Warning
If you select the Strict Group Membership option, you delete all OTDS
or Content Server users from the group, who are not also members of
the SAP role. Only OTDS or Content Server users, who have an
equivalent in the SAP role remain in that group.
You have the following auditing options for Extended ECM for SAP Solutions:
• ArchiveLink auditing
Relevant to all ArchiveLink operations in SAP, e.g. in the GOS attachment list.
• Content Server auditing
Relevant to business workspaces and Content Server operations.
• DocuLink auditing
Relevant to all DocuLink operations.
• License Cockpit auditing
Relevant for all operations during license measurement
• OAG1: Archive Link Basic Settings: Select the ArchiveLink Logging check box.
• OALOGCUST: Customize ArchiveLink Logging: Define what should be logged.
• OA_LOG_VIEW_DOC: Display Application Log for Documents: Selection and
display report (Authorization for S_WFAR_LOG authorization object required for
display).
To monitor user actions in DocuLink for certain projects and attribute objects, you
can specify a protocol in customizing. These actions are saved in the protocol table /
IXOS/DC_TBPROT. For more information, see Section 21.3 “Administrating the
protocol tables” in OpenText DocuLink for SAP Solutions - Customizing and
Administration Guide (DC-CGD).
• Open the following page: Core System – Feature Configuration > Event
Auditing > Set Auditing Interests.
• Select the following items: AL Create, AL Read, AL Update.
With the Extended ECM for SAP Solutions license measurement, you assess the
number and types of users who are working with an SAP system and Extended
ECM for SAP Solutions. License measurement for Archiving and Document Access
and Extended ECM for SAP Solutions can be integrated in the SAP license
measurement Global License Audit System (GLAS). With this information, you can
align your contract with SAP or OpenText to meet your requirements more
accurately.
Extended ECM for SAP Solutions license measurement consists of the following
parts:
Note: A user is not locked, if the actual days of usage exceed the number
of days that are covered by the assigned license type. This mismatch is
noted in the license report.
The following license types are available, depending on whether they are sold by
SAP or OpenText.
Type Description
Licenses sold by OpenText
OXECMF OpenText Extended ECM for SAP – Professional User
OXECMO OpenText Extended ECM for SAP – Occasional User
OXECMB OpenText Extended ECM for SAP – External B2B User
OXECMC OpenText Extended ECM for SAP – External B2C User
OXECMN OpenText Extended ECM for SAP – Non-SAP User
ODOCF OpenText Document Access – Full Named User
ODOCW OpenText Document Access – Web Named User
ODOCO OpenText Document Access – Occasional User
OARCF OpenText Archiving – Full Named User
OARCW OpenText Archiving – Web Named User
OARCO OpenText Archiving – Occasional User
Licenses sold by SAP
SXECMF SAP Extended ECM by OpenText – Named User
SXECMO SAP Extended ECM by OpenText limited access option
SAP Document Access by OpenText – User: Business Expert, Ltd.
SDOCF
Professional
SAP Document Access by OpenText – User: Employee, Employee Self
SDOCW
Service (ESS) User
SARCF SAP Archiving by OpenText – User: Business Expert, Ltd. Professional
SAP Archiving by OpenText – User: Employee, Employee Self Service (ESS)
SARCW
User
SARCF2 SAP Archiving by OpenText
SARCO SAP Archiving by OpenText limited access option
SDOCF2 SAP Document Access by OpenText
SDOCO SAP Document Access by OpenText limited access option
22.2 Prerequisites
To use the Extended ECM for SAP Solutions license measurement, you must do the
following:
1. On the SAP system, create roles for each license type that you need with the
authorization object and appropriate license type, and assign them to the users.
2. In Content Server, assign the appropriate license type to the users of Extended
ECM for SAP Solutions. For example, a user who rarely needs to work with
business workspaces needs a different license than users that daily work with
business workspaces.
user who runs a license measurement needs a business role with the following
authorization objects:
2. Create a role for a user who runs license measurement according to the
information given in the table above.
3. On the systems which are called via RFC, create a role for communication users
who are called via RFC from a central license measurement system.
• Writing status, warning and error messages to application log object SLG1.
If validation issues have been found, this shows as a warning message in the log
of each function. You then must check the more detailed license report in
transaction /otx/license.
• Each function module contains an external ID referring to the related application/
product.
• The function modules call a central method of the OpenText license evaluation to
calculate the license counts.
Important
Add the following entries only if you purchased your licenses from
SAP. If you purchased your licenses directly from OpenText, set Call?
= false for all these entries.
Unit Measurement
1140 OT: Licensed User: Buss. Expert, Ltd Pro
1141 OT: Licensed User: Employee, ESS User
1144 OT: Licensed User: Buss. Expert, Ltd Pro
1145 OT: Licensed User: Employee, ESS User
1152 OT: User limited access option
1154 OT: User
1. In Content Server Administration page, click Enterprise > Users & Groups to
open the Content Server user management.
Note: If there are conflicting license assignments for users because one of
their groups has a different type, the most comprehensive license type is
counted.
Only users with the Access Business Workspaces privilege can access business
workspaces. Each time a user with this privilege accesses business workspace is
counted for the license measurement.
2. Edit the restrictions for the usage privilege Extended ECM Operation > Access
Business Workspaces (Mandatory for Licensing) according to your license
model. Mismatches between granted privileges and license type assignment are
displayed in the report.
Note: The SAP administrator who runs the license measurement must have the
following business administrator’s usage privileges in Content Server.
Standard Mode
Use the standard mode for a simple scenario:
• The SAP client on which you run the license dashboard is the only system
that is being measured.
• The Content Server instance that is being measured is customized in the IMG
activity OpenText Extended ECM for SAP Solutions > Infrastructure >
Maintain Extended ECM Connections. You can select a Content Server if
more than one is configured.
Expert Mode
Use the expert mode for a system measurement of more than one SAP client and
possibly more Content Server installations.
You can use expert mode to include all Content Server instances that are
connected to a remote SAP system.
This section is only visible if Extended ECM is installed and Connection IDs are
maintained in the IMG activity.
Save your settings.
3. OpenText Products Sold by SAP That Have Been Licensed: Select if you
licensed OpenText Employee File Management (EFM) or OpenText Travel
Receipts Management for SAP Solutions (TRM). When you selected an option,
DocuLink projects that are recognized as EFM or TRM projects are ignored
when validating access permissions to DocuLink. In any case, TRM or EFM
DocuLink projects are listed in the license report.
4. Include OpenText Content Server: Select an option from the list of available
Content Servers. This list contains entries that are maintained in the IMG
activity OpenText Extended ECM for SAP Solutions > Infrastructure >
Maintain Extended ECM Connections.
Save your settings.
5. Click Start License Measurement and confirm the creation of the background
job.
The Status section informs you about the status of the measurement. Click
Refresh to update the status. If the measurement was performed without errors,
click Display Latest License Report to view the report.
For more information, see “Understanding the consolidated measurement
results” on page 456.
In expert mode, you have the following options how license data is retrieved for
consolidation:
• Direct transfer through RFC connection. The remote system must be available
during the measurement.
• Export an XML file from the remote SAP system and import it to the license
measurement cockpit inbox. Use this option if the remote system is not available
during measurement. You can either create and export file manually on the
remote system, save it to a disc, and then upload it to the measuring system, or
you can retrieve the export file through the RFC connection. In both cases, you
must make sure that the age of the retrieved license data does not exceed the
maximum age that you set for license data.
• Content Server connected to an SAP system.
This section is only visible if Extended ECM is installed and Connection IDs
are maintained in the IMG activity.
Save your settings.
b. OpenText Products Sold by SAP That Have Been Licensed: Select if you
licensed OpenText Employee File Management (EFM) or OpenText Travel
Receipts Management for SAP Solutions (TRM). When you selected an
option, DocuLink projects that are recognized as EFM or TRM projects are
ignored when validating access permissions to DocuLink. In any case, TRM
or EFM DocuLink projects are listed in the license report.
Activate / deactivate
Activate or deactivate an SAP client or a Content Server. Inactive systems
are only visible in the list of inactive systems. They are not deleted,
though. Measurement data that has been uploaded to the inbox for that
system, is invisible when the system is inactive. It is available again once
you activate the system.
New system
Create a system connection manually. Alternatively, create a destination
through an RFC destination.
For this, you need the following information. Most of the SAP related
information are available in transaction SLICENSE. Content Server related
information are taken from the Maintain Extended ECM Connections
IMG activity.
Edit entry
Edit an entry.
b. Confirm that you want to start a background job for this. While the
background job is running, License Measurement Cockpit is locked for
other activities.
You can use transaction SM37 to monitor the background job. The status of
the background job is also displayed in the title bar of the inbox.
a. Click Display Latest License Report to open the latest report in PDF
format.
c. Open the Consolidated Users tab to view a consolidated list of users from
all systems. For more information, see “Understanding the consolidated
measurement results” on page 456.
When you create the export file, the remote system must be available through an
RFC connection. The export file will first be uploaded to the inbox and then can be
saved to the local file system.
File types – Measurement data for an SAP system consists of one XML file of file
type SA. Measurement data of a Content Server consists of two files: Content Server
license info of file type CL and Content Server users list of file type CU.
Tip: If the measured system has no connection to the system where you are
going to do the actual measurement, and you cannot create the export file from
remote, you can do the following: In the License Measurement Cockpit of the
measured system, create an entry for an active SAP Client, and then create the
export file and save it to the file system or portable disk. Then import it to the
inbox of the measuring system.
3. Select the system, for which you want to create the export file.
5. On the Servers and Inbox for Measurement tab, click Export to File
System.
7. After the import, select a directory to save the export file to.
If you exported measurement data from a Content Server, two files are saved:
First a file of file type CL with the Content Server license, and immediately after
that a file of file type CU with user information.
Overview list
On the Status and Result tab, you see the results of the consolidated measurement.
Total number or users, grouped by license type.
Compressed list
On the Consolidated Users tab, you see the Compressed User List of
Consolidation. Users from the measured systems are grouped to unique ID's and
properties. Duplicate users were identified by matching login names. Partition
suffixes of Content Server logins are ignored so that they match the SAP user IDs.
Example: User login on the SAP system is PETER, and user login on Content Server is
peter@partition. Both logins are consolidated into one count.
Column Count of grouped user IDs contains the number of different logins from
the measured systems that were mapped to one entry in the compressed user list.
Complete list
Click Change view and select Grouped users to view the Complete User List of all
Measured Systems.
Important
If the source system is an SAP Client users with classification types T for
technical users and X for specifically excluded users were not transferred. Also
not transferred are users with invalid Valid from or Valid To dates in the user
management.
Aside from detailed information about the measured system and the user, this list
also contains license type information and the number of days in which the user has
used functions of Archiving, Document Access or Extended ECM. This information
is relevant for users with a license type for occasional users. If this number exceeds
52, an issue is displayed.
In single source systems, a license type of Extended ECM is sufficient for usage of
Archiving, Document Access or Extended ECM; a license type for Document Access
is also sufficient for usage of Archiving.
At least in one of the measured systems, the user has accessed Archiving, Document
Access or Extended ECM functions on more than 52 days in the past year but none
of his license types is sufficient.
The license type is assigned to SAP logins by roles. Due to the role assignment, it can
occur that a role related to more than one license type is assigned to a user login.
Validation issue type CL occurs if licenses sold by OpenText and SAP are maintained
at the same time for the same user login and client.
ID Description
CL Users with an OpenText license and an SAP
license
Important
As the consolidation merges data of duplicate users, it may be that in some
cases issues that were seen in the single source systems disappear. In other
cases, it may be that new issues are raised.
Example: Content Server user hmueller@ECM has no license type assigned and issue XECM_
NO_LICENSE was indicated.
SAP user hmueller has license type SXECMF Extended ECM Full User sold by SAP and issue
CL was found.
After consolidation, both user entries were identified to belong to the same person. The
resulting license type of this unique user is SXECMF. Therefore the issue XECM_NO_LICENSE
is no longer valid, which means that issue CA_XECM will not be raised for that unique ID. But
issue CL persists and is indicated as the inconsistency between seller models could still be a
source of error.
For each user, the license type of the highest priority is obtained from the values of
authorization object J_6NLC_TYP authorization object assigned to this user:
In addition, the program checks for access permissions of the user based on other
authorization objects:
• if the user is allowed to access a product but the maintained license type is not
sufficient.
• if no license type was maintained for a user.
License types for occasional usage are maintained when a user is accessing OpenText
applications only occasionally. This concerns, for example, ESS usage, usage as
Employee, or Web usage.
For license measurement, the maintained license type set in authorization object J_
6NLC_TYP is counted. At the same time, the access log entries not older than the
current date -1 year are cross checked in table /OTX/CL_T_ACCESS.
If the count of entries for a user login in a client is greater than 52, and the license
type is classified as a type for occasional usage, this causes a validation issue of type
CO.
Table 22-4: CO: Users with occasional license used the product on more than
52 days per year
ID Description
OARCO OpenText Archiving – Occasional User
OARCW OpenText Archiving – Web Named User
SARCW SAP Archiving by OpenText – User:
Employee, ESS User
The license type is assigned to SAP logins by roles. Due to the role assignment, it can
occur that a role related to more than one license type is assigned to a user login.
Validation issue type CL occurs if licenses sold by OpenText and SAP are maintained
at the same time for the same user login and client.
ID Description
CL Users with an OpenText license and an SAP
license
Data older than one year is not required and can be regularly deleted.
To delete log entries older than one year, run transaction se38 to start the
program /OTX/CL_MAINTAIN_ACCESS_LOG. It checks for ACTVT = 03 of
authorization object S_USER_GRP.
The data of this log table has no further relevance beyond license validation.
XECM_NO_LICENSE
User has access permissions to use Extended ECM features on Content Server but
has no sufficient license type.
XECM_MAX_ACCESS_EXCEEDED
User has an “occasional” license type but has accessed Extended ECM functions on
Content Server on more than 52 days in the past year.
XECM_MULTIPLE_SELLERS
License types sold by OpenText (type O) are mixed with license types of SAP
reselling (type S).
You can use Content Server Transport Warehouse to transport one Extended ECM
for SAP Solutions configuration from one Content Server installation to another, for
example if you are using development, test and productive systems.
For more information about the Transport Warehouse, see the Content Server online
help.
• The import evaluates Content Server nodes like folders, classifications and
categories as they are used in the configuration of business object type,
workspace type and unique names by the name they had in the source system. If
a node with the same name exists in the target system, it is used, otherwise a
warning is issued. If more than one node with the same path is found, the first
one is used and a warning is issued. You can change the node on the preview
page.
• The import checks the usage of categories with attributes and attribute sets for
location and sub location path in workspace type and external document storage,
RM Classification, classification and multilingual names. If it is not correct a
warning is issued. Additionally, if the category does not contain the used
attributes or attribute sets a warning is issued.
• To transport the configuration from the Extended ECM SAP side version 10.5
to Content Server 10.5.1 – When a transport file from the SAP Configuration
Export Report /OTX/RM_EXPORT_BUS_O is imported, the property usages
including the property modifier in location, sub location path of workspace type
4. Click Preview. The transport file is checked and you can preview everything
that is going to be imported and where. Errors and warnings are also displayed.
ID Mapping
Contains all node IDs that have been found in the transport file, for example
for classifications, or for categories that are used for the location or the
workspace name. If the target system contains nodes with the same name as
the source system, they are prefilled with that suggestion. You can change
the node.
a. Click Select to map another node. These settings are buffered and used
when you refresh the preview or start the import. Alternatively, edit the
transport file and save it.
b. Click Preview to read the new changes into the preview.
6. When you are satisfied with the import preview, click Import.
A result page informs you in detail about what has been imported.
The migration for templates is done for each template separately. For more
information, see “Migrating templates” on page 471.
Projects
You can migrate Projects to business workspaces. The Project roles Coordinator,
Member, and Guest are migrated along with their respective permissions.
Projects can contain other projects. These nested projects will also be converted
into business workspaces. For this, you need not necessarily have workspace
hierarchies in your template.
Limitations
• Area (only for cases and binder): Workspace Area for which this binder and
case is valid.
• Path: Path to the location, which contains items that you want to migrate.
• Recursive: Converts also all nested sub-items, which means it converts all
binders, cases or projects sub-folders of a folder, into business workspaces if
they match the search criteria. If no search filter is selected all sub-folders
will be converted.
• Name Filter: Apply a filter to the name field. You can, for example, search
for items that start with a certain string, or that end with certain characters.
• Object Type: A Content Server Object Type
• Business Workspace Template: Workspace template that will be applied to
the migrated workspaces
• Status: Status of the migration mapping
– Open: You are still working on it, the mapping will not be processed.
– Active: The mapping will be processed. To start the migration, see
“Running and monitoring a migration process” on page 470.
– In Progress: The mapping is currently being processed.
– Completed: The agent processed all binders and cases. For a detailed
result and possible errors, see “Running and monitoring a migration
process” on page 470.
2. Batch Size: Enter how many instances you want to process in one batch. If an
error occurs, the process stops this batch and continues with the next batch.
4. Select an option from the Refresh list to update the result lists.
The Overall Migration Status shows the sum of all migrated items. The Migration
Status table details this information per migration mapping. If an error occurs, check
the log file for more information. The log files are located in <OpenText home>\logs
\migration_logs\. If an error occurs during migration, it will be always logged
even if logging is turned off. You can filter the Migration Status table, for example,
to see only the entries of the last seven days. You can also sort the table by creation
date.
3. Click Submit.
Once the migration starts, you can see log files under in <OpenText home>\logs\
migration_logs\.
1. Go to the volume, where the templates for your folder are kept:
• Cases and Binders – Document Templates volume. From the Global menu,
select Enterprise > Document Templates.
• Contracts – Document Templates volume. From the Global menu, select
Enterprise > Document Templates.
• Folders – Document Templates volume. From the Global menu, select
Enterprise > Document Templates.
• Communities – Community templates volume. On the Content Server
Administration page, click Communities Administration > Open the
Community Templates Volume.
3. From the function menu of the item template, select Copy to Workspace
Template.
4. On the following page, select the workspace type and enter a name for the new
template. Some templates may require additional information.
Important
The business object declaration must be maintained before the report can be
executed; see also “Creating a business object declaration in SAP” on page 54.
The search help, which is configured in the business object declaration, must
not have a Search Help exit. Search helps with search help exits are not
supported for batch creation.
Note: Configuring search help using CDS entities (for example MEKKD) is
supported in batch operations.
Prerequisites
• The OTEXRL software component and the OTX namespace must be set to
modifiable using the SE03 transaction.
c. Click Execute.
The generated report has the name /OTX/RM_WSC_CREATE_<business
object>; by default it is added to the /OTX/RM_WSCG package and inserted
in a transport request.
2. Run the report that you created to actually generate the workspaces:
b. Run the created mass report, for example, for equipments /OTX/RM_WSC_
CREATE_EQUI.
d. Select Update only to only update existing business workspaces and not
create new business workspaces.
e. Select Simulation to first check the report and see if the report matches
your expectations.
g. Click Execute.
If not simulated, the specified workspaces are created or updated in
Content Server.
• With synchronous processing: errors that may occur are added to the
error queue and logged in the SAP log, which you can access with the
SLG1. At the end, the batch process returns status and error information
for each workspace that was or was not created.
• With asynchronous processing: the asynchronous queue processes the
batch declaration, status information and errors are logged there as
well. For more information, see “Monitoring the asynchronous queue”
on page 160.
Important
The business object declaration must be maintained before the report can be
started. As for the classic report for batch creation, search help exits are not
supported. There is a new checkbox to tell the report to ignore search help
exits.
Restrictions
• The fields of the search help are rendered as selection fields in the second screen
of the report. If the number of fields is larger than 20, then only the first 20 fields
are displayed.
• The report does not support search helps using CDS entities. Then use the
standard report to create a business object type specific report.
Using The report for the automated workspace creation and update needs the exact keys of
predefined the Plant Maintenance business objects. The Extended ECMfor SAP Enterprise Asset
auxiliary reports
Management Business Scenario contains two auxiliary reports to list the technical
keys for the corresponding object.
Report Description
/OTX/RLSA_PM_LIST_ORD_OP Lists a given Plant Maintenance order
hierarchy
/OTX/RLSA_PM_LIST_TL_GRP Lists a given Plant Maintenance task group
hierarchy
Note: This step works if the exits are used for formatting only. It is still
recommended to use search helps without exits.
4. Select Update only to update existing business workspaces only, and not to
create new business workspaces.
5. Select Simulation to first check the report and see if the report matches your
expectations.
7. Click Reset Restriction Fields to calculate the selection fields for restriction
based on the search help assigned to the business object type.
8. Click Execute.
Note: If you change the business object type, click Reset Restriction Fields
anew to get the corresponding list of fields.
• Synchronous processing – Errors that may occur are added to the error queue
and logged in the SAP log, which you can access with the SLG1 transaction. At
the end, the batch process returns status and error information for each
workspace that was or was not created.
• Asynchronous processing – The asynchronous queue processes the batch
declaration; Status information and errors are logged there as well. For more
information, see “Monitoring the asynchronous queue” on page 160.
Special case: If you are creating composite business workspaces in a batch operation, you first
Composite have to create the parent business workspaces, as they are the location for the
business
workspaces
respective child business workspaces. The location where child business workspaces
are created is always controlled by the property provider. Regardless of any location
settings, you may have entered in the business object declaration of the child. If
there is no business workspace in which a child business workspace can be created,
no child business workspaces are created.
3. Select the Update properties check box to update ArchiveLink entries that have
already been declared.
Tip: If you selected a large amount of data, run the report in the
background using the Execute in Background command from the
Program menu.
4. Click Execute.
5. Click Execute.
The output shows ArchiveLink entries that have been placed in the asynchronous
queue. Green indicates that an entry in the asynchronous queue has been created.
You can use the asynchronous queue to monitor the actual processing of the
declaration. For more information, see “Monitoring the asynchronous queue”
on page 160.
The following parameters are displayed:
BLOCK NUM
ArchiveLink entries are declared in blocks; this is the block number.
BLOCK IDX
The number within a block.
Message
Error message for an ArchiveLink entry.
New: You can now use batch operations to declare large numbers of SAP DMS
documents.
2. Enter the respective parameters to select the required SAP DMS entries.
3. Select the Update properties check box to update SAP DMS entries that have
already been declared.
Tip: If you selected a large amount of data, run the report in the
background using the Execute in Background (F9) command from the
Program menu.
4. Click Execute.
You can use the /OTX/RMMON transaction to monitor the processing. For more
information, see “SAP: Monitoring batch processing jobs” on page 481.
3. Select the Update properties check box to update entries that have already been
declared.
Tip: If you selected a large amount of data, run the report in the
background using the Execute in Background command from the
Program menu.
4. Click Execute.
The output shows the processed entries; icons signal the result of the declaration.
Entries which are ignored are already records.
The following parameters are displayed:
BLOCK NUM
Entries are declared in blocks; this is the block number.
BLOCK IDX
The number within a block.
Message
Error message for an entry.
Note: If you used asynchronous processing for the batch job, you must use the
asynchronous queue monitor. For more information, see “Monitoring the
asynchronous queue” on page 160.
3. Click Execute.
Besides the standard SAP job attributes the number of processed entries, their
process status and the current declaration rate/minute are tracked. These values
are updated during the job execution. Click Refresh to display the most current
values.
4. Click Job Details to access the SAP standard job overview, job log and spool
functions.
To schedule a job:
1. Navigate to the Extended ECM > Document (ArchiveLink) ... > Schedule Job
Removing Deleted Records activity and click Execute.
2. Define the job and schedule it. Create a variant for each connection ID.
3. Click Step.
5. Click Save.
Important
You can run the infrastructure diagnostic program after specifying at least the
Extended ECM connection in the Infrastructure section of the IMG.
• The Infrastructure part is for technical consultants who set up the connection
between the SAP system and the OpenText servers. The report contains the
following types of information: the connection to Content Server, Web service
communication such as logical ports, the OTDS service or HTML controls.
• The Extended ECM part contains the infrastructure information in addition to
information about the customizing, like business object declarations, document
declarations, or item types.
This information only displays if you start the activity from OpenText Extended
ECM for SAP Solutions > Extended ECM > Diagnostic Program.
A green light icon indicates that everything is in order. For checks with a red light
icon, a recommendation is displayed. For more information about each check, see
“Understanding the details of the Diagnostic Program” on page 486.
Note: You can also run the Diagnostic Program as a background job.
3. Click Execute.
Note: For the Infrastructure part of the Diagnostics Program, see Section 25.1.2
“Understanding the details of the Diagnostic Program” in OpenText Extended
ECM for SAP Solutions - Installation and Upgrade Guide (ERLK-IGD).
If both Content Server and the SAP system are upgraded to 16.2.10, Enterprise
Library is not used anymore and therefore not mentioned in the Diagnostic
Program. This is also indicated by a positive test “Does the REST API replace the
Enterprise Library web service?” in the Service Communication section. For test
entries regarding the Enterprise Library, see a previous version of this guide, for
example Section 23.1.2 “Understanding the details of the Diagnostic Program” in
OpenText Extended ECM for SAP Solutions - Customizing Guide (ERLK160209-CGD).
BO Declarations
Are there business object Extended ECM > Maintain “Creating a business object
declarations for this Business Object declaration in SAP”
connection ID? Declarations on page 54
Document Declarations
Are there document Extended ECM > Document “SAP: Creating a document
declarations for this (ArchiveLink) ... > Maintain declaration” on page 219
connection ID? Document Declarations
Are there assignments for Extended ECM > Document
these document declarations? (ArchiveLink) ... > Assign
Declaration ID to Object
Type and Document Type
Are there automatic Extended ECM > Document
assignments? (ArchiveLink) ... > Assign
Declaration ID to Object
Type and Document Type
Use Widgets in UI “Using the Content Server
Integration Widget“
on page 283
Is the “Support Directory” Infrastructure > Maintain Section 22.2.6 “Maintaining
provided for business objects Extended ECM Connections Extended ECM connections”
declarations using Widgets in OpenText Extended ECM for
in UI? SAP Solutions - Installation
and Upgrade Guide (ERLK-
IGD)
Are parameters for Widgets See detailed error message if
available? applicable.
Is the OTDS REST Service
available?
For SAP ERP or SRM only: Is Check if software component “Prerequisites” on page 284
the class SAP_UI is 740 or later.
CL_WD_HTML_ISLAND
available?
For SAP CRM only: Is the “Prerequisites” on page 284
WEBCUIF 701 component
available?
Roles
Does the current SAP user Checks the permissions of Section 22.1.2 “Assigning
have sufficient permissions the current user SAP roles” in OpenText
in SAP to declare records? Extended ECM for SAP
Solutions - Installation and
Upgrade Guide (ERLK-IGD)
Does the current SAP user Checks the permissions of Section 22.1.2 “Assigning
have sufficient permissions the current user SAP roles” in OpenText
in SAP to view record Extended ECM for SAP
details? Solutions - Installation and
Upgrade Guide (ERLK-IGD)
1. In the IMG, navigate to the Extended ECM > Configuration Report activity,
and then click Execute .
The report opens. You can use standard SAP functions to view details, browse
the report, or filter separate lists in the report.
2. To save the report to a local file in, for example in HTML format or as a
spreadsheet, click Local file ..., and select the format that you want.
All errors that occur during document declaration in batch mode are stored. Also
update declaration errors are tracked. The error queue then allows reprocessing the
entries that failed. Errors that occur during the processing of the asynchronous
queue can be monitored there. They are not logged in an error queue. For more
information about the asynchronous queue, see “Creating business workspaces and
declaring document asynchronously” on page 156.
a. If you want to first have a look at the error entries and afterwards re-
process these entries, select the Process records in manual mode check box
and specify the maximum number of entries in the Hit restriction field.
b. Click Execute.
The Error Queue Management dialog displays the selected entries. In this
manual mode, the number of hits is restricted to the value specified before.
d. Click Yes.
A result list of the re-processed ArchiveLink entries is displayed.
e. To view the SAP log of the error that caused the entry in the error queue,
click the number in the Log number column.
To open the print list record error queue (SAP ERP 6.0 only):
In addition to the standard values you can also enter the user who failed in the
declaration process (Error created by field) and the date of the error entry (Error
created at field).
3. You may process the records either in the manual or in the automatic mode:
Proceed as described under Step 3 on page 489 or Step 4 on page 490,
respectively.
4. To view the SAP log of the error that caused the entry in the error queue, click
the number in the Log number column.
3. You may process the records either in the manual or in the automatic mode:
Proceed as described under Step 3 on page 489 or Step 4 on page 490,
respectively.
4. To view the SAP log of the error that caused the entry in the error queue, click
the number in the Log number column.
The application object for Extended ECM for SAP Solutions is /OTX/RM.
Note: There are no additional objects or subobjects for an SAP SRM system.
2. Enter the application object /OTX/RM in the Object field and specify additional
parameters as required. Use a subobject to filter the log.
3. Click Execute.
4. Select a log entry, and then click Technical Information to display the
entry's technical context information.
In an error situation with a specific ArchiveLink entry, you can view the
property values Client, Object Type, and SAP object ID.
5. Click Detailed Information to show the calls stack where the error or
warning occurred. Expand the selected log entry to get more detailed
information.
Tip: Search for the term “Business Workspaces / Extended ECM Information”
to find information related to Business Workspaces.
For Business Workspaces, the following information has been added at the end of
the report:
• Classifications
DataID, Name, SubType and detailed information about available classifications.
For more information about classifications, see OpenText Content Server Admin
Online Help - Classifications Administration (LLESCLS-H-AGD).
• Document Template Configuration
Document template parameters that have been specified on the Administration
page, presented in a technical format with information, for example, about
managed objects, or the DataID of the classification tree.
• Document Template Volume Information
All templates in the document template volume with detailed information. For
more information, see “Defining a workspace template” on page 111.
• Business Object Configurations
Content of the business object types tables, which contain business object type
information. For more information, see “Configuring business object types”
on page 133.
• Workspace Types table
Content of the OTSAP_REFERENCE_TYPES table which contains information
about workspace types that you defined. For more information, see “Creating a
workspace type” on page 65.
• Connections to Business Applications
Business applications that are connected to Content Server. Connection failures
are also listed. For more information, see the Content Server Administration
help.
• Business Applications Multilingual Information
Multilingual name settings for business applications. For more information, see
“Editing workspace names” on page 81.
• OpenText Imaging Viewers
Configured OpenText Imaging Viewers. For more information, see Section 24.4
“Configuring Imaging viewers” in OpenText Extended ECM for SAP Solutions -
Installation and Upgrade Guide (ERLK-IGD).
• Extended ECM Policy Information
All policies that are available. For more information, see OpenText Extended ECM
for SAP Solutions - User Management and Access Control Scenarios (ERLK-CUM).
• Business Object type callback information
Workspace template defined for the business object type when the business
workspace is created from the business application. For more information, see
“Configuring the creation of business workspaces” on page 136.
• Business object type multilingual information
Multilingual business object metadata. For more information, see “Configuring
multilingual metadata languages” on page 64.
Tip: You could use this report to compare two system environments, for
example the development system and the production system.
2. Select either the Lite System Report or the Full System Report option.
3. Click Generate.
Caution
Depending on the size of your system, the Full System Report may take
some time to be generated.
The generated report is a text document, called sysreport.txt, that resides in the
logs directory of your Content Server installation. When you finish generating a
System Report, the file path to the location where the file resides appears in the File
Path section on the Content Server System Report page. You can click the System
Report's link to access the report.
If a System Report has already been generated, a link to the most recently generated
report will appear as part of the header on the System Report page. To get the most
current version of the System Report, you must generate the report again.
Notes
• To use logging in Content Server in general, you must enable it: On the
Content Server Administration page, click Core System - Server
Configuration > Log Settings, and select log levels, for example, 2 – INFO
for Thread Logs.
• Changing the log level settings does not require a restart of the Content
Server services. You set the logging for the current Content Service instance
not for other instances of the Content Server.
1. Open OpenText Administration Client and login to the server where Enterprise
Library Services is installed.
2. Navigate to Enterprise Library Services > Configuration and adjust the
following value:
logging.OTDS.level = TRACE
3. Start the Directory Services web administration client in a web browser. Open
http://<fully_qualified_domain_name_of_server:<port_number/otds-
admin/ and sign in.
4. Sign in as otadmin@otds.admin.
5. From the web administration menu, under the Info heading, click System
Status.
6. On the System Status page, click Download System Configuration Report.
If you can stop and restart the system, you can generate a specific log files that
contain exactly the information that OpenText Customer Support needs to analyze
the problem.
Note: Do not delete the logs directory itself; any subdirectories under it
can be deleted.
7. Restart the following services so that the above changes take effect:
10. Optional If OpenText Customer Support asked you to generate a Content Server
system report, do it now. For more information, see “Understanding the
Content Server System Report” on page 497.
11. Stop the Content Server (OTCS), Content Server Admin (OTCSAdmin), Content
Server Cluster Agent, and Tomcat services.
12. Go to the <Content Server home>\logs directory and zip all files in there.
14. Reset the original logging settings. On the Content Server Administration page,
click Core System – Server Configuration > Log Settings and set the log level.
15. Restart the Content Server (OTCS), Content Server Admin (OTCSAdmin) and
Tomcat services.
16. Contact OpenText Customer Support on how you can provide them with the
zipped log files.
1. On your Content Server server, open a command prompt window and navigate
into the <Content Server home>\bin directory.
2. Start the following command, where <cs-home> is the root directory of your
Content Server installation.
OTUpdateAnalyzer.bat -m <cs-home> -c
3. After the script completed, you can open the report in your default web
browser. When prompted, type y and press ENTER.
4. Navigate into <Content Server home>\temp\OTUA and copy the files that
include the date on which the report was run, for example OT_DELTA_REPORT_
1372769971871.csv or OT_DELTA_REPORT_1372769971871.html.
Version information is also included in the system reports of Content Server and the
configuration report in the SAP system.
• Content Server
On the Content Server menu, select Help > About Content Server. The
version is displayed, for example, Content Server 16.2. You also find detailed
information in the Content Server system report. For more information, see
“Understanding the Content Server System Report” on page 497.
• Web Services and other OpenText components
Go to Control Panel > Add/Remove Programs or Programs and Features. In the
list of programs, you see which version is installed.
• SAP System, Database information and OpenText Components
In the SAP IMG (transaction SPRO, OpenText Extended ECM for SAP Solutions
> Extended ECM > Configuration Report), run the Configuration Report to get
information about the SAP server. In this report, you find information like the
versions of OTEXBAS, OTEXERP, OTEXRL, OTEXRLC, OTEXRLS, OTEXBASO,
OTEXBASF, OTEXRLO, and OTEXRLF. For more information, see
“Understanding the Configuration Report” on page 488.
• Support Package of installed SAP System
In the SAP GUI application, on the menu, select System > Status. Click
Component information to see the installed SAP components with release
number and highest support package. If you only want to know the version
numbers of OTEXBAS, OTEXERP, OTEXRL, OTEXRLC, OTEXRLS, OTEXBASO,
OTEXBASF, OTEXRLO, and OTEXRLF, you can use this instead of the
configuration report.
• SAP Fiori apps
For each application, there is a static version.html file, which includes the
version number. To retrieve the file, enter the following in a browser:
http(s)://<SAP hostname>:<SAP port>/sap/bc/ui5_ui5/otx/<subpath of
fiori app>/version.html
25.6 Troubleshooting
Troubleshooting describes some commonly encountered problems, with solutions or
tips on how to avoid them. For further information on known problems for your
Extended ECM for SAP Solutions version see the corresponding Release Notes in
OpenText My Support.
– Do the SAP HTTP server and the Content Server have the same second-level
and top-level domain name?
• Verify that your Internet Explorer settings allow cookies.
• Verify if the SAP system is in the same IP domain as the Enterprise Library
Services or Content Server. The first two levels are important, for example
company.com.
• Verify that OTDS is properly configured.
• Verify that the SAPSSOEXT authentication handler is configured with the correct
PSE file with the correct SAP certificate.
• Verify that there is a corresponding Content Server user for the SAP user.
Cause Time difference between the SAP server and the Content Server server.
Solution Verify that time settings of the SAP server and Content Server (RCS Server) are
identical.
It is recommended to use a time server to keep time settings of SAP and Content
Server identical.
In case of a virtualized server, modify the time settings of the respective real server,
as the virtual server draws its time settings from the real one.
• Search the SAP logs for an Enterprise Library Services error message.
• Verify that the given document type has been associated to a declaration and this
association has been marked as automatic (IMG activity Assignment of
declaration ID to object type and doc. Type).
• Verify that a workflow entry has been configured (IMG activities Maintain/
Activate Receiver Module Events).
• Verify that the SAP Workflow System is set up and running correctly (SWU3
transaction).
See SAP documentation for details.
Solution If you experience problems with viewing certain document types, add the fax
extension as an alternative to the image/tiff entry in the config\mime.types file
of OpenText Content Server.
Solution In the business object type definition, select a workspace type for default display.
For more information, see “Configuring a basic business object type” on page 135.
Solution
• The user can press F12 in the browser to get a console log for more technical
errors which can be forwarded to the administrator combined with a date/time
when this came up.
• On the SAP front end server, use transaction /IWFND/ERROR_LOG to get error
messages. To change the log level, click Error Log > Global configuration.
• On the SAP backend server, use transaction /IWBEP/ERROR_LOG to get error
messages. To change the log level, click Error Log > Global configuration.
• On both SAP frontend and backend check the application log SLG1.
• Refer to SAP Fiori documentation for more logging and tracing options in the
Fiori framework.
SAP system
Content Server
System Report: “Understanding the Content Server System Report” on page 497
Contains the complete configuration information of the Content Server system.
Look for the “Extended ECM Information” section.
3. In the Reports pane, open the Scenarios tab and select the scenario.
4. In the Actions pane, click Generate Report. A new window opens, which
you can close.
1. From the web administration menu, under the Info heading, click System
Status.
attribute
Content Server concept to store metadata. Attributes are organized in categories.
Business properties of a business object are mapped to attributes.
BAdI
business object
Representation of a “real-life” object in the business application. This can be, for
example, a business partner, a service process, or a product. Business objects are
the center point of Extended ECM.
Business Workspaces
Content Server core module that enables the use of business workspaces with or
without a connection to a business application.
business attachment
Content Server item, for example a document or a folder, that is added as a link to
the business workspace of a business object. The item, which is used as business
attachment elsewhere, is indicated by an icon and has a link to the respective
business object. The other way around, you can configure a business object type,
so that it can be added to a Content Server item.
business workspace
Content Server item that contains documents and other items which are related to
a business object.
category
Content Server concept to store metadata. A category contains attributes or
attribute sets. A category can be mapped to store metadata delivered from the
business application.
Classic UI
Classic View
Content Server user interface with folders, function menus and sidebars. As
opposed to Content Server Smart View.
See also: Smart UI
classification
Classifications are used to categorize Content Server items, for example,
documents, compound documents, and folders into a taxonomy of Classifications
called Classification Trees. For business workspaces, classifications control what
kind of business workspace can be created in a certain folder.
declaration
document declaration
Definition of how a document is to be stored in Archive Center via ArchiveLink.
document metadata
Describes the document and its business context. Different types of documents
may have different metadata assigned. Metadata can be used to search for a
document.
document properties
Set of attributes that all documents share; for example, the owner of a document
or the creation date.
document templates
Templates for documents with default content and attributes.
See also: workspace templates
GOS
group replacement
Method to dynamically assign access rights for a Content Server item such as a
business workspace or a document to a group of users. The group replacement is
typically based on attributes of the Content Server item.
impersonation
Method in which users of the business application utilize other users to gain
access to Content Server. Impersonation must be implemented according to the
requirements of the business application.
indexing
Process of collecting data about Content Server items so that they can be searched
with Content Server search functionality.
integration widget
Enables an integration method to display Content Server content in HTML-based
application. Content is displayed with JavaScript and HTML5 technology rather
than embedding the classical Content Server user interface.
OSS notes
OTDS
perspective
Controls how users see the layout of a business workspace in Content Server
Smart View. Perspectives consider rules, for example, the workspace type,
template, or the user group. You design and configure a perspective in
Perspective Manager, a tool that walks you through the creation of a perspective
and translates it into ActiveView coding.
Perspective Manager
See: perspective
policies
Method to transfer and apply SAP authorization objects in Content Server.
print lists
Documents that are created by the SAP system and, if necessary, can be processed
automatically. They represent extracts from the SAP data base, compiled
according to specific criteria, and created by reports.
property provider
Program or web service that delivers properties of a business object from the
business application to Content Server.
record
Records Management
relationship
Hierarchical relationship between business objects that are visualized as
relationships between business workspaces. A sidebar widget and Related
Workspaces Folders make related business workspaces visible in Classic View. In
RFC service
A program used for communication between the SAP application and the archive
system via RFC (Remote Function Calls).
SAP Notes
Notes provided by SAP that contain post-release changes or corrections for
already released versions of SAP products. When you encounter SAP-specific
problems or false behavior in SAP programs, especially after or during a new
installation of product components, check the SAP Support Portal for necessary
SAP notes.
sidebar widget
Element of a business workspace in Classic View that displays various types of
business workspace metadata and information to the end user.
simple search
Saved query and customized search form that can be used to find business
workspaces, cases and binders, and to create shortcuts. Also known as Custom
View Search in Content Server.
Smart UI
Smart View
Content Server user interface with a landing page and container pages. The
content is presented in tiles that contain widgets. The pages are highly
configurable using the Perspective Manager.
SPRO
system attributes
Metadata that all content items have in common, for example item names, creator
of an item, or the modification date.
widget
Element of the user interface that displays information for the user.
workspace reference
Business object that is linked to a business workspace. If the business workspace
already exists, users add the business object as business reference to it.
workspace templates
Templates for new business workspaces with default configuration, folder
structure, and optionally default content. Templates are offered to the user based
on the classification and the storage location of the new document.
workspace type
Content Server object that controls the location where a business workspace is
stored, some of the GUI components such as sidebar widgets, and the name
pattern of the business workspace.
In OpenText's ECM for SAP solutions, a property provider plays a critical role in enhancing document metadata beyond basic attributes, ensuring that all relevant business properties are adequately represented. This allows for more robust and effective retrieval and management of documents. Default classes are available to handle ArchiveLink properties, and customization can be achieved through extending these classes to suit specific business needs, further enriching the document management environment with comprehensive metadata .
Having the same classification for both the business workspace template and its location in OpenText is crucial to ensuring that business workspaces can be created manually with consistent organization and adherence to standardized classifications. This alignment helps in maintaining structural integrity and consistency of workspace organization within the system .
To manage email storage and workspace suggestions, OpenText employs a combination of configured rules and email search settings within the Outlook add-in. The add-in uses these rules to perform pattern matching on email properties, and assigns numeric weight values to business workspaces according to the frequency and relevance of emails stored. This approach helps prioritize workspace suggestions efficiently by displaying those with the highest weight value to users, thus enhancing productivity and organization .
When creating workspace templates in OpenText, it is crucial to ensure that the Content Server subtype for a business workspace (subtype 848) is configured as a template. The classification for the workspace template and the business workspace location must be the same. Metadata inheritance should be turned off to avoid system performance issues, using indexing functions instead. Additionally, permissions, team roles, and group replacements must be defined carefully to control access and roles within the workspace .
In OpenText, bulk document declarations are managed through an asynchronous queue to maintain performance efficiency. The asynchronous queue allows document declarations running in batch processes and workflow requests to be processed, ensuring that the business workspace is created before the business document is declared. The system utilizes parallel processing to speed up operations and allows manual intervention for monitoring and restarting queued items. The processing can be optimized by analyzing the rate of workspace creation and scheduling queue processing manually .
Categories and attributes in OpenText define the configuration of workspace types or business object types. Categories allow setting the location and names of business workspaces, and also serve in mapping business properties from a business application to category attributes. Attributes, which align with business property names, are vital for uniquely identifying business workspaces. OpenText recommends using a Text:Reference attribute for this purpose to uniquely identify the business workspace .
OpenText ensures security and access control within business workspaces by enabling replacement of groups in workspace templates to restrict access, defining permission handling, and setting up team roles and participants. Additionally, permissions need to be carefully mapped and defined for each template used, ensuring that only authorized users have access to the respective parts of the business workspace and that sensitive information is protected .
Metadata inheritance in OpenText can lead to system performance issues because it involves copying metadata en masse from a business workspace into documents and items within it. This copying is a one-time action, and subsequent metadata updates are not inherited. Instead, OpenText recommends using indexing functions, which keep metadata retrievals efficient and do not affect system performance negatively. Disabling inheritance is advised with the goal of utilizing more dynamic and resource-efficient metadata handling methods .
The Outlook add-in in OpenText suggests business workspaces based on rules and email search settings. The add-in examines the email properties for specific terms or patterns as configured by rules and checks for relationships with existing business workspace emails, including the sender and recipients. Suggested workspaces are assigned numeric weight values from this analysis, and the add-in displays workspaces with the highest weights. The integration supports configurations to prioritize specific patterns and terms, aiming to deliver highly relevant suggestions .
Asynchronous processing in OpenText's ECM for SAP Solutions offers significant advantages for event-based creation of business workspaces. It supports parallel processing and allows intricate operations like workspace creation to be handled in a queued fashion, ensuring that crucial events are processed without interrupting system performance. This approach improves response time and resource allocation by processing operations in intervals and prioritizing critical events, while also allowing for manual triggers to cater to specific business scenarios, thereby maximizing efficiency and minimizing downtime .