Extended ECM Administration Guide
Extended ECM Administration Guide
Solutions
Administration Guide
ERLK160000-00-AGD-EN-2
OpenText™ Extended ECM for SAP® Solutions
Administration Guide
ERLK160000-00-AGD-EN-2
Rev.: 23. Sept. 2016
This documentation has been created for software version 16.0.
It is also valid for subsequent software versions as long as no new document version is shipped with the product or is
published at https://knowledge.opentext.com.
Tel: +1-519-888-7111
Toll Free Canada/USA: 1-800-499-6544 International: +800-4996-5440
Fax: +1-519-888-0677
Support: https://support.opentext.com
For more information, visit https://www.opentext.com
Disclaimer
Every effort has been made to ensure the accuracy of the features and techniques presented in this publication. However,
Open Text Corporation and its affiliates accept no responsibility and offer no warranty whether expressed or implied, for the
accuracy of this publication.
Table of Contents
1 What is OpenText Extended ECM for SAP Solutions ............ 5
1.1 What is new? .................................................................................... 5
1.2 Related documentation ...................................................................... 6
6 Troubleshooting ...................................................................... 49
6.1 Content Server HTML dialogs do not display in SAP due to an
connection error .............................................................................. 49
6.2 A logon screen is displayed instead of Content Server HTML dialogs ...50
6.3 A user cannot declare records or view record details ......................... 51
6.4 A user cannot declare records or view record details or maintain
document declarations .................................................................... 51
6.5 When storing a business document in a given SAP business object,
a record is not automatically declared ............................................... 51
6.6 Business workspaces cannot be displayed anymore in SAP once
the Undelete module is removed ...................................................... 52
6.7 Problems with MIME type of uploaded content .................................. 52
6.8 A workspace type is not available to configure a business object
type ................................................................................................ 52
6.9 The URL to the business object is not displayed in the workspace’s
Properties tab ................................................................................. 52
6.10 Problems with SAP Fiori apps .......................................................... 53
GLS Glossary 55
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.
Product docu- The following documentation is available for Extended ECM for SAP Solutions
mentation respectively in the OpenText Knowledge Center (https://knowledge.opentext.com/
knowledge/cs.dll/Open/10194282):
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 - Administration Guide (ERLK-AGD) (this
guide)
The Administration Guide describes ongoing maintenance tasks.
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 - 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.
Release Notes The Release Notes describe the following aspects in detail:
• The software supported by the product
• Requirements
• Restrictions
• Important dependencies
• Last-minute changes regarding the documentation
• Manual IDs of the current documentation
The Release Notes are continually updated. The latest versions of the Extended ECM
for SAP Solutions Release Notes is available in the OpenText Knowledge Center:
Extended ECM for SAP Solutions (https://knowledge.opentext.com/knowledge/
cs.dll/Open/62387578).
Extended ECM for SAP Solutions provides different means to analyze or diagnose
your system:
• SAP Diagnostic Program
Verifies different parameters regarding the connection to Content Server as well
as configuration and customizing parameters.
• SAP Configuration Report
Compiles a variety of customizing information and parameters of your SAP
system.
• Error queues
Store event that appeared in relation to business workspaces, business
attachments and record declaration.
• Content Server system report
Adds Extended ECM for SAP Solutions specific information to the Full System
Report of Content Server
New
Important
You can run the infrastructure diagnostic program after specifying at least
the Extended ECM connection in the Infrastructure section of the IMG.
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 11.
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 19.1.2
“Understanding the details of the Diagnostic Program” in OpenText Extended
ECM for SAP Solutions - Installation and Upgrade Guide (ERLK-IGD).
BO Declarations
Are there business object Extended ECM > Maintain Section 3.3 “Creating a
declarations for this Business Object business object declaration in
connection ID? Declarations SAP” in OpenText Extended
ECM for SAP Solutions -
Customizing Guide (ERLK-
CGD)
Document Declarations
Are there document Extended ECM > Document Section 6.10 “SAP: Creating
declarations for this (ArchiveLink) ... > Maintain an document declaration” in
connection ID? Document Declarations OpenText Extended ECM for
SAP Solutions - Customizing
Guide (ERLK-CGD)
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
Item Types
Is the “otx.sap.rm.Folder” OpenText Administration Section 18.5.3 “Importing
folder type present? Client Enterprise Library folder and item type” in
Services server > Enterprise OpenText Extended ECM for
Library Services > SAP Solutions - Installation
Document Model > Folder and Upgrade Guide (ERLK-
Types IGD)
or rather
Does the folder type have a Section 6.6 “SAP: Creating an
default classification? Enterprise Library item type
Is the OpenText Administration and additional categories for
“otx.sap.rm.Document” item Client Enterprise Library a specific property provider”
type present? Services server > Enterprise in OpenText Extended ECM for
Library Services > SAP Solutions - Customizing
Document Model > Item Guide (ERLK-CGD)
Types
Is the
“otx.sap.rm.SystemArchiveLi
nk” item type present?
Is the
“otx.sap.rm.SystemPrintList”
item type present?
Use Widgets in UI Section 10 “Using the
Content Server Integration
Widget” in OpenText
Extended ECM for SAP
Solutions - Customizing Guide
(ERLK-CGD)
Is the “Support Directory” Infrastructure > Maintain Section 17.5 “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)
1. In the IMG, navigate to the Extended ECM > Configuration Report activity and
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.
/OTX/RMPEQ
ArchiveLink entries
/OTX/RMPEQPRINTL
Print lists
/OTX/RM_WSC_PEQ
Business workspaces and business attachments
All errors during declaration in batch mode are stored. Also update declaration
errors are tracked. The error queue then allows reprocessing the entries that failed.
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.
4. Processing records in automatic mode
Deselect the Process records in manual mode check box and run the report
either in the background or directly.
The result list is the same as in the manual re-processing, with all entries of the
error queue filtered according to your selection mask entries.
To open the print list record error queue (SAP ERP 6.0 only):
3. You may process the records either in the manual or in the automatic mode:
Proceed as described under Step 3 on page 14 or Step 4 on page 15, respectively.
3. You may process the records either in the manual or in the automatic mode:
Proceed as described under Step 3 on page 14 or Step 4 on page 15, 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 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.
For Extended ECM for SAP Solutions, the following information has been added at
the end of the report:
Tip: You could use this report to compare two system environments, for
example the development system and the production system.
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.
New: You can now use the Content Server general logging for the logging of
the Connected Workspaces module.
Notes
• To use logging in Content Server in general, you must enable it: On the
Content Server Administration page, click Server Configuration >
Configure Server Parameters > Server Logging Options, and select a log
level for Content Server logging, for example, Detailed thread logging.
• 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.
2. Find the following elements and change the values according to your needs:
<context-param>
<param-name>LivelinkServer</param-name>
<param-value>localhost</param-value>
</context-param>
<context-param>
<param-name>LivelinkServerPort</param-name>
<param-value>2099</param-value>
</context-param>
<context-param>
<param-name>LivelinkEncoding</param-name>
<param-value>UTF8</param-value>
</context-param>
2.3.2 Setting the log level for the Extended ECM web service
You can change the log level for the Extended ECM web service in Apache Tomcat
web server. The default setting is WARN.
2. Find the following elements and change the value according to your needs:
<root>
<priority value ="TRACE"/>
<appender-ref ref="console"/>
<appender-ref ref="logfile"/>
</root>
• ALL
• TRACE
• DEBUG
• INFO
• WARN
• ERROR
• FATAL
Tip: For more information, see the Apache Tomcat 8: Logging in Tomcat
documentation (http://tomcat.apache.org/tomcat-8.0-doc/logging.html).
1. Open OpenText Administration Client and login to the server where Enterprise
Library Services is installed.
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 [email protected].
5. From the web administration menu, under the Info heading, click System
Status.
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.
4. Stop the Apache Tomcat service from the OTDS, Extended ECM services, and
Enterprise Library service installation.
5. If you wish to keep the existing log files, backup all current log files in the
following directories:
6. From the logging directories <Content Server home>\logs and <Tomcat home>
\logs, delete all files, including those in subdirectories of the \logs directories.
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:
1. On your Content Server server, open a command prompt window and navigate
into the <Content Server home>\bin directory.
2. Run 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.
The asynchronous queue for the creation of business workspaces and document
declaration helps you increase system speed and overcome occasional consistency
issues.
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 33.
1. Enqueue item
2. Store items
in queue
4. Read items
from queue
5. Create business
workspaces
Interaction
mechanisms in
SPRO
1. Lock queue filling 2. Lock queue reading 3. Lock automatic 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 the OpenText
Knowledge Center (https://knowledge.opentext.com/knowledge/cs.dll/Open/
44140285).
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 the OpenText Knowledge Center (https://
knowledge.opentext.com/knowledge/cs.dll/Open/44140285).
1. In the IMG, navigate to the Extended ECM > Maintain Receiver Module
Events activity and click Execute.
1. In the IMG, navigate to the Extended ECM > Maintain Declaration Queue
activity and click Execute.
Server group
You can define which server group should process the queue. For more
information about parallel processing with asynchronous RFC, see the
SAP documentation about parallel processing with asynchronous RFC
(for example at http://help.sap.com/saphelp_snc700_ehp01/helpdata/
en/22/0425c6488911d189490000e829fbbd/frameset.htm)
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 33 and all necessary permissions in Content
Server. This user is also the owner of the business workspaces in Content
Server.
4. The report displays the content of the queue. It also summarizes the settings
you made in the queue properties.
• Priority: While adding new items, the process can also define the processing
priority and with that differentiate the workspace creation scenarios.
• SLG Reference: Click to view a more detailed entry in the SAP application
log.
• Created by: Creator of the item
• Created on: Creation date and time in the format YYYYMMDDHHMMSS.
• Activity: Activity, for example Create a workspace. For information about
the value, press F4.
• Obj. Type: Business object type
• Key: Business object key
• Cont. Rep., Doc ID, Doc.type StrgeDat, Date, Reserver, Flag: Only relevant
for document declaration items.
5. To retry the creation of business workspaces for queued items, select one or
more rows, then click Re-process selected items.
Important
OpenText strongly recommends that you contact OpenText Global Services
to identify a reasonable and consistent backup and disaster recovery
strategy.
When you create your backup concept, consider including the following in your
backup:
• OpenText Runtime and Core Services database schema
• Connected Workspaces database schema
• Content Server database schema
• OpenText Archive Center database schema
• File systems of the servers that contain the binaries and configuration files
• Documents and disk buffers of Archive Center
• Fulltext index (is reflected in the file system and belongs to the Content Server)
Tip: To backup the fulltext index, you must stop the Administration
service.
Note: OpenText recommends that the times of associated backups do not differ
too much, since this may lead to inconsistencies when you need to restore the
system.
Important
The business object declaration has to be maintained before the report can be
executed; see also Section 3.3 “Creating a business object declaration in SAP”
in OpenText Extended ECM for SAP Solutions - Customizing Guide (ERLK-CGD).
Prerequisites
• The OTEXRL software component and the OTX namespace must be set to
modifiable using the SE03 transaction.
• Your SAP user must be registered as a developer.
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. Start the created mass report, for example, for equipments /OTX/
RM_WSC_CREATE_EQUI.
At the end, the batch process returns status and error information for each
workspace that was or was not 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.
The output shows the processed ArchiveLink entries; icons signal the result of the
declaration. Entries which are ignored are already records.
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.
A summary on the processed ArchiveLink entries is given at the end of the output.
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.
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.
3. Click Step.
5. Click Save.
Example:
The ticket information which should be copied into the ticket.txt file can be
obtained from the RCS.log from the logs directory of the application server.
Usually the ticket is valid for two minutes only. The PSE file needs to be exported
from the SAP system. For more information, see Section 17.1 “Exporting the SAP
PSE certificate for the SAP authentication handler” in OpenText Extended ECM for
SAP Solutions - Installation and Upgrade Guide (ERLK-IGD).
For more information, for example on error codes, also see the PDF files in the
same directory on the CD.
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.
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 Section 3.13.1 “Configuring a basic business object type”
in OpenText Extended ECM for SAP Solutions - Customizing Guide (ERLK-CGD).
Solution
Attribute
BAdI
See Business Add-In (BAdI).
Window in SAP ERP that contains content, which is related to the business object.
The Business Content window can be opened in an SAP ERP system from the
Generic object services (GOS) menu of a business object. The Business Content
window displays the business workspace and its content, business attachments,
business documents (ArchiveLink), notes and local files.
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.
Configuration item for business objects in Content Server. The business object
type describes the structure of the data. A business object type in Content Server
has its counterpart in the business application.
Business reference
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
Category
Classic View
Content Server user interface with folders, function menus and sidebars. As
opposed to Content Server Smart View.
See Also Smart View.
Classification
Connected Workspaces
Content Server module that enables the use of business workspace with or
without a connection to an external system.
Declaration
See Document declaration.
Document declaration
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
Basis for new business workspaces that are managed with Extended ECM for
SAP Solutions. Templates are offered to the user based on the business object type
and the storage location of the new document.
SAP: Functions that are not application-specific and can generally be used for any
business object, e.g. creating or displaying the business workspace.
GOS
See Generic object services (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
Content Server module that controls documents and other objects based on rules
and classifications. Compliance and other legal regulations require that
documents have a controlled life time cycle, that they are archived, that they can
be frozen or that they are deleted after a certain time. Records Management also
controls access to the documents. To set a document under the regulations of
Records Management, it is declared as record.
OSS notes
See SAP Notes.
OTDS
See OpenText Directory Services (OTDS).
Perspective Manager
See Perspective.
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.
Policies
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
See OpenText Records Management.
Records Management
See OpenText Records Management.
Relationship
SAP Notes
installation of product components, check the SAP Support Portal for necessary
SAP notes.
A tool for customizing in the SAP system, opened with the SPRO transaction.
Sidebar widget
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 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.
See Also Classic View.
SPRO
See SAP Reference IMG (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 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.