OpenText™ Extended ECM for SAP ® Solutions
Administration Guide This guide describes how to maintain an OpenText Extended ECM for SAP Solutions system. It also contains information about monitoring, logging and troubleshooting.
ERLK160200-00-AGD-EN-04
OpenText™ Extended ECM for SAP ® Solutions Administration Guide
ERLK160200-00-AGD-EN-04 Rev.: 15. Dec. 2017 This documentation has been created for software version 16.2. 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. Open Text Corporation 275 Frank Tompa Drive, Waterloo, Ontario, Canada, N2L 0A1 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
Copyright © 2017 Open Text. All R ights Reserved. Trademarks owned by Open Text. Disclaimer No Warranties and Limitation of Liability 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 1.2
What is new in version 16.2? ............................................................. 5 Related doc umentation .... .................................................................. 6
2
System an alysis ... ...................................................................... 9
2.1 2.1.1 2.1.2 2.1.3 2.1.4 2.1.5 2.2 2.3 2.3.1 2.3.2 2.3.3 2.3.4 2.4 2.4.1 2.4.2 2.4.3
Analyzingt he SAP system ............................................................... 10 Understanding the SAP Diagnostic Program ......................... ............ 10 Understanding the details of the Diagnostic Program ......................... 11 Understanding the Configuration Report ........................................... 13 Using the Error Queue s ............. ...................................................... 14 Analyzing t he application log ............................................................ 17 Understanding the Content Server System Report ............................ 22 Analyzingt he Tomcat web services ............................................ ...... 25 Configuring host and port for Content Server in Tomcat ..................... 25 Setting the log level for the Extended ECM web service ..................... 25 Viewing the log file of the web services .... ......................................... 26 Viewing the status of the Tomcat web applications ..... ....................... 26 Creatinglo g files for OpenText Customer Support ............................. 26 Logging authentication issues ..... ..................................................... 26 Generating Content Server log files ................... .............. ................. 27 Creating a cumulative update report .. .............. ................................. 29
3
Usingtheasynchro nous queue for business workspace creation ..................................................................................... 31
3.1 3.2 3.3
Setting up asynchronous queueing for event based creation .. ............ 33 Settingque ue properties ................................................. ................. 33 Monitoring the asynchronous queue .................. ............. .................. 35
4
Backupr ecommendations ...................................................... 37
5
Using batch operations ........................................................... 39
5.1
5.3
Content Server: Migrating binders and cases to business workspaces ..... ......... ...................................................................... 39 Mapping bi nders and cases to workspace templates ...................... ... 39 Running an d monitoring a migration process ..................................... 40 Configuring log settings for the migration .......................................... 40 SAP:Creat ing or updating business workspaces using batch operations ....... ......... ................................... ................................... 41 SAP:Decla ring ArchiveLink documents using batch operations ......... 43
5.4 5.5 5.6
SAP:Decla ring print list records using batch operations ................. ... 44 SAP:Monit oring batch processing jobs ....................................... ...... 46 SAP:Sche duling jobs for removing deleted records ........................... 47
5.1.1 5.1.2 5.1.3 5.2
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
iii
Table of Contents
6
Troubleshooting ...................................................................... 51
6.1
Content Server HTML dialogs do not display in SAP due to an connection error ..................... .................................................. ....... 51 A logon screen is displayed instead of Content Server HTML dialogs ...52 A user cannot declare records or view record details ......................... 53 A user cannot declare records or view record details or maintain document declarations ............................................. ....................... 53
6.2 6.3 6.4 6.5
6.10
When storing businesscally document in a..given SAP business object, a record is notaautomati declared ............................................. 53 Business workspaces cannot be displayed anymore in SAP once the Undelete module is removed .................................................. .... 54 Problems with MIME type of uploaded content .... .............................. 54 A workspace type is not available to configure a business object type ................................................................................................ 54 The URL to the business object is not displayed in the workspace’s Properties tab ................................................. ................................ 54 Problems with SAP Fiori apps .......................................................... 55
GLS
Glossary
6.6 6.7 6.8 6.9
iv
57
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
Chapter 1
What is OpenText Extended ECM for SAP Solutions OpenText Extended ECM for SAP Solutions is a combination of Content Server modules, web services and an SAP package, with which you can integrate Content Server functionality into SAP businessarchiving, processes. This includes functionality for document and records management, workflow, and collaboration. Business workspaces, cases and binders
A business workspace in Content Server contains content that is relevant for a business object. From Content Server side, users can easily view the data of this business 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 attachments
In addition to the content that is stored in a business workspace for a business object, users can connect additional documents as business attachments to a business object.
Business relationships
Extended ECM for SAP Solutions provides tools to illustrate a relationship between business workspaces. For example, a hierarchical relationship between business workspaces can be displayed in a sidebar widget of a business workspace.
1.1 What is new in version 16.2? This document applies to software version 16.2 including patches released until December, 2017. “System analysis“, page 9 The product, components, and administration activities have been renamed as follows: •
The product ECMLink is now Extended ECM for SAP Solutions.
•
The Content Server module ECMLink is now Connected Workspaces.
•
ECMLink Web Services are now Extended ECM Web Services.
•
Content Server administration: There are now two relevant sections on the Administration Page: Connected Workspaces for general configuration and Extended ECM for configuration related to external systems such as SAP.
•
SAP administration: In the IMG, all activities are collected in the OpenText Extended ECM for SAP Solutions section. In addition to the Infrastructure section, there is a Extended ECM section. The Maintain Enterprise Library Settings activity has been renamed to Maintain Extended ECM Connections. In general to refer to connections to OpenText components, Connection ID is used instead of Enterprise Library ID.
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
5
Chapter 1 What is OpenText Extended ECM for SAP Solutions
1.2 Related do cumentation Important
OpenText strongly recommends that you read OpenText Extended ECM for SAP Solutions - Overview Guide (ERLK-GGD) to make you familiar with architectural aspects and business scenarios of Extended ECM for SAP Solutions. Product documentation
The following documentation is available for Extended ECM for SAP Solutions respectively on OpenText My Support (https://knowledge.opentext.com/knowledge/ cs.dll/Open/https://knowledge.opentext.com/knowledge/llisapi.dll/Open/10194282):
OpenText Extended ECM for SAP Solutions - Overview Guide (ERLK-GGD) The Overview Guide contains a short overview over the functions and features of Extended ECM for SAP Solutions. It also explains the architecture and shows different business scenarios of Extended ECM for SAP Solutions. 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) 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 - 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 - 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.
6
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
1.2. Related documentation
OpenText Extended ECM for SAP Solutions - Installation Guide with SAP HANA (ERLKIWH) This specific Installation Guide describes the setup of one architecture scenario for Extended ECM for SAP Solutions with SAP HANA as database. OpenText Extended ECM for SAP Solutions eBook The eBook describes the key concepts and capabilities of Extended ECM for SAP Solutions. The OpenText Extended ECM for SAP Solutions eBook is available on OpenText My Support (https://knowledge.opentext.com/knowledge/llisapi.dll/Open/ 18208703). Content Server Champion Toolkit A variety of documents deals with deployment scenarios of Content Server as well as Best Practices examples. The Content Server Champion Toolkit documents are available on OpenText My Support (https://knowledge.opentext.com/knowledge/llisapi.dll/open/19905386). 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 NotesRelease are continually latest versions of the Extended ECM for SAP Solutions Notes isupdated. availableThe on OpenText My Support: Extended ECM for SAP Solutions (https://knowledge.opentext.com/knowledge/llisapi.dll/ Open/67811874).
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
7
Chapter 2
System analysis 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
The product, components, and administration activities have been renamed as follows: •
The product ECMLink is now Extended ECM for SAP Solutions.
•
The Content Server module ECMLink is now Connected Workspaces.
•
ECMLink Web Services are now Extended ECM Web Services.
•
Content Server administration: There are now two relevant sections on the Administration Page: Connected Workspaces for general configuration and Extended ECM for configuration related to external systems such as SAP.
•
SAP administration: In the IMG, all activities are collected in the OpenText Extended ECM for SAP Solutions section. In addition to the Infrastructure section, there is a Extended ECM section. The Maintain Enterprise Library Settings activity has been renamed to Maintain Extended ECM Connections. In general to refer to connections to OpenText components, Connection ID is used instead of Enterprise Library ID.
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
9
Chapter 2 System analysis
2.1 Analyzing the SAP system 2.1.1
Understanding the SAP Diagnostic Program You can use the Diagnostic Program to analyze your installation. Important
You can run the infrastructure diagnostic program after specifying at least the Extended ECM connection in the Infrastructure section of the IMG. The diagnostic program is aimed at two different target groups: •
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 11. Note: You can also run the Diagnostic Program as a background job. To run the Diagnostic Program manually:
1.
If you are only interested in infrastructure information, in the IMG, navigate to the OpenText Extended ECM for SAP Solutions > Infrastructure > Diagnostic Program and click Execute. If you are also interested in the Extended ECM specific information, in the IMG. navigate to the OpenText Extended ECM for SAP Solutions > Extended ECM > Diagnostic Program activity.
10
2.
If there is only one Extended ECM connection configured, the diagnosis is started immediately. If there are more connections configured, perform the following steps, enter the connection ID.
3.
Click
Execute.
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
2.1. Analyzing the SAP system
2.1.2
Understanding the details of the Diagnostic Program This section lists the various tests of the Diagnostic Program and refers to sections in this guide which contain helpful information. Note: For the Infrastructure part of the Diagnostics Program, see section 20.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 declarations for this
Extended ECM > Maintain Business Object
Section 3.4 “Creating a business object declaration in
connection ID?
Declarations
SAP” in OpenText Extended ECM for SAP Solutions Customizing Guide (ERLKCGD)
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
11
Chapter 2 System analysis
Document Declarations Are there document declarations for this connection ID?
Extended ECM > Document (ArchiveLink) ... > Maintain Document Declarations
Section 6.10 “SAP: Creating an document declaration” in OpenText Extended ECM for SAP Solutions - Customizing Guide (ERLK-CGD)
Extended ECM > Document Are there assignments for these document declarations? (ArchiveLink) ... > Assign Declaration ID to Object Type and Document Type Are there automatic assignments?
Extended ECM > Document (ArchiveLink) ... > Assign Declaration ID to Object Type and Document Type
Item Types Is the “otx.sap.rm.Folder” folder type present?
OpenText Administration Client Enterprise Library Services server > Enterprise Library Services > Document Model > Folder Types
Does the folder type have a default classification? Is the “otx.sap.rm.Document” item type present?
OpenText Administration Client Enterprise Library Services server > Enterprise Library Services > Document Model > Item Types
Section 19.5.3 “Importing folder and item type” in OpenText Extended ECM for SAP Solutions - Installation and Upgrade Guide (ERLKIGD) or rather Section 6.6 “SAP: Creating an Enterprise Library item type and additional categories for a specific property provider” in OpenText Extended ECM for SAP Solutions - Customizing Guide (ERLK-CGD)
Is the “otx.sap.rm.SystemArchiveLi nk” item type present? Is the “otx.sap.rm.SystemPrintList” item type present? Use Widgets in UI
Section 7 “Using the Content Server Integration Widget” in OpenText Extended ECM for SAP Solutions - Customizing Guide (ERLK-CGD)
Infrastructure > Maintain Is the “Support Directory” Section 18.5 “Maintaining provided for business objects Extended ECM Connections Extended ECM connections” declarations using Widgets in OpenText Extended ECM for in UI?
12
SAPUpgrade SolutionsGuide - Installation and (ERLKIGD)
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
2.1. Analyzing the SAP system
Are parameters for Widgets available?
See detailed error message if applicable.
Is the OTDS REST Service available? For SAP ERP or SRM only: Is the class CL_WD_HTML_ISLAND available?
Check if software component Section 7.1 “Prerequisites” in SAP_UI is 740 or higher. OpenText Extended ECM for SAP Solutions - Customizing Guide (ERLK-CGD)
For SAP CRM only: Is the WEBCUIF 701 component available?
Section 7.1 “Prerequisites” in OpenText Extended ECM for SAP Solutions - Customizing Guide (ERLK-CGD)
Roles
2.1.3
Does the current SAP user have sufficient permissions in SAP to declare records?
Checks the permissions of the current user
Section 17.2 “Assigning SAP roles” in OpenText Extended ECM for SAP Solutions Installation and Upgrade Guide (ERLK-IGD)
Does the current SAP user have sufficient permissions in SAP to view record details?
Checks the permissions of the current user
Section 17.2 “Assigning SAP roles” in OpenText Extended ECM for SAP Solutions Installation and Upgrade Guide (ERLK-IGD)
Understanding the Configuration Report You can use the SAP Configuration Report to summarize your Extended ECM for SAP Solutions configuration. The report displays system and configuration parameters coming from customizing transactions and tables. You can use this information for reference and for debugging. You can export the list to a file. To run the SAP Configuration Report:
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.
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
13
Chapter 2 System analysis
2.1.4
Using the Error Queues Errors occurring during the declaration either of ArchiveLink entries, print lists or business workspaces are tracked in an error queue. This queue can be accessed with the following transactions: /OTX/RMPEQ
ArchiveLink entries
/OTX/
Print lists
RMPEQPRINTL Business workspaces and business attachments. Errors of creating /OTX/ business workspaces in the course of creating a document are written to / RM_WSC_PEQ OTX/RMPEQ
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 Section 3.22 “Creating business workspaces and declaring document asynchronously” in OpenText Extended ECM for SAP Solutions - Customizing Guide (ERLK-CGD). To open the ArchiveLink records error queue:
1.
Start the /OTX/RMPEQ transaction.
2.
Restrict the entries to be listed by specifying the required parameters. In addition to the standard ArchiveLink values you can also enter the user who failed (Error in the declaration process (Error created by field) and the date of the error created at field). entry You may process the records either in the manual or in the automatic mode (see Step 4):
14
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
2.1. Analyzing the SAP system
3.
Processing records in manual mode a.
If you want to first have a look at the error entries and afterwards reprocess 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.
c.
Select the entries you want to reprocess and click Re-process.
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.
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
15
Chapter 2 System analysis
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):
1.
Start the /OTX/RMPEQPRINTL transaction.
2.
Restrict the entries to be listed by specifying the required parameters. In addition to the standard print list 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 15 or Step 4 on page 16, respectively.
To open the business workspaces error queue:
1.
16
Start the /OTX/RM_WSC_PEQ transaction.
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
2.1. Analyzing the SAP system
2.
Restrict the entries to be listed by specifying the required parameters. 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 15 or Step 4 on page 16, respectively.
4.
2.1.5
To view the SAP log of the error that caused the entry in the error queue, click the number in the Log number column.
Analyzing the application log Extended ECM for SAP Solutions tracks errors and warning situations in the SAP standard application log. The application object for Extended ECM for SAP Solutions is /OTX/RM. Depending on the scenario, the following subobjects are available: /OTX/AUTH
Authorization check
/OTX/BRUPD
Business attachment update
/OTX/CONFIG Configuration /OTX/DECUI
Record declaration UI
/OTX/DISP
Disposition report
/OTX/ERRQ
Error queue failure
/OTX/GOS
GOS attachment list
/OTX/GOSENH Modify GOS items via enhancement /OTX/GOSMENU GOS menu /OTX/HTTPSRV HTTP server failure
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
17
Chapter 2 System analysis
/OTX/LINKE
Link entry changed
/OTX/MIGR
Migrate report
/OTX/MIG_IDS Migrate Content Server IDs report /OTX/RMDOL
Content Server Business Attachments
/OTX/RMWSA
Workspace Policies
/OTX/RMWSS
Business Object Search
/OTX/SEAB
Full-text Search Base
/OTX/SEAPI
Full-text search API
/OTX/SEARCH Search report /OTX/SEAX
Full-text search connector
/OTX/TEST
Test
/OTX/UPD
Update events
/OTX/WSSET
Read, create, or update business workspace
/OTX/CRM
SAP CRM related issues
Note: There are no additional objects or subobjects for an SAP SRM system. To view the SAP application log:
1.
18
Start the SLG1 transaction.
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
2.1. Analyzing the SAP 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.
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
19
Chapter 2 System analysis
4.
20
Select a log entry and click Technical Information to display the entry's technical context information.
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
2.1. Analyzing the SAP system
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.
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
21
Chapter 2 System analysis
6.
Double-click on the subentry to show a detailed error message. If available, click Detailed Information to display the details of the error message.
2.2 Understanding the C ontent S erver Sy stem Report The Content Server System Report contains extensive details about your Content Server system. Tip: Search for the term “Connected Workspaces / Extended ECM
Information” to find information related to Extended ECM for SAP Solutions. The Content Server System Report contains module specific information in both the full and the lite version. For Extended ECM for SAP Solutions, the following information has been added at the end of the report: •
Enterprise Library Applications Application ID and volume ID and its status
•
OpenText Directory Services Connection information about OpenText Directory Services, URL of the web service and the login screen of the Directory Services server.
•
22
Classifications
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
2.2. Understanding the Content Server System Report
DataID, Name, SubType and detailed information about available classifications. For more information about classifications, see Administering Classifications Classifications Admin Online Help (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 . •
Workspace Types table Content of the OTSAP_REFERENCE_TYPES table which contains information about workspace types that you defined. For more information, see .
•
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 Section 3.11.4 “Editing workspace names” in OpenText Extended ECM for SAP Solutions - Customizing Guide (ERLK-CGD).
•
OpenText Imaging Viewers Configured OpenText Imaging Viewers. For more information, see Section 22.6 “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 .
•
Business object type multilingual information Multilingual business object metadata. For more information, see Section 3.10 “Configuring multilingual metadata languages” in OpenText Extended ECM for SAP Solutions - Customizing Guide (ERLK-CGD).
•
Workspace type multilingual information Multilingual workspace type names. For more information, see Section 3.11.4 “Editing workspace names” in OpenText Extended ECM for SAP Solutions Customizing Guide (ERLK-CGD).
•
Workspace type callback setting information
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
23
Chapter 2 System analysis
Location and classification settings for the different workspace types. For more information, see . •
Business object type property map information All mappings of business properties to category attributes.
•
Business object type property group map information Mappings or business property groups to category sets.
•
Business object type property groups information Property groups of the different business object types. •
Unique name settings Unique names that are configured for reference, for example to categories, folders, or themes. Tip: You could use this report to compare two system environments, for
example the development system and the production system. To generate a system report:
1.
In the Server Configuration section on the Content Server Administration page, click the System Report link.
2.
On the System Report page, 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.
24
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
2.3. Analyzing the Tomcat web services
2.3 Analyzing the Tomcat web services 2.3.1
Configuring host and port for Content Server in Tomcat After installation of the Apache Tomcat web server, and deployment of the Extended ECM Web service, the server name is localhost with port 2099. You can change these settings, for example if you need to address more than one Content Server instance. To change host name and port of Content Server:
1.
Open the
\webapps\otsapxecm\WEB-INF\web.xml file in an editor.
2.
Find the following elements and change the values according to your needs: LivelinkServer cs.example.com LivelinkServerPort 2099 LivelinkEncoding UTF8
3.
2.3.2
Restart the Tomcat for the changes to take effect.
Setting the log level for t he 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. To set the log level:
1.
Open the \webapps\otsapxecm\WEB-INF\classes\log4.xml file in an editor.
2.
Find the following elements and change the value according to your needs:
You have the following options: • •
ALL TRACE
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
25
Chapter 2 System analysis
• • • • •
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).
2.3.3
Viewing the log file of the web services The log files for the services relevant for Extended ECM are located here: \logs •
Extended ECM: ecmlink.log
•
Enterprise Library Services: ot-elib.log
•
OTDS: otds.log
•
Content Web Service: cws Tip: In previous versions, les-services was used.
2.3.4
Viewing the status of the Tomcat web applications To view the status:
1.
Start the Tomcat Web Application Manager, for example http://myserver. opentext.net:8080/manager/html/
2.
Look for /otsapxecm.
2.4 Creating l og files for OpenText Cu stomer Support 2.4.1
Logging au thentication i ssues To log authentication issues, you can activate additional authentication logging in OpenText Administration Client and create a report of the OpenText Directory Services configuration directly from its LDAP backend. You can use this report when you report issues to OpenText Customer Support. For more information, see Section 20 “System Status” in OpenText Directory Services - Installation and Administration Guide (OTDS-IWC). To configure authentication logging in Content Server:
1.
26
Open OpenText Administration Client and login to the server where Enterprise Library Services is installed.
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
2.4. Creating log files for OpenText Customer Support
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://
2.4.2
4.
Sign in as [email protected].
5.
From the web administration menu, under the Info heading, click System Status.
6.
On the System Status page, click Download System Configuration Report.
7.
The system configuration report downloads to your machine. An information box displays, depending on your browser settings, that you can click to display the report.
Generating Content Server log files If you want to generate log files on a productive system and do not have the option to restart Content Server and services, you can enable logging on a running system without any restart. In this case the log file may contain information that is not needed to analyze a specific error. 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. To generate Content Server log files without a restart: •
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.
To generate Content Server log files with a restart:
1.
Logon to the Content Server server with administrator rights.
2.
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.
3.
Stop the following services: • • •
4.
Content Server (OTCS) Content Server Admin (OTCSAdmin) Content Server Cluster Agent
Stop the Apache Tomcat service from the OTDS, Extended ECM services, and Enterprise Library service installation.
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
27
Chapter 2 System analysis
5.
If you wish to keep the existing log files, backup all current log files in the following directories: • •
6.
\logs \logs
From the logging directories \logs and \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: • • • •
Content Server (OTCS) Content Server Admin (OTCSAdmin) Content Server Cluster Agent Apache Tomcat Service
8.
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.
9.
Reproduce the errors that you were experiencing.
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 22.
11. Stop the Content Server (OTCS), Server Admin (OTCSAdmin), Content Server Cluster Agent, and TomcatContent services. 12. Go to the \logs directory and zip all files in there. 13. Go to the \logs directory and zip all files in there. 14. Reset the srcinal logging settings. On the Content Server Administration page, click Server Configuration> Configure Server Parameters> Server Logging Options 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 provi de them with the zipped log files.
28
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
2.4. Creating log files for OpenText Customer Support
2.4.3
Creating a cumulative update report The cumulative update report tells which files will be changed when you apply an update and to which version each file belongs. To generate a cumulative update report:
1.
On your Content Server server, open a command prompt window and navigate into the \bin directory.
2.
Run the following command, where is the root directory of your Content Server installation. OTUpdateAnalyzer.bat -m -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 \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.
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
29
Chapter 3
Using the asynchronous queue for business workspace creation The asynchronous queue for the creation of business workspaces and document declaration helps you increase system speed and overcome occasional consistency issues. Use case: Asynchronous creation of business workspaces with SAP events With the asynchronous queue in place, creation and update requests for business workspaces are queued for asynchronous processing. Usually, the asynchronous process is started by a background job. The process then processes the queue entries and creates or updates business workspaces. If an operation fails, the entry stays in queue with a proper hint until the failure source is remedied. Use case: Asynchronous creation of business workspace plus related document declaration Some transactions create a business object and a document at the same time, for example the ME21N transaction to create a purchase order. Extended ECM for SAP Solutions is configured to store the document in the corresponding business workspace. If no workspace exits, it creates a business workspace for the business object. Technically, Extended ECM for SAP Solutions triggers the creation of the business workspace, and verybusiness soon after that triggers thebusiness declaration of the business document in that workspace. If the workspace is not created at this time, for example because of a server overload, an error occurs. The asynchronous queue ranks creation requests to ensure that first the business workspace is created, and afterwards the business document can be declared in this business workspace. Both document declarations running in batch processes and document declarations running in workflow requests (for example a bulk declaration report running in background) run in the asynchronous queue. Parallel processing
You can use parallel processing for the asynchronous queue. In order to increase 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.
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
31
Chapter 3 Using the asynchronous queue for business workspace creation
Figure 3-1: Asynchronous queuing for business workspaces Queue processing
1. An event or a user enqueues items 2. The enqueuing actions stores the items in the queue Enqueuing can be paused with option Lock queue filling. 3. The queue processor reads items from the queue Reading from the queue can be paused with option Lock queue reading. 4. Business processes are being created. Creating business workspaces can be paused with option Lock automatic queue processing. Processing of the items is either started manually or by a scheduled job. API functions and function modules
The Extended ECM for SAP Solutions contains function modules for Create or Update events to be processed either synchronously or asynchronously. For 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/68222307). 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.
32
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
3.1. Setting up asynchronous queueing for event based creation
3.1 Setting up as ynchronous q ueueing for e vent based creation Extended ECM for SAP Solutions provides function modules that you can use to trigger the creation or update of business workspaces or business documents by an event. To use the asynchronous queue, you must use the dedicated function modules that contain _ASYNC or _ASY in their name. 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/68222307). To use the asynchronous queue for event based creation of business workspaces:
1.
In the IMG, navigate to the Extended ECM > Maintain Receiver Module Events activity and click Execute.
2.
Configure eventing with a function module that is designed for the asynchronous queue. For more information, see Section 5.2 “SAP: Linking events to receiver type function modules” in OpenText Extended ECM for SAP Solutions - Customizing Guide (ERLK-CGD).
Authorizations for the background user (for example WF-BATCH) •
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.
3.2 Setting queue properties To maintain the queue properties:
1.
In the IMG, navigate to the Extended ECM > Maintain Declaration Queue Execute. activity and click
2.
Set the following options according to your requirements:
3.
•
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.
Define the settings of the queue processing program /OTX/ RM_WSC_Q_CONSUMER_BGJOB. a.
Start the SE38 transaction.
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
33
Chapter 3 Using the asynchronous queue for business workspace creation
b.
As program, enter /OTX/RM_WSC_Q_CONSUMER_BGJOB.
c.
Click
d.
Define the settings:
Execute.
Number of items to process Define the number of items to process in total. If the parameter is empty the program runs as long as there are items to process. Number of items to fetch Define the number of items that are collected for processing at the same time. Default is 150. Ideally, it is at least the multiplication of the number of processes and the number of items per process. If there are more items in the queue than the defined number, they are collected in a new selection. Number of items per process Define the number of items that are processed by each process at the same time. Default is 50. Use old processing (deprecated) Only select if you do not want to use the new processing logic. If you select this check box, all other settings are ignored and parallel processing is not possible. 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) Number of parallel processes Define the number of processes that run in parallel:
e. 4.
•
Number of parallel processes = 0: no parallelization is used at all.
•
Number of parallel processes = 1: data fetching runs decoupled from the workspace creation. All request are sent in one web service request according to the number of items per process parameter
•
Number of parallel processes >1: data fetching runs decoupled from the workspace creation. The value determines how many web service calls are started in parallel.
Save your entries. These settings are used when the program is executed.
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
34
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
3.3. Monitoring the asynchronous queue
Server. This user is also the owner of the business workspaces in Content Server.
3.3 Monitoring the asynchronous queue You can view items in the asynchronous queue that failed to process. You can enable the re-processing of the failed items. To monitor the queue:
1.
Start the /OTX/RM_WSC_Q transaction.
2.
Enter your selection criteria as required. 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. Execute to start the report.
3.
Click
4.
The report displays the content of the queue. It also summarizes the settings you made in the queue properties.
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
35
Chapter 3 Using the asynchronous queue for business workspace creation
The database table contains the following information: • • • • • • • •
36
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.
6.
To view further rows, click
Next items.
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
Chapter 4
Backup recommendations 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: •
Content Server database schema
•
OpenText Archive Center database schema
•
Content Server installation directory
•
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. •
Documents and disk buffers of Archive Center. For more information, see Section 19 “Backups and recovery” in OpenText Archive Center - Administration Guide (AR-ACN) 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.
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
37
Chapter 5
Using batch operations 5.1 Content Server: Migrating binders and cases to business workspaces
You can convert binders and cases in a workspace area into business workspaces. To do so, you create a mapping defining which binders and cases will be converted and how the resulting business workspaces look like. You will then start an agent, which processes the mappings. You can chose what to convert first, binders or cases. In either case, your scenario remains fully functional. If you have a business workspace that contains cases, you cannot create new cases in it. The same with binders that contain business workspaces converted from cases. You can create new business workspaces but no cases anymore in this binder.
5.1.1
Mapping binders and cases to workspace templates Before you can start a migration process, you must define, which binders and cases you want to be converted to which type of workspace. You can define such a mapping now and run it at a later time. With the status of a mapping you can control whether it can be processed or not. To create a migration mapping:
1.
On the Content Server Administration page, click Connected Workspaces > Migration Administration > Mappings.
2.
For each migration mapping, enter the following information: •
Area: Workspace Area for which this binder and case is valid.
•
Path: Path to a folder, binders or case, which contains items that you want to migrate.
•
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 40. In Progress: The mapping is currently being processed.
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
39
Chapter 5 Using batch operations
•
5.1.2
Completed: The agent processed all binders and cases. For a detailed result and possible errors, see “Running and monitoring a migration process” on page 40. Add Mapping to add another row.
3.
Click
4.
Click Update to save your mappings.
Running and monitoring a migration process Mappings in Active status can be processed. You start the processing agent manually and monitor its progress. To run a migration process:
1.
On the Content Server Administration page, click Connected Workspaces > Migration Administration > Executing and Tracking.
2.
Batch Size: Enter a how many binders and cases you want to process in one batch. If an error occurs, the process stops this batch and continues with the next batch.
3.
Click Run Agent Now. The agent starts processing all active migration mappings. You can monitor the progress in the tables on that page.
4.
Select an option from the Refresh list to update the result lists.
The Overall Migration Status shows the sum of all migrated binders and cases. 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 \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 data.
5.1.3
Configuring log settings for the migration You can set the log level for the migration. You may want to have a more detailed log level for testing and debugging. For mass migration you may want to reduce the log level for a better performance. To set the log level for the migration:
1.
On the Content Server Administration page, click Connected Workspaces > Migration Administration > Settings.
2.
Select the required log level. • •
40
OFF: Disables logging for Content Server. Nevertheless, error in migration will always be logged. WARN: Provides minimal logging for Content Server
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
5.2. SAP: Creating or updating business workspaces using batch operations
• • •
3.
INFO: Provides basic logging for Content Server DEBUG: Provides verbose logging for Content Server TRACE: Most elaborate logging
Click Submit.
Once the migration starts, you can see log files under in \logs\ migration_logs\.
5.2 SAP: Creating or updating business workspaces using batch operations Usually, business workspaces are created or updated automatically triggered by an event or manually by users. However, in special cases you may wish to create or update a series of business workspaces in one go. This can be done by generating an SAP report for the respective business object type and using this report to create the workspaces in Content Server. Important
The business object declaration has to be maintained before the report can be executed; see also Section 3.4 “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.
To create workspaces in batch operation:
1.
Generate the report for the batch declaration: a.
Enter /n/OTX/RM_WSC_GEN to run the report.
b.
Select an appropriate SAP business object in the Object Type field.
c.
Click
Execute.
The generated report has the name /OTX/RM_WSC_CREATE_; 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: a.
Start the SA38 transaction.
b.
Run the created mass report, for example, for equipments /OTX/ RM_WSC_CREATE_EQUI.
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
41
Chapter 5 Using batch operations
c. d. e. f.
If required, specify selection criteria. Select Update only to only update existing business workspaces and not create new business workspaces. Select Simulation to first check the report and see if the report matches your expectations. Execute. Click 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 35.
Special case: Composite business workspaces If you are creating composite business workspaces in a batch operation you must first create the parent business workspaces, as they are the location for the 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.
42
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
5.3. SAP: Declaring ArchiveLink documents using batch operations
5.3 SAP: Declaring ArchiveLink documents using batch operations A batch declaration is required if you have large numbers of already existing ArchiveLink documents that you want to declare. These documents may have been created before the Extended ECM for SAP Solutions installation or their document declaration were not maintained initially. You can chose between synchronous and asynchronous processing. For more information, see Section 3.22 “Creating business workspaces and declaring document asynchronously” in OpenText Extended ECM for SAP Solutions - Customizing Guide (ERLK-CGD). To use a batch declaration for records in synchronous mode:
1.
Run the SA38 transaction, enter the report /OTX/RM_MAKE_RECORDS in the Program field, and click Execute. Alternatively, start the /OTX/RMMIG transaction.
2.
Enter the respective parameters to select the required ArchiveLink entries.
3.
Select the Update properties check box to update ArchiveLink entries that have already been declared. Note: The document name must be unique in order to avoid name
collisions during the batch process. Such a unique title template could be, for example, Declaration ID [ArchiveLink.Storage Date] [ArchiveLink.Document ID]. For more information, see Section 6.10 “SAP: Creating an document declaration” in OpenText Extended ECM for SAP Solutions - Customizing Guide (ERLK-CGD). 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.
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
43
Chapter 5 Using batch operations
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 35. 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.
5.4 SAP: Declaring print list records using batch operations A batch declaration is available if you want to declare existing print lists for archiving purposes. To use a batch declaration for print list records:
1.
Start the /OTX/RMMIGPRINTL transaction. Alternatively, run the SA38 transaction, enter the report /OTX/ RM_MAKE_RECORDS_PRINTLIST in the Program field and click
44
Execute.
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
5.4. SAP: Declaring print list records using batch operations
2.
Enter the respective parameters to select the required entries.
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 corresponding spool request (the output of report /OTX/ RM_MAKE_RECORDS_PRINTLIST) may look like this:
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.
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
45
Chapter 5 Using batch operations
Message Error message for an entry. A summary on the processed entries is given at the end of the output.
5.5 SAP: Monitoring batch processing jobs You can monitor batch jobs for creating or updating business workspaces, and declaring ArchiveLink documents and print lists in the /OTX/RMMON transaction. 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 35. To monitor batch processing jobs:
46
1.
Start the /OTX/RMMON transaction.
2.
In the Monitoring of document and workspace processing jobs dialog, enter parameter to filter the list of jobs.
3.
Click
Execute.
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
5.6. SAP: Scheduling jobs for removing deleted records
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.
5.
If required, click Delete Job to delete the monitoring entries.
5.6 SAP: S cheduling job s for r emoving de leted records The report /OTX/RM_REMOVE_LINKS deletes ArchiveLink entries for documents that no longer exist in Content Server. For this, you must select the Delete notifications option in your Enterprise Library application. For more information, see Section 19.5.1 “Creating an Enterprise Library application” in OpenText Extended ECM for SAP Solutions - Installation and Upgrade Guide (ERLK-IGD). You can schedule the execution of the /OTX/RM_REMOVE_LINKS report according to your needs. Depending on the dispositions on your system, a periodical or only manual execution can be necessary. To schedule a job:
1.
Navigate to the Extended ECM > Document (ArchiveLink) ... > Schedule Job Removing Deleted Records activity and click Execute.
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
47
Chapter 5 Using batch operations
48
2.
Define the job and schedule it.
3.
Click Step.
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
5.6. SAP: Scheduling jobs for removing deleted records
4.
Enter the value /OTX/RM_REMOVE_LINKS in the Name field of the ABAP program group.
5.
Click
Save.
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
49
Chapter 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 for SAP Solutions version see the corresponding Release Notes in OpenTextECM My Support.
6.1 Content Se rver H TML d ialogs d o not d isplay i n SAP due to an connection error In SAP, the Content Server HTML dialogs do not display, for example, when pressing F4 to select a Content Server system category of a Content Server folder. A message like “This program cannot display the webpage.” is displayed. Cause
The connection fails.
Solution
Check the following: •
•
Verify your server settings: •
Is the Content Server running?
•
Is the Content Server protocol correct?
•
Is the Content Server hostname correct?
•
Is the Content Server port correct?
•
Is the Content Server path correct?
•
Is the Content Server hostname provided in a fully qualified format?
Verify your SAP HTTP server settings: •
•
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.
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
51
Chapter 6 Troubleshooting
6.2 A logon screen is displayed instead of Content Server HTML dialogs Cause Solution
The Single-sign on mechanism failed. Check the following: •
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.
•
Verify that the SAP logon ticket works. For verifying SAP logon tickets, there is a tool from SAP which is now part of the OpenText Extended ECM for SAP Solutions installation medium (\SAP SSO Libraries\SAP_SSO Diagnostic_Information). Usage: ssosample -i [-p ] -t ssotrace.log -l 3
Example: ssosample -i ticket.txt -p verify.pse -t ssotrace.log -l 3
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 18.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.
52
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
6.3. A user cannot declare records or view record details
6.3 A use r ca nnot de clare records or vi ew r ecord details Cause
Solution
Either the SAP user or the corresponding Content Server user does not have sufficient permissions. Do the following • •
Verify the SAP user has the /OTX/RM_USER role. Verify that the Content Server user has sufficient permissions in the target folder for the desired activity (creating or viewing).
6.4 A user cannot declare records or view record details or maintain document declarations Description
Cause Solution
Content Server HTML dialogs do not display (for example, when pressing F4 to select a Content Server system category of a Content Server folder). The SAP application log shows the error message that the SAP ticket could not be parsed. Time difference between the SAP server and the Content Server server. 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 of a virtualized server, modify the time settings the respective real server, as case the virtual server draws its time settings from the realofone.
6.5 When storing a bu siness document in a g iven SAP business object, a record is not automatically declared Cause
Solution
Enterprise Library Services error, or configuration problem, or missing workflow entry, or SAP Workflow System not running correctly. Check the following: •
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).
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
53
Chapter 6 Troubleshooting
See SAP documentation for details.
6.6 Business wo rkspaces c annot be di splayed anymore in SAP once the Undelete module is removed Cause Solution
Enterprise Library Services configuration problem. In the OpenText Administration, under Enterprise Library Services > Configuration, remove the value UndeleteWS from the elservice.livelinkroots.roots entry.
6.7 Problems w ith MIM E ty pe of u ploaded co ntent Cause
Solution
Limitation in the process how OpenText Content Server determines the MIME type of uploaded content. 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.
6.8 A workspace type is not available to configure a business object type Cause Solution
The workspace type is disabled. Enable the workspace type in Content Server Administration.
6.9 The URL to the business object is not displayed in the workspace’s Properties tab
54
Cause
No workspace type has been configured for default display for this business object type.
Solution
In the business object type definition, select a workspace type for default display. For more information, see Section 3.16.1 “Configuring a basic business object type” in OpenText Extended ECM for SAP Solutions - Customizing Guide (ERLK-CGD).
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
6.10. Problems with SAP Fiori apps
6.10 Problems with S AP Fiori apps Cause
Configuration problem or technical problem in the frontend system, the backend system, or on the client.
Solution
Check the following •
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.
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
55
Glossary ArchiveLink
An interface between the SAP system and an archiving system. Using ArchiveLink, mostly static and finished documents are stored. ArchiveLink documents can be declared in Extended ECM. attribute
Content Server concept to store metadata. Attributes are organized in categories. Business properties of a business object are mapped to attributes. BAdI
See Business Add-In (BAdI). Business Add-In (BAdI)
SAP method to enhance standard SAP functions with custom functionality. 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 Content window
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. business 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. business object type
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.
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
57
Glossary
business workspace
Content Server item that contains documents and other items which are related to a business object. cases and binders
See business workspace. 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
Content Server user interface with folders, function menus and sidebars. As opposed to Content Server Smart View. See Also Smart View. 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. Connected Workspaces
Content Server module that enables the use of business workspace with or without a connection to a business application. declaration
See document 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
See workspace templates.
58
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
Glossary
Generic Object Services (GOS)
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
Enables an integration to with display Contentand Server content in HTML-based application. Content is method displayed JavaScript HTML5 technology rather than embedding the classical Content Server user interface. OpenText Directory Services (OTDS)
A repository of user information and a collection of services to manage this user information. OTDS is used by Content Server for user authentication. OpenText Records Management
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).
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
59
Glossary
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
See OpenText Records Management. Records Management
See OpenText 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. Automatic relationships are defined in the property provider. Users can establish manual relationships. 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.
60
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
Glossary
SAP Reference IMG (SPRO)
A tool for customizing in the SAP system, opened with the SPRO transaction. SAP Business Add-In
See Business Add-In (BAdI). 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 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 UI. 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 templates
Basis for new business workspaces that are managed with Extended ECM for SAP Solutions. Templates are offered to the user based on the classification and the storage location of the new document. workspace type
Contentsome Server that controls thesuch location wherewidgets, a business stored, of object the GUI components as sidebar andworkspace the name is pattern of the business workspace.
OpenTextExtendedECMforSAPSolutions–AdministrationGuide ERLK160200-00-AGD-EN-04
61