0% found this document useful (0 votes)
836 views452 pages

OpenText™ Archiving and Document Access For SAP Solutions Scenario Guide

This document provides a summary of the configuration and customization of Archiving and Document Access for SAP Solutions scenarios. It describes key archiving scenarios for incoming and outgoing documents using various SAP interfaces. It also covers the components involved in document integration in SAP applications, including the SAP ArchiveLink interface and required basis customizing steps.

Uploaded by

mhajmohammadnia
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
836 views452 pages

OpenText™ Archiving and Document Access For SAP Solutions Scenario Guide

This document provides a summary of the configuration and customization of Archiving and Document Access for SAP Solutions scenarios. It describes key archiving scenarios for incoming and outgoing documents using various SAP interfaces. It also covers the components involved in document integration in SAP applications, including the SAP ArchiveLink interface and required basis customizing steps.

Uploaded by

mhajmohammadnia
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 452

OpenText™ Archiving and Document

Access for SAP Solutions

Scenario Guide

The Archiving and Document Access for SAP Solutions scenario


guide describes the configuration and customization of
Archiving and Document Access for SAP Solutions scenarios.

ER160208-CCS-EN-01
OpenText™ Archiving and Document Access for SAP Solutions
Scenario Guide
ER160208-CCS-EN-01
Rev.: 28. Mar. 2019
This documentation has been created for software version 16.2.8.
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 © 2019 Open Text. All Rights Reserved.


Trademarks owned by Open Text.

One or more patents may cover this product. For more information, please visit https://www.opentext.com/patents.

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™ Archiving and Document Access for
SAP Solutions? ........................................................................ 13

Part 1 Overview of document integration in SAP applications 15

2 Overview of key scenarios ..................................................... 17


2.1 Archiving scenarios ......................................................................... 17
2.1.1 Archiving using the SAP ArchiveLink interface .................................. 18
2.1.2 Archiving using SAP Netweaver ILM ................................................ 19
2.1.3 Archiving using the SAP Knowledge Provider infrastructure ............... 20
2.1.4 Archiving using the ODMA interface ................................................. 20
2.1.5 Archiving using generic object services (GOS) .................................. 21
2.1.6 Archiving using SAP Records Management ...................................... 21
2.1.7 Archiving using SAP PLM DMS ........................................................ 22
2.2 Converting document formats (rendition) .......................................... 22
2.3 Displaying and processing (archived) documents .............................. 23
2.4 Searching and managing documents ................................................ 23
2.5 Document processing between different systems .............................. 24

3 Overview of the components involved .................................. 25

4 Scenarios for document archiving ........................................ 29


4.1 Categorization of archiving scenarios ............................................... 29
4.2 Incoming documents ....................................................................... 31
4.2.1 Description of archiving scenarios .................................................... 31
4.2.2 Scenario processes and the OpenText components involved ............. 33
4.2.3 Archiving incoming documents with workflow .................................... 36
4.2.4 Archiving with bar code technology .................................................. 37
4.3 Outgoing documents ....................................................................... 38
4.3.1 Output determination (for SAP ERP only) ......................................... 39
4.3.2 Post Processing Framework (for SAP CRM only) .............................. 39
4.3.3 Outgoing documents with forms ....................................................... 41

5 Scenarios for SAP CRM .......................................................... 43


5.1 Working with documents in SAP CRM 7.0 ........................................ 43
5.1.1 SAP CRM Web UI: Assignment block ............................................... 44
5.1.2 SAP CRM Web UI: OpenText DocuLink for SAP Solutions ................ 45
5.1.3 SAP GUI: OpenText DocuLink for SAP Solutions .............................. 46
5.1.4 OpenText DesktopLink, OpenText Imaging ExchangeLink and
OpenText Imaging NotesLink ........................................................... 46
5.1.5 OpenText Imaging Enterprise Scan .................................................. 46
5.1.6 Batch import of documents .............................................................. 46

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide iii
ER160208-CCS-EN-01
Table of Contents

Part 2 SAP basis customizing 47

6 Introduction .............................................................................. 49
6.1 The SAP ArchiveLink interface ......................................................... 49
6.2 Customizing phases overview .......................................................... 50
6.3 Authorizations in SAP applications ................................................... 52
6.3.1 Authorization concept ...................................................................... 52
6.3.2 Authorization objects for ArchiveLink functions .................................. 52
6.3.3 Authorization maintenance .............................................................. 53
6.3.4 Rights for feedback users ................................................................ 55
6.3.5 Minimum authorizations of DesktopLink client users .......................... 56

7 Initial customizing ................................................................... 57


7.1 Setting up an archiving device ......................................................... 57
7.2 Creating queues ............................................................................. 59
7.3 Scheduling an ArchiveLink job ......................................................... 60
7.4 Maintaining an ArchiveLink number range ........................................ 62
7.5 Maintaining the ArchiveLink basic settings for DMS ........................... 63
7.6 Setting parameters for the archive format ......................................... 65

8 Communications setup ........................................................... 67


8.1 Configuring an SAP system in the OpenText Administration Client ..... 67
8.2 Creating a feedback user in pipeline based scenarios ........................ 68
8.3 Creating an exchange directory ........................................................ 69

9 Basis customizing ................................................................... 71


9.1 Basics ............................................................................................ 71
9.1.1 Key terms ....................................................................................... 71
9.1.1.1 Object type ..................................................................................... 71
9.1.1.2 Document type ................................................................................ 72
9.1.1.3 Document class .............................................................................. 72
9.1.1.4 Protocol .......................................................................................... 73
9.1.1.5 Archive (storage system, content repository) ..................................... 75
9.1.2 ArchiveLink management concept .................................................... 76
9.2 Maintaining HTTP content repository in the SAP application .............. 78
9.2.1 Creating an archive on the OpenText Archive Center ........................ 81
9.3 Maintaining global document types ................................................... 81
9.3.1 Creating document types ................................................................. 81
9.3.2 Customizing document classes ........................................................ 83
9.4 Maintaining links ............................................................................. 84
9.5 Document type customizing wizard .................................................. 85
9.6 Sending a certificate ........................................................................ 86

iv OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
Table of Contents

10 Integrating Archiving and Document Access for SAP


Solutions into SAPUI5 or SAP Fiori apps ............................. 89
10.1 SAP Fiori architecture ...................................................................... 89
10.2 Integration of OpenText products ..................................................... 90
10.2.1 Archiving and Document Access for SAP Solutions in SAP Fiori ........ 91
10.2.1.1 Relevant packages for integration .................................................... 91
10.2.2 Archiving and Document Access for SAP Solutions and OpenText
Business Center for SAP Solutions .................................................. 92
10.2.2.1 Packages for integration .................................................................. 93
10.2.2.2 Packages for business object browsing ............................................ 94
10.3 Understanding the customizing for a Fiori integration ......................... 95
10.4 Customizing the Fiori Launchpad for OpenText Test Launcher ........... 97
10.4.1 Frontend: Adding the OData services ............................................... 97
10.4.2 Frontend: Activating the ICF services ............................................... 98
10.4.3 Frontend: Configuring navigation ...................................................... 98
10.4.3.1 Defining a semantic object ............................................................... 99
10.4.3.2 Defining catalogs, target mapping, groups and tiles ......................... 100
10.4.4 Frontend: Configuring access ........................................................ 102
10.5 Creating your own extension of an SAP Fiori app ............................ 104
10.6 Extending your own SAPUI5 app ................................................... 106
10.7 Creating your own Fiori app for business object browsing ................ 106
10.7.1 Understanding authorizations ......................................................... 108
10.7.2 Customizing the SAP backend system ........................................... 109
10.7.2.1 Preparing the data and navigation structure for the app ................... 109
10.7.2.2 Using the perspective template _OTEB_BC_TEMPLATE_01 for the
app layout ..................................................................................... 113
10.7.2.3 Alternative: Creating a perspective without template ........................ 116
10.7.2.4 Adapting the perspective and creating the data binding ................... 117
10.7.3 Customizing the SAP frontend system ............................................ 119
10.8 Customizing for business documents ............................................. 121
10.9 Customizing the integration of OpenText™ Document Presentment
Live for SAP® Solutions ................................................................. 122

Part 3 Scenario customizing 125

11 Archiving via the ArchiveLink interface .............................. 127


11.1 Maintaining presettings for storage scenarios .................................. 127
11.2 Storing print lists ........................................................................... 128
11.3 Archiving incoming documents with bar codes ................................ 129
11.3.1 Prerequisites ................................................................................ 129
11.3.2 Steps ........................................................................................... 129
11.3.3 Creating and linking a document type ............................................. 130
11.3.4 Specifying bar code settings for the object type/document type ........ 131

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide v
ER160208-CCS-EN-01
Table of Contents

11.3.5 Activating bar code entry (module-specific) ..................................... 133


11.3.5.1 FI module ..................................................................................... 133
11.3.5.2 SD module ................................................................................... 134
11.3.5.3 HR module ................................................................................... 134
11.3.5.4 MM module ................................................................................... 136
11.3.6 Setting up archive modes for scanning ........................................... 136
11.3.7 Configuring Enterprise Scan .......................................................... 139
11.4 Archiving incoming documents with workflow .................................. 140
11.4.1 Prerequisites ................................................................................ 140
11.4.2 Steps ........................................................................................... 142
11.4.3 Workflow parameters .................................................................... 142
11.4.4 Overview ...................................................................................... 143
11.4.4.1 Default settings and agent assignment ........................................... 143
11.4.5 Customizing with the document type customizing wizard ................. 144
11.4.6 Scan settings ................................................................................ 147
11.4.6.1 Enterprise Scan ............................................................................ 147
11.4.6.2 Windows Viewer ........................................................................... 148
11.4.6.3 Windows Viewer together with Enterprise Scan ............................... 148
11.4.6.4 Scanning to PDF ........................................................................... 149
11.4.6.5 Archiving via the document pipeline ................................................ 152
11.5 Manually storing incoming documents ............................................ 152
11.6 Archiving outgoing documents ....................................................... 154
11.6.1 Prerequisites ................................................................................ 154
11.6.2 Creating and linking a document type ............................................. 154
11.6.3 Customizing output determination .................................................. 155
11.6.3.1 Checking creation of outgoing documents ....................................... 155
11.6.3.2 Customizing output determination for document storage .................. 156
11.6.3.3 Enhancing outgoing documents for different transmission media ...... 158
11.6.4 Customizing the Post Processing Framework (for SAP CRM only) ... 158
11.6.4.1 Creating and editing the processing class ....................................... 159
11.6.4.2 Creating an action profile ............................................................... 159
11.6.4.3 Defining conditions for the action profile .......................................... 166
11.6.4.4 Linking the action profile to the transaction type .............................. 169
11.7 Migrating ArchiveLink documents ................................................... 171
11.7.1 Migrating ArchiveLink documents using function modules ................ 171
11.7.2 Automation of migrating ArchiveLink documents using reports ......... 171

12 Archiving via SAP Netweaver ILM ....................................... 173


12.1 Setting up ILM Scenario in OpenText Enterprise Library .................. 174
12.2 Setting up ILM Scenario in SAP System ......................................... 176
12.2.1 ILM for ArchiveLink-Stored Documents ........................................... 177

13 Archiving via the SAP Knowledge Provider infrastructure ...


179

vi OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
Table of Contents

13.1 Customizing content management ................................................. 179


13.2 Migrating KPro documents using function modules .......................... 182
13.3 Automation of migrating KPro documents using reports ................... 182

14 Archiving via the ODMA interface (DesktopLink) ............... 185


14.1 Setting up DesktopLink .................................................................. 185
14.1.1 Accessing DesktopLink customizing ............................................... 186
14.1.2 Maintaining document types .......................................................... 187
14.1.3 Standard customizing .................................................................... 188
14.1.3.1 User-specific settings in the SAP application for DesktopLink ........... 188
14.1.3.2 Creating multi-document types ....................................................... 191
14.1.3.3 Maintaining links ........................................................................... 192
14.1.3.4 Determining the workflow and default settings ................................. 192
14.1.3.5 Configuring attribute transfer .......................................................... 192
14.1.3.5.1 Preassigning key fields .................................................................. 193
14.1.3.5.2 Transferring and saving attributes .................................................. 195
14.1.3.5.3 Transferring user-defined attributes ................................................ 196
14.1.3.5.4 Inserting attributes in work item texts .............................................. 197
14.1.4 Document conversion customizing ................................................. 197
14.1.4.1 Configuring client-side (classic) conversion to TIFF or PDF .............. 197
14.1.4.2 Configuring rendition server conversion to TIFF or PDF ................... 198
14.1.5 Expert customizing ........................................................................ 200
14.1.5.1 Maintaining DesktopLink scenarios ................................................ 200
14.1.5.2 Maintaining DesktopLink technical settings ..................................... 201
14.1.5.3 Maintaining work item text ............................................................. 202
14.1.5.4 Maintaining behavior for FAX/TIF documents .................................. 203
14.1.5.5 Maintaining customer exits ............................................................ 203
14.1.5.6 Closing the SAP GUI mode automatically ....................................... 204
14.1.6 Tools ............................................................................................ 204
14.1.6.1 Linking TIFF/PDF with original ....................................................... 204
14.1.6.2 Showing current DesktopLink version ............................................. 205
14.1.6.3 Showing DesktopLink logging ........................................................ 205
14.1.7 Configuring special scenarios ........................................................ 206
14.1.7.1 Assign then store scenario ............................................................. 206
14.1.7.2 DocuLink scenario ......................................................................... 209
14.1.7.3 Using ODMA attributes in DocuLink using DesktopLink ................... 210
14.1.8 Enhancements for DesktopLink ...................................................... 213
14.1.8.1 Enhancing SAP object types (for SAP ERP only) ............................ 213
14.1.8.2 Authorizations ............................................................................... 214
14.2 ExchangeLink and NotesLink ......................................................... 215

15 Archiving using generic object services (GOS) (for SAP


ERP only) ................................................................................ 217

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide vii
ER160208-CCS-EN-01
Table of Contents

15.1 Setting up DesktopLink as a generic object service (GOS) ............... 217


15.2 Providing DocuLink as a generic object service (GOS) .................... 218

16 Archiving in SAP Records Management ............................. 221


16.1 Document entry via DesktopLink .................................................... 221
16.2 Storing via mail applications ........................................................... 223
16.3 Automatic (batch) import ................................................................ 224
16.3.1 Providing element types in the SAP Records Management system .. 224
16.3.2 Configuring the assignment to the Records Management system ..... 225
16.3.3 Creating the folder structure for batch import ................................... 227
16.3.4 Troubleshooting in case of duplicates ............................................. 228

17 Archiving in SAP PLM DMS (for SAP ERP only) ................ 229
17.1 Scanning into SAP PLM DMS ........................................................ 229
17.2 Setting up automatic (batch) import ................................................ 230
17.3 Document entry via DesktopLink .................................................... 231

18 OpenText Forms Management ............................................. 233


18.1 Components ................................................................................. 233
18.2 Rights for OpenText Forms Management ....................................... 234
18.3 Adding a form ............................................................................... 234
18.3.1 Starting OpenText Forms Management .......................................... 235
18.3.2 Creating logical archivescollections ................................................ 236
18.3.3 Creating the form record ................................................................ 236
18.3.4 Assigning form pages to document pages ....................................... 240
18.3.5 Entering and archiving form pages ................................................. 242
18.3.5.1 Scanning form pages .................................................................... 242
18.3.5.2 Form pages from the file system .................................................... 242
18.3.6 Activating the form ........................................................................ 244
18.3.7 Modifying and linking the SAP ABAP program ................................. 244
18.3.7.1 SD module - using an SAPscript form ............................................. 245
18.3.7.2 SD module - using a Smart Form ................................................... 252
18.3.7.3 MM module ................................................................................... 258
18.3.8 Defining a processing method for the PPF and specifying it in the
action profile ................................................................................. 264
18.4 Defining offset and layout of forms ................................................. 266
18.4.1 Adjusting forms ............................................................................. 266
18.4.2 Adjusting the form layout for COLD documents (FORM.INFO) ......... 267
18.5 Assigning forms to COLD documents ............................................. 270
18.6 Options for OpenText Forms Management ..................................... 271
18.6.1 Copying forms .............................................................................. 271
18.6.1.1 Client and archive copy ................................................................. 271
18.6.1.2 Archive copies of forms ................................................................. 273

viii OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
Table of Contents

18.6.1.3 Copying the form table .................................................................. 274


18.6.2 Checking the status of a form ......................................................... 275
18.6.3 Deleting forms .............................................................................. 275
18.6.4 Activating and deactivating forms ................................................... 275
18.6.5 Printing a form list ......................................................................... 276
18.6.6 Detail view of an entry ................................................................... 276
18.6.7 Tracking changes in OpenText Forms Management ........................ 277

19 Rendition Management ......................................................... 279

20 Displaying and processing documents with OpenText


viewers ................................................................................... 281
20.1 Configuration for the Windows Viewer ............................................ 282
20.1.1 Communication ............................................................................. 282
20.1.1.1 Communication protocols in SAP applications ................................. 282
20.1.1.2 Communicating via OLE ................................................................ 284
20.1.1.3 Communicating via HTTP .............................................................. 286
20.1.2 Settings ........................................................................................ 286
20.1.2.1 Settings for document display with Windows Viewer ........................ 286
20.1.2.2 Print lists with hyperlinks ................................................................ 287
20.1.2.3 Log level and language ................................................................. 287
20.1.2.4 Protocol OT_HTTP2: Registering the Windows Viewer for PDF and
JPG ............................................................................................. 288
20.2 Configuration for Java Viewer or Web Viewer ................................. 289
20.3 Application related customizing ...................................................... 295

21 Document processing between SAP and OpenText


Enterprise Process Services ................................................ 297

Part 4 Using the scenarios 299

22 Starting the archiving procedure ......................................... 301


22.1 Starting archiving from the SAP application ..................................... 301
22.1.1 Archiving via the standard SAP transaction ..................................... 302
22.1.2 Archiving using the generic object services (GOS) .......................... 302
22.1.3 Archiving using the DesktopLink transaction J8AM .......................... 304
22.1.4 Document overview (in SAP ERP only) ........................................... 306
22.1.5 Archiving outgoing documents ....................................................... 306
22.1.5.1 Testing output determination .......................................................... 306
22.1.5.2 Testing the Post Processing Framework ......................................... 307
22.1.6 Archiving print lists in SAP ERP ..................................................... 311
22.1.6.1 Preparation ................................................................................... 311
22.1.6.2 Generating a test list ..................................................................... 311
22.1.6.3 Storing a test list ........................................................................... 313

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide ix
ER160208-CCS-EN-01
Table of Contents

22.1.6.4 Displaying a test list ...................................................................... 313


22.1.7 Archiving print lists in SAP CRM ..................................................... 315
22.1.7.1 Preparation ................................................................................... 315
22.1.7.2 Generating a test list ..................................................................... 315
22.1.7.3 Storing a test list ........................................................................... 317
22.1.7.4 Displaying a test list ...................................................................... 317
22.1.8 Archiving using SAP PLM DMS (in SAP ERP only) ......................... 319
22.1.8.1 Scanning into SAP PLM DMS ........................................................ 319
22.1.8.2 Automatic (batch) import ................................................................ 320
22.1.8.3 Document entry using DesktopLink ................................................ 321
22.2 Archiving from Windows applications .............................................. 322
22.2.1 Archiving multiple documents in SAP applications ........................... 323
22.3 Archiving from mail applications ..................................................... 323
22.3.1 ExchangeLink ............................................................................... 324
22.3.2 NotesLink ..................................................................................... 324
22.4 Archiving in Windows Viewer ......................................................... 325

23 Indexing and archiving ......................................................... 327


23.1 Select scenario, default setting and document type ......................... 327
23.2 Executing archiving ....................................................................... 329
23.2.1 Storing for subsequent entry .......................................................... 329
23.2.2 Store and enter ............................................................................. 330
23.2.3 Storing for subsequent assignment ................................................ 332
23.2.4 Store and assign ........................................................................... 332
23.2.5 Assign then store .......................................................................... 334
23.2.6 DocuLink ...................................................................................... 335
23.2.7 SAP Records Management ............................................................ 336
23.2.8 SAP PLM ..................................................................................... 336
23.3 Test example - Archiving incoming documents with workflow ........... 337
23.4 Test example Late archiving with bar codes .................................... 338

24 Displaying and processing (archived) original documents ...


343
24.1 Searching for documents in SAP applications ................................. 343
24.2 Displaying original documents in Windows Viewer ........................... 344
24.2.1 Authorizations in SAP applications ................................................. 345
24.2.2 Document retrieval in SAP Records Management ........................... 346
24.3 Displaying forms ........................................................................... 346
24.4 Displaying original documents in Java Viewer/Web Viewer/ ............. 348
24.5 Launching DocuLink views via generic object services (GOS) .......... 348

25 ArchiveLink PLUS and OpenText Business Content ......... 351


25.1 ArchiveLink Full Text Search .......................................................... 351
25.1.1 Prerequisites ................................................................................ 351

x OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
Table of Contents

25.1.1.1 Technical prerequisites .................................................................. 352


25.1.1.2 Configuring ArchiveLink document declaration ................................ 352
25.1.1.3 Configuring Content Server search ................................................. 353
25.1.1.4 Setting up technical user and impersonation (optional) .................... 353
25.1.2 Customizing search templates ....................................................... 356
25.1.2.1 Creating a Logical Destination in Extended ECM Connections ......... 367
25.1.3 Performing the Search in SAP GUI ................................................. 368
25.1.4 Performing the search in Web Dynpro UI ........................................ 371
25.1.4.1 Layout of search results ................................................................. 372
25.1.4.2 Configuring Web Dynpro search application .................................... 374
25.1.5 Authorization Object J_6NRL_SEA for the use of search templates .. 376
25.2 OpenText Business Content window .............................................. 376
25.2.1 Customizing OpenText Business Content in list of Generic Services
attributes ...................................................................................... 377
25.2.2 Using the Business Workspace function ......................................... 379
25.2.2.1 Customizing steps ......................................................................... 380
25.2.2.2 Customizing container and non-container behavior of business
workspace items ........................................................................... 380
25.2.2.3 Creating business workspaces (SAP view) ..................................... 381
25.2.2.4 Viewing and browsing business workspace items (SAP view) .......... 382
25.2.2.4.1 Using pagination in Business Content window ................................ 383
25.2.2.4.2 Sorting list items ........................................................................... 385
25.2.2.4.3 Displaying the folder list in the tree view ......................................... 386
25.2.2.5 Working with business workspaces and documents (SAP view) ....... 386
25.2.2.6 Working with business workspaces (Smart view) ............................. 392
25.2.2.6.1 Adding a business workspace (Smart view) .................................... 393
25.2.2.7 Performing full text search in Business Workspace .......................... 393
25.2.3 Using the Business Documents function ......................................... 397
25.2.3.1 Customizing additional ArchiveLink attributes .................................. 397
25.2.3.1.1 Mapping external attributes ............................................................ 399
25.2.3.2 Using the Business Documents function ......................................... 401
25.2.4 Using the Business Attachment function ......................................... 406
25.2.5 Using the Notes function ................................................................ 407
25.2.6 Using the OpenText Tempo Box and Local Files function ................ 409

26 Viewing ArchiveLink documents in a Fiori app .................. 411

Part 5 SAP application log 415

27 Troubleshooting using the SAP application log ................ 417


27.1 SAP application log for DesktopLink scenarios ................................ 417
27.1.1 Log entries and log lines ................................................................ 417
27.2 SAP application log for ArchiveLink Fulltext Search ......................... 419

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide xi
ER160208-CCS-EN-01
Table of Contents

27.3 SAP application log for ArchiveLink Attributes ................................. 419


27.4 SAP application log for Rendition Management ............................... 419
27.5 SAP application log for Business Application Integration (BAI) ......... 420
27.6 SAP application log for license measurement .................................. 420

28 OpenText License Report ..................................................... 421


28.1 Technical overview ........................................................................ 422
28.2 Prerequisites ................................................................................ 424
28.3 Preparing license measurement on the SAP system ........................ 424
28.3.1 Setting up users for measurement .................................................. 424
28.3.2 Maintaining measurement tables .................................................... 426
28.4 Preparing license measurement on Content Server ......................... 429
28.5 Running license measurement ....................................................... 430
28.5.1 Running in standard mode ............................................................. 431
28.5.2 Running in expert mode ................................................................. 432
28.6 Creating an export file with license data .......................................... 437
28.7 Understanding the consolidated measurement results ..................... 438
28.8 Understanding and resolving licensing issues ................................. 439
28.8.1 Validation issues after consolidation ............................................... 440
28.8.2 Validation issues types on the SAP system ..................................... 441
28.8.3 Validation issue types on Content Server ........................................ 444

GLS Glossary 445

xii OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
Chapter 1
What is OpenText™ Archiving and Document
Access for SAP Solutions?

With Archiving and Document Access for SAP Solutions, you can automatically
store SAP and non-SAP data and documents on a secure archive server, for example
OpenText™ Archive Center. This increases operational efficiency by freeing IT from
the time-consuming chore of manual backups and recovery. It also offloads data
from production systems for improved system performance and faster upgrades.

Archiving and Document Access for SAP Solutions offers a range of options for
integrating SAP documents and other documents in the different SAP applications,
including emails, faxes, images and informal correspondence. Besides archiving
documents, you can manage, search, display and edit them.

This guide is designed to help you identify, set up and use the document integration
scenarios you need.

Archiving and Document Access for SAP Solutions software


packages
Archiving and Document Access for SAP Solutions consists of the following SAP
packages:

• SAP basis package OTEXBAS


Provides all base applications:

– OpenText™ DocuLink for SAP Solutions


– OpenText™ DesktopLink
– Forms Management
– Imaging Integration
– ArchiveLink attributes
– License Measurement
• SAP ERP package OTEXERP (optional)
Optional package with ERP specific functionality

– Allows use of DVS/PLM nodetypes in DocuLink


– Provides transaction /ixos/plm as an uploader transaction for DVS/PLM
documents
– Provides client independent objects and code for sample DocuLink projects,
which are not only SAP ERP specific but can also be used for base examples

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 13
ER160208-CCS-EN-01
Chapter 1 What is OpenText™ Archiving and Document Access for SAP Solutions?

• SAP CRM package OTEXCRM (optional)


Optional package with CRM specific functionality.

– Allows use of SAP CRM link range in Content Management node type in
DocuLink
– Client independent objects and code for a sample DocuLink project in SAP
CRM
• SAP Fiori package OTEXBASO (optional)
Optional package with OData services for SAP Fiori
• SAP Fiori UI package OTEXBASF (optional)
Optional package with SAP Fiori specific user interface functionality for
ArchiveLink PLUS and test application
• Solution Framework for Business Object Browsing package OTEXBASB
(optional)
Optional package with extensions to Archiving and Document Access for SAP
Solutions and OpenText™ Business Center Foundation to build Fiori apps for
business object browsing

14 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
Part 1
Overview of document integration in SAP
applications
Chapter 2
Overview of key scenarios

Archiving and Document Access for SAP Solutions offers a range of options for
integrating SAP documents and other documents in the different SAP applications,
including emails, faxes, images and informal correspondence, etc. Besides archiving
documents, it allows you to manage, search, display and edit them.

2.1 Archiving scenarios


Some standard archiving scenarios are provided in SAP applications, which can be
used for long-term storage with an OpenText Archive Center.

Depending on the interface through which the documents enter the SAP system, we
distinguish the following:

SAP ArchiveLink interface


SAP ArchiveLink is mostly used to store static documents that need no further
editing.
SAP NetWeaver ILM
SAP NetWeaver Information Lifecycle Management (ILM) provides the tools to
manage the entire life cycle of SAP business data. This includes data archiving,
retention management, legal case management and decommissioning of legacy
systems.
Content Management Service in the KPro (Knowledge Provider) infrastructure
KPro provides the option of archiving dynamic documents that are still being
processed without losing additional information, such as versioning or
processing status.
ODMA (Open Document Management API) interface
ODMA allows storing various documents from any Windows application.
Generic object services (GOS)
Generic object services use the available object data and can be called
independently of the SAP application.
SAP Records Management
SAP Records Management is used to manage electronic and paper records
together.
SAP PLM Document Management System (DMS) (SAP ERP only)
The SAP PLM Document Management System (DMS) is meant for the
replication of product data.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 17
ER160208-CCS-EN-01
Chapter 2 Overview of key scenarios

Data exchange with SAP Mobile Clients


In SAP CRM 4.0, the SAP standard allows you to exchange CM documents
between CRM online and the SAP Mobile Clients. Thus, CM documents created
at a Mobile Client can be stored in an archive using the SAP CRM system.
For more details see the SAP Help.

2.1.1 Archiving using the SAP ArchiveLink interface


All of the following scenarios use the SAP ArchiveLink interface for archiving
documents in the archive.
Customizing see “Archiving via the ArchiveLink interface“ on page 127.

Print list storage


Print lists are the result of report runs in the SAP system, for example, batch
where-used lists or cost center reports, or reports from the tasks monitor.
Print lists can contain indexing data and hyperlinks in order to provide access to
subobjects or linked documents within a print list.
If the print list was created as an individual file which can be accessed through
an unique path, it can be archived in compressed format. When archiving, you
can create a print list description file for the main file, which contains indexing
data. This means that the required information can be accessed simultaneously
from different work centers.
Archiving with bar codes
In this archiving scenario, incoming documents are given a bar code at the start
of processing. Documents are only scanned and archived after they have been
entered in the SAP system. The document continues to move through the
company in paper form, but the link between the document and the application
document is automated. The normal workflow is followed in the user
department - apart from the use of bar codes. This scenario is therefore mostly
used for large volumes of documents.
With this scenario you can also link exactly one object to several SAP business
objects.
For this scenario you can use the Enterprise Scan component.
Archiving incoming documents with workflow
For this scenario, the incoming document is scanned in by a member of the
postal staff (if it is not already available in electronic format) and stored in an
archive. A link to the document is forwarded to the transaction user through
SAP Business Workflow. He captures the application document, if necessary
with the help of the original document.
Alternatively, one and the same person can store the incoming document as well
as enter the associated application document.
The scenario is suitable (in the former case) for large volumes of documents or
(in the latter case) for specially protected documents.
For this scenario you can use the Enterprise Scan component.

18 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
2.1. Archiving scenarios

Archiving outgoing documents


Outgoing documents are all documents created in the company's SAP system,
for example, correspondence, invoices, order confirmations, etc. Use this
scenario when you want to store outgoing documents in your archive and link
them to the associated application document. The exact procedure varies for the
different application components.

Archiving forms
In the SAP system, outgoing documents are normally printed in standard forms,
in order to preserve legible, attractive pages into which graphical elements such
as company logos can be integrated. This means that the standard forms are
filled with data generated by the SAP reports.
If you archive these documents and display them in the ArchiveLink Viewer,
you only see the data, not the form.
You can solve this problem by scanning in the forms and saving them in the
archive. You can then display the archived documents in their own forms.
For this scenario you can use the Forms Management component.

Migrating ArchiveLink documents


You can transfer (migrate) individual ArchiveLink documents or complete
storage systems into other storage systems. If necessary, this migration can even
be performed automatically. For example, you can migrate all documents that
were archived before a certain date into another (long term) storage system.
Therefore, OpenText supplies a special function module and a report.

2.1.2 Archiving using SAP Netweaver ILM


SAP NetWeaver Information Lifecycle Management (ILM) consists of three
components:

Data Archiving
The standard SAP data archiving functions have been enhanced to allow for the
integration of the other two components and to support not only archiving but
also data destruction and snapshot creation.

Retention Management
This component manages data retention policies from the time the data is
created until it has to be destroyed. It can perform e-Discovery to find all data
connected to a business object, and set legal holds.

Retention Warehouse
This component provides a standardized method for decommissioning legacy
systems. Data from decommissioned systems are stored in a central Retention
Warehouse and are still accessible for business users and application of retention
policies.

For customizing see “Archiving via SAP Netweaver ILM“ on page 173.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 19
ER160208-CCS-EN-01
Chapter 2 Overview of key scenarios

2.1.3 Archiving using the SAP Knowledge Provider


infrastructure
There are also standard scenarios that use the KPro (Knowledge Provider) interface
rather than the SAP ArchiveLink infrastructure.
Customizing see “Archiving via the SAP Knowledge Provider infrastructure“
on page 179.

Archiving Content management documents


By default, CM documents are stored in a database (SAP content server). If you
want to save these documents permanently, along with the version and
processing information, you can also configure storage in an archive (OpenText
Archive Center).
Configuring this scenario consists only of the steps described in “Archiving via
the SAP Knowledge Provider infrastructure“ on page 179.
Migrating Content Management documents
Storing KPro documents in an archive instead of an SAP Content Server can be
performed for individual documents or for complete storage systems, and if
necessary also automatically. Thus you can automatically transfer or copy
documents to an archive for long-term storage, for example depending on a
certain status transition. Therefore, OpenText supplies a special function module
and a report.
Customizing see “Migrating ArchiveLink documents” on page 171.

2.1.4 Archiving using the ODMA interface


In addition to the SAP standard, the ODMA (Open Document Management API)
interface provides further options for integrating documents in your SAP system.
Customizing see “Archiving via the ODMA interface (DesktopLink)“ on page 185.

Archiving files from Windows applications


You can use the ODMA interface to archive your own files from all Windows
applications quickly and easily from your workstation. With the Archiving and
Document Access for SAP Solutions archive you can link these documents to
SAP business processes and locate them again using SAP business objects.
Additionally, information from user-defined ODMA attributes can be evaluated
during archiving. For the DocuLink scenario, for example, the views can be
restricted directly at display.
The ODMA interface uses the DesktopLink components.
Archiving emails and linking them to SAP objects
You can link emails from your mail system in SAP applications, that is link to
SAP objects. They can be archived to records in a SAP Records Management, for
instance.
User-defined ODMA attributes (properties), which were defined in the mail
application, can be transferred to an SAP system as well when archiving using
OpenText Imaging ExchangeLink or NotesLink.

20 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
2.1. Archiving scenarios

For this scenario, the NotesLink or NotesLink components are used.

2.1.5 Archiving using generic object services (GOS)


Generic object services can be called independently of the SAP application. Thus, the
OpenText component DesktopLink can be opened directly from within an SAP-
specific transaction, and the underlying business object data for the transaction can
be used when archiving the document.
Customizing see “Archiving using generic object services (GOS) (for SAP ERP only)
“ on page 217.

DocuLink can be provided as a generic object service, as well. Thus, a pre-


configured DocuLink view can be displayed depending on the current business
object data. There the familiar DocuLink functionality is available as well, archiving
documents to an object.

2.1.6 Archiving using SAP Records Management


Another possibility to archive documents is from within the SAP Records
Management. In this case, documents or emails are assigned to electronic records
directly from within the (mail) applications. Batch import of several documents at
once is also possible.

The following entry scenarios are available:

Document entry using DesktopLink


Using DesktopLink, you can enter documents into SAP Records Management
directly from within Windows applications, and assign them to already existing
SAP records.
Archiving emails and linking them to SAP records
You can enter emails and assign them to already existing Records Management
records directly from withinMicrosoft Outlook and Lotus Notes. File
attachments can be entered in RM in the same way.
For this scenario, the DesktopLink and NotesLink or ExchangeLink components
are used.
Automatic (batch) import
You can import several documents into Records Management at once and assign
them to already existing Records Management records or create new records
with the documents.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 21
ER160208-CCS-EN-01
Chapter 2 Overview of key scenarios

2.1.7 Archiving using SAP PLM DMS


Another possibility to archive documents is from within the SAP Product Lifecycle
Management (PLM). In this case, the SAP PLM DMS (Document management
system) is used.
Customizing see “Archiving in SAP PLM DMS (for SAP ERP only)“ on page 229.

The following entry scenarios are available:

Scanning into SAP PLM DMS


You can enter and assign an original document to an already existing PLM DMS
document by scanning it.
Automatic (batch) import
You can import several documents into the SAP PLM DMS at once, and assign
them to already existing PLM DMS documents.
Document entry using DesktopLink
Using DesktopLink, you can enter documents into the SAP PLM Document
Management System (DMS) directly from Windows applications, and assign
them to already existing PLM DMS documents.

2.2 Converting document formats (rendition)


Note: The following scenarios require the OpenText Rendition Server.

Using the special function modules and reports supplied by OpenText, you can
convert documents into a different document format (PDF, TIFF), independently
from the time of archiving and from a specific client. This can be useful, for example,
when you want to store documents long-term and independently from new
software versions, or if the documents should not be modified anymore.
Customizing see “Rendition Management“ on page 279.

Converting ArchiveLink documents


Documents stored in an SAP content repository using ArchiveLink can
automatically be converted to a different document format (for example, PDF,
TIFF) at a later time and, if necessary, be assigned to all business objects that the
original is assigned to as well.
Converting local files
Files that are stored on a client locally can automatically be converted to a
different document format (for example, PDF, TIFF) and be stored on the client
as well.

22 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
2.3. Displaying and processing (archived) documents

2.3 Displaying and processing (archived) documents


Note: In the following scenarios you can use the OpenText Imaging Clients
component.

Displaying documents
The user can display archived documents at their workstations. This can be done
from the SAP system for documents that are linked to an SAP document, or
directly from a viewer.

Editing documents
In addition to displaying archived documents, notes and annotations can be
attached and the document can be printed or checked for authenticity.

Displaying documents with form


Data from outgoing documents that is normally printed on standard forms (for
example, orders, order confirmations, delivery notes) can be displayed together
with the scanned and archived standard forms. You can also display COLD
(Computer Output to Laser Disk) document lists together with forms.

2.4 Searching and managing documents


An SAP system may be used for archiving a large volume of documents. In order to
find a particular document easily, you require scenarios for searching and managing
documents.

Managing documents
You can store, manage and find SAP documents and any other documents
independently from the transactions in the SAP system. The data can either be in
the database or on an archive server. The documents are stored in an user-
specific folder. By default, access is through the SAP application and is
facilitated by selection and search functions.
This scenario provides a cross-module, cross-system, document-centered
overview of processes that can be handled using SAP applications. The
application can be started as a stand-alone application or integrated in other
SAP applications, such as Records Management. Finally, predefined views
especially for archiving documents can be opened.
This scenario can be implemented, for example, for creating customer folders or
displaying document flows.
You can use DocuLink here. This component is described in the OpenText
DocuLink for SAP Solutions - Customizing and Administration Guide (DC-CGD) and
the OpenText DocuLink for SAP Solutions - User Guide (DC-UGD).
DocuLink can also be launched as a generic object service. That way you can
display DocuLink data for a particular business object directly from within other
SAP applications. The business object data can automatically be used as
selection criteria for the DocuLink view.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 23
ER160208-CCS-EN-01
Chapter 2 Overview of key scenarios

Extracting documents and displaying them offline


Sometimes it can be useful to access data and documents from an SAP system in
offline mode. For this purpose, a scenario exists for exporting data from an SAP
system and its associated documents from an archive so that an offline search
operation can be carried out. Access to the extracted data is through a special
Web browser application.
You can use the download scenario with OpenText Rendition Server.

2.5 Document processing between different systems


Within the SAP Business Workflow it is possible to perform some of the workflow
steps in OpenText Enterprise Process Services. In this case, the standard XML
workflow interface as well as the standard XML service, are used.

24 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
Chapter 3
Overview of the components involved

Using Archiving and Document Access for SAP Solutions, document integration in
SAP applications can be further extended and expanded by additional useful
functions.

OpenText™ DesktopLink
You can use DesktopLink to archive your own files quickly and easily from your
workstation. You can also search for previously archived documents. To do this,
DesktopLink uses the ODMA interface (Open Document Management API)
integrated in the Systems based on OpenText Archive Center. You can select
whether you want to archive the file in its original format or in TIFF or PDF
format.
With Archiving and Document Access for SAP Solutions you can link
documents to SAP business processes and locate them again using SAP business
objects.
With DesktopLink, archived documents can be managed and displayed using
DocuLink. You can copy properties from Microsoft Office documents to
DocuLink when archiving.
With DesktopLink you can set up a connection from ExchangeLink and
NotesLink to the SAP application, so that you can archive Microsoft Outlook or
Lotus Notes objects (mainly emails) and link them to SAP business objects. This
functionality is called ExchangeLink or NotesLink. Furthermore, documents can
be assigned to records in a SAP Records Management or to PLM DMS
documents using DesktopLink.
DesktopLink supports all SAP standard archiving scenarios (without bar code)
for incoming and outgoing documents.
OpenText™ Imaging Enterprise Scan
With Enterprise Scan, workflows can be implemented from receipt by post
through scanning and linking to the leading application, through to archiving.
After scanning, the pages can be checked carefully, straightened and cleaned up.
Several functions are available to improve contrast and legibility. Enterprise
Scan also provides support for sorting and archiving.
Enterprise Scan is used for archiving incoming documents with the integration
of bar code technology.
OpenText™ Imaging Windows Viewer
The Windows Viewer displays archived documents on the user's workstation. It
also provides functions for attaching notes and annotations and for printing and
checking the authenticity of documents. It also enables the standard TWAIN
interface to scan and immediately archive individual documents.
The Windows Viewer supports a number of different standard archiving
scenarios (without bar code) using DesktopLink.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 25
ER160208-CCS-EN-01
Chapter 3 Overview of the components involved

OpenText™ Imaging Java Viewer


The Java Viewer is an applet that can be used for displaying and printing
documents in Web-based scenarios and appending comments to these
documents. The program is installed on a Web server and is automatically
loaded on your computer when you click a link to open a document. In addition
to displaying archived documents, notes and annotations can be attached, you
can search for specific text within the document, and the document can be
printed.
OpenText™ Imaging Web Viewer
The Web Viewer is an application for displaying and printing documents in
web-based scenarios, as well as adding comments, similar to the Java Viewer. The
program is also installed on a Web server, where it converts all common
document formats into HTML pages for the client. Thus no installation
whatsoever is required, nor a Java Virtual Machine; merely a Web browser is
required. On the other hand, direct manipulation of texts in the document is not
possible.
OpenText™ Forms Management
OpenTextForms Management for SAP Solutions is an additional component for
managing scanned standard forms and for displaying them with outgoing SAP
documents (such as orders, order confirmations, delivery notes). You can also
use this component to display COLD (Computer Output to Laser Disk)
document lists together with forms.
OpenText™ Imaging ExchangeLink and OpenText™ Imaging NotesLink
With ExchangeLink and NotesLink you can also use DesktopLink to integrate
emails from your mail system into SAP applications, that is link them with SAP
objects.
OpenText DocuLink for SAP Solutions (DocuLink)
DocuLink uses the SAP infrastructure to enable simple access to all business
documents in the company. DocuLink is a cross-module, cross-system
application that is fully integrated in the SAP application for a document-
centered overview of processes that can be run with a SAP application. Here the
OpenText Archive Center manages and saves the documents. Using DocuLink's
transparent folder structure, you can easily research SAP data and documents
without reference to the SAP transaction. By default, access is using the SAP
application.
This component can be implemented, for example, for creating customer folders
or displaying document flows.
Note: For a description of this component, see OpenText DocuLink for SAP
Solutions - Customizing and Administration Guide (DC-CGD) and OpenText
DocuLink for SAP Solutions - User Guide (DC-UGD).
OpenText™ Enterprise Process Services
OpenText Enterprise Process Services allows you to create, run and administer
business workflows. Archived documents can be attached to the workflows.
This also applies to workflows distributed between different systems (for
example, SAP applications).

26 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
OpenText™ Rendition Server
Rendition Server enables other OpenText products and solutions to generate
renditions for further processing (for example, to store renditions alongside the
original document in OpenText Enterprise Library). Rendition Server converts
(renders) documents to a standard long-term format.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 27
ER160208-CCS-EN-01
Chapter 4
Scenarios for document archiving

4.1 Categorization of archiving scenarios


A first distinction between the archiving scenarios can be made by their origin:

• Print lists (Result of report runs in the SAP system)


• Incoming documents (Import through scanning or file/mail system)
• Outgoing documents (created in SAP system using SAPscript or SAP Smart Forms)

Print lists are a special type of document and are therefore treated differently.
Incoming and outgoing documents are processed differently but are very similar in
terms of their configuration.

Archiving incoming documents is done in two steps:

1. Store: Store the document in an archive.


2. Alternatively, according to the archiving scenario:

• Enter: Enter and post in the SAP system, from a technical point of view:
Creating a business object
or
• Assign: Assign document to an existing application document.

The scenarios can therefore be divided according to their combination of archiving


and entering/assigning as follows:

Automation of document processing

• SAP Business workflow is integrated.


• Bar code technology is integrated.
• No special technology is integrated (manual processing).

Time of document creation

• The document is newly entered for an incoming document.


• The document already exists. The incoming document is assigned to it.

Division of labor

• Storing and entering or assigning is carried out by two or more people at


different workstations.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 29
ER160208-CCS-EN-01
Chapter 4 Scenarios for document archiving

• Storing and entering or assigning is carried out by one person at on


workstation.

The following table provides an overview of the archiving scenarios for incoming
documents, arranged according to the three aspects:

Automation Application document is Application document


of document newly created for incoming already exists
processing document
Involves Involves one Involves Involves one
several person several person
people people
Integration of Storing for Store and Storing for Store and
SAP Business subsequent enter subsequent assign
workflow entry assignment
Integration of Early - - -
bar code storing
technology with bar
code
Late
archiving
with bar
codes
Manual - DocuLink, - Assign then
storage SAP Records store, SAP
Management PLM,
(DocuLink, ,
SAP Records
Management)

You find a description of the individual scenarios in the following sections.

You find a more detailed description of the configuration for individual scenarios
and the various components in the Customizing section.

The use of standard scenarios in Archiving and Document Access for SAP Solutions
is described step by step in the Application of scenarios section using examples.

30 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
4.2. Incoming documents

4.2 Incoming documents


The archiving scenarios for incoming documents listed in the table in
“Categorization of archiving scenarios” on page 29 are described here. Next, the
process for each scenario is described, as well as the OpenText components
involved.

4.2.1 Description of archiving scenarios


Storing for subsequent entry
The paper documents are scanned in and integrated into the SAP application's
workflow as soon as they are received in the company. The document is
archived before a business object is created in the SAP application. All work
connected with these documents is performed on documents already scanned.
Storing for subsequent entry is carried out at the beginning of a workflow from
the SAP application. Archiving scanned documents initializes the workflow for
the specified document type, in which a workflow object (work item) is created
for the document. At the same time, a message is sent to the person responsible
for processing the document, informing them that the document is ready for
processing. The settings for this are entered together with OpenText for a
project.
The individual steps for the Storing for subsequent entry scenario are:

• Receiving incoming correspondence (for example, invoices from suppliers)


• Scanning paper documents
• Starting the archiving procedure from the SAP application; the SAP
application receives the DocID
• Archiving (or destruction) of paper original
• Entering scanned documents into the SAP application workflow

Store and enter


Here the document is created and archived simultaneously. You can then trigger
the workflow.
Early storing with bar code
Archiving takes place before the application document is entered.
The document is stored early but is still transported on paper to the person
responsible. With this scenario you can link several incoming documents to just
one business object. In order to do this, the same bar code must exist on several
documents. This scenario is normally used in this exceptional case only.
Late archiving with bar codes
Archiving takes place after the application document is entered.
This scenario is used to automate the link process for large numbers of
documents. With this scenario you can also link exactly one object to several
SAP business objects.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 31
ER160208-CCS-EN-01
Chapter 4 Scenarios for document archiving

Storing for subsequent assignment


Similar to Storing for subsequent entry, when archiving, a work item is
created that is used for subsequent linking of the document to a business object
and not entry.
The scenario is suitable for documents for which an application document has
already been created (for example, a cover letter for an invoice) or for
documents that are stored considerably later after their entry.
Store and assign
Archiving takes place after the application document is entered. After archiving
a workflow is created, which is carried out immediately.
Archiving is started from the SAP application and the document ID (the unique
identifier in the archive) is given directly to the SAP application during
archiving.
Assign then store
Archiving takes place after actual processing in the SAP application. The
assignment is performed manually by the user or by preconfiguration (attribute
transfer). No workflow or bar code technology is involved. This process
corresponds with the Storing for subsequent assignment scenario without a
workflow.
This scenario is usually used for ad-hoc cases. It is also used for specially
protected documents that are only to be processed by one person.
DocuLink
Archiving is performed either at the same time as or after a record is created in the
DocuLink view. Creating and assigning the record can also be performed
automatically using attribute transfer from the document.
SAP PLM
Archiving occurs after the PLM DMS document is processed. If the appropriate
preconfiguration is available, the assignment can also be performed
automatically.
SAP Records Management
Archiving is performed after the actual processing of the SAP record, that is a
document is manually assigned to an existing SAP record.

32 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
4.2. Incoming documents

4.2.2 Scenario processes and the OpenText components


involved
The following table shows a short description of the different scenario processes, the
OpenText components involved, and a respective example.

Table 4-1: Scenario processes and the OpenText components involved

Scenario Short description + process Example Ente Desk


rpris topLi
e nk
Scan
Storing for The document is archived before a Informal request for X X
subsequent business object is created in SAP. quotation from a
entry customer, which is
1. (Convert.)
later entered as an
2. Archive. order in the SAP
3. (Archived document moves as application.
a work item through the
company.)
4. Enter business object and link
doc.
Store and The document is created and Receipt of an order - X
enter archived simultaneously. by fax, for which an
order document is
1. (Convert.)
immediately
2. Archive and enter business entered.
object.
3. (Archived document moves as
a work item through the
company.)
Early Archiving occurs before the Receipt of one (or X X
Storing application document is entered. more) customer
with bar order(s) from a
1. Scan document and archive
codes particular customer
with bar code.
by fax, which is/are
2. Document moves through the first given bar
company in paper form. code(s) and
3. Enter business object and link archived, but is/are
(1 or more) doc. further processed
but in paper form. A
total order is only
entered for it later.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 33
ER160208-CCS-EN-01
Chapter 4 Scenarios for document archiving

Scenario Short description + process Example Ente Desk


rpris topLi
e nk
Scan
Late Archiving occurs after the After an advertising X -
archiving application document is entered. campaign there are
with bar 1. Assign bar code to document. many customer
codes inquiries about a
2. Enter business object and bar product. These are
code of document. given a bar code and
3. Document moves through the forwarded to the
company in paper form. transaction user.
4. Scan document and archive; They process each
link with business object using inquiry individually
bar code. by entering an order
and adding the bar
code for every
inquiry. Only later
are all inquiries
collected, scanned at
a scan station and
stored.
Storing for The document is archived and An order X X
subsequent later linked with an existing confirmation is
assignment business object. entered. Later a
cover letter is
1. Enter business object.
created for it and
2. (Convert doc.) (Convert.) archived. The
3. Archive. archived document
is forwarded as a
4. Archived document moves work item to
through the company as a another member of
work item. staff who links the
5. Link document to existing document to the
document through work item. order confirmation.
Store and The document is archived and Orders are entered - X
assign assigned simultaneously. for several customer
inquiries. At the
1. Enter business object.
same time, an other
2. (Convert document.) transaction user
3. Archive document; document scans all the
is assigned to the existing customer inquiries
document through work item. simultaneously and
assigns the relevant
order at the same
time.

34 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
4.2. Incoming documents

Scenario Short description + process Example Ente Desk


rpris topLi
e nk
Scan
Assign then Archiving occurs after the After an order has - X
store document is processed. been entered, a
customer complaint
1. Enter business object.
sent by email is
2. Document moves through the entered for this
company in paper form. order. This
3. Archive document and link document is
manually to business object. subsequently
assigned to the
outgoing document.
SAP PLM Archiving occurs after the PLM A corrected - X
DMS document is processed. construction
drawing is
1. PLM DMS document is
subsequently
entered.
assigned to a PLM
2. Document moves through the DMSdocument.
company in paper form.
3. Document is archived and
manually (or automatically
through attribute transfer)
assigned to the PLM DMS
document.
SAP Records Archiving occurs after the SAP An order - X
Management record is processed. confirmation
received by email is
1. Create the SAP record.
subsequently
2. Document moves through the assigned to an SAP
company in paper form. customer record.
3. Archive document and
manually link it to business
object.
DocuLink Archiving occurs either at the same A new product - X
time as or after the record is record with an order
created. confirmation is
assigned to a
1. Create or select record.
customer.
2. Archive document and
manually link it to the record.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 35
ER160208-CCS-EN-01
Chapter 4 Scenarios for document archiving

4.2.3 Archiving incoming documents with workflow


The following overview shows the scenarios for archiving incoming documents with
their workflow task and the time base of archiving and performing the workflow
task. In this case, workflow means the one-step standard workflow for document
archiving, that is after archiving, the document is forwarded to the inbox of the
transaction user. This workflow can be integrated into larger workflow scenarios as
a project solution.

Scenario Task Time relation between


archiving and workflow
processing
Storing for TS30001128 Later, by someone else
subsequent entry Create or change a
business object (in
SAP CRM creation is
only supported for
the BUS1006 object)
Store and enter TS30001128 Immediately, by the same
Create or edit a person
business object (in
SAP CRM creation is
only supported for
the BUS1006 object)
Storing for TS30001117 Later, by someone else
subsequent Assign to existing
assignment business object
Store and assign TS30001117 Immediately, by the same
Assign to existing person
business object
Assign then Assign to existing Immediately, by the same
store[a] business object, no person
workflow task
[a]No work item is generated and sent in this scenario, so strictly speaking it is not a real workflow
scenario.

In all scenarios documents of different formats can be linked to SAP business objects:

Scanned documents
To scan documents, you can use Enterprise Scan or the Windows Viewer's
DesktopScan function. The archive request is granted by the SAP GUI.

Note: The Store and enter and Store and assign scenarios are not
supported by Enterprise Scan.

Faxes
To store faxes, you can use the Enterprise Scan's FaxLink function. The same
restrictions apply as for scanned documents.

36 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
4.2. Incoming documents

Microsoft Office documents


You can store Microsoft Office documents with DesktopLink in all scenarios. To
do this, additional customizing steps are required which are described in
“Setting up DesktopLink” on page 185.

4.2.4 Archiving with bar code technology


In this scenario, bar codes are used to link documents to SAP business objects. When
you post a document in the SAP application, a dialog box is displayed in which you
should enter the bar code and the document type. The documents, including bar
codes, are scanned in at a separate scan work center using Enterprise Scan and the
bar code is read. The documents are archived from Enterprise Scan and the bar code
and document ID are given to the SAP system. Links are automatically created to
SAP documents with the corresponding bar codes. The bar code is only used as a
link and is not stored as an attribute.

Figure 4-1: Archiving with bar code technology

When you launch Enterprise Scan, the valid archive types (archive modes) and the
SAP configuration are read from the Administration Server. This provides
Enterprise Scan with the important information which SAP system is being
communicated with and in which logical archive (storage system) documents are to
be archived. Communication takes place in the following stages:

1. The bar code is added to the paper document.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 37
ER160208-CCS-EN-01
Chapter 4 Scenarios for document archiving

2. The posting and bar code are entered in the SAP GUI. The bar code is entered in
the table of open bar codes.
3. The original paper document is sent to the scan work center.
4. The document is scanned in and the bar code is recognized by Enterprise Scan.
5. Enterprise Scan sends the document together with the bar code to the Document
Pipeline.
6. On the Administration Server (Archive Center A in figure 5–1), an OpenText
Document Pipeline DocTool (doctods) identifies the Archive Center that
contains the archive (content repository).
7. The Administration Server sends the host name (DShost) of the archive server
(Archive Center B in figure 5–1) to the OpenText Document Pipeline.
8. The Document Pipeline forwards the document to the Archive Center’s
Document Service.
9. The Document Service identifies the document ID and sends it to the Document
Pipeline.
10. The Document Pipeline sends a message to the SAP application. The message
contains the bar code, the archive ID, and the document ID of the archive. The
SAP application uses corresponding bar codes to link the archived document to
the posting (table of open bar codes).

Using the procedure described in steps 6 to 8, Enterprise Scan can access several
Archive Center. The prerequisite for this is that the Archive Centers recognize one
another.

Enterprise Scan identifies the Administration Server with the archive modes from
the Registry entry HKEY_CURRENT_USER/Software/IXOS/IXOS_ARCHIVE/Profiles/
<Profile_name>/CWin/ ArchiveLink/Archive-0/ADMServerName.

4.3 Outgoing documents


Outgoing documents are generated by the SAP application and used in the SD and
MM modules, for example. Typical outgoing documents are invoices, orders, order
confirmations, purchase orders for materials and reminders. In SAP ERP they are
generated, printed and sent using output determination. In SAP CRM they are
generated, printed and sent using the Post Processing Framework (PPF).

Note: The Post Processing Framework (PPF) replaces the output determination
of previous SAP systems for the SAP CRM application.

Specify here:

• the way in which outgoing documents are distributed


• the format and time of the output
• whether the distribution is to be triggered by an event or must be explicitly
requested
• whether the documents are archived.

38 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
4.3. Outgoing documents

4.3.1 Output determination (for SAP ERP only)


Outgoing documents are classified in output determination, for example, BA00 order
confirmation or NEW purchase order. To enable outgoing documents to be archived,
output determination must be connected to output control using the ArchiveLink
interface. In order to do this, a document type is assigned to the output type. The
prerequisite for archiving is the correct configuration of output determination for
generating outgoing documents.

4.3.2 Post Processing Framework (for SAP CRM only)


The Post Processing Framework (PPF) is an interface for triggering conditional
actions, for example, printing delivery notes, faxing order confirmations, or
triggering approval procedures.

Use Action profiles to define how actions are to be processed for business objects. The
action profiles are linked to an activity type. An activity type controls the processing
of a particular business occurrence and is assigned to one business object only. This
determines for each business object which action is triggered for performing an
activity type and how it is processed.

The execution of the action profiles can be linked to conditions. In this case the
actions are only triggered and processed when the relevant conditions have been
met.

The following diagram shows the general process for the example of a CRM order:

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 39
ER160208-CCS-EN-01
Chapter 4 Scenarios for document archiving

Figure 4-2: PPF - general process

1. In the context of a sales activity, a CRM order business object is created. Various
organizational data is required for this in addition to business partner data.
2. Saving the object initializes processing by the PPF Manager.
3. The PPF Manager identifies the relevant action profile for the sales activity.

40 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
4.3. Outgoing documents

4. The conditions defined in the assigned action profile for scheduling and starting
are checked.
5. If the conditions are met, the business partner for this order is identified and a
SmartForm (the layout) is generated for the outgoing document. Information on
which SmartForm is generated and by which method, is specified (for each
partner if necessary) in the action type.
6. Finally, the outgoing document is generated for the identified business partner
and, according to the configuration, is printed, archived, and/or sent to the
partner.

4.3.3 Outgoing documents with forms


Outgoing documents are often printed on pre-printed paper forms. When archiving
these documents, only the data generated in SAP is saved, not the layout. The data
and the layout are required, however, in order to display the documents correctly.
OpenText Forms Management provides a solution to this problem. This OpenText
component enables forms and their links to SAP data to be stored, so that when it is
displayed using Windows Viewer, the document looks exactly like the printed paper
version. For more information on customizing form archiving and display see
“OpenText Forms Management“ on page 233.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 41
ER160208-CCS-EN-01
Chapter 5
Scenarios for SAP CRM

5.1 Working with documents in SAP CRM 7.0


There are several ways for working with documents in SAP CRM 7.0.

Note: If not mentioned otherwise, this is also true for enhancement packages of
CRM 7.0.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 43
ER160208-CCS-EN-01
Chapter 5 Scenarios for SAP CRM

5.1.1 SAP CRM Web UI: Assignment block

Figure 5-1: SAP CRM Web UI: Attachments assignment block

In the SAP CRM Web UI, there are the following sections in the Attachments
assignment block:

CM Documents
Lists the CM documents assigned to the selected SAP business object. CM
Documents are versionable documents that can be are stored using SAP KPro
technology.
ArchiveLink Documents
Lists the ArchiveLink documents assigned to the selected SAP business object.
These documents are grouped by their document types in order to get a better
overview. ArchiveLink documents are static documents, for example, scanned
documents, that are stored using SAP ArchiveLink technology. You can add,
display and delete ArchiveLink documents.

For both document types, you should use the OpenText Archive Center for the
actual storage of the documents.

You can use the OpenText Imaging Windows Viewer to display both ArchiveLink
and CM documents.
You can also use OpenText Imaging Java Viewer, OpenText Imaging Web Viewer
for ArchiveLink documents by applying SAP OSS note 821218 in the SAP SNOTE
transaction and performing the Imaging Integration with SAP customizing as
described under “Configuration for Java Viewer or Web Viewer” on page 289.
Using these OpenText viewers provides you with additional capabilities like notes
and annotations on documents.

44 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
5.1. Working with documents in SAP CRM 7.0

5.1.2 SAP CRM Web UI: OpenText DocuLink for SAP


Solutions
You can integrate OpenText DocuLink for SAP Solutions (DocuLink) in two ways
into the SAP CRM Web UI:

• Using the SAP transaction launcher technology; the respective customizing is


described in section 18.3.1.2 “Configuring the transaction launcher” in OpenText
DocuLink for SAP Solutions - Customizing and Administration Guide (DC-CGD).
• Using the SAP assignment technology; this integration requires assistance from
OpenText Global Services experts.

Figure 5-2: SAP CRM Web UI: OpenText DocuLink for SAP Solutions
integration using transaction launcher

Note: DocuLink has been enhanced to display CRM CM documents; however,


adding of CM documents is not yet supported.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 45
ER160208-CCS-EN-01
Chapter 5 Scenarios for SAP CRM

5.1.3 SAP GUI: OpenText DocuLink for SAP Solutions


SAP GUI is used in the newer SAP CRM releases for administrative and
configuration purposes only. However, DocuLink is supported for SAP GUI on
CRM systems and you might consider using it for special tasks like scanning or late
archiving with barcodes.

5.1.4 OpenText DesktopLink, OpenText Imaging


ExchangeLink and OpenText Imaging NotesLink
OpenText DesktopLink is supported on SAP CRM; however, it requires the
installation of the SAP GUI on the client. DesktopLink supports the conversion of
documents into the long term formats TIFF and PDF. The integration into Microsoft
Office applications is supported through ODMA (Open Document Management
API).

5.1.5 OpenText Imaging Enterprise Scan


You can use the OpenText Imaging Enterprise Scan application in order to scan
documents into SAP CRM; however, depending on the use case, it might require the
installation of the SAP GUI on the client.

5.1.6 Batch import of documents


In case you want to attach many documents to SAP CRM business objects, you can
use the OpenText batch import pipelines. These batch import pipelines either extract
the required attributes from the provided documents or use attributes supplied with
the documents, for example using an XML file.
The imported documents are stored as ArchiveLink documents.

46 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
Part 2
SAP basis customizing
Chapter 6

Introduction

6.1 The SAP ArchiveLink interface


This brief introduction to SAP ArchiveLink (ArchiveLink) shall aid understanding of
the customizing process. You find further explanations of terminology and
references in the individual sections preceding the description of the customizing
tasks.
For more information see the SAP library under Basis | Basis services/Communications
interface | SAP ArchiveLink (BC-SRV-ARL) | BC-SAP ArchiveLink | Information for all
CRM: SAP Web Application Server | Basis services/Communications interface | SAP
ArchiveLink (BC-SRV-ARL) | ArchiveLink

Interface ArchiveLink is the communication interface between SAP application components


and external archives. SAP application components are the different SAP modules
(FI, SD, HR, CRM, etc.); external archives are in this case the logical archives on the
Archive Center. The ArchiveLink interface enables a range of documents to be
stored (archived) and searched quickly. Archived documents are not managed
separately, but are connected to the associated SAP business objects, so that the
search follows the standard SAP procedure.

The SAP modules may be connected either directly and/or indirectly to ArchiveLink:

Direct connection
Generally, all SAP modules support direct connection to ArchiveLink. The
connection must be implemented in the source code of the individual modules.
This implementation is module-dependent and is not available for all SAP
modules as a default.

Indirect connection
With indirect module connection, there is an additional SAP module between
the original SAP module and ArchiveLink. Both the original SAP module itself
and ArchiveLink are connected to this additional SAP module. Additional SAP
modules for indirect connection may be one of the following:

DMS (Document Management System)


Some modules use the DMS to connect external documents to SAP business
objects, for example, drawing management in MM.

MC (Message Control)
MC is used to archive outgoing documents in an archive via ArchiveLink.

PPF (Post Processing Framework)


PPF replaces MC in SAP CRM it also is used to archive outgoing documents
in an archive via ArchiveLink.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 49
ER160208-CCS-EN-01
Chapter 6 Introduction

ADK (Archive Development Kit)


For data archiving, ADK assumes control of communication with the
ArchiveLink interface.

Elements Like the SAP system structure, ArchiveLink also features three layers:

• Database
special database tables store the information relating to ArchiveLink.
• Applications
programs for archiving, display and other functions.
• User interface
ArchiveLink components of the SAP GUI.

Note: The GUI component from the archlink.exe, archlink.ini and


some DLL files is no longer a component of ArchiveLink. Communication
methods that use these files must be replaced by other methods.
Communication via DDE between SAP GUI and Windows Viewer and
between SAP GUI and Enterprise Scan is replaced by communication via
OLE or HTTP. OpenText therefore provides prepared transports containing
the appropriate protocols with the appropriate customizing (see
“Communication protocols in SAP applications” on page 282).

Versions Version 0045 of SAP ArchiveLink also enables communication via HTTP and is
called SAP Content Server HTTP. You find detailed documentation for the new
interface in the SAP library under Basis | Basis Services/Communication Interface | SAP
ArchiveLink (BC-SRV-ARL) | BC-SAP ArchiveLink | Information for archive suppliers.
CRM: Basis | Basis Services/Communication Interface | SAP ArchiveLink (BC-SRV-ARL)
| ArchiveLink Information for developers

6.2 Customizing phases overview


Before you can archive documents with Archiving and Document Access for SAP
Solutions, you must carry out the customizing process. The respective customizing
phases depend on the archiving scenarios required and the SAP modules for which
these scenarios are to be applied. The customizing phases can be structured as
follows:

“Initial customizing“ on page 57


This phase includes setting up several basic ArchiveLink functions that are
necessary for different archiving scenarios. This customizing must be performed
once for each SAP system.

“Communications setup“ on page 67


This phase includes setting up communication between the Archive Center and
the SAP systems, in particular setting up the HTTP connection. The
configuration must be carried out once for each pair of SAP system and Archive
Center.

50 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
6.2. Customizing phases overview

“Basis customizing“ on page 71


This phase includes settings for the assignment and sorting of documents with
regard to archiving them in an archive system. Basis customizing must be
performed for each archiving scenario. It does not matter which scenario and
which module is involved.
“Scenario customizing” on page 125
This phase includes tasks specific to each scenario and also partially specific to
the SAP module for which a scenario is customized.
Special customizing
This phase covers all the steps that are additional to standard customizing.
These could be expansions for file formats that are not supported by the
standard or the creation of new bar code types.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 51
ER160208-CCS-EN-01
Chapter 6 Introduction

6.3 Authorizations in SAP applications


6.3.1 Authorization concept
The archiving and searching of documents on the OpenText Archive Center is fully
controlled within the SAP system by means of the SAP authorization concept. This
concept comprises the following components:

Authorization object
An authorization object describes actions that can be permitted, for example,
performing transactions and reading or modifying tables. An authorization
object contains a number of fields, such as Table, Transaction, Task, Content
Repository. There are special authorization objects for archiving and searching
documents in archive systems.
Authorizations
An authorization is an instance of an authorization object and contains specific
values for the fields in an authorization object, for example transaction numbers,
table names or task codes. Before an user can perform an action, the SAP
application checks whether it has the required authorization to do so, that is
whether the required values are entered in the fields of the authorization object.
Authorizations are predefined in the SAP application. The system administrator
can define additional authorizations.
Authorization profile (Profile)
An authorization profile is a set of authorizations. Authorizations are not
assigned individually to users. Instead, each user is given one or more
authorization profiles. Some profiles, such as SAP_ALL, are predefined in the
SAP application. The system administrator can define additional profiles.

6.3.2 Authorization objects for ArchiveLink functions


SAP provides the following authorization objects for checking authorizations to
access ArchiveLink functions:

S_WFAR_OBJ
Authorization object of BC_Z object class that contains the fields Activity,
Object type, Document type, and Content repository.

S_WFAR_PRI
Authorization object of BC_Z object class for checking access to stored print lists.
It contains the fields ABAP program name, Activity, Object type, Document
type and Content repository (archive).

S_TABU_DIS
Authorization object of BC_A object class that controls access to tables for table
maintenance. It is used by ArchiveLink for standard view maintenance and
contains the fields Authorization group and Activity. The system
administrator requires the SAOP authorization group.

52 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
6.3. Authorizations in SAP applications

Tasks are indicated by different numbers:

• 01 - Create documents
• 02 - Edit documents
• 03 - Display documents
• 04 - Print documents
• 06 - Delete documents
• 70 - Administration

No authorizations are transmitted during communication between the SAP


application and the archive, so the OpenText components do not recognize these
authorizations. The authorization to display documents therefore also contains the
right to create and modify notes and annotations for a document. You can disable
the ability to create and/or modify annotations by setting the appropriate parameters
for the Windows Viewer (see the OpenText Imaging Viewers and DesktopLink -
Configuration Guide (CL-CGD) documentation).

For print lists with hyperlinks: users who are authorized to display a print list
containing hyperlinks can also display archived documents via the hyperlink.

6.3.3 Authorization maintenance


For maintaining authorizations, profiles and users, the following transactions are
used:

SU01 - User maintenance


Assigns authorization profiles to individual users. If you change an user's access
rights, the user must log on again.
SU02 - Maintain profile
Assigns authorizations to individual profiles. Profiles must be activated before
they be used in the system. When they are activated, a checkmark is displayed
in the Act. column.
SU03 - Maintain authorizations
Under BC_Z / Basis - Central functions you find the S_WFAR_OBJ and
S_WFAR_PRI authorization objects.

SU53 - Display authorization data


Identifies missing authorizations. If you receive a system message telling you
that you have no permission to do something, you are lacking the necessary
authorization. Immediately after the failed action, run the SU53 transaction to
identify the missing authorization.
ST01 - System trace
Enables an authorization check and identifies which authorizations are checked
for the individual user actions. Thus you can determine which authorizations
the user requires for certain actions.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 53
ER160208-CCS-EN-01
Chapter 6 Introduction

For more details, refer to OpenText My Support (https://


knowledge.opentext.com/knowledge/llisapi.dll?func=ll&objId=15819130&
objAction=ArticleView&viewType=1).

Authorization maintenance allows for the targeted control of access to documents.


Similarly, you can also restrict access to print lists.

To perform Maintain Authorizations transaction:

1. Run the SU03 transaction.

2. Double-click the BC_Z / Basis - Central Functions object class.


3. Double-click the S_WFAR_OBJ / ArchiveLink: Authorizations for access to
documents authorization object.
A list of all the authorizations for this object is displayed.

4. Create a new authorization or modify an existing one. Authorizations that are


marked as Generated in the Type column are generated authorizations that
cannot be modified.

5. Enter the required values in each field:

• Activity: what can the user do with the documents?


• Content Repository Identification: can the user only access documents
that are stored in specific archives?
• Document type: which document types can the user access?
• Object type: can the user only access documents that are linked to business
objects of specified object types?

Example 6-1: Authorization list


A user with this authorization can read documents of all types that are
archived in the A1 archive and linked to business objects of the BKPF
object type.

54 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
6.3. Authorizations in SAP applications

6. Save and activate the authorization.

7. Copy the authorization to an authorization profile and activate the profile (SU02
transaction).

8. Assign the authorization profile to users (SU01 transaction). The users must then
log on again.

6.3.4 Rights for feedback users


In some archive scenarios, the Archive Center sends a confirmation with the
ARC_DOC_ID (document ID of a stored document) to a technical user (CPIC) in the
SAP system who is called the feedback user. For more details see “Creating a
feedback user in pipeline based scenarios” on page 68.

The scenarios requiring a feedback user are the following:

• Archiving print lists


• Early/late storing with bar codes
• Data archiving

The feedback user requires authorizations that are not contained in the SAP_ALL
profile. You must therefore assign at least the following profiles to the feedback user:

• S_A.USER
• S_A.CPIC
• Create a profile with the authorizations S_AL_ADMI and S_AL_ALL_PRI

These profiles contain the administration right (task 70) for the authorization objects
S_WFAR_OBJ and S_WFAR_PRI, as well as administration rights required for queues.
You should also check the OSS notes in the bc-srv-arl-int area, as well as the
ESC, to see whether additional rights are required for your SAP version and storage
scenarios.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 55
ER160208-CCS-EN-01
Chapter 6 Introduction

6.3.5 Minimum authorizations of DesktopLink client users


If you save a document via the DesktopLink client, either using theDrag & Dropor
Save to DesktopLink option, the client program opens an RFC connection to your
SAP system. To enable this, you need minimum RFC related authorizations for the
user that is used for the RFC connection. Apart from the authorizations required to
archive documents in SAP or open and view data in OpenText DocuLink, you must
set minimum permissions in the authorization object S_RFC.

To set necessary permissions:

1. In the authorization object S_RFC, edit the following Field name values:

• ACTVT – set to 16.


• RFC_NAME – set to J8A3, RFC1, RFCH and SYST.
• RFC_TYPE – enable the FUGR setting.

These values are sufficient for minimum access to the DesktopLink functionality.
For more information, see also SAP (OSS) note 460089 “Minimum authorization
profile for external programs”
( https://service.sap.com/sap/support/notes/460089 ).

56 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
Chapter 7
Initial customizing

Initial customizing comprises basic settings for ArchiveLink, which must be


implemented once for each SAP system. These basic settings are:

• “Setting up an archiving device” on page 57


• “Creating queues” on page 59
• “Scheduling an ArchiveLink job” on page 60
• “Maintaining an ArchiveLink number range” on page 62
• “Maintaining the ArchiveLink basic settings for DMS” on page 63 (for
printlists)
• “Setting parameters for the archive format” on page 65 (required for print lists
containing hyperlinks)

7.1 Setting up an archiving device


To archive print lists and outgoing documents, you must configure a virtual printer
as an archiving device. The SAP system uses this printer to “print to the archive”.

To configure a virtual printer:

1. Run the SPAD transaction.

2. Click Output devices.

3. Click Change.
An overview of the output devices that can be edited is displayed.

4. Click Create.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 57
ER160208-CCS-EN-01
Chapter 7 Initial customizing

Figure 7-1: Storing print lists: Setting up an archiving device

5. In the Output device box, enter the parameters ARCH.

6. On the DeviceAttributes tab, enter the following parameters:

Device type
ARCHLINK

Spool server
Server on which the spool server runs; pick one from the list.

Device class
Archiving program

Authorization group
not required

58 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
7.2. Creating queues

Model, Location, Message


any information

7. On the Access Method tab, enter the following parameters:

Host Spool Access Method


I: Archiving device

8. Click Save and then Exit.

7.2 Creating queues


Print lists and archive files from data archiving are stored and retrieved
asynchronously. ArchiveLink does not wait for the storage or retrieval process to
finish, but continues after receiving the order confirmation. This means that the
actual order processing, particularly for large volumes of data, can take place at
times when the system load is low. Therefore, you must set up queues for
asynchronous processes, which you can monitor in the ArchiveLink monitor. The
following queues and associated error queues are available:

Asynchronous archiving
The storage queue (CARA queue) contains the orders for asynchronous
archiving, which are forwarded to the archive. The associated error queue is also
called the CARA-E queue.
Storage confirmation
The confirmation queue (CFBC queue) contains the feedback from the archive
indicating that a storage operation has been successful. If errors occur during
storage, the appropriate messages are put into the error queue (CFBC-E queue).
Asynchronous retrieval
The retrieval queue (CFBA queue) contains the requirements for retrieving
archived print lists and archive files. The related error queue is also called the
CFBA-E queue.

To create queues for asynchronous processes:

1. Run the OAQI transaction.

2. Enter an X for each queue.

3. Enter the SAP user name of the archive administrator or the SAP system
administrator as the Queue Administrator. This user receives the queue error
messages.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 59
ER160208-CCS-EN-01
Chapter 7 Initial customizing

Figure 7-2: Creating queues

4. Click Execute and then Exit without saving.

Note: In more recent releases SAP implemented their file validation


framework into the program (RSCMSCAJ) which is called by the storage queue
(CARA). Therefore, in the case of print list errors or to avoid print list errors,
check SAP Note 2552635 - Error during ArchiveLink printlist storage.

7.3 Scheduling an ArchiveLink job


The ArchiveLink job processes the files in the queues for asynchronous processes. It
should run as a scheduled job every five minutes.

To schedule an ArchiveLink job:

1. Run the OAB4 or OAAT transaction.

2. Create the job step by clicking on ABAP program and enter the name of the job:
ilqbatch.

Note: Do not create any variants!

3. Click Save.
ARCHIVELINK is entered in the Job name field, and C is entered in the Job class.

60 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
7.3. Scheduling an ArchiveLink job

Figure 7-3: Defining an ArchiveLink job

4. Accept these settings.

5. Click Start condition.

6. Click Immediate and activate the Periodic job option.

7. Click Period values.

8. Click Other period.

9. Enter the value 5 in the Minute(s) field.

Figure 7-4: Scheduling an ArchiveLink job

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 61
ER160208-CCS-EN-01
Chapter 7 Initial customizing

10. Click Save until all entries are saved (4 times).

7.4 Maintaining an ArchiveLink number range


For ArchiveLink, a number range interval for generating unique file names and
unique order numbers for asynchronous orders must be set up.

1. Run the OANR transaction.


2. Click Intervals.
3. Click interval.
4. Enter the following parameters:
No.
01

From Number
100000
The number range must not begin with 0 (see OSS note 173607)!
To Number
9999999999

NR Status
Leave blank.
Ext
This is an internal number range - leave deactivated.

Figure 7-5: Maintaining an ArchiveLink number range

5. Click Save.

62 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
7.5. Maintaining the ArchiveLink basic settings for DMS

7.5 Maintaining the ArchiveLink basic settings for


DMS
To archive print lists in Archiving and Document Access for SAP Solutions, the print
list management for DMS must be deactivated.

Note: DMS is not used in SAP CRM.

To maintain the ArchiveLink basic settings:

1. Run the OAG1 transaction.

2. Make sure the following options are selected:

• Deactivate IMC
• Deactivate Print List Management in DMS

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 63
ER160208-CCS-EN-01
Chapter 7 Initial customizing

Figure 7-6: ArchiveLink basic settings for DMS

3. Click Save.

64 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
7.6. Setting parameters for the archive format

7.6 Setting parameters for the archive format


To archive print lists containing hyperlinks, attribute search index and/or color data,
you must set the rspo/archive_format parameter to 2 in the SAP instance profile.
This parameter can have one of two values:

• Format 1 contains ASCII characters, as well as line feed and form feed as control
characters.
• Format 2 contains print controls, preceding columns, comments and DARC
index lines.

The default value is 2. Check the value and change it if necessary.

To check parameters for the archive format:

1. Run the SE38 transaction.

2. Enter the report name RSPARAM, click Execute and then again Execute.

3. The list contains the rspo/archive_format parameter together with its value.

Figure 7-7: Parameters for the archive format

There are two ways to modify the parameter:

• Using an editor to modify the profile file itself; the path to the profile file is:
usr/sap/<SID>/SYS/profile/<SID>_DVEBMGS<INS>_<r3_host>.
Here <SID>_DVEBMGS<INS>_<r3_host> is the name of the instance profile.
• Using the SAP profile maintenance with the RZ10 transaction.

Note: After modifying the profile parameters you must restart the SAP system.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 65
ER160208-CCS-EN-01
Chapter 8
Communications setup

The following procedures set up the communication between the SAP systems and
the archive:

• “Configuring an SAP system in the OpenText Administration Client”


on page 67: the configuration must be performed once for each pair of SAP
system and Archive Center.
• “Creating a feedback user in pipeline based scenarios” on page 68: a feedback
user is only needed in pipeline based scenarios in which a pipeline sends data
directly to the SAP system.
• “Creating an exchange directory” on page 69: in some archiving and download
scenarios, data is exchanged via a special exchange directory in the file system.
• “Sending a certificate” on page 86: to secure the connection between the SAP
GUI and Archive Center using SecKeys.

8.1 Configuring an SAP system in the OpenText


Administration Client
Before assigning an SAP system to a logical archive, the SAP system must have been
created and configured.

In the OpenText Administration Client, you must configure the connection to the
SAP systems for each Archive Center. This includes the gateway configuration. If
OpenText components (for example, Archive Center and Enterprise Scan work
center) are in different subnets, you must configure a separate gateway for each
subnet.

For more details see OpenText Archive Center - Administration Guide (AR-ACN).

To assign an SAP system to a logical archive:

1. Open the Administration Client and select SAP Servers in the Environment
object in the console tree.
2. Select the Archive Assignments tab in the result pane. All archives are listed in
the top area of the result pane.
3. Select the archive to which a SAP system should be assigned. Keep in mind, that
SAP system can be assigned only to original archives.
4. Click New Archive SAP Assignment in the action pane. A window to configure
the SAP archive assignment opens.
5. Enter the settings for SAP archive assignment:

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 67
ER160208-CCS-EN-01
Chapter 8 Communications setup

SAP system connection


SAP system connection name of the SAP system with which the logical
archive communicates.

ArchiveLink version
The ArchiveLink version 4.5 is currently used.

Note: Note that not all archiving scenarios using Archive Center are
supported for ArchiveLink version 4.6.

Protocol
Communication protocol between the SAP application and Archive Center.
Fully configured protocols that can be transported in the SAP system are
supplied with the SAP products of OpenText.

Use as default SAP system connection


Selects the SAP system to which the return message with the barcode and
document ID is sent in the Late Storing with Barcode scenario. This
setting is only relevant if the archive is configured on multiple SAP
applications, for example, on a test and a production system.

6. Click Finish.

Notes

• If you store into several clients of an SAP system, see the following
article (https://knowledge.opentext.com/knowledge/llisapi.dll?func=ll&
objId=15817282&objAction=ArticleView&viewType=1) in My Support.

• If you are using a CRM system, continue with “Creating an exchange


directory” on page 69.

8.2 Creating a feedback user in pipeline based


scenarios
Communication between OpenText archives and SAP system is only done via
HTTP. Therefore, a feedback user is only needed in pipeline based scenarios in
which a pipeline sends data directly to the SAP system, for example, in a barcode
scenario or in batch/COLD processing.
This feedback user must:

• be created in the SAP system on the client on which storage is taking place (if
storage is taking place on several clients of an SAP system identical on all clients)

• be assigned the necessary rights (see “Rights for feedback users” on page 55),

• be entered in the OpenText™ Administration Client when configuring the SAP


system (see “Configuring an SAP system in the OpenText Administration Client”
on page 67).

68 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
8.3. Creating an exchange directory

To create and manage the feedback user in the SAP system user
administration:

1. Run the SU01 transaction.


2. Enter a name for the feedback user, for example, OTCPIC.
3. Click Create, or copy the existing SAPCPIC user using Copy as.
4. Enter or modify the following user data:

Address tab
Last name
Name of feedback user, for example, OTCPIC

Logon data tab


Password
Password of feedback user; the password entered must be identical to
the one created in the OpenText Administration Client
User group
Technical User

User type
System or Communication

Profile tab
see “Rights for feedback users” on page 55

• S_A.USER
• S_A.CPIC
• Create a profile with the authorizations S_AL_ADMI and S_AL_ALL_PRI

5. Click Save.

8.3 Creating an exchange directory


Note: For HTTP communication, the Archive Center does not require access to
this directory.

In the following archiving and download scenarios, data is exchanged via a special
exchange directory in the file system:

• Archiving SAP print lists


• Data archiving (also called Archiving of REORG files)
• Forms Management
• Downloading archived print lists for printing via SAP spool

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 69
ER160208-CCS-EN-01
Chapter 8 Communications setup

In these archive scenarios, the SAP application server stores the data in the exchange
directory (basic path in OAC0 transaction). The physical location of the exchange
directory depends on the operating system platforms of the SAP database server.

Capacity The exchange directory is created in its own partition (Windows NT/2000) or file
system (UNIX). The hard disk capacity must be larger than the largest document to
be archived. SAP print lists can be in excess of 400 MB. They are compressed by the
Archive Center before being saved on the archive medium.

Authorization in In UNIX, the exchange directory must belong to the SIDadm user (user with which
UNIX the SAP application accesses the exchange directory) and read and write access must
be set up (for example, 770). The setgid bit (also called s-bit) must be set for the
group so that the files in the directory inherit the group ID. This is required because
the SAP application does not give the exchange files universal read access.

Indication The exchange directory must be indicated to the SAP application for every logical
archive:

• SAP application: Transaction OAC0.

70 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
Chapter 9

Basis customizing

Basis customizing must be performed for every archive scenario and for every new
storage system (archive), irrespective of the SAP module involved. This provides the
basis for the subsequent customizing of individual scenarios. For individual
scenarios, see “Scenario customizing” on page 125.

9.1 Basics
This section contains a description of the basic terms and the background of Basis
customizing. You can find further information in the SAP Library under
Basis | Basis Services/Communication Interface | SAP ArchiveLink (BC-SRV-ARL) |
ArchiveLink | Information for developers
CRM: SAP Web Application Server | Basis services/Communications interface | SAP
ArchiveLink (BC-SRV-ARL) | ArchiveLink

9.1.1 Key terms


9.1.1.1 Object type
Object type is an SAP-specific term. The object type describes an SAP application
business object specific to each SAP module. It describes the structure of the records,
including the key fields of the different tables. The BKPF object type, for example,
defines the document number, company code and fiscal year key fields. In addition,
the object type specifies how the object is processed. Processing is defined by
methods, which are determined for each object type. These methods contain
operations that can be applied to each object. Object types are set up in the SAP
application standard and do not need to be defined in terms of ArchiveLink
customizing. The main object types are:

Object type Used for


BKPF FI documents (document header)
VBAK outgoing documents in SD
PREL HR documents
BUS1006 business partners in CRM
DRAW SAP print lists (print instruction)
SOOD SAP office documents
ARCHIVE SAP data archiving

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 71
ER160208-CCS-EN-01
Chapter 9 Basis customizing

9.1.1.2 Document type


The Document type describes the content and meaning of the archived document.
Allocating document types enables you to treat documents according to technical
processing, workflow treatment, storage period and authorization. Different
document types can be kept in different archives. There is a naming convention for
the standard SAP application document types: The name of the document type
consists of the module name and an abbreviation, for example, FIIINVOICE means
FI module, Incoming INVOICE. In addition to the standard document types, new
document types can be defined freely.

SAP applications distinguish between the following groups of document types:

Incoming documents
These documents are either scanned in or captured as a screen image using
another method. Incoming faxes belong to this group too. Examples include
incoming invoices without invoice verification FIIINVOICE and incoming credit
memos without invoice verification FIICREDIT.
Outgoing documents
These documents are created in the SAP application and are usually printed out.
They can be processed automatically. For example, the outgoing order
confirmation SDOORDER.
Print lists
These documents are created in the SAP application as screen lists or ABAP lists
and can be processed automatically.
Archive files
These documents are database extracts containing obsolete data, which is
removed from the database and saved elsewhere. The archive files are created in
the SAP application.
Desktop files
These documents come from other software programs, such as Microsoft Word,
Microsoft Excel, CAD applications, etc.

9.1.1.3 Document class


The Document class specifies a document's file format. It is assigned to each
document class and is required for starting the correct display program for an
archived document. Many document classes can be displayed using the OpenText
Imaging Clients (Windows Viewer, Java Viewer, Web Viewer), but for others the
program used to create the document is started (for example, Microsoft Office
applications). The display program to use for a document class and the way in
which communication takes place is specified in the ArchiveLink protocols. The
most important document classes are:

72 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
9.1. Basics

Document Description
class
FAX Document class for documents scanned in black and white.
The FAX document class supports the TIFF formats (.tif) TIFF
CCITT group 3 or 4. These documents are displayed by the
Windows Viewer, Java Viewer, Web Viewer. TIFF group 3
and 4 is a standard format for black and white bitmaps. For
documents scanned in color, the JPG document class is used.
JPG Document class for documents scanned in color. The files are
stored in JPEG (.jpg) format and are displayed by Windows
Viewer, Java Viewer, Web Viewer. JPEG is a format for
saving and compressing color images.
ALF For print lists (Advanced List Format). Print lists are
displayed by Windows Viewer, Java Viewer or Web Viewer.
PDF For outgoing documents (Portable Document Format). PDF is
used as the default format for outgoing documents by SAP
applications and is displayed by Windows Viewer or Java
Viewer using an Adobe Acrobat plugin. In the Web Viewer,
the PDF document is displayed as an HTML file, as usual,
thus no plugin is required.
REO For archive files
DOC, XLS ... For desktop files, for example, from office programs. Usually
they are displayed using the program with which they were
created. Web Viewer can also be used to view MS office
documents.

9.1.1.4 Protocol
A protocol defines how a document class is handled in SAP applications (OAA3
transaction). A protocol is assigned to an archive (content repository, archive). This
ensures that all documents of a document class held in the same archive (content
repository) are handled in the same way. Furthermore, the document class
determines the program used to retrieve and display the document.

To maintain and create applications, run the OAA4 transaction or run the OpenText
Archiving and Document Access for SAP Solutions > DesktopLink and Archiving
for SAP Solutions > ArchiveLink > Front End Communication Customizing >
Maintain Applications activity in the IMG.

To create and maintain protocols in the IMG, run the activity. Alternatively, you can
run the OAA3 transaction.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 73
ER160208-CCS-EN-01
Chapter 9 Basis customizing

Used for Displaying documents Scanning


Protocol Communication type
OT_OLEU1 OPEN_V_URL OPEN
Using the archive ID and the (Communication via OLE)
document ID, an URL is
created which can be signed.
This URL is passed on to the
Windows Viewer as an OLE
parameter.
OT_OLEU2 like OT_OLEU1 OPEN_V_URL
Using the archive ID and the
document ID, an URL is
created which can be signed.
This URL is passed on to the
scan client.
OT_HTTP2 Default OPEN
Based on HTTP (Communication via OLE)
communication. Using the
archive ID and the document
ID, an URL is created which
can be signed. This URL is
passed on to the browser.
Windows Viewer and other
display applications are
started and displayed within
the browser. Print lists are
displayed by starting the
Windows Viewer using OLE,
as with OT_OLEU1.
We recommend using this
protocol for SAP ArchiveLink
4.5.
OT_HTTP3 like OT_HTTP2 OPEN_V_URL
Using the archive ID and the
document ID, an URL is
created which can be signed.
This URL is passed on to the
scan client.

Note: OpenText recommends using the OT-... protocols supplied. They are
direct successors of the IX_...protocols described in older guide versions.

Communication The ODMA takes over all the communication between Windows Viewer and
between Archive Center. Since version 6.0 of the OpenText Imaging clients only HTTP
OpenText
components
communication is supported.

Enhanced When running communication between OpenText Imaging Clients and Archive
security Center via HTTP, you can secure the communication between the individual
components as follows:

74 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
9.1. Basics

• Securing the connection between OpenText Imaging Clients and the Archive
Center and encrypting the communication with SSL.
• Securing the connection between the SAP GUI and OpenText components using
SecKeys. Here the URL sent is signed digitally. The Archive Center verifies the
signature and only accepts requests with a valid signature.
In this case, the SAP system must send the public key to the Archive Center as a
certificate for the signature check (OAHT transaction, see “Sending a certificate”
on page 86 and section 8 “Configuring security settings” in OpenText Archive
Center - Administration Guide (AR-ACN)).

9.1.1.5 Archive (storage system, content repository)


SAP refers to archives as content repositories. In the OpenText Administration Client,
the term logical archive or simply archive is used. Each archive is given an archive ID
that must be internally unique within the entire network of connected Archive
Center and SAP systems. The archive/collection ID comprises two characters and
may contain only capital letters and numbers. It is assigned identically in both the
SAP system and the Administration Client.

Figure 9-1: Unique archive IDs

Caution
Do not assign long archive names!
Since SAP basis version 4.6 you can also enter longer archive names when
creating archives (OAC0 transaction). For ArchiveLink, however, the
restriction to two characters per name remains.

Number of The number of archives used depends on the following criteria:


archives
• Corporate structure
• Archiving period of documents: An archive contains documents that have the
same storage period.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 75
ER160208-CCS-EN-01
Chapter 9 Basis customizing

• Assigning of specific authorizations: Depending on the SAP module and the


content of the documents, a different authorization is required (for example, for
FI and HR documents).
• Implementation of different archiving and cache strategies
• Separation of test and productive data
• Taking into account daily data volumes and administrative effort: Do not create
too many archives.

9.1.2 ArchiveLink management concept


Archived documents must have an unique reference to an SAP business object. To set
up this connection, three management activities are required which together are
referred to as basis customizing:

“Maintaining HTTP content repository in the SAP application” on page 78


Each archive is assigned a two-character alphanumeric archive ID. Other
important details are the protocol to be used for communication, port number
and name of the Archive Center host.
Perform the archive definition using the OAC0 transaction. The data is saved in
the TOAAR table.
“Maintaining global document types” on page 81
Assigning document types classifies documents to be archived according to
content-specific criteria. The document type indirectly specifies how the
documents are processed and in which archive they are stored. When you define
the document type, you indicate the document class, which in turn defines the
format of the document.
Perform the document type definition using the OAC2 transaction. The data is
saved in the TOAVE table.
“Maintaining links” on page 84 (assigning document types to the archive)
In the third step the two pieces of information above are linked. To uniquely
assign archived documents to business objects, two further inputs are required:
the SAP object type and the link table, in which individual links between
business objects and documents are saved.
Perform the link maintenance using the OAC3 transaction. The data is saved in
the TOAOM table.

Tables All data is stored in tables. All table names used in conjunction with ArchiveLink
start with TOA (Table for Optical Archiving). The TOAAR, TOAVE and TOAOM tables are
customizing tables.

The following overview shows the relationships within basis customizing:

76 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
9.1. Basics

Figure 9-2: Relationships within basis customizing

Link tables Assignments of archived documents to business objects are contained in the link
tables. This enables you to separate data about the archived documents from object
data and to archive multiple documents for one business object. The standard link
tables are:

TOA01 to For documents that are linked to SAP application business


TOA03 objects. There are several tables with the same structure for
these links in order to optimize access times.
TOAHR For documents that are linked to HR objects of the SAP
components PA (Personnel Management) and PY (Payroll).
TOADL For managing print lists. This table has a different structure
and cannot be defined. With maintaining links with OAC3
transaction, you must select one of the TOA01-03 or TOAHR
tables for print lists (DRAW).

You can define additional link tables in the SAP system (OAD3 transaction).

To display tables, run the SE16 transaction. The link tables TOA01-03 each contain
nine columns. Each row of these tables contains important information about an
archived document and the SAP application business object to which it is assigned.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 77
ER160208-CCS-EN-01
Chapter 9 Basis customizing

Figure 9-3: Link tables TOA01-03: Structure

The following overview shows the significance of the individual table columns and
their references.

Figure 9-4: Link tables TOA01-03: Relationships

9.2 Maintaining HTTP content repository in the SAP


application
Each archive must be created both in the SAP system and on the OpenText Archive
Center, using the same name.

To configure an HTTP content repository:

1. In IMG, run the OpenText Archiving and Document Access for SAP Solutions
> DesktopLink and Archiving for SAP Solutions > ArchiveLink > Maintain
Content Repositories activity. Alternatively, you can run the OAC0 transaction.
The Content Repositories overview table is displayed.

2. To switch to edit mode, click Display → Change.

3. To create a new content repository, click Create.


To modify an existing storage system, select it in the list and click Detail.

4. Click Full administration.

78 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
9.2. Maintaining HTTP content repository in the SAP application

Note: The following image shows the configuration in a SAP basis 6.0
system for an archive that is to operate in secure mode. Secure mode means
that SecKeys are used to transmit URLs.

Figure 9-5: Configuration for a secure HTTP archive

5. Enter the following parameters:

Content Rep.
Two-character archive name, which may only contain capital letters and
numbers. When you use a two-character name, you have the highest degree
of compatibility for different archiving scenarios. For example, for KPro and
Data Archiving scenarios, you can use up to 30 characters. For pure
ArchiveLink scenarios, only two characters are allowed.
Description
Description of the archive, for example, indication of archive usage and the
Archive Center.
Document Area
For an ArchiveLink archive, enter ArchiveLink. For a KPro archive enter
the corresponding document area.
Storage type
HTTP Content Server

Protocol
Name of the protocol used for communication (see “Protocol” on page 73).

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 79
ER160208-CCS-EN-01
Chapter 9 Basis customizing

The OpenText protocols OT_* can be created manually as described in


OpenText Archiving and Document Access for SAP Solutions - Installation and
Upgrade Guide (ER-IGD). They are also available with transports that can be
downloaded from OpenText My Support (https://knowledge.opentext.com/
knowledge/cs.dll?func=ll&objId=15777379&objAction=browse).
Version no.
ArchiveLink interface version 0045 is recommended. Note that ArchiveLink
version 0046 does not support all archiving scenarios.
HTTP server
Name of the OpenText Archive Center. In addition, the port should be
shown, for example: monopoly:8080.
From SAP basis 6.20, the port no. is entered in a separate field.
Port Number
Port Number of ArchiveLink connection.
SSL Port Number
When using the secure transfer protocol SSL (Secure Socket Layer).
Program (CRM: HTTP Script)
Enter archive.
Basic Path, Archive Path
Path to the exchange directories. For HTTP communication, the Archive
Center does not require access to this directory.
The SAP application server stores the documents to be archived on the basic
path. The Archive Center makes the documents requested by the SAP
application available on the archive path (see “Creating an exchange
directory” on page 69). For data archiving, the exchange directory must be
entered identically in the FILE or SARA transaction with particular attention
to upper/lower case.
Notes

• The basic path and the archive path are only displayed in Full
administration mode.
• The path must always be closed using a forward slash (/) on UNIX
platforms and a backslash (\) on Windows platforms:
\\<Host name>\<Share name>\<Exchange directory>\.

OutputDevice
Enter ARCH.
No signature
If you select this option, the URLs for this archive are transmitted without
encryption. When you disable this option, the URL is given a SecKey, in
which important data is encrypted. In the latter case, a certificate must be
sent from the SAP application to the Archive Center (see “Sending a
certificate” on page 86) and the signature check must be configured in the
OpenText Administration Client (see the section 8 “Configuring security
settings” in OpenText Archive Center - Administration Guide (AR-ACN)).

80 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
9.3. Maintaining global document types

6. Click Save.

You can send a certificate from your SAP system directly to the content repository
defined here.

To send the certificate for your content repository:

1. Wait for the confirmation message that the archive is ready.

2. Click Send certificate.

Note: To send certificates centrally, use the oaht transaction.

9.2.1 Creating an archive on the OpenText Archive Center


On the OpenText Archive Center you must create an archive with the same name as
in the SAP application. When you configure the archive, specify the media type on
which the documents are to be archived (for example, CD, DVD, WORM, hard disk),
and indicate the exchange directory.
For more details see OpenText Archive Center - Administration Guide (AR-ACN).

9.3 Maintaining global document types


This section describes the maintaining of document types and document classes.
You have the option to create your own document types and document classes.

9.3.1 Creating document types


ArchiveLink provides standard document types for all SAP modules. These
standard document types are not always sufficient to classify documents precisely.
In this case, create your own document types, one document type for each group of
documents that correspond to the same content criteria, are processed in the same
way, and are stored in the same archive (content repository).

To create a new document type:

1. In IMG, run the OpenText Archiving and Document Access for SAP Solutions
> DesktopLink and Archiving for SAP Solutions > ArchiveLink > Maintain
Document Types activity. Alternatively, you can run the OAC2 transaction.

2. To switch to edit mode, click Display → Change.

3. You have two options:

• Click New entries to create a new document type.


• To create a new document type based on an existing one, select your
document type in the list and click Copy as.

4. Enter the required parameters. You do not have to create each document type
individually, you can enter several new document types in a table.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 81
ER160208-CCS-EN-01
Chapter 9 Basis customizing

Figure 9-6: Global document types

Document type
Enter a name for the document type. User-defined document types must
begin with Y or Z.

Description
Enter a description of the document type. This description is displayed to
the SAP application user for selecting the document type. It should
therefore describe the use of the document type precisely and if necessary in
several languages.

Document class
To find the list of existing document classes, run transaction OAD2.
Associated document class:

FAX for documents scanned in black and white


JPG for documents scanned in color
ALF for print lists
PDF for outgoing documents
REO For archive files
DOC, XLS ... for desktop files

Status
Select the check box if you want the document type to appear in the
Business Document Navigator as a standard document type.

5. For new entries:


Click Save and then Back to display the document type overview.
For copied entries:
Click Enter and confirm the prompt when exiting the transaction.

82 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
9.3. Maintaining global document types

9.3.2 Customizing document classes


You can create and customize your document classes.

To customize document class:

1. In IMG, run the OpenText Archiving and Document Access for SAP Solutions
> DesktopLink and Archiving for SAP Solutions > ArchiveLink > Maintain
Document Classes activity. Alternatively, you can run the oad2 transaction.

• To create a new document class, click New Entries.


• To edit an existing document class, select and double-click a document class
in the list to open its Details dialog.

2. You can customize the following entries:

• Doc. class – Enter the name of the document class.


• Description – Enter a description for the document class.
• MIME type – Assign a MIME type to the document class.
• Application – If required, enter the name of an application.

Note: To include the new MIME types for Microsoft Office 2007, see:
SAP Note 1237688 (https://service.sap.com/sap/support/notes/1237688)
and the attached Excel file.

3. Click Save and Back to save your document class and to return to the
document class list.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 83
ER160208-CCS-EN-01
Chapter 9 Basis customizing

9.4 Maintaining links


Each new document type must be assigned to an archive in which the documents
are archived. The object type and the link table are also assigned.

To maintain link between the document type and the storage system:

1. In IMG, run the OpenText Archiving and Document Access for SAP Solutions
> DesktopLink and Archiving for SAP Solutions > ArchiveLink > Maintain
Links activity. Alternatively, you can run the OAC3 transaction.

2. To switch to edit mode, click Display → Change.

3. To create a new link, click New entries.


To create a new link based on an existing one, select the link in the list and click
Copy as.

4. Enter:

Figure 9-7: Link between the document type and the storage system

Object Type
Object type to which the document type belongs. The most important object
types are:

BKPF for FI documents (document header)


VBAK for outgoing documents in SD
PREL for HR documents
DRAW for SAP application print lists (print
instruction)
SOOD for SAP application office documents
ARCHIVE for SAP application data archiving

Doc. Type
Document type short text

84 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
9.5. Document type customizing wizard

L
Status of Link entry. Enter an X to activate the link so you can use it.
Cont.Rep.ID (Content Server)
Archive ID, name of the archive. The archive must be configured in both the
SAP application (OAC0 transaction) and the Content Server.
Link
Link table in which the assignments of the archived documents to the SAP
application objects are saved.

TOA01 to for documents that are linked to SAP application business


TOA03 objects
TOAHR for documents that are linked to HR objects.

The link data for print lists is contained in the TOADL table. For link
maintenance you must enter one of the TOA01-03 or TOAHR tables for
print lists.
Retent. Period
Optional input: Legal storage period for documents of this type in months.
This field is for information purposes only. After the retention period has
expired, the link entry is not automatically removed.

5. For new entries:


Click Save and then Back to display the document type overview.
For copied entries:
Click Enter and confirm the prompt when exiting the transaction.

9.5 Document type customizing wizard


You can also use the document type customizing wizard to create new document
types and modify existing ones, but you cannot delete document types. The wizard
combines the settings of the OAC2 and OAC3 transactions. For workflow document
types, you must also enter all workflow-related settings such as task, method,
workflow parameters and defaults. The prerequisite for this is that the archive is
configured with the OAC0 transaction.

The wizard carries out the customizing using the Continue and Back buttons. It
provides detailed information for each input stage. The following description
provides an introduction to the wizard's customizing steps for a document type
without a workflow and establishes the link to the customizing transactions.

To use the document type customizing wizard:

1. Run the OAD5 transaction.

2. Click Continue to start customizing.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 85
ER160208-CCS-EN-01
Chapter 9 Basis customizing

3. Enter the Document type and the Description as in the OAC2 transaction, 1st
and 2nd column labeled Doc.type.
You also have the option of selecting a sample document type and using its
settings as standard values.
4. Leave the Workflow document type option deactivated to create the document
type without a workflow.
5. Enter the Document class as in the OAC2 transaction. If you selected a sample
document in step 3, the document class of this template is used.
6. Enter the Object type as in the OAC3 transaction.
7. Enter the Content Repository, the Link, and the Retention per. as in the OAC3
transaction.
8. Click Finish.
This completes the document type and link maintenance. The document type
status in the OAC2 transaction is not set. The status of the link in the OAC3
transaction is automatically set to X, activating the link.

9.6 Sending a certificate


By using SAP certificates and setting the security parameters in the OpenText
Administration Client, signatures from SAP requests are validated by the OpenText
Archive Center. This method can be used if the SAP Content Server HTTP 4.5
(ArchiveLink 4.5) interface is used for communication between SAP and the archive.

The SAP system sends its requests to the archive system as an URL. The URLs are
digitally signed by the SAP system using a private key. The Archive Center
compares the signature with the public key and only accepts requests with a valid
signature. In order to enable validation, the SAP system must send the public key to
the Archive Center as a certificate. To check the validation of the sent certificate, the
system administrators of the SAP system and the Archive Center compare the finger
prints of the sent and received certificate. If the finger prints are identical, the
archive administrator enables the certificate for the specific SAP system. Operations
requiring SecKeys (reading, updating, creating, deleting) are defined in the Archive
Center (see OpenText Archive Center - Administration Guide (AR-ACN)).

To send the SAP certificate:

1. Run the OAHT transaction.

Tip: Alternatively, you can send the certificate while maintaining the
storage system in the SAP application in the OAC0 transaction, see
“Maintaining HTTP content repository in the SAP application” on page 78.
2. Find the Archive Center you want to send the certificate to in the list of HTTP
Content Servers.
3. Click Execute.

86 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
9.6. Sending a certificate

The certificate is sent.

For import of a certificate on the Archive Center see OpenText Archive Center -
Administration Guide (AR-ACN).

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 87
ER160208-CCS-EN-01
Chapter 10
Integrating Archiving and Document Access for
SAP Solutions into SAPUI5 or SAP Fiori apps

You can make business document available in SAPUI5 apps. These can be either
your own custom apps or SAP Fiori apps based on SAPUI5. The documents are
displayed in a custom tile or can be navigated to in cross-app navigation. There may
be some ambiguity in terminology, because a “Fiori app” could be one of the
following:

• A SAP Fiori app as delivered by SAP. For a list of all apps, see https://
fioriappslibrary.hana.ondemand.com (• A SAP Fiori app as delivered by SAP
(see https://fioriappslibrary.hana.ondemand.com).
• A SAPUI5 app following the SAP Fiori Design Guidelines
• Any browser app hosted on an SAP Fiori Launchpad server.

In any case, the techniques presented in this chapter refer to apps implemented with
SAPUI5 and typically hosted on an SAP Fiori Gateway server with SAP Fiori
Launchpad.

10.1 SAP Fiori architecture


SAP Business Suite or S/4HANA features an ABAP engine for transactional
applications. Backend application artifacts and application content are stored in the
backend database.

In addition, the UI apps are deployed on a central SAP ABAP NetWeaver server,
which also contains the UI Service Add-on for the shell services and the Gateway
Add-on for the OData enablement of the ABAP-based Suite system.

Fiori apps are created using HTML5 and SAPUI5. For some extensions, the
underlying jQuery JavaScript library may be used. All supported form factors and
operating systems are supported with one development project and a single code
line per user interface app.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 89
ER160208-CCS-EN-01
Chapter 10 Integrating Archiving and Document Access for SAP Solutions into SAPUI5 or
SAP Fiori apps

10.2 Integration of OpenText products


SAP Fiori integrations are, for example, available for the following products:

• OpenText™ Extended ECM for SAP® Solutions


For more information, see OpenText Extended ECM for SAP Solutions - Customizing
Guide (ERLK-CGD).
• OpenText™ Archiving and Document Access for SAP Solutions
Described in this guide.
• OpenText™ Business Center for SAP® Solutions
For more information, see OpenText Business Center for SAP Solutions -
Configuration Guide (BOCP-CGD).
• OpenText™ Document Presentment Live for SAP® Solutions
For more information, see “Customizing the integration of OpenText™
Document Presentment Live for SAP® Solutions” on page 122 and section 5
“Integrating Document Presentment Live into SAP Fiori ” in OpenText Document
Presentment Live for SAP Solutions - Customizing Guide (CCMSAPL-CGD).

As a user of OpenText Extended ECM for SAP Solutions and Archiving and
Document Access for SAP Solutions, you are entitled to use the framework of
OpenText Business Center for SAP Solutions, with which you can build custom Fiori
apps to browse for business objects. This collection of ABAP Add-Ons provided by
OpenText Business Center for SAP Solutions is called OpenText Fiori Business
Object Browsing Enabler for SAP Solutions.

Additional resources

• Release notes for Archiving and Document Access for SAP Solutions (https://
knowledge.opentext.com/knowledge/llisapi.dll/Overview/67835278): list of
required Add-Ons and versions, basic steps for building a custom Fiori app for
business object browsing.
• OpenText Business Center for SAP Solutions - Configuration Guide (BOCP-CGD):
detailed information about the Fiori app framework.

90 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
10.2. Integration of OpenText products

10.2.1 Archiving and Document Access for SAP Solutions in


SAP Fiori
Archiving and Document Access for SAP Solutions integrates into the different
layers of SAP Fiori:

• Base functionality for Archiving and Document Access for SAP Solutions in the
backend
• Specific OData services as extension of the Gateway layer in the backend
• SAPUI5 integration for ArchiveLink PLUS functionality in the frontend, which
means a list a business documents
• Test application OpenText Test Launcher in the frontend
• Integration into existing SAP Fiori apps, for example Track Sales Order as
described in the solution accelerator

Figure 10-1: SAP Fiori Integration for Document Access

10.2.1.1 Relevant packages for integration


The following packages are relevant for the integration and must be installed in the
according systems. After you have installed the packages, you can start to integrate
the functionality in your application.

Table 10-1: Relevant Packages for SAP Fiori (Document Access)

Package Add-on Package Functionality System


/OTX/ALDS_BASE OTEXBAS Base functionality ERP (CRM, SRM, S/
4HANA) Backend

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 91
ER160208-CCS-EN-01
Chapter 10 Integrating Archiving and Document Access for SAP Solutions into SAPUI5 or
SAP Fiori apps

Package Add-on Package Functionality System


/OTX/RM_AL OTEXRL (Extended Optional Extended ERP (CRM, SRM, S/
ECM) ECM functionality, to 4HANA) Backend
get the Records
Management status
of ArchiveLink
documents
/OTX/ALDS_ODATA OTEXTBASO OData services, ERP (CRM, SRM, S/
extension of the 4HANA) Backend
Gateway layer
If the backend does
not support OData
services (no
component IW_BEP
or SAP_GWFND
installed), the OData
services are installed
on the frontend
system.
/OTX/ALF_UI OTEXBASF ArchiveLink PLUS Central Hub/
component Gateway Frontend
/OTX/ALF_UI4BC OTEXBASF ArchiveLink PLUS Central Hub/
Business Documents Gateway Frontend
for Business Center
/OTX/ OTEXBASF Test application Central Hub/
RMF_LAUNCH Gateway Frontend
/OTEB/BC_MAIN OTEXBASB Add-on for Business ERP (CRM, SRM, S/
object browsing. 4HANA) Backend
Requires Business
Center Add-ons.

10.2.2 Archiving and Document Access for SAP Solutions and


OpenText Business Center for SAP Solutions
Document Access customers can create custom Fiori apps with the framework of
OpenText Business Center. A Fiori app built on top of the Business Center
framework is then the leading application. The Business Center framework is also
called business object browsing enabler.

The picture how Archiving and Document Access for SAP Solutions integrates into
the different layers of SAP Fiori, then looks as follows:

92 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
10.2. Integration of OpenText products

• SAP Gateway layer

– ArchiveLink PLUS functionality for business documents integrated in the


custom SAP Fiori app built with the Business Center framework. This is also
called “business object browsing app” or “business object browser”.
• Backend layer

– Base functionality for Archiving and Document Access for SAP Solutions
including the optional Add-On OTEXBASB.
– Specific OData services as extension of the gateway layer
– Business Center foundation and customizations for the Fiori custom app

10.2.2.1 Packages for integration


The following packages are relevant for the integration and must be installed in the
according systems. After you have installed the packages, you can start to integrate
the functionality in your application.

Table 10-2: Relevant Packages for SAP Fiori (Document Access)

Package Add-on Package Functionality System


/OTX/ALDS_BASE OTEXBAS Base functionality ERP (CRM, SRM, S/
4HANA) Backend
/OTX/RM_AL OTEXRL (Extended Optional Extended ERP (CRM, SRM, S/
ECM) ECM functionality, to 4HANA) Backend
get the Records
Management status
of ArchiveLink
documents

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 93
ER160208-CCS-EN-01
Chapter 10 Integrating Archiving and Document Access for SAP Solutions into SAPUI5 or
SAP Fiori apps

Package Add-on Package Functionality System


/OTX/ALDS_ODATA OTEXTBASO OData services, ERP (CRM, SRM, S/
extension of the 4HANA) Backend
Gateway layer
If the backend does
not support OData
services (no
component IW_BEP
or SAP_GWFND
installed), the OData
services are installed
on the frontend
system.
/OTX/ALF_UI OTEXBASF ArchiveLink PLUS Central Hub/
component Gateway Frontend
/OTX/ALF_UI4BC OTEXBASF ArchiveLink PLUS Central Hub/
Business Documents Gateway Frontend
for Business Center
/OTX/ OTEXBASF Test application Central Hub/
RMF_LAUNCH Gateway Frontend
/OTEB/BC_MAIN OTEXBASB Add-on for Business ERP (CRM, SRM, S/
object browsing. 4HANA) Backend
Requires Business
Center Add-ons.

10.2.2.2 Packages for business object browsing


The following packages are relevant for building a leading custom Fiori app for
business object browsing. For the required versions and support packages, consult
the detailed information in the Release Notes of OpenText Archiving and Document
Access for SAP Solutions.

Table 10-3: Relevant Packages for SAP Fiori

Add-on Package Functionality System


OTBCBAS Business Center Base Backend
functionality
OTBCINB Business Center Inbox Backend
functionality; main inbox
features are not allowed, if
the customer did not buy
Business Center licenses, but
the package is still required
due to technical
dependencies
OTBCFND Business Center Foundation Backend

94 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
10.3. Understanding the customizing for a Fiori integration

Add-on Package Functionality System


OTBCWSR OData services, extension of Backend
the Gateway layer
OTBCWUI Business Center Fiori UI Frontend
component

10.3 Understanding the customizing for a Fiori


integration
The following steps are relevant to enable the Archiving and Document Access for
SAP Solutions functionality in the different systems:

Prerequisites

• You have installed and configured the SAP Fiori system landscape. For more
information about the system landscape, see SAP Help Portal at Setup of SAP
Fiori System Landscape with ABAP Environment (http://help.sap.com/
fiori_bs2013/helpdata/en/ba/f61f533f86ef28e10000000a4450e5/frameset.htm).
• SAPUI5 version as stated in the Release Notes.
• You have done the initial configuration of SAP Gateway.

Important
The connection between the backend system and the frontend system must
be configured as a trusted connection.
• You have set up the SAP Fiori infrastructure.

For more documentation, see the SAP Help Portal at https://help.sap.com:

• Search for SAP Fiori Implementation Information and then open the guide for
your SAP release
• Search for UI Technology Guide for SAP S/4HANAand then open the guide for
your SAP release.

The following steps are relevant to enable the Archiving and Document Access for
SAP Solutions functionality in the different systems:

Table 10-4: Installation and configuration steps in the different systems

Step System Additional information


Basic installation of SAP ERP (backend system) OpenText Archiving and
Archiving and Document Document Access for SAP
Access for SAP Solutions Solutions - Installation and
Upgrade Guide (ER-IGD)

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 95
ER160208-CCS-EN-01
Chapter 10 Integrating Archiving and Document Access for SAP Solutions into SAPUI5 or
SAP Fiori apps

Step System Additional information


Installation of additional SAP ERP (backend system) if Install the Archiving and
Archiving and Document IW_BEP or SAP_GWFND are Document Access for SAP
Access for SAP Solutions installed Solutions OData services on
packages for OData services: the backend only if the other
OTEXBASO OData services are installed
there. If the backend does not
support OData services,
install them on the frontend
system.
Installation of additional SAP Gateway system On the frontend, the basic
Archiving and Document (frontend system) installation of Archiving and
Access for SAP Solutions Document Access for SAP
packages for SAP Fiori: Solutions is not necessary.
OTEXBASF
Setting up the SAP Fiori SAP Gateway system SAP Help Portal https://
Launchpad (frontend system) help.sap.com. Search for
Setting Up the Launchpad
and open the guide for your
SAP release.

For more information, see SAP Help Portal at https://help.sap.com, search for one of
the topics below and open the guide for your SAP release:

• SAP Fiori for SAP Business Suite


• SAP Fiori Launchpad
• SAP Fiori Implementation Information
• UI Technology Guide for SAP S/4HANA

After you have enabled the functionality in general, further steps are necessary to
integrate a specific application.

Retrieving version information


For each application, there is a static version.html that includes the version
number.

To retrieve version information in a browser:

1. In a browser, in the address bar, enter the following

http(s)://<SAP hostname>:<SAP port>/sap/bc/ui5_ui5/otx/<subpath


of Fiori app>/version.html

Example:

http://mucr3d5o.opentext.net:8000/sap/bc/ui5_ui5/otx/RMF_LAUNCH/
version.html

96 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
10.4. Customizing the Fiori Launchpad for OpenText Test Launcher

2. The version number displays in the browser window.

10.4 Customizing the Fiori Launchpad for OpenText


Test Launcher
OpenText Test Launcher /OTX/RMF_LAUNCH is a test application. You can use it to
test the integration of Archiving and Document Access for SAP Solutions in the Fiori
Launchpad. It is contained in the ABAP Add-On OTEXBASF of Archiving and
Document Access for SAP Solutions.

Configuration overview

• The application comes with its OData services. You check if they are available
after installation and activate them if necessary.
• In the Fiori Launchpad, users work with their apps. You configure the Fiori
Launchpad to show the OpenText Test Launcher for relevant users such as
administrators who test the integration. For this, you create a tile catalog and a
tile group.
• The application is displayed in a tile. The tile is configured to show a specific
navigation target with a defined semantic object.
• The PFCG role defines, which users can access a specific tile catalog and tile
group. For the test user, you define a specific role and assign a catalog and a
group to it.

10.4.1 Frontend: Adding the OData services


The OData services are typically installed on the backend system, and you add them
as external services on the frontend system. If the OData services are not added yet,
you add them in the Activate and maintain services transaction.

To add the OData service:

1. Start the Activate and maintain services (/IWFND/MAINT_SERVICE) transaction.

2. Click Add Service.

3. Enter the system alias of your backend system.

4. In the External Service Name field, enter the technical name of the relevant
OData services without the version number. The following services are
relevant: /OTX/ALDS_ODATA_SRV for business documents

5. In the Version field, enter the version number.

6. Click Get Services.

7. Click Add Selected Services.

8. Enter a technical name for the service in your customer namespace.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 97
ER160208-CCS-EN-01
Chapter 10 Integrating Archiving and Document Access for SAP Solutions into SAPUI5 or
SAP Fiori apps

9. Assign a package or click Local Object.

10. Click Execute to save the service.

11. On the Activate and maintain services screen, check if the system alias is
maintained correctly. If not, delete the alias and add the correct one.

10.4.2 Frontend: Activating the ICF services


Check if the relevant services are already activated. If not, activate them.

To activate the ICF service:

1. On the frontend server, start transaction Maintain Services (SICF).


2. Click Execute.
3. Navigate to default_host > sap > bc > ui5_ui5 > otx.

4. Activate the following services:

• alf_doc_ui for the ArchiveLink PLUS Business Document Component


• rmf_launch for the Test Launcher

To activate the service select it and on the menu, click Service/Host > Activate.

10.4.3 Frontend: Configuring navigation


Navigation between launchpad applications is based on abstract representations
(intents) that are resolved to concrete navigation targets.

Each application within the launchpad has a resource locator (URL) by which it can
be loaded. Instead of directly encoding the (technical) name of the target application
into the URL hash, the launchpad performs an indirection by so-called intents.

The intent is resolved to the concrete navigation target by the launchpad target
resolution service. The concrete application targets have to be configured by the
administrator. In this configuration (called target mapping), administrators map the
combination of a semantic object and an action (both defined in the app launcher
tile) to the navigation target by specifying launchpad role and instance as well as
application alias or ID. This allows any link specifying an intent-based URL to

98 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
10.4. Customizing the Fiori Launchpad for OpenText Test Launcher

trigger the correct application assigned to the user. Since target mappings are
assigned to users as part of a catalog, they can be assigned to PFCG roles, while an
intent is independent of a role and can therefore be resolved differently based on the
role of the user that triggers the navigation.

Prerequisites for customizing navigation

• The user who performs the customizing must be assigned the composite role
SAP_UI2_ADMIN or its related sub roles, and the SAP_UI2_USER_700 role.

Table 10-5 list all values that are needed in different configuration contexts. Define
meaningful values and make a note of them as you need them later in the process.

Table 10-5: Sample Values for Navigation

Object Action or Tool Value Needed later for


Semantic object SAP Netweaver > UI For example Defining target
Technologies > SAP ZZXECM_SO mapping, defining
Fiori > Adding Apps the tile
to SAP Fiori
Launchpad > Define
Semantic Objects
Catalog Launchpad Designer Extended ECM Defining the PFCG
> Catalog > Add Catalog, role
catalog XECM_TEST_CAT
Tile Launchpad Designer Title: OpenText Defining the group
> Catalog > Tiles > Test Launcher
Create
Group Launchpad Designer Extended ECM Defining the PFCG
> Add Group Group, role
XECM_TEST_GROUP

10.4.3.1 Defining a semantic object


The semantic object is used later when you configure the target mapping for the tile
catalog.

To define a semantic object:

1. Start the /UI2/SEMOBJ transaction.

2. Click New Entries and add a semantic object, for example ZZXECM_SO.

3. Enter a semantic object name and a semantic object description.

4. Click Save.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 99
ER160208-CCS-EN-01
Chapter 10 Integrating Archiving and Document Access for SAP Solutions into SAPUI5 or
SAP Fiori apps

10.4.3.2 Defining catalogs, target mapping, groups and tiles


In the SAP Fiori Launchpad Designer, you define the following:

• A catalog that contains target mapping, groups and tiles. Later, you assign the
catalog to the PFCG role.
• A target mapping for the catalog. For each application you define an intent
(semantic object) and a target (defined by the launchpad).
• A tile for each of your apps, for example the OpenText Test Launcher.
• A group within the catalog. Later, you assign the group to the PFCG role.
You can add tiles to the group.

To start the Launchpad Designer:

• Start the /UI2/FLPD_CONF (cross-client) or /UI2/FLPD_CUST (client-specific)


transaction.

Note: Maintain catalogs and groups either only in current client or only
across clients. Maintaining catalogs and groups mixed in current client
and across clients can lead to inconsistencies.

To create a catalog:

1. In the Launchpad Designer, on the Catalogs tab, in the footer, click + Add.

2. Add a title, for example Extended ECM Test, and an ID, for example
XECM_TEST_CAT.

3. Click Save.

To define target mapping:

1. In the new catalog, click Target Mapping.

2. In the footer, click Create Target Mapping.

100 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
10.4. Customizing the Fiori Launchpad for OpenText Test Launcher

3. Define the following in the Intent section:

• Semantic Object: Enter the ID of the semantic object that you defined
previously, for example ZZXECM_SO
• Action: Define a unique name in the context of the semantic object, for
example launcher.

4. Define the following in the Target section:

• Select SAPUI5 Fiori App.


• Title: for example OpenText Test Launcher
• URL: /sap/bc/ui5_ui5/otx/rmf_launch
• Component: otx.ecmlink.launcher

To create a tile:

1. In the catalog, click Tiles to open the list of tiles.

2. In the footer, click Create

3. Enter at least the following:

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 101
ER160208-CCS-EN-01
Chapter 10 Integrating Archiving and Document Access for SAP Solutions into SAPUI5 or
SAP Fiori apps

• Title and Subtitle: Enter the titles of the tile that are displayed for the user.
• Icon: Specify an icon that is displayed in the tile.
• Use semantic object navigation: Select.
• Semantic Object: Enter the ID of the semantic object that you defined
previously, for example ZZXECM_SO
• Action: Define a unique name in the context of the semantic object, for
example launcher.
4. Click Save.
5. Click the Back arrow to return to the catalog.

To create a group:

1. In the Launchpad Designer, on the Groups tab, in the footer, click + Add.
2. Define the following:

• ID: Enter an ID, for example XECM_TEST_GROUP. You use this ID later when
defining the PFCG role.
• Title: For example OpenText Test Group
3. Click Save.
4. To add tiles to the group, click + Add Tile
5. Click the search icon. In the window, enter the title of the tile that you defined
before, for example OpenText Test Launcher and filter the list for it.
6. The catalog list displays all catalogs that contain the tile. Click the catalog.
7. In the list of contained tiles, select the tile that you want to add, for example
OpenText Test Launcher.
8. Click the Back arrow to return to the group.

10.4.4 Frontend: Configuring access


To grant the users access to the application, you create a new single role and do the
following:

• Add the catalog and group that you created before to the role menu.
• Add Start authorizations for the OData services
• Assign users to the role.

After creating the role you assign it to the users.

To create a role for the Test Launcher:

1. Start the PFCG transaction.

102 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
10.4. Customizing the Fiori Launchpad for OpenText Test Launcher

2. Create a new single role and open the Menu tab.

3. On the Menu tab, open the menu of the button for adding objects (probably
labeled Transaction), and click SAP Fiori Tile Catalog. Select or enter the
following:

• Catalog Provider: Fiori Launchpad Catalogs

• Catalog ID: ID of the group created before, for example XECM_TEST_CAT

4. On the Menu tab, open the menu of the button for adding objects and click SAP
Fiori Tile Group.

5. In the Assign Group window, enter the following:

• Group ID: ID of the group created before, for example XECM_TEST_GROUP

6. On the Menu tab, open the menu of the button for adding objects and click
Authorization Default.

7. In the Service window, in the Authorization Default list, click Tadir Service.
Specify the following values:

• Program ID: R3TR

• Object Type: IWSG

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 103
ER160208-CCS-EN-01
Chapter 10 Integrating Archiving and Document Access for SAP Solutions into SAPUI5 or
SAP Fiori apps

8. In the table, enter the name of the OData service you have activated. Enter the
name as follows: technical name_<four-digit version number with leading
zeros>:
Service for business documents: ZALDS_ODATA_SRV_0001.

9. On the User tab, assign the role containing the catalogs, groups, and OData start
authorizations to a user by specifying the user ID.
Thereby, the user has UI access to the apps in the catalogs and the start
authorizations for the respective OData services on the frontend server.

10. On the Authorization tab, click the button next to Profile Name to generate the
authorization profile for the role.

11. Click Change Authorization Data, and then Generate.

10.5 Creating your own extension of an SAP Fiori app


One way to integrate the Archiving and Document Access for SAP Solutions
functionality is to create an application that requires no modifications in the SAP-
delivered standard application.

A typical SAP-delivered standard application consists of bootstrap files, views, view


controllers, and internationalization files. A custom application extends an SAP-
delivered standard application and consists of the bootstrap file Component.js,
which extends the Component.js of the SAP standard application,
internationalization file, view fragments, views, and view controllers.

Resources

For more information, see the following resources:

• SAP help: Extending SAPUI5 apps (https://sapui5.hana.ondemand.com/#/topic/


a264a9abf98d4caabbf9b027bc1005d8)
• Extended ECM for SAP Solutions SDK Guide in OpenText My Support (https://
knowledge.opentext.com/knowledge/cs.dll/Open/63007681).
• The related solution accelerator “Integrating Extended ECM in the SAP Fiori
App Track Sales Orders” provides sample custom applications that integrates
Archiving and Document Access for SAP Solutions functionality, for example
into the Track Sales Order app. You can download the solution accelerator from
OpenText My Support (https://knowledge.opentext.com/knowledge/llisapi.dll/
Open/62692551).

The Fiori-related solution accelerator “Integrating Extended ECM in the SAP Fiori
App Track Sales Orders” provides sample custom applications that integrates the
Archiving and Document Access for SAP Solutions functionality, for example into
the Track Sales Order app. When you create your own extension, review this
solutions accelerator. You can download the solution accelerator from OpenText My
Support (https://knowledge.opentext.com/knowledge/llisapi.dll/Open/62692551).

104 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
10.5. Creating your own extension of an SAP Fiori app

Prerequisites

• You have development tools installed:

– SAP Web IDE cloud edition: https://cloudplatform.sap.com/capabilities/


product-info.SAP-Web-IDE.9e5c9d90-e8e0-4e82-aed2-09087a10c973.html
– Offline tools: https://tools.hana.ondemand.com/#sapui5
• You have installed the following development tools: ABAP Development Tools
for SAP NetWeaver, SAPUI5 Application Development Tool for Eclipse.
• SAPUI5 version as stated in the Release Notes
• For offline development, ensure the local Tomcat web server is configured to
work with SAPUI5 Eclipse.
• You have installed the relevant Archiving and Document Access for SAP
Solutions Add-on packages for Fiori integration and customized the system for
the SAP Fiori integration.

For offline development, the main steps are:

• Download the SAP-delivered standard application from the ABAP system.


• Test the SAP-delivered standard application in your local Launchpad sandbox
environment.
• Create a custom application that extends an SAP-delivered standard application.
• Check the SAP-enabled extension options.
• Define the extensions metadata.
• Test the custom application in your local Launchpad sandbox environment.
• Upload the custom application to the ABAP system.
• Test the custom application on the ABAP system.
• Configure the custom application on Fiori Launchpad.
• Test the custom application on Fiori Launchpad.

For more information, search for UI Extensibility Workflow at https://help.sap.com.

After all steps to extend an SAP-delivered standard application were done


successfully, you see a custom tile on the SAP Fiori Launchpad.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 105
ER160208-CCS-EN-01
Chapter 10 Integrating Archiving and Document Access for SAP Solutions into SAPUI5 or
SAP Fiori apps

10.6 Extending your own SAPUI5 app


If you wanted to create your own SAPUI5 app, you basically have the following
options:

• App built with SAP Fiori Elements: check https://sapui5.hana.ondemand.com/#/


topic/358cf2598d71462b8ac2bd8c944efbfd
Change to your SAPUI5 version to make sure, the technique is already
supported.
• App, which you “freely” implemented with SAPUI5.

– If you want your original app unchanged, use the extension techniques as
already mentioned in previous section. This means you create a new custom
app that integrates the business documents UI control of OpenText Archiving
and Document Access for SAP Solutions.
– Alternatively, you directly insert the code into your original application to
integrate the business documents UI control of OpenText Archiving and
Document Access for SAP Solutions.

10.7 Creating your own Fiori app for business object


browsing
By allowing customers to use the framework of Business Center to define own
custom apps, there is another powerful yet simple way to integrate Archiving and
Document Access for SAP Solutions functionality into the landscape.

Read the usage restrictions listed in the Release Notes of OpenText Archiving and
Document Access for SAP Solutions. Always follow supported customizing options
and enhancements as described in OpenText Business Center for SAP Solutions -
Configuration Guide (BOCP-CGD).

Additional resources

• Release notes for Archiving and Document Access for SAP Solutions (https://
knowledge.opentext.com/knowledge/llisapi.dll/Overview/67835278): list of
required Add-Ons and versions, basic steps for building a custom Fiori app for
business object browsing.
• OpenText Business Center for SAP Solutions - Configuration Guide (BOCP-CGD):
detailed information about the Fiori app framework.

Prerequisites

See the Release Notes for the latest supported or recommended versions.

• SAPUI5 plug-ins
• Archiving and Document Access for SAP Solutions Add-on packages for
integration are installed and properly configured

106 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
10.7. Creating your own Fiori app for business object browsing

• You customized the system for the SAP Fiori integration


• You have installed the relevant OpenText Business Center for SAP Solutions
add-on packages for Fiori integration
• You have installed the OTEXBASB add-on package.
• On the SAP frontend, the Fiori apps of Document Access, Extended ECM and
Business Center are active. The OData services of these products are also
registered. Trusted system connections and system aliases to SAP backend
systems are also defined.

License restrictions

The license for Archiving and Document Access for SAP Solutions includes a subset
of the OpenText Business Center for SAP Solutions functionality. With the
installation of the OTEXTBAS add-on package, you see all transaction required for
Business Object Browsing in the IMG branch of OpenText Archiving and Document
Access for SAP Solutions. If you have sufficient licenses, you can also access the
Business Center configuration with transaction /OTX/PF00_IMG.

• General Settings
• Workplace Configuration
• Add-In Customizing
• Fiori App Customizing (called Web Services in Business Center configuration)

Basic information

• In OpenText Archiving and Document Access > Business Object Browsing >
General Settings > Logical Systems you must have an entry with Logical
system = LOCAL. For more information, see Section 3.2 “Configuring logical
systems” in OpenText Business Center for SAP Solutions - Configuration Guide
(BOCP-CGD).
• The Business Center Fiori framework provides the specific Fiori task app /sap/
bc/ui5_ui5/otbcwui/pf07_bc_ui_03, which renders the pattern of a Master-
Detail app. For more information about the Master-Detail app, see SAP Fiori
Design Guidelines ( https://experience.sap.com/fiori-design-web/v1-30/master-
detail-app/).
The following URL parameters determine which data records and business
objects are displayed:

– Work object type wobjType is an abstraction of the business object and how it
is displayed
– Node nodeId is an abstraction of an item to navigate to usually an business
object instance or a list of instances of a specific business object
– Work center or Workplace workplaceId is an abstraction for navigation to
group access to several nodes which are related to each other

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 107
ER160208-CCS-EN-01
Chapter 10 Integrating Archiving and Document Access for SAP Solutions into SAPUI5 or
SAP Fiori apps

10.7.1 Understanding authorizations


The following authorization objects are used by the Business Center framework by
default. You can view them with the PFCG transaction.

• J_6NPF_NAV restricts users to specific work centers and thus to specific nodes
assigned to those work centers. The value of the authorization object is the Work
Center ID.
• J_6NPF_WTY restricts permissions to specific actions on specific nodes and work
objects.

Sample authorization role

• If you must restrict access to your business data, for example to table KNA1, you
use the code enhancements as described in the BC configuration guide.
• In the Menu tab, you must have TADIR Services

R3TR IWSV /OTX/RM_WSC_ODATA_SRV 0001


Relates to the OData Service for the Fiori
control for business workspaces of
Extended ECM.
R3TR IWSV /OTX/ALDS_ODATA_SRV 0001
R3TR IWSV /OTX/PF05_DATA 0003

The following authorization objects are used

• S_RFC : Activity=16; RFC_NAME=/IWBEP/FGR_MGW_CLIENT_IF, SYST*;


RFC_TYPE=FUGR
• S_RFCACL: ACTVT=16; RFC_EQUSER=Y; all other values = * or a more
restricted value, if necessary
• S_SERVICE: results from values in Menu tab
• J_6NPF_NAV: contains ID of workplace
• J_6NPF_WTY: contains IDs of work object types and node IDs

Depending on what the user shall be able to see in ArchiveLink the related
permissions must also be assigned.

108 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
10.7. Creating your own Fiori app for business object browsing

10.7.2 Customizing the SAP backend system


Customizing the SAP backend system for the use of Business Center involves the
following steps, which you all perform in the SPRO transaction.

• “Preparing the data and navigation structure for the app”

– Define a work object type


– Define where data is retrieved from
– Define the navigation structure and the nodes it consists of
– Define work centers
– Set the web item handler class
• “Using the perspective template _OTEB_BC_TEMPLATE_01 for the app
layout”
Create the perspective, which is the layout of the app. You can use our template
as basis. If you want to create a perspective without template, see “Alternative:
Creating a perspective without template” on page 116.
• “Adapting the perspective and creating the data binding”

– Change the work center name, which is displayed to the user


– Create a perspective ID for each pair of node ID and work object type
– Place the nodes in the work center
– Create a data binding to fill variables in a perspective with data from the
business object
– Define, which properties you want to display in the detail section of an item.
– Change the perspective labels and texts

10.7.2.1 Preparing the data and navigation structure for the app
1. Start the SPRO transaction and navigate to OpenText Archiving and Document
Access > Business Object Browsing.

2. Work object type


Define the selection, display, and processing of work objects:

a. Go to Workplace Configuration > Work object types > Work object types.
b. Define a work object type, for example work object type OTX_EX_CUST01.
c. Set at least a handler class, similar to the default handler class /OTX/
PF03_CL_DATA_HANDLER_DYN.
d. Define a display structure and a data selection structure. In the simplest
case it is a database table, for example KNA1.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 109
ER160208-CCS-EN-01
Chapter 10 Integrating Archiving and Document Access for SAP Solutions into SAPUI5 or
SAP Fiori apps

3. Data selection
Define the table and the field from which the data is taken:

a. Go to Workplace Configuration > Work object types > Dynamic data


selection.
b. For each work object type, define the following:

• Table, for example KNA1.


• Table Field, for example KNA1 - KUNNR, KNA1 - NAME1, which you are
expecting to use at runtime.

110 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
10.7. Creating your own Fiori app for business object browsing

4. Nodes
Define the nodes that you use in a navigation structure:

a. Go to Workplace Configuration> Navigation> Nodes.


b. Create at least one active node, which is related to the work object type
defined before, for example OTX_ALCUST_NODE for the work object type
OTX_EX_CUST01.
c. Under this node, in the Order by branch, define at least one entry to have a
default sorting
5. Navigation structure
Define the order of nodes within a structure:

a. Go to Workplace Configuration > Navigation > Navigation structure.


b. Create a navigation structure, for example COCKPIT_OTX_EX01. Node levels
are not required, because they are not used in the Fiori UI. This navigation
structure is only a reference in the next configuration.
6. Work center
Define the work center that can be selected in the navigation bar.:

a. In the Business Center configuration, go to OpenText Business Center for


SAP Solutions> Workplace Configuration> Navigation> Work Center.
b. Define at least one work center, for example OTX_EX01_WP, under which
you want to group your apps.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 111
ER160208-CCS-EN-01
Chapter 10 Integrating Archiving and Document Access for SAP Solutions into SAPUI5 or
SAP Fiori apps

7. Web item handler class


Define a web item handler class for the work object type:

a. Go to Web Services > Work Object Types > Work Object Types.
b. Define a web item handler class for your work object type, for example /
OTX/CL_AL_EX_BOBCUST_ITEM for the work object type OTX_EX_CUST01.
Such a class must implement the interface /OTX/PF62_IF_ITEM_HANDLER.
For more information, see Section 8.12.2.28
“CHANGE_RELATED_BUS_OBJECT” in OpenText Business Center for SAP
Solutions - Configuration Guide (BOCP-CGD).
Do not implement methods, which are indicated as OBSOLETE or NOT
RELEASED.
c. Set a Key definition for the work object type, for example KUNNR at field
position 1.
d. Define the Related business object, for example Object Type = KNA1 and
Field List (Key) = KUNNR, because at runtime this information is
conveyed from the Business Center app to the Fiori controls of Archiving
and Document Access for SAP Solutions.

If you want to use this layout template, continue with “Using the perspective
template _OTEB_BC_TEMPLATE_01 for the app layout” on page 113.

112 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
10.7. Creating your own Fiori app for business object browsing

If you do not want to use this layout, “Alternative: Creating a perspective without
template” on page 116.

10.7.2.2 Using the perspective template _OTEB_BC_TEMPLATE_01 for


the app layout
OpenText Archiving and Document Access for SAP Solutions provides a layout
template _OTEB_BC_TEMPLATE_01, which you can use to create new perspectives
for business object browsing.

Layout template OpenText Archiving and Document Access for SAP Solutions provides a layout
template _OTEB_BC_TEMPLATE_01, which you can use to create new perspectives
for business object browsing.

Prerequisites

• The user who does the customizing needs authorizations to use the perspective
editor. For more information, see Section 8.3 “Editing perspectives and layouts”
in OpenText Business Center for SAP Solutions - Configuration Guide (BOCP-CGD).
• If you installed the transport Administration – /OTBCWUI/PF07_BC_ADMIN –
Perspective Manager as suggested by the Business Center documentation, there
is a catalog and group named Business Center Administration with a tile named
Maintain PerspectivesBusiness Center Administration. Maintain Perspectives,
Perspective Manager, Perspective Editor are synonyms of the same entity of the
Business Center Fiori app.
• The otherwise optional ABAP Add-On OTEXBASB is required on the SAP backend
server, on which the ABAP Add-Ons of Business Center Fiori for SAP Solutions
are installed
• The BC Set /OTEB/BC_TEMPLATE_01 must be activated on the client of the SAP
backend server. For more information, see Section 8 “Installing the solution
framework for Fiori business object browsing” in OpenText Archiving and
Document Access for SAP Solutions - Installation and Upgrade Guide (ER-IGD).
• All steps in “Preparing the data and navigation structure for the app”
on page 109must be performed successfully.

Tips on using the template

• The layout ID is _OTEB_BC_TEMPLATE_01. Do not change the ID.


• The BC Set /OTEB/BC_TEMPLATE_01 provides perspective texts in English
language assigned to the layout for text keys DOCUMENTS, INFO, RELATED
and WORKSPACE. Translations in further languages will be provided by
language packages. Texts are copied to a new item perspective at creation time.
This means, that translations installed later are only available for the
_OTEB_BC_TEMPLATE_01 layout and perspectives created thereafter.

• Create a perspective based on layout _OTEB_BC_TEMPLATE_01 as your base


perspective.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 113
ER160208-CCS-EN-01
Chapter 10 Integrating Archiving and Document Access for SAP Solutions into SAPUI5 or
SAP Fiori apps

• Modify general things, which you repeatedly require Fiori in this base
perspective.

• Localized perspective texts are specific to each perspective. Therefore, if you


repeatedly use localized texts, define and translate them as soon as possible in
your base perspective before you create other perspectives.

• Create your productive perspectives from that base perspective.

• If _OTEB_BC_TEMPLATE_01 will be changed or other sample layouts or templates


will be delivered later, your already created perspectives will not change.

• The layout _OTEB_BC_TEMPLATE_01 was created for property binding. This


means that the content of one field (column) of the work object type’s display
structure is bound to the value of one property. If you need to have dynamic,
concatenated texts, consider one of the following ways:

– Using Selection Exit – Define a display structure to be used in the work


object type. For each property you want to bind you need to have a column,
which delivers the value at runtime. Also define the Selection Exit in the work
object type customizing. For more information, see Section 7.1.1 “Defining
work object types” in OpenText Business Center for SAP Solutions -
Configuration Guide (BOCP-CGD).
The exit is an ABAP object class implementing the /OTX/
PF03_IF_CHANGE_SELECT interface. In the implemented code of method
CHANGE_SELECTION_RESULT you change the entries of parameter PCT_DATA. If
you need line breaks, use class constant CL_ABAP_CHAR_UTILITIES=>CR_LF .

– Using perspective editor and SAPUI5 – Using perspective editor and


SAPUI5 does not mean, that you do not use custom exits at all. It rather
suggests that you could insert more SAPUI5 controls as Layout containers
into the tree of your perspective. For example, several sap.m.Text controls,
which are assembling the concatenated text, and you have one control for
each column of the display structure. For this approach you need more
practice in using SAPUI5 controls and this may break the layout more easily,
if you insert new controls at the wrong places of the perspective tree.

To create the perspective based on the layout template


_OTEB_BC_TEMPLATE_01:

1. Use the SE09 transaction to create a customizing transport request. You will
need it when editing perspectives and perspective view bindings.

2. Start the Fiori Launchpad and click the Perspectives Maintenance tile. On the
start page of the Perspective Editor, you have access to all available perspectives
and layouts.

3. Check the available layouts


To see if the layout template _OTEB_BC_TEMPLATE_01 is available, click Layouts.

114 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
10.7. Creating your own Fiori app for business object browsing

Note: Do not change this layout. In future support packages this layout
may be changed without further notice.

Click All Perspectives and proceed with the next step.


4. Create a new perspective

a. At the very bottom of the page, click Create Perspective.


b. Select the customizing request that you created for this.
c. In step 1. Choose a creation approach, select Layout
d. In step 2. Specify parameters, enter the following:

• Perspective Type: Item


• Perspective ID: Enter the ID of the new perspective.
• Root Work Object Type: Use the search help to select a valid work
object type, which you defined beforehand in the Business Center
customizing on the backend server.
• Select Layout: Select the layout with the help of the search help. Select
layout with _OTEB_BC_TEMPLATE_01.
• Enter a description to make it easier for you to recognize the purpose of
the perspective and app.
e. Click Create.
The perspective is created.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 115
ER160208-CCS-EN-01
Chapter 10 Integrating Archiving and Document Access for SAP Solutions into SAPUI5 or
SAP Fiori apps

5. You can now adapt it if you want to. For more information, see Section 8.3
“Editing perspectives and layouts” in OpenText Business Center for SAP Solutions
- Configuration Guide (BOCP-CGD) and a document about the template’s details
in OTDN (https://knowledge.opentext.com/knowledge/llisapi.dll/Open/
63009526).

10.7.2.3 Alternative: Creating a perspective without template


If you do not want to use the template, you can create your perspective starting from
scratch.

1. Item type perspective


Create an item type perspective for the layout of your Fiori app:

a. Click the Perspective Maintenance tile on the Launchpad to start the


Perspective Editor.
b. On the start page of the Perspective Editor, you have access to all available
perspectives and layouts. Click Create Perspective on the toolbar at the
bottom of the page.
c. In the Create Perspective dialog box, create a perspective, using the
following parameters:

• Perspective ID: Enter, for example, OTX_RM_BOB_ITEM_CUSTOMER


• Perspective Type: Select Item from the list.
• Perspective Template: Choose, for example Existing Perspective from
the list.
• Select Perspective: Click in the field to open the Select Perspective
dialog box and choose a perspective from the list, for example
PF31_DEFAULT_ITEM.
• Enter description: Enter a description.
d. Click Create.

2. Perspective View
The detail page of a perspective or layout enables you to perform all actions to
configure the perspective to your needs. For more information about
Perspectives, also see Section 8.3 “Editing perspectives and layouts” in OpenText
Business Center for SAP Solutions - Configuration Guide (BOCP-CGD).

Example: [ot_bc_app_namespace].view.item.ItemHeaderAttrStats: item


header, for which the data binding is maintained. To maintain the data binding, in the
Business Center configuration go to Web Services > Workplace > Nodes. In the
following dialog structure go to Nodes> Master List - Data Binding.
[ot_bc_app_namespace].view.item.AttributeList: renders a list of attributes,
which can be used for details. To maintain it, in the Business Center configuration got to
Web Services > Perspectives > Data Binding. In the following dialog structure go to
Perspective> Attributes List View.

116 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
10.7. Creating your own Fiori app for business object browsing

Further perspective views may be the areas in which you can open a business workspace
control (BSP application /OTX/RMF_BWS4BC_02) and business documents control (BSP
application /OTX/ALF_DOCS4BC_02).

Create perspective views for this perspective:

a. To make perspective views of OpenText Archiving and Document Access


for SAP Solutions available on the detail page of a perspective, right-click
on the node Views. Select and execute the function Add Module Views. In
the following pop-up window, enter the name of the BSP application, for
example /OTX/RMF_BWS4BC_02 or /OTX/ALF_DOCS4BC_02. Then click OK.
The related item views are added under the node Views.
b. In the list under the node Views, you may then find the following views:

• otx.alplus.doc4otbcwui02.view.item.BusinessDocuments:
renders the list of business documents. A click on a document opens it
in an overlay over the existing web page.
• otx.alplus.doc4otbcwui02.view.item.BusinessDocumentsSplit:
use together with view DocumentDisplay. It renders the list of business
documents. A click on a document opens the document display in the
view DocumentDisplay.
• otx.alplus.doc4otbcwui02.view.item.DocumentDisplay: use
together with BusinessDocumentsSplit. Displays opened documents.
• otx.ecmlink.bws4otbcwui02.view.item.BusinessWorkSpace:
renders the business workspace by opening the integration widget from
Content Server.
c. You can place a view by drag and drop to the tree of the perspective.
d. With the perspective editor, you can adjust the layout of the Fiori app.
Where applicable you are free to choose display texts and icons. At text
fields with globe icon, you can define a text ID in upper case and angle
brackets. These are maintained in configuration OpenText Business Center
for SAP Solutions > Fiori App Customizing > Perspectives > Perspective
Texts. For more information, see the BC configuration guide and the ECM
for SAP Solutions – SDK and API documentation (https://
knowledge.opentext.com/knowledge/llisapi.dll/Open/68222307).

10.7.2.4 Adapting the perspective and creating the data binding


1. Work center name
Define the name of your work center that is displayed to the users:

a. In the Business Center configuration, go to OpenText Archiving and


Document Access > Business Object Browsing > Fiori App Customizing >
Workplace > Work Center.
b. Enter a display text for your work center.
2. Perspective ID
For each pair of node ID and work object type define a perspective ID:

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 117
ER160208-CCS-EN-01
Chapter 10 Integrating Archiving and Document Access for SAP Solutions into SAPUI5 or
SAP Fiori apps

a. In the Business Center configuration, go to OpenText Archiving and


Document Access > Business Object Browsing > Fiori App Customizing >
Workplace > Work Center.
b. Create a mapping of node ID, work object and perspective.
c. You can also define other properties like node description or pagination
sizes. You also can define an exit class to enhance the node. For more
information, see the BC configuration guide.
d. In the sub nodes Search fields, Sort fields and Filter fields, define the table
columns that you want to use in the app for searching, sorting or filtering.
e. In the sub node Master List – Data Binding, define the display texts of each
item in the master list.
3. Nodes in work center
Place the nodes on the work center.

a. In the Business Center configuration, go to OpenText Archiving and


Document Access > Business Object Browsing > Fiori App Customizing >
Workplace > Assignment of Nodes to Work Center.
b. Create an entry for each assignment of work center, node ID and work
object type, for example OTX_EX01_WP – OTX_ALCUST_NODE –
OTX_EX_CUST01.
The Node position is currently not used in Fiori UI.
4. Data binding
Define the data binding of a perspective in the Fiori app. For more information,
see Section 8.8 “Input helps” in OpenText Business Center for SAP Solutions -
Configuration Guide (BOCP-CGD):
Define the data binding of a perspective in the Fiori app.
For more information, see sections see the following:

• Section 8.7 “Configuring the data binding of perspectives” in OpenText


Business Center for SAP Solutions - Configuration Guide (BOCP-CGD)
• Section 8.3.2.1 “Configuring property bindings” in OpenText Business Center
for SAP Solutions - Configuration Guide (BOCP-CGD)
• “Using the perspective template _OTEB_BC_TEMPLATE_01 for the app
layout” on page 113

a. In the Business Center configuration, go to OpenText Archiving and


Document Access > Business Object Browsing > Fiori App Customizing >
Perspective > Data Binding.
b. Instead of the Header View sub node, use a layout as suggested in our
perspective template and use property binding in the perspective editor.
c. Instead of the Attribute List View sub node, use a layout as suggested in
our perspective template, and use property binding in the perspective
editor. You may, however, use the Attribute List View sub node if you
want to use hyperlinks at properties. See the release notes for known issue
of property binding and hyperlinks.

118 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
10.7. Creating your own Fiori app for business object browsing

d. At sub node Table View, you define the content of table views (Advanced
Line Items), that you want to see in the perspective.

5. Perspective texts
Maintain and translate the perspective texts. For more information, see Section
8.3.3 “Maintaining perspective texts” in OpenText Business Center for SAP
Solutions - Configuration Guide (BOCP-CGD):

a. In the Business Center configuration, go to OpenText Archiving and


Document Access > Business Object Browsing > Fiori App Customizing >
Perspective > Perspective Texts.
b. Select the perspective ID, for example OTX_AL_BOB_ITEM_CUSTOMER.
c. At sub node Texts, you define the texts of every text ID, which is defined in
the perspective. With menu Goto > Translation, each text can be translated
into target languages.

10.7.3 Customizing the SAP frontend system


To customize the SAP frontend for the Business Center integration:

1. Start transaction /UI2/SEMOBJ to define one or more custom semantic objects


for your app navigation, for example OTX_AL_EX_BOB_CUSTOMER to relate
to your business object.

2. Open the Launchpad Designer to define a Fiori catalog for your app navigation.
The Launchpad Designer opens in a browser with the following URL:

https://[sapsystem].example.net:[port]/sap/bc/ui5_ui5/sap/
arsrvc_upb_admn/main.html

3. Create a target mapping for each of your browsing apps. The content consists of
the semantic object, which you defined earlier, and an action.

Semantic Object Action


OTX_AL_EX_BOB_CUSTOMER browseDocumentAccess
OTX_AL_EX_BOB_CUSTOMER browseExtendedECM

Add the following values:

• Application Type: select SAPUI5 Fiori App


• Title: enter a description
• URL: enter /sap/bc/ui5_ui5/otbcwui/pf07_bc_ui_03
• ID: enter ot.approve.requests03

Notes

• OpenText recommends that you add the URL parameters nodeid,


wobjType and workplaceId as mandatory with specific values, for

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 119
ER160208-CCS-EN-01
Chapter 10 Integrating Archiving and Document Access for SAP Solutions into SAPUI5 or
SAP Fiori apps

example OTX_ALCUST_NODE, OTX_EX_CUST01 and OTX_EX01_WP.


By doing so, you prevent that a person, who is allowed to use this target
mapping, can misuse it to call the Business Center Fiori app for a
different configuration.

• Do not forget to set a default value for Parameter system with a valid
system alias, for example OTXADAEXAMPLE, which is delivered by
the customizing of the Fiori solution accelerator.

4. In the same Fiori catalog, define a tile for each target mapping with the URL
parameters according to the target mapping.

5. After you have created or edited your Fiori catalog, use the PFCG transaction to
change or create an authorization role on the SAP frontend system to assign the
Fiori catalog to that role. This is done in the Menu tab as a item of type SAP
Fiori Tile Catalog.

6. The following is the customizing of an example authorizations role.


In Menu tab, you must have TADIR services.
Related to OData services from OpenText:

• R3TR IWSG ZALDS_ODATA_SRV_0001


• R3TR IWSG ZRM_WSC_ODATA_SRV_0001
Relates to the OData Service for the Fiori control for business workspaces of
Extended ECM.
• R3TR IWSG ZPF05_DATA_0003

Related to personalization:

• R3TR IWSG ZINTEROP_0001


• R3TR IWSG ZPAGE_BUILDER_PERS_0001

You also need access to the SAP Fiori Tile Catalog(s) and perhaps also to SAP
Fiori Tile Group, if you want to also have default tile group.
The following authorization objects are used:

• S_SERVICE: prefilled by the entries in Menu tab


• S_TCODE: TCD=SICF
• /IWFND/SRV: Wildcards; or if required more restricted
• /UI2/CHIP: /UI2/CHIP=X-SAP-UI2* ; ACTVT=*
• S_PB_CHIP: ACTVT=03,16; CHIP_NAME=X-SAP-WD-CHIP*

For more information about further frontend basis authorizations, see the SAP
documentation (http://help.sap.com).

120 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
10.8. Customizing for business documents

10.8 Customizing for business documents


When you display the list of business documents in SAP Fiori Launchpad, the app
displays columns for the fields @DESCRIPTION@ and @AR_DATE@.

You can define additional columns for other custom fields.

Note: Depending on the design of the UI the number of custom columns,


which are actually displayed, is restricted. Currently the maximum number of
custom columns used in the Fiori UI is restricted to 10.

Prerequisites You have maintained the attributes storage table and defined external attribute
mapping.

To define a custom column:

1. In the IMG, navigate to the OpenText Archiving and Document Access for
SAP Solutions > ArchiveLink PLUS > Maintain Custom Columns activity and
click Execute.

2. Click New Entries and add a column.

3. Enter the following:

• Object Type: Business object type, for example EQUI.


• Field Name: Name of the field that you want to display in an additional
column.
• Table Name of Storage Table: Name of the table in which the attributes are
stored.
Use the (F4) search help to get a valid combination of field name and table
name. Every attribute field of every storage table used for ArchiveLink
PLUS is valid.
• Column: To define the position of the column, enter a number. Make sure to
use each number only once for each business object type.

4. Click Save.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 121
ER160208-CCS-EN-01
Chapter 10 Integrating Archiving and Document Access for SAP Solutions into SAPUI5 or
SAP Fiori apps

10.9 Customizing the integration of OpenText™


Document Presentment Live for SAP® Solutions
You can integrate Document Presentment Live into a Fiori App from Archiving and
Document Access for SAP Solutions. With this integration, the app provides a
button, with which you can create a new business document with Live Letters Web
UI.

For more information about Document Presentment Live, see Section 5 “Integrating
Document Presentment Live into SAP Fiori ” in OpenText Document Presentment Live
for SAP Solutions - Customizing Guide (CCMSAPL-CGD).

To customize the Document Presentment Live integration:

1. Create a semantic object with the name OTDPADALiveLetter. The name must be
exactly like this, also regarding the cases. For more information about semantic
objects, see “Defining a semantic object” on page 99.

2. Create a target mapping for semantic object OTDPADALiveLetter and the


create action in the Launchpad Designer. Use the following parameters:
Source of Navigation Target: SAPUI5 Fiori App
Title: The title of the target, for example, Live Letters: OpenText Document
Presentment Live Letters
URL: /sap/bc/ui5_ui5/otdpui/roadmap/dp
Component: ot.dp
For more information, see “Defining catalogs, target mapping, groups and tiles”
on page 100.

122 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
10.9. Customizing the integration of OpenText™ Document Presentment Live for SAP®
Solutions

3. Make sure that users have access permissions for the target. For more
information, see “Frontend: Configuring access” on page 102.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 123
ER160208-CCS-EN-01
Part 3
Scenario customizing
Chapter 11
Archiving via the ArchiveLink interface

11.1 Maintaining presettings for storage scenarios


You can assign a document type to a document type group. Then, you determine the
responsible agents for the work item, and select the storage scenarios that you want
to use. The grouping can be workplace-related or application-related. Document
types are grouped to improve clarity on the initial screen of the storage process
Store documents.

To maintain presettings for storage scenarios:

1. In IMG, run the OpenText Archiving and Document Access for SAP Solutions
> DesktopLink and Archiving for SAP Solutions > ArchiveLink > Maintain
Presettings for Storage Scenarios activity. Alternatively, you can run the
OAWS transaction or the Customizing wizard “Customizing with the
document type customizing wizard ” on page 144.

2. In the Default setting list, you find all existing document type groups.
To create a new Default setting, click New Entries. Enter a technical name and a
description for your new Default setting.

3. To assign a new document type to a Default setting, select a setting and in the
Dialog Structure, double-click Entries. Click New Entries.

4. Enter the following settings:

• Doc. Type: enter the new document type .


• OT: select the required object type, for example, Job, Organizational unit,
User. The object types are defined in SAP HR - Organizational Management.
For more information, see the HR - Organizational Management
documentation.
• Agent ID: enter the appropriate agent ID for the organizational unit. For
example, for the organizational unit US, enter the user Smith.

5. To enable the storage scenarios that can be selected for the document type,
select the corresponding check box.
Only the selected storage scenarios are available for the end user in the Store
documents dialog.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 127
ER160208-CCS-EN-01
Chapter 11 Archiving via the ArchiveLink interface

11.2 Storing print lists


The following prerequisites must be fulfilled to archive print lists successfully (for
details see “SAP basis customizing” on page 47):

• The initial customizing must be fully completed.


• The HTTP connection must be set up.
• A logical archive must be set up in the SAP application and on the OpenText
Archive Center.

No scenario-specific adjustments are required for print list storage.

128 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
11.3. Archiving incoming documents with bar codes

11.3 Archiving incoming documents with bar codes


Table 11-1: Summary: Customizing Late archiving with bar codes

Tasks Where?
SAP system Transactions
1. Creating a sample document type. 1. OAC2
2. Linking a document type. 2. OAC3
3. Setting up barcode entry.
3. OAC5
4. Defining module-specific settings:
4. • OBD5
• FI: Linking the document type with the FI document.
• SD: Linking the document type with the Sales document type. • VNOP
• MM: Activating storage of incoming documents. • SPRO
• HR: Setting barcode entry for the HR info type. • SPRO
Administration Client for Enterprise Scan Archive Modes tab
1. Defining an Archive Mode and a Scan Host entry.
Enterprise Scan Profile >
Configure menu
1. Configuring profiles.

11.3.1 Prerequisites
The following prerequisites must be fulfilled.

• The initial customizing must be fully completed.


• The HTTP connection must be set up.
• An archive (content repository) must be set up in the SAP application and on the
OpenText Archive Center.
• Enterprise Scan must be installed on the workstation.

For more information, see “SAP basis customizing” on page 47.

11.3.2 Steps
Customizing for Late archiving with bar codes comprises the following steps:

• “Creating and linking a document type”


• “Specifying bar code settings for the object type/document type”
• “Activating bar code entry (module-specific)”
• “Setting up archive modes for scanning”
• “Configuring Enterprise Scan”

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 129
ER160208-CCS-EN-01
Chapter 11 Archiving via the ArchiveLink interface

11.3.3 Creating and linking a document type


To create and link a document type:

1. Run the OAC2 transaction

2. Create a global document type (for details see “Maintaining global document
types” on page 81).
Enter the required parameters (example values only):

Doc.type
ZSDIACTINQ

Doc.type
(Description)
Customer request

Doc.class
FAX

3. Run the OAC3 transaction and enter the link (see “Maintaining links”
on page 84).
Enter the required parameters (example values only):

Obj.type
BUS1006

Doc.type
ZSDIACTINQ

Status
X

Cont.Rep.ID
YE

Relationship
TOA01

130 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
11.3. Archiving incoming documents with bar codes

11.3.4 Specifying bar code settings for the object type/


document type
For the Late archiving with bar codes scenario, bar code entry must be activated
for each object type for which bar codes are used. There are additional settings that
enable you to restrict bar code entry to particular document types and/or users, to
check the bar code and to allow the multiple use of a bar code.

1. In the IMG, run the OpenText Archiving and Document Access for SAP
Solutions > DesktopLink and Archiving for SAP Solutions > ArchiveLink >
Activate Bar Code Entry activity. Alternatively, you can use the OAC5
transaction.
The Settings for bar code entry screen appears.
2. To switch to edit mode, click Display → Change.
3. Click New entries.
4. Enter the bar code settings.

Figure 11-1: Bar code settings

Object type
Object type for which bar code entry is to be activated, for example, BKPF or
BUS1006.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 131
ER160208-CCS-EN-01
Chapter 11 Archiving via the ArchiveLink interface

Document type
Optional: Document type for which bar code entry is to be activated, for
example, the test document type ZFIIINVTST or ZSDIACTINQ. If you leave
the field blank, bar code entry is active for all document types linked to the
object type.
User
Optional: Users for whom bar code entry is to be activated. If no user is
entered, bar code entry is active for all users.
BCode type
If you want the bar code to be checked, select the bar code type here. This
selection is used for calculating the check sum.
Bar code active
This option must be activated.
Check is active
When the option is activated, the system uses a check sum to see whether
the numerical bar code value entered is correct. Invalid values are rejected.
Checking is important if the bar code was entered manually.
Note: To be able to use this option, the selected bar code type must
have a check sum.
No cancel
When the option is activated, users must enter a bar code and cannot cancel
the processing. This can lead to a deadlock when the Check is active and the
No cancel options are active and a transaction user enters an invalid bar
code.
Multiple entry
When the option is activated, multiple instances of the bar code can appear
in the table of open bar codes. This allows to assign a stored document to
multiple SAP business objects.
Hold R/3 entry
When the option is activated, after an archived document has been
successfully assigned, the entry created in the SAP system is not deleted
from the SAP table of open bar codes. This allows to assign different
archived documents with the same bar code to an SAP business object.
Hold externally
When the option is activated, after an archived document has been
successfully assigned, the entry created by the Archive Center system is not
deleted from the table of open bar codes. This allows to assign other SAP
business objects to an archived document.

5. Click Save.

No further customizing is required for the SAP CRM module. If the bar code settings
were made for the object/document type (see “Specifying bar code settings for the

132 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
11.3. Archiving incoming documents with bar codes

object type/document type” on page 131), the menu option Create | Enter Bar Code
is available for the business object in the generic object services.

11.3.5 Activating bar code entry (module-specific)


The following steps are required to activate bar code entry in the individual
application modules. This results from the module-specific subdivision of object
types.

11.3.5.1 FI module
The object type BKPF is linked to various different FI document types, for example, the
vendor invoice KR and the customer invoice DR. The user enters the FI document
type at posting; thus, bar code input for FI document types in combination with the
company code must be activated in an additional step.

To assign FI document types:

1. Run the OBD5 transaction.


The Object Types for Early Entry in Financial Acctng screen appears.

2. Click Display → Change to switch to edit mode.

3. Click New entries.

4. Enter the assignment of the document type to FI document type and company
code using the following parameters. This entry represents an unique identifier,
that is only one document type can be assigned to a combination of FI
document type with company code.

CoCd
Company code, for example, 1000. If you leave this field blank, the bar code
entry is active for all company codes and thus for the whole FI module.
Type
FI document type, fore example, KR. If you leave this field blank, the bar
code entry is active for all FI document types and thus for all posting types.
Doc.type
Document type, for example, ZFIIINVTST. The bar code settings for this
document type must be defined in the OAC5 transaction.

5. Click Save.

To test the settings, enter a posting, for example with the FB01 transaction. The bar
code dialog must be displayed.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 133
ER160208-CCS-EN-01
Chapter 11 Archiving via the ArchiveLink interface

11.3.5.2 SD module
Various sales document types are connected with the VBAK object type, for example,
the request for quotation AN and the rush order SO. The user enters the sales
document type when posting it; thus, bar code entry for sales document types must
be activated in an additional step.

To activate bar code entry for sales document types:

1. Run the VNOP transaction.


The Document Types for Late Entry Using Barcode screen appears.

2. To switch to edit mode, click Display → Change.

3. In the +list for the required sales document type (SaTy column), enter the
respective document type in the DocType-Create column.

Figure 11-2: Document types for late entry with barcode

4. Click Save.

To test the settings, enter a posting, for example, with the VA01 transaction. The bar
code dialog must be displayed.

11.3.5.3 HR module
You can structure the HR object types PREL (for employees) and PAPL (for job
applicants) in more detail using info types, subtypes and objects. This enables you to
assign scanned documents exactly. For example, an employee's photo is assigned to
infotype 0002 (personal data), while a child's birth certificate belongs to infotype
0021 (family member/dependents). Many infotypes are further divided into
subtypes, and they can also be assigned to an object element. A child, for example,
belongs to subtype 2, and the object elements of this subtype are the employee's or
applicant's children.

134 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
11.3. Archiving incoming documents with bar codes

To structure the HR object types:

1. Run the SPRO transaction and click Implementation Guide IMG.

2. Navigate in the structure to


Personnel Management > Personnel Administration > Tools > Optical
Archiving.

3. Click Set Up Optical Archiving in HR.

4. To switch to edit mode, click Display → Change.

5. Enter the configuration for an existing document type. To create your own
document types, click New entries.
Specify the following parameters:

Obj.type
PREL or PAPL object type

Document type
Document type to be used for certain scanned documents
Description
Description of the document type
Infotype
Infotype to which the scanned documents are to be linked
Subtype
-, + or value, if known for this document type
Obj.ID
-, + or value, if known for this document type
Date
Enter a +, if a date is to be entered at data input.
Authoriz
Enter a +, if the user's authorization is to be verified.

For the input combinations see the following table:

Infotype Subtype Obj.type Example


No infotype - - - Resume that cannot be assigned to an
infotype.
Infotype Number - - Photo: Infotype 0002, personal data.
without
subtype
Infotype Number + or - Diploma: a + requests the correct
with value subtype at input
subtype

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 135
ER160208-CCS-EN-01
Chapter 11 Archiving via the ArchiveLink interface

Infotype Subtype Obj.type Example


Infotype Number + or + or Documents for a particular family
with value value member
subtype and
object ID

6. Click Save.

11.3.5.4 MM module
Additional bar code entry for goods receipt documents by flow type and transaction
is activated in the MM module. Bar code entry in the OAC5 transaction must be
maintained for the BUS2017 object type.

To activate bar code entry in the MM module:

1. Run the SPRO transaction and click Implementation Guide IMG.

2. Navigate in the structure to


Materials Management > Inventory Management and Physical Inventory >
Goods Receipt.

3. Click Activate Storage of Incoming Documents.

4. Double-click Activate Storage per Movement Type and activate the desired
transaction type in the Store column, for example, 101 Wareneingang.

5. Click Save and then Back.

6. Double-click Activate Storage per Transaction and activate the desired


transaction type in the Store column, for example, MB01, Post Goods Receipt
for PO.

7. Click Save and then Back.

8. Click Cancel.

To test your settings, enter a posting with the corresponding transaction (in our
example MB01). The bar code dialog box must be displayed.

11.3.6 Setting up archive modes for scanning


In the Late storing with bar codes scenario the storage job is initiated by
Enterprise Scan. For this the scanning program requires

• the logical archive ID in order to store the document in the correct archive
• the SAP system to which to send the bar code and the document ID.

For more details see Section 11 “Configuring scan stations” in OpenText Archive
Center - Administration Guide (AR-ACN).

136 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
11.3. Archiving incoming documents with bar codes

To set up archive modes for scanning:

1. Start the OpenText Administration Client, establish the connection to the


archive from which the archive modes are read, and browse to Environment
Scan Stations.

2. Select the Archive Modes tab.

3. Right-click in the Archive Modes list on the right-hand side and select Add
from the context menu.
The Add Archive Mode dialog is displayed.

Figure 11-3: Add archive mode in Archive Center

4. In the Add Archive Mode dialog, enter:

Name
Name for the archiving type. Do not use spaces.
Scenario
Late_Archiving, short term for the Late archiving with bar codes
scenario.
Archive
Name of the logical archive to which the documents are sent.
Conditions
BARCODE. If this option is activated, the document can only be archived if a
bar code has been recognized.

5. Click OK.
A new entry appears in the list of archive modes.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 137
ER160208-CCS-EN-01
Chapter 11 Archiving via the ArchiveLink interface

6. To assign the new archive mode to an Enterprise Scan workstation, right-click


in the Scan Host Entries list on the left-hand side and select Add from the
context menu.

Figure 11-4: Add New Scan Host Entry on the Archive Center

7. Enter the following parameters:

Scan host
Name of the Enterprise Scan computer that scans and stores the documents
of the particular document type. Make sure to enter the name in lower case
letters.
Archive mode
Name of the archive mode just defined, in the example Incoming_Invoices
Default
Defines the selected archive mode as the default for the scan.

8. Browse to Environment > SAP Servers and check the Archive Assignments
tab. Select the specified archive and check the Archive SAP assignments tab. A
check mark in the Default columns indicates the SAP system to which the
confirmation of the archive is sent. (see also “Creating an archive on the
OpenText Archive Center” on page 81).

138 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
11.3. Archiving incoming documents with bar codes

11.3.7 Configuring Enterprise Scan


Before you can scan and archive with Enterprise Scan, you need to configure the
relevant profiles.

To configure Enterprise Scan:

1. Start Enterprise Scan on the workstation for which you configured the archive
mode.

2. In the Enterprise Scan menu, click Profile > Configure.


3. In the Input tab, create a subprofile for scanning and set the required scanning
parameters.

4. In the Processing tab, create a subprofile for processing the documents. The
process must contain at least the bar code recognition and the separation of the
documents by bar code.
Click Configure to open a dialog where you can select the bar code type to be
recognized during scanning and the bar code type to use for dividing the pages
into separate documents.

5. On the Archiving tab, create a subprofile for archiving in the archive. Configure
the DocumentPipeline storage type and specify the archive mode.

6. If the selection list does not contain the archive mode you want, check the
following:

a. The name of the Enterprise Scan (Scan host) entered in the OpenText
Administration Client.
b. The connection with the Archive Center on which the archive modes are
configured. The Archive Center currently connected is shown in the
Archiving subprofile.

Note: For more details, see Section 9 “Working with profiles” in OpenText
Imaging Enterprise Scan - User and Administration Guide (CLES-UGD).

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 139
ER160208-CCS-EN-01
Chapter 11 Archiving via the ArchiveLink interface

11.4 Archiving incoming documents with workflow

Figure 11-5: Summary: Customizing Incoming documents with workflow

Note: The direct scanning to PDF is available; for details see “Scanning to
PDF” on page 149.

11.4.1 Prerequisites
The following prerequisites must be fulfilled (see “SAP basis customizing”
on page 47):

• The initial customizing must be fully completed.


• The HTTP connection must be set up.
• An archive (content repository) must be set up in the SAP application and on the
OpenText Archive Center.
• Enterprise Scan or Windows Viewer with DesktopScan must be installed on the
computer.

140 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
11.4. Archiving incoming documents with workflow

• Automatic basic customizing for SAP Business Workflow has been performed.
The basic customizing for the workflow must be performed in order to activate
the workflow environment and to generally enable workflows. Run the SWU3
transaction and click Automatic Customizing .

Note: The RFC destination workflow is only shown as complete, if Test


RFC destination has been run.

In addition, the workflow tasks must be defined as general tasks before the actual
customizing of the Incoming documents with workflow scenario.

Workflow tasks can only be processed if the agent has been assigned. For a
workflow task to be performed by any user, the standard task must be defined as a
general task. Each standard task must be defined separately.

To define a standard task as general task:

1. Run the PFTC transaction.

2. Enter the following parameters:

Task type
Standard task
Task
30001117

3. Click Change and confirm the message.

4. In the menu, select Additional data > Agent assignment > Maintain.

5. Check whether General task is defined for the standard task.


If this is not the case, select the entry and click Attributes.

6. Select the General Task option.

7. Click Transfer.

8. Repeat the above procedure for the Task 30001128.

Alternatively, the workflow task can be released for a particular agent group. Click
Agent assignment create in the Maintain Agent Assignment dialog. You can select
from the same user object types as for the default settings (see “Default settings and
agent assignment” on page 143).

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 141
ER160208-CCS-EN-01
Chapter 11 Archiving via the ArchiveLink interface

11.4.2 Steps
Customizing document types used in workflow scenarios consists of several steps.
The sequence these steps are carried out depends on whether you perform
customizing with the document type customizing wizard (see “Customizing with
the document type customizing wizard ” on page 144) or with the following
individual special transactions:

1. Creating document types and maintaining links (basis customizing)


2. Defining a document type as a workflow document type (link to workflow),
specifying the method and workflow task
3. Specifying workflow parameters
4. Specifying default settings, that is scenarios and distribution lists for documents
5. Checking settings in Enterprise Scan

11.4.3 Workflow parameters


The Storing for subsequent entry and Store and enter scenarios require further
parameters. These typically comprise the transaction code with which the data entry
is started. The parameters depend on the object type and the selected method. The
following table contains typical examples.

SAP Object Method Workflow parameter Workflow parameter


application type name content
(document)
FI (Invoice) BKPF CREATE TRANSACTIONCODE FB10, FB60, F-43
SD (Task) VBAK CREATE TRANSACTIONCODE VA01
SD (Task) VBAK CREATE SALESDOCUMENTTYP Transfer to database
E field
SD (Task) VBAK EDIT TRANSACTIONCODE VA02
MM MKPF CREATE TRANSACTIONCODE MB1C
(delivery
note)
HR PAPL CREATE DOKCUMENTCLASSES Document type
(application)
CRM BUS1006 CREATE PARTNERCATEGORY 01, 02, 03
(Business
partner)

142 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
11.4. Archiving incoming documents with workflow

11.4.4 Overview
11.4.4.1 Default settings and agent assignment
You can use default settings to combine document types, mostly related to
departments or business areas. This simplifies document assignment during
archiving. You can assign a document type to several default settings.

During customizing, you specify who should perform the entry or assignment for
each default setting. Typically this will be a group of so-called agents. As soon as
one of the designated agents opens the work item, it is removed from the workflow
inbox of other agents. The following overview shows all agent assignment options.

Object type Name Description


A Work center Members of a local work group or work area, for example,
final assembly
US User SAP user from the SAP user maintenance
O Organizational Group of SAP users, for example, team, department
unit
P Person Employee as maintained in HR
S Position SAP user who is assigned to a position, for example,
Purchasing employee 01
C Job All SAP users assigned to a job, for example, Sales
employee

To configure a personal view of the default settings:

1. Run the OAWD transaction.


2. In the context menu, click Settings > User settings.

Figure 11-6: User settings for default settings

3. Activate the required options:

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 143
ER160208-CCS-EN-01
Chapter 11 Archiving via the ArchiveLink interface

Fastpath to Storage Scenarios


Displays the icons for the configured scenarios of a document type.
Display Key, Not Long Text
Displays the default setting, document type and recipient names. There is
no need for these names to be unique. With non-unique names, the
uniquely defined values can be displayed instead of the name: setting key,
document type short text and recipient ID.
Limit View to
For users who only use one setting, the view can be restricted accordingly.
You must select the required setting before calling up the user settings.

4. Click OK.

11.4.5 Customizing with the document type customizing


wizard
The workflow customizing can be performed using the document type customizing
wizard. For entry scenarios there is the TS30001128 standard task. For the Storing
for subsequent assignment and Store and assign scenarios, the standard task
TS30001117 is used.

No work item is generated and sent in the Assign then store scenario, so in this
sense it is not a workflow scenario. However, you do need to assign document types
to default settings if you wish to use this scenario. But you cannot perform this
assignment unless the document type is defined as a workflow document type.

The following description explains the document type customizing wizard using the
example of a document type for incoming scanned orders, for SAP CRM for
incoming customer inquiries.

Alternative access to workflow customizing

You can also run the customizing using a number of special transactions:

• The default settings for all scenarios can be customized in the IMG >
OpenText Archiving and Document Access for SAP Solutions >
DesktopLink and Archiving for SAP Solutions > ArchiveLink > Maintain
Presettings for Storage Scenarios activity. Alternatively, you can run the
OAWS transaction.
• You can also customize the workflow document types in the IMG. Run the
OpenText Archiving and Document Access for SAP Solutions >
DesktopLink and Archiving for SAP Solutions > ArchiveLink > Assign
Document Type to a Workflow activity. Alternatively, you can run the SOA0
transaction.
• You can also customize the workflow parameters in the IMG. Run the
OpenText Archiving and Document Access for SAP Solutions >
DesktopLink and Archiving for SAP Solutions > ArchiveLink > Maintain

144 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
11.4. Archiving incoming documents with workflow

Workflow Parameters activity. Alternatively, you can run the OACA


transaction.

To customize using the document type customizing wizard for SAP ERP

1. Run the OpenText Archiving and Document Access for SAP Solutions >
DesktopLink and Archiving for SAP Solutions > ArchiveLink > ArchiveLink
Customizing Wizard activity. Alternatively, you can run the OAD5 transaction.
The Document Type Customizing Wizard dialog is displayed.

2. Click Continue.

3. Select a value for the Doc.type field and click Continue.

4. If you want to use a similar document type as a template, enter its short text.
Otherwise leave the Doc.type field blank and click Continue.

5. Select the Workflow document type option and click Continue.

6. Enter the object type to which the document type belongs.


Depending on the scenarios you wish to use with this document type, enter one
or more of the following parameters:

Scenario Entry Assignment


Storing for subsequent Method: CREATE --
entry Task: TS30001128
Store and enter Method: CREATE --
Task: TS30001128
Storing for subsequent -- Task: TS30001117
assignment
Store and assign -- Task: TS30001117
Assign then store -- --

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 145
ER160208-CCS-EN-01
Chapter 11 Archiving via the ArchiveLink interface

By fully specifying all tasks, as shown above, all five scenarios are supported.
The names (long text) are displayed when you press the ENTER key.
7. Click Continue. You receive a warning message if you fail to complete all the
fields. Confirm this.
8. Depending on the scenarios used, you must now enter the workflow
parameters. The parameter names that can be used for the selected object type
and method already exist in the list. You must only enter the values for the
parameters. Generally, this is the transaction code to be invoked by the
workflow; the transaction code must be entered in capitals. For an overview see
“Workflow parameters” on page 142.
9. Click Continue.
10. Enter the archive (content repository) and the link table. Click Continue.
11. The following two steps specify the presettings.
You can assign a document type to several presettings. If you wish to use
existing presettings, select them in the list and click Continue.
12. If you wish to create one or more new presettings, enter the following
parameters:

ID
Unique key, consisting of 4 characters. The list of presettings is sorted in
alphabetical order of the IDs.

146 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
11.4. Archiving incoming documents with workflow

Name
Description of the presetting to be displayed.

Click Continue.
13. If you created new presettings, you must specify their details in the additional
Details of presettings dialog:

a. Define who is to process the work item. Enter the agent object type and the
actual agent or agent group. For more details, see “Default settings and
agent assignment” on page 143. If you do not assign an agent, the work
item is sent to the user who archived the document.
b. Select the scenario in which the document type is used. To see the full
name, drag the columns wider or point the mouse at the column title until
the quick info text appears.
c. If you selected multiple presettings, specify the agents and scenarios for all
presettings. Click to change the default setting.
d. Click Continue.
14. Click Finish.

11.4.6 Scan settings


The scan settings required differ depending on the scan clients that are used. The
following options are available:

• “Enterprise Scan”
• “Windows Viewer”
• “Windows Viewer together with Enterprise Scan”
• “Scanning to PDF”
• “Archiving via the document pipeline”

11.4.6.1 Enterprise Scan


Before documents can be archived, they must be scanned and checked. For a more
detailed description see OpenText Imaging Enterprise Scan - User and Administration
Guide (CLES-UGD).
The following prerequisites must be fulfilled:

Subprofile definition
As of Enterprise Scan version 5.0, a subprofile must be defined in the Archiving
tab for each scenario to be used (if necessary without the Barcode condition).
This subprofile requires an archive mode which can be configured via the
Archive Center administration client. In the settings for the archive mode, make
sure the configured SAP system is used as the default for the logical archive.
You can find details on configuring archive modes in “Setting up archive modes
for scanning” on page 136 and in Section 11 “Configuring scan stations” in
OpenText Archive Center - Administration Guide (AR-ACN).

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 147
ER160208-CCS-EN-01
Chapter 11 Archiving via the ArchiveLink interface

System settings at the scan client


If your SAP system uses several application servers, you require several ports
with different instance numbers.

To check system settings at the scan client:

1. Open the Services file in the %WinDir%\system32\drivers\etc folder.

2. Check if the following entries exist, and insert them if necessary:

sapdp<INS>32<INS>/tcp
sapgw<INS>33<INS>/tcp

Note: In case you edit this file, insert an empty line at the end.

3. Save the Services file.

11.4.6.2 Windows Viewer


Before documents can be archived, they must be scanned and checked.
As a prerequisite, DesktopLink must be installed and a RFC or HTTP connection
must be activated. No further settings are required. Windows Viewer is mainly used
for the Store and enter and Store and assign scenarios.

11.4.6.3 Windows Viewer together with Enterprise Scan


If you installed both applications on your system, you can specify in the SAP
protocol which application the end user may use for scanning. The following
options are available:

• Specify that only the Windows Viewer may be used.


• Specify that both scanning applications are available; in this case the application
used is the one registered on the end user's computer as an OLE application.

The SAP protocol contains the application that is started using OLE. This setting
applies to all archives that use the protocol.

To define settings in the SAP protocol:

1. Run the OAA3 transaction.

2. Double-click in the list the protocol to be used for the archive (content
repository). You find the assignment of the document type and archive in the
OAC3 transaction, and the configuration for the archive in the OAC0 transaction.

3. Click Change.

4. Double-click the Archive from frontend entry.

5. Double-click the FAX document class.

148 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
11.4. Archiving incoming documents with workflow

6. Check and change the entry in the Application field if required:

IXSCAN
Both applications can be started.
IXVIEWER
Only Windows Viewer is started.

7. Click OK.
8. Click Save.

Windows If the settings in the SAP protocol specify that both applications can be used for
Viewer and scanning, the application used is the one registered on the computer as an OLE
Enterprise Scan
on the same
application.
computer However, if both Windows Viewer and Enterprise Scan are installed on the
computer, make sure that the registered application is the one you want to use, since
both applications are registered with the same OLE class ID:

Enterprise Scan
Enterprise Scan registers itself every time it starts.
Windows Viewer
Windows Viewer must be registered manually; enter in the command line:
<path>\alviewer.exe /regserver
where <path> describes the path of the directory in which the Windows Viewer
was installed.

11.4.6.4 Scanning to PDF


The direct scanning to the PDF format provides an additional format to the standard
fax and text formats.

Starting with Enterprise Scan 10.5, the DocFormat property can be returned to set the
right document class. This can be done by setting the command option
@DTI=DocFormat.

To maintain the applications IXSCAN and IXSCAN_HTTP, run the IMG > OpenText
Archiving and Document Access for SAP Solutions > DesktopLink and Archiving
for SAP Solutions > ArchiveLink > Front End Communication Customizing >
Maintain Applications activity. Alternatively, you can run the OAA4 transaction.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 149
ER160208-CCS-EN-01
Chapter 11 Archiving via the ArchiveLink interface

Furthermore for function Archive from Frontend and application IXOS.


IXSCAN.SC2SAP, add a new event = G with command @DTI=DocFormat.

For more information about the definition of applications IXSCAN and IXSCAN_HTTP,
see Section 12.2 “Maintaining SAP ArchiveLink application” in OpenText Archiving
and Document Access for SAP Solutions - Installation and Upgrade Guide (ER-IGD).

Figure 11-7: Maintenance for IXSCAN

150 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
11.4. Archiving incoming documents with workflow

Figure 11-8: Maintenance for IXSCAN_HTTP

With these settings in place and with the communication protocols set for document
class FAX , you can use document types assigned to document class FAX to scan and
assign documents with other mime types. For more information about
communication protocols, see Section 12 “Handling communication protocols” in
OpenText Archiving and Document Access for SAP Solutions - Installation and Upgrade
Guide (ER-IGD).

In the case of SAP's store business documents option of the GOS menu or in the case
of the store documents function of transaction OAWD, every new link is populated
then with the actual document class as created by Enterprise Scan.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 151
ER160208-CCS-EN-01
Chapter 11 Archiving via the ArchiveLink interface

11.4.6.5 Archiving via the document pipeline


With the Storing for subsequent entry and Store and assign scenarios, the
following problem may occur:

If you specify that original documents are to be archived by Enterprise Scan using
the document pipeline, the documents are first processed by the document pipeline.
While an original document is still in the pipeline, a document ID is assigned and
notified to the SAP application, and linked to the application document. The original
document is then archived and removed from the document pipeline.

If this process is interrupted for any reason after the original document ID has been
assigned but before the original document is transferred to the archive, this means
that this original document is assigned and recognized in the SAP application, but
cannot be retrieved and displayed because it is still not in the archive. No data is
lost. The original document is still in the pipeline. If you try to display the original
document, however, this results in an error message.

To solve this problem, you must ensure that all scanned original documents are in
the archive at the end of each session. To do this, monitor the scan document
pipeline.

You can do this by opening the Document Pipeline Info window (Start | Programs
| IXOS | ECR | IXOS Document Pipeline Info) on a computer with the
administration tools installed and creating a connection to the host on which the
scan document pipeline was installed - in general Enterprise Scan itself. In the input
column, all entries should be set to 0. This confirms that the document pipeline is
empty.

If a number is output for a specific processing step, this indicates that the original
documents were not processed beyond this point and are still waiting. You must
find out what the problem is and correct the error. Then click the rows with a
number other than 0 and select the Restart item in the menu that opens. The
processing of original documents resumes from where it was interrupted. The
number is set to 0 indicating that processing is complete and the original documents
are in the archive.

11.5 Manually storing incoming documents


Customizing for the Assign then store scenario corresponds to the customizing for
the Storing for subsequent assignment scenario. In contrast, the Assign then
store scenario does not feature a workflow. For technical reasons, nevertheless, a
workflow document type must be defined; the workflow parameters must be
entered, but are ignored by the Assign then store scenario.

152 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
11.5. Manually storing incoming documents

Figure 11-9: Summary: Customizing Assign then store

Customizing comprises the following steps:

1. Creating a document type (see “Maintaining global document types”


on page 81)
2. Maintaining links
3. Defining a document type as a workflow document type (linking with
workflow)

To define a workflow document type use the Document Type Customizing Wizard
(OAD5 transaction) as described in “Customizing with the document type
customizing wizard ” on page 144.
Note the following points:

• Enter an object type with the CONFIRM method. You can check that in the SWO3
transaction.
• For technical reasons you must enter values for the method, task and workflow
parameters, however they are ignored for this scenario, as the workflow is not
involved. An user assignment must be defined as well, although it is ignored
later.

Note: You can also use the Assign then store scenario to store documents in
DocuLink and, if necessary, to create a record for those documents at the same
time. For details, see “Configuring special scenarios” on page 206.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 153
ER160208-CCS-EN-01
Chapter 11 Archiving via the ArchiveLink interface

11.6 Archiving outgoing documents

Figure 11-10: Summary: Customizing Outgoing documents

11.6.1 Prerequisites
To archive outgoing documents, the following conditions must be fulfilled (see “SAP
basis customizing” on page 47):

• The initial customizing must be fully completed.

• The HTTP connection must be set up.

• An archive (content repository) must be set up in the SAP application and the
OpenText Archive Center.

• Output determination or the Post Processing Framework (PPF) has been


configured and outgoing documents are generated correctly.

11.6.2 Creating and linking a document type


To creating and link a document type:

1. Run the OAC2 transaction

2. Create a new global document type, or maintain the SAP standard document
type (see “Maintaining global document types” on page 81). Take care to select
the PDF entry in the Doc.class field.

Note: Outgoing documents are always generated in PDF format.

3. Run the OAC3 transaction

4. Enter the link, or maintain the link of the SAP standard document type (see
“Maintaining links” on page 84).

154 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
11.6. Archiving outgoing documents

11.6.3 Customizing output determination


11.6.3.1 Checking creation of outgoing documents
Before starting the customizing, check whether outgoing documents are created
correctly.

To check creation of outgoing documents:

1. Enter a test posting with the following parameters:

SD module
VA01 transaction, Sales order

MM module
ME21 transaction, Create purchase order

2. Display the test postings:

SD module
VA03 transaction

MM module
ME23 transaction

3. Display the message list:

SD module
Extras | Output | Header | Edit menu
MM module
Header | Messages menu

Figure 11-11: Creating outgoing documents

Check the following:

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 155
ER160208-CCS-EN-01
Chapter 11 Archiving via the ArchiveLink interface

• If the list is empty, no outgoing documents are created and the output
determination must be configured.
• The status must be successfully processed, indicated by a green point or
1 in the Status column. Otherwise, the output determination must be
configured correctly.
For details see the SAP documentation.
• The Output column displays the output type that you must maintain for
storage.
For details see the SAP documentation.

11.6.3.2 Customizing output determination for document storage


You must set the output determination for each module and output type that has
outgoing documents to be archived.

To set the output for document storage:

1. Run the SPRO transaction and click Implementation Guide IMG.

2. Navigate in the structure:

SD module
Sales and Distribution > Basic Functions > Output Control > Output
Determination > Output Determination Using the Condition Technique
For each group of message types, you see the Maintain Output
Determination entries.
MM module
Materials Management > Purchasing > Messages > Output Control >
Message Types
For each group of message types, you see the Define Message Types
entries.

3. Click execute in front of the required entry.

4. Only for the MM module: Double-click the Maintain Message Types entry.

5. Double-click the line with the required output type.

6. Select the Default values tab.

156 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
11.6. Archiving outgoing documents

7. Enter the following parameters:

Dispatch time
Time when the outgoing document was created. Storage can only be
performed after generation. For testing purposes select Send immediately.
Transmission Medium
For storage, select Print output or fax. If you want to send outgoing
documents in a different manner, see “Enhancing outgoing documents for
different transmission media” on page 158

8. Select the Storage system tab.

9. Enter the following parameters:

Storage Mode
For storage, either Print and archive or Archive only must be selected.
Document type
Document type you managed for storage in Basis Customizing.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 157
ER160208-CCS-EN-01
Chapter 11 Archiving via the ArchiveLink interface

11.6.3.3 Enhancing outgoing documents for different transmission media


For storage of outgoing documents you must either select Print output or fax as the
transmission medium. If you want to send outgoing documents in a different
manner, such as via SAP Business Workflow, a new output type for archiving
documents is required. The original output type is used to send the document to the
business partner, and the new output type is used to store the document.

Figure 11-12: Outgoing documents for different transmission media

To define a new output type:

1. Copy the configured original output type.


2. Integrate the copied output type to the output determination, identically to the
original output type.
3. For the original output type, enter the required transmission medium and the
recipient (partner role). Enter Print only as the storage type or leave this field
blank.
4. For the copied output type, enter the Print output transmission type, the
Archive only store mode and the document type.

11.6.4 Customizing the Post Processing Framework (for SAP


CRM only)
You must adapt the Post Processing Framework (PPF) for each business object in
SAP CRM for which you want to store outgoing documents. This includes the
following steps:

• “Creating and editing the processing class”


• “Creating an action profile”
• “Defining conditions for the action profile”
• “Linking the action profile to the transaction type”

The following section describes customizing using the example of a customer order.
Each customer order (ZSDIORDER document type) that was created and saved in the
CRMD_ORDER transaction is to be printed and sent to the customer. As the scheduling
condition for this action, you define that the documents must be created by the

158 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
11.6. Archiving outgoing documents

AGENT01 user. The document layout is defined by the SmartForm standard, which is
provided by the SAP application; however, the administrator can adapt the layout if
necessary.

11.6.4.1 Creating and editing the processing class


In order to generate outgoing documents in CRM, you must create and edit a
processing class. This class transfers the actions to Smart Forms and forwards them
for processing.

To create and edit the processing class:

1. In the SE80 transaction, copy the template for the


CL_DOC_PROCESSING_CRM_ORDER processing class with the
CRM_ORDER_EXEC_SMART_FORM processing method.

2. In the method code, look for this line:

* -------> ls_archive_index-object_id = ls_orderadm_h-GUID

3. Remove the comment sign for this line.

4. Replace the ls_orderadm_h-GUID entry with the object ID of the object type
that corresponds to the outgoing document.
In this example, the line is:

ls_archive_index-object_id = BusinessProcess

Note: For forms overlay, further adaptations are required; see “Defining a
processing method for the PPF and specifying it in the action profile”
on page 264.

5. Save your entries.

6. In the next step (“Creating an action profile” on page 159), enter the name of
this modified processing class as a parameter.

11.6.4.2 Creating an action profile


The action profile defines which actions are triggered and are to be processed for a
business object. The profile can contain multiple action types that describe the
different types of processing in each case, for example, different communication
methods. The layout of outgoing documents is also specified here, as well as the
method of database selection (the processing method).

For the sales order, an action type is created for each type of partner (for example,
sold-to party, ship-to party, etc.), which also contains details such as whether the
document is to be output by email, fax, or printer.

You can define the action profile including the activities with the help of a wizard or
step-by-step in the individual transactions.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 159
ER160208-CCS-EN-01
Chapter 11 Archiving via the ArchiveLink interface

To create an action profile using the wizard:

1. Run the SPRO transaction and click Implementation Guide IMG.

2. Navigate in the structure:


Customer Relationship Management > Basic Functions > Actions.

3. Click Creating actions with a wizard.

4. Read the starting page and click Continue.

Figure 11-13: Action profiles: Customizing Wizard

5. Click the Create New Action Profile option.

6. Enter the following parameters:

Action Profile
Enter a name for the new action profile from the permitted name range.

Description
Enter an informal description of the profile.

Date profile
The date profile defines which date types, duration times, reference objects
and date rules can be used in an application (optional).

160 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
11.6. Archiving outgoing documents

Object type
Name of the business object type, for example, CRM sales transaction
(BUS2000115).

7. Click Continue.

8. Create a new action for the action profile. Enter a name for the Action
Definition from the permitted name range and a description.

9. Click Continue.

Figure 11-14: Action profiles: Setting actions

10. Define the following settings for the action:

Processing time
Specify when the action is to be processed:

• Immediate processing - the action is started as soon as the start


condition is fulfilled.
• Processing when document is saved - the action is started immediately
after updating.
• Processing via selection report - the action is started after run-in
and evaluation by a report. After evaluation by the report, the system

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 161
ER160208-CCS-EN-01
Chapter 11 Archiving via the ArchiveLink interface

tests whether a start condition exists first. If there is no start condition or


the condition is met, the action is started.

ScheduleAutomatically
If the indicator is set, the actions are automatically activated for the
processing as soon as the scheduling conditions are met. If it is not set, the
transaction user must manually activate the actions found in the application
document for the processing.
Display in Toolbox
This option specifies whether activities from this action definition can be
selected and performed from the (GOS) toolbar.
Chngbl in Dialog
The user can change the condition and processing parameters for the
actions in the document.
Executable in Dialog
The user can trigger the action manually on the Actions tab of the business
object.

11. Click Continue.

12. Optional: Specify the Set partner determination.


If you select the Partner Dependant field, you can enter a Partner Function for
which the action applies. You can also define the action partner-dependant via
the conditions.

13. Click Continue.

14. Select a processing type.

15. Click Continue.

162 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
11.6. Archiving outgoing documents

Figure 11-15: Action profiles: Processing Smart Forms

16. Enter detailed settings for the selected processing type:

Form name
Smart Form name; defines the layout of the outgoing document
Processing Class
User-specific output processing class
Use the class modified in the previous step with the
CL_DOC_PROCESSING_CRM_ORDER template.

Note: In previous SAP basis versions, processing was performed


using a report and a report form.
Processing Method
User-specific output processing method
Use the method modified in the previous step (see “Creating and editing
the processing class” on page 159). For forms overlay, this method must be
adapted further (see “Defining a processing method for the PPF and
specifying it in the action profile” on page 264).
Output Device
Select the device you want to print or archive the document with.
Archive Mode
Indicate how the document is to be processed:

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 163
ER160208-CCS-EN-01
Chapter 11 Archiving via the ArchiveLink interface

• Print/Fax/E-mail only
• Store only
• Print/Fax/E-mail and Store

The following parameters are only available for the Print/Fax/E-mail and
Store storage mode:

Archive Object Type


Select here BUS2000115 as the archive object type (action).

Document Type
Enter a document type with the format PDF, which is linked to the business
object (see “Creating and linking a document type” on page 154).

Archive copies
If you activate this option, a copy of the document will be archived.

17. Click Continue.

Figure 11-16: Action profiles: Action definition

18. If desired, you can enter a process description for the action that is displayed
when the document is processed.

164 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
11.6. Archiving outgoing documents

19. Click Continue.

20. You can define scheduling conditions for the actions. The scheduling condition
determines whether an action is to be scheduled for processing. An action is
therefore only generated if the scheduling condition is met.
If desired, select an existing scheduling condition for the action. (see “Defining
conditions for the action profile” on page 166)

21. Click Continue.

22. The scheduling condition is evaluated before the activity is performed. The
activity is only performed if the start condition is fulfilled.
If desired, select an existing start condition for the action (see “Defining
conditions for the action profile” on page 166).

23. Click Continue.

24. Click Complete to create the action profile with the action types and the
corresponding conditions.

Later you can assign further action definitions to the same profile with the help of
the wizard, for example, for different partner functions. To do so, simply repeat the
process described above as of Step 5, using the Select Existing Action Profile
option.

Creating an action profile without a wizard

Alternatively, you can create the action profile without using the wizard:

To create an action profile without using the wizard:

1. Navigate in the IMG structure:


Customer Relationship Management > Basic Functions > Actions > Change
Actions and Conditions and click Define Action Profiles and Actions
(CRMC_ACTION_DEF transaction).

2. Copy one of the templates that corresponds to your business object.

Note: If there is no suitable action profile, create a new one. To do this,


click New entries and enter the parameters, as described in Step 6 for the
procedure with the wizard.

For a customer order, select ORDER_MESSAGES.

a. Select the existing action profile and click Copy as.


b. Change the name of the copied action profile and check the Obj.type
indication. The action profile is only valid for this business object.
c. Press Enter.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 165
ER160208-CCS-EN-01
Chapter 11 Archiving via the ArchiveLink interface

d. In the Specify object to be copied dialog box, select the copy all option.
3. Change the name of the action type copied at the same time and press the Enter
key.
4. Confirm the message on the number of copied entries.
5. Click Enter.
6. Create or edit an action type, you may need one for each partner type.

a. Select the newly created profile in the list of action profiles.


b. Click the Action Definition folder in the dialog structure.
c. Enter the parameters for an action definition.
In our example, processing when saving the document is selected as the
Time of Processing.
7. Specify the processing types for the action profile, that is the format in which
the document is to be output.

a. Click the Processing types folder in the dialog structure.


b. Add all the permitted processing types to the list.
c. Optional: specify which processing type is to be used by default by
activating the Default option in the appropriate row of the list.
d. To enter detailed settings for processing, select the processing type in the
list and click Set processing type.
e. Enter the parameters for an action definition as with the wizard described
in Step 16. The screenshot shows the parameter values for the sales order
for the Smart Forms print processing type.
Print and Store is selected as the storage mode.

8. Save your entries.

11.6.4.3 Defining conditions for the action profile


You can define scheduling and start conditions for the activity.

The scheduling condition determines whether an action is to be scheduled for


processing. An action is therefore only generated if the scheduling condition is met.

The scheduling condition is evaluated before the activity is performed. The activity
is only performed if the start condition is fulfilled. The definition is the same for both
types of condition.

To define a scheduling condition:

1. Run the SPRO transaction and click Implementation Guide IMG.


2. Navigate in the structure:
Customer Relationship Management > Basic Functions > Actions > Change
Actions and Conditions.

166 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
11.6. Archiving outgoing documents

3. Click Define Conditions.


(CRMC_ACTION_CONF transaction)

4. Double-click the action profile to select it from the Scheduling of Actions list.
A list of all the previously scheduled actions for this profile appears on the
right. In the OK status column you can see whether or not the action has
already been properly carried out.

5. If no activity has been scheduled for this action profile yet, click Create and
select the action definition for the activity you want to schedule.

Figure 11-17: Scheduling actions for an action profile

On the Overview tab, you find general information about the action. If the
Default Settings from Action Definition option is activated, the predefined
settings are displayed. If this option is deactivated, the predefined values can be
modified here.
In the ActionDetails tab, you find more details on the output device, the spool,
the form, and the cover sheet for each action.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 167
ER160208-CCS-EN-01
Chapter 11 Archiving via the ArchiveLink interface

Figure 11-18: Action details

6. To edit the conditions for the activity, select the ScheduleCondition tab or
StartCondition.

7. Click Edit Condition. The browser for start and scheduling conditions opens.

8. Click Create.

9. Enter a Description for the condition.

10. Click in the Condition Definition field. An editor is displayed which you can
use to create your conditions with the correct syntax. For more details see the
SAP Help.
In our example, the start condition is that the document creating user must be
AGENT01.

168 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
11.6. Archiving outgoing documents

Figure 11-19: Start conditions for actions

11. Save your conditions.

11.6.4.4 Linking the action profile to the transaction type


The action profile must be linked to a transaction type so that the appropriate action
profile can be run for each transaction of this type - if necessary observing defined
conditions. You can select an existing transaction type, or create a new one.

To select an existing transaction type:

1. Run the SPRO transaction and click Implementation Guide IMG.

2. Navigate in the structure:


Customer Relationship Management > Basic Functions > Actions.

3. Click Assign Action Profile to the Item Category.


(CRMC_ACTION_CONF transaction)

4. Select the desired transaction type you want to link the activity to.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 169
ER160208-CCS-EN-01
Chapter 11 Archiving via the ArchiveLink interface

To create a new transaction type:

1. Run the SPRO transaction and click Implementation Guide IMG.

2. Navigate in the structure:


Customer Relationship Management > Transactions > Basic Settings.

3. Click Define Transaction Types.

In our example, we select the ZTA (IXOS Telesales) sales transaction, which is a
copy of the Telesales transaction type.

To assign the action profile:

1. Enter the Action Profile in the transaction type details.

Figure 11-20: Assigning an action profile to a transaction type

2. Click Accept.

170 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
11.7. Migrating ArchiveLink documents

11.7 Migrating ArchiveLink documents


You can transfer (migrate) individual ArchiveLink documents or even complete
storage systems into other storage systems. If necessary, this migration can also be
performed automatically with a special function module and a report.

11.7.1 Migrating ArchiveLink documents using function


modules
The /IXOS/RT_BASIC_ARCHIVELINK function module is included in the /IXOS/
RT_AL function group and allows you to transfer individual ArchiveLink documents
to different storage systems. This is done by assigning a new document type which
defines the content repository.

This function module can be performed, for example, in the SE37 transaction and
requires the following parameters:

PI_ARCHIVE_ID
Archive ID the document is to be transferred from

PI_ARC_DOC_ID
Document ID of the document you want to migrate

PI_DOC_TYPE
Document type of the document you want to migrate

PI_DOC_TYPE_TARGET
Document type of the migrated document. The document type defines the
content repository for the document.

11.7.2 Automation of migrating ArchiveLink documents using


reports
You can also automate migrating ArchiveLink documents by using the application-
independent /IXOS/RT_AL_SCENARIO report. With this report you can migrate all
documents in a particular content repository simultaneously, for example, or you
can schedule a job to perform the migration in regular intervals.

You can run this report, for example, in the SA38 transaction.

During performance, enter the following parameters:

Archived date from, Archived date to


Specify an archiving date for the documents you want to migrate.

Source Document Type


Document type of the document you want to migrate

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 171
ER160208-CCS-EN-01
Chapter 11 Archiving via the ArchiveLink interface

Target Document Type


Document type of the migrated document. The document type defines the
content repository for the document.

Tip: For large amounts of data, we recommend executing the report as a


background process.

As a result of the report you obtain a protocol which indicates how many documents
were migrated successfully and for which documents the migration was aborted
with an error. If you double-click a row in the protocol, details from the log file are
displayed.

172 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
Chapter 12
Archiving via SAP Netweaver ILM

SAP SAP NetWeaver Information Lifecycle Management (ILM) consists of three


NetWeaver ILM components:

Data Archiving
The standard SAP data archiving functions have been enhanced to allow for the
integration of the other two components and to support not only archiving but
also data destruction and snapshot creation.
Retention Management
This component manages data retention policies from the time the data is
created until it has to be destroyed. It can perform e-Discovery to find all data
connected to a business object, and set legal holds.
Retention Warehouse
This component provides a standardized method for decommissioning legacy
systems. Data from decommissioned systems are stored in a central Retention
Warehouse and are still accessible for business users and application of retention
policies.

XML DAS and All transactions triggered by SAP NetWeaver ILM in connection with data storage are
WebDAV controlled by the XML Data Archiving Service (XML DAS). The ILM functions are
storage
interface
only available when using XML DAS to transmit the metadata necessary for
retention management through an accordingly extended WebDAV protocol to the
storage system. The OpenText Enterprise Library Services, starting with version
9.7.1, include a BC-ILM 2.0 SAP ILM WebDAV Storage Interface. That makes it
possible for you to store your archived data within the SAP ILM scenario.

The following sections summarize the steps that are necessary to connect your SAP
ILM system with your OpenText storage system.

For an overview of the detailed procedure, see the following documentations:

• Customizing Enterprise Library system


Section 4 “Scenario: SAP NetWeaver ILM WebDAV storage interface” in
OpenText Enterprise Library - Scenario and Configuration Guide (EL-GGD)
• Customizing SAP ILM system
http://help.sap.com/erp2005_ehp_05/helpdata/en/7f/
e188e04fdd462e8ec330bb80efc389/frameset.htm

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 173
ER160208-CCS-EN-01
Chapter 12 Archiving via SAP Netweaver ILM

12.1 Setting up ILM Scenario in OpenText Enterprise


Library
The following steps are required for the setup of the ILM scenario in OpenText
Enterprise Library:

1. Installing WebDAV Services in your Enterprise Library system – You need an


Enterprise Library installation containing the components Content Server,
Archive Center, and Enterprise Library Services.
To install WebDAV Services, select WebDAV Services from the product group
Core Services and Other Components in the Shared Services Bundle Suite
Installer.
For more information, see Section 4.1 “Installing the software” in OpenText
Enterprise Library - Scenario and Configuration Guide (EL-GGD).
2. Creating an Enterprise Library volume – For ILM, your Enterprise Library
system needs an Enterprise Library volume. If your system does not yet provide
one to use for ILM, you have to create at least one Enterprise Library application
with an associated volume.
For detailed information about the procedure, see Section 4.2 “Creating a
volume” in OpenText Enterprise Library - Scenario and Configuration Guide (EL-
GGD).
3. Creating an Archive Storage Provider Rule – ILM scenarios require at least one
logical archive and thus a Storage Provider rule to put all ILM documents into
this logical archive.
For detailed information about the procedure, see Section 4.3 “Defining logical
archive and storage provider for ILM” in OpenText Enterprise Library - Scenario
and Configuration Guide (EL-GGD).
4. Creating a User – ILM scenarios require at least one Enterprise Library user. You
may use a dedicated technical user or any user available within your Enterprise
Library system. The SAP ILM system is later configured with this user and
password being part of the connection parameters. The ILM volume should
grant access only to this dedicated user.
For detailed information about the procedure, see Section 4.4 “Creating a
dedicated user for ILM” in OpenText Enterprise Library - Scenario and
Configuration Guide (EL-GGD).
5. Configuring Records Management for SAP ILM – In the ILM scenario, the SAP
ILM system acts as the master application that runs the retention management
on the ILM documents. However, you have to configure Records Management
to support the ILM retention features. A default Records Management
classification must be applied to all ILM folder and item types.
For detailed information about the procedure, see Section 4.5 “Configuring
Records Management for SAP ILM” in OpenText Enterprise Library - Scenario and
Configuration Guide (EL-GGD).
6. Supporting big files for SAP ILM – Documents are transferred through ILM
without information about the content length (chunked transfer encoding). To

174 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
12.1. Setting up ILM Scenario in OpenText Enterprise Library

support files bigger than 9 MB, you have to configure Archive Center to allow
this.
For detailed information about the procedure, see OpenText Enterprise Library -
Scenario and Configuration Guide (EL-GGD).
7. Excluding documents from undelete – You must ensure that deleted Enterprise
Library objects are not moved to the Undelete Volume in Content Server but
deleted at once.
For detailed information about the procedure, see OpenText Enterprise Library -
Scenario and Configuration Guide (EL-GGD).
8. Adding dead properties – A dead property, as defined by WebDAV's RFC 2518
specification, means that the server, in this case the WebDAV server, only
records the value of the property without checking syntax. Syntax and semantics
of a dead property are enforced and defined by the client, in this case the SAP
ILM server. The automatically created ILM item and folder types already contain
the dead properties defined by the ILM specification. In your ILM scenario you
have to add dead properties only if the SAP system needs to support additional
properties.
For detailed information about the procedure, see Section 4.7 “Adding dead
properties” in OpenText Enterprise Library - Scenario and Configuration Guide (EL-
GGD).
9. Testing ILM installation – After setting up your WebDAV ILM system, you can
verify your configuration using the testing tool provided by OpenText in the
download area of Enterprise Library Services in My Support.
For detailed information about the procedure, see Section 4.9 “Testing the ILM
installation” in OpenText Enterprise Library - Scenario and Configuration Guide (EL-
GGD).
10. ArchiveLink-stored documents – Additionally to the basic ILM functionality,
you can also manage the retention of documents stored through SAP
ArchiveLink. This scenario only supports ArchiveLink-stored documents that
are available within the same ELS installation (this Archive Center and all
known Archive Centers).
For detailed information about the procedure, see Section 4.10 “ILM-managed
objects and ArchiveLink-stored documents” in OpenText Enterprise Library -
Scenario and Configuration Guide (EL-GGD).

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 175
ER160208-CCS-EN-01
Chapter 12 Archiving via SAP Netweaver ILM

12.2 Setting up ILM Scenario in SAP System


This section summarizes the steps necessary to connect XML Data Archiving Service
(XML DAS) with an OpenText WebDAV server as storage location. For more
information about the detailed procedure, click the link to the corresponding section
of the SAP documentation.

Customizing Steps
1. Providing WebDAV Server as Archive Store for SAP NetWeaver ILM
http://help.sap.com/saphelp_nw70ehp1/helpdata/EN/01/
9142b5caa241cd8e38c7608282e12c/content.htm

• URL of the WebDAV server:


http://<server>:<port>/ot-webdav/ilm/<ILM Volume>
• Logon user and password of the WebDAV server:
Use the user and password created in step 4 of “Setting up ILM Scenario in
OpenText Enterprise Library” on page 174.
2. Defining the Connection to Storage for SAP NetWeaver ILM
http://help.sap.com/saphelp_nw70ehp1/helpdata/EN/03/
d11118dcf44154b63d3324052cf2c2/content.htm
3. Registering the Store for SAP NetWeaver ILM in XML DAS
http://help.sap.com/SAPHELP_NW70EHP1/helpdata/EN/49/
b3125f37a14b3db5f744c5a176d7c7/content.htm
To use a WebDAV Server as an XML DAS archive store, you need to create an
entry for your store in the XML DAS administration.
4. Provide Home Paths for XML DAS Archive Store (Java)
http://help.sap.com/saphelp_nw73/helpdata/en/18/
637846f5b14d31b0746c98de68234e/content.htm
In this step, you provide the home paths to your archived resources.

Further Information
• For an overview and more information about working with the SAP Information
Lifecycle Management, see
Deploying Information Lifecycle Management (ILM) in the SAP System
http://help.sap.com/erp2005_ehp_05/helpdata/en/7f/
e188e04fdd462e8ec330bb80efc389/frameset.htm
• For an overview and more information about working with XML Data Archiving
Service (XML DAS), see
Use XML Data Archiving Service (XML DAS) for Archiving
http://help.sap.com/saphelp_nw73/helpdata/en/4c/
3a2343b50843b4e10000000a42189e/frameset.htm
and
Administration of the XML Data Archiving Service (XML DAS)

176 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
12.2. Setting up ILM Scenario in SAP System

http://help.sap.com/saphelp_nw73/helpdata/en/45/
32bc4e4a134a2ae10000000a11466f/frameset.htm
• The ILM Store Browser allows you to view the hierarchy of your archived data.
You can also view detailed information about the location of your archived files
and resources. See
ILM Store Browser
http://help.sap.com/saphelp_nw73/helpdata/en/46/
9f7ff73ebe2c06e10000000a114a6b/content.htm

12.2.1 ILM for ArchiveLink-Stored Documents


You can also apply the SAP ILM retention management to ArchiveLink-stored
documents and print lists without moving these documents or changing anything in
the ArchiveLink protocol or in the HTTP Content Server Interface. To allow this, the
ArchiveLink documents are represented in the ILM storage system by ArchiveLink
references.

Note: This scenario only supports ArchiveLink-stored documents that are


available within the same ELS installation (this Archive Center and all known
Archive Centers).

The WebDAV server does the following:

1. Recognizes ArchiveLink references


Every WebDAV resource that has the content length = 0 and is therefore empty,
and carries the property al_crep_id, is identified as an ArchiveLink reference.
The ILM policies are propagated to the ArchiveLink documents by the
ArchiveLink reference properties containing the prefix al_.
For example:
al_doc_id: carries the ArchiveLink document ID for the content repository.
al_crep_id: represents the content repository as it is known in the SAP system.
al_sid: identifies the SAP system.
2. Applies the retention constraints assigned as properties to a reference resource
to the actual ArchiveLink-stored document

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 177
ER160208-CCS-EN-01
Chapter 13
Archiving via the SAP Knowledge Provider
infrastructure

The KPro (Knowledge Provider) infrastructure uses the Content Management


Service to store Content Management documents. Configuring storage for
documents in an OpenText Archive Center instead of in an SAP Content Server
consists only of the steps described for Content Management in the next section.

Furthermore, OpenText supplies a function module and a report with which you
can transfer individual or several KPro documents to a different content repository
in one step, and if necessary can also automate this task. This functionality is
described as migration in the following.

Migration is only possible if the HTTP protocol is used, and only SAP system
databases and structure storage repositories are supported as SAP Content Servers.

13.1 Customizing content management


By default, Content management documents are saved in a database, like all other
SAP documents. If you want to save the documents in an archive instead, you need
to carry out a few customizing steps. You will still have access to documents already
saved.

Note: The content management functionality is principally available in all


applications. The Archiving and Document Access for SAP Solutions products
supports it in all KPro-based SAP applications.

The storage of content management documents is controlled using storage


categories. Each document is stored in a physical document class (PHIO). In the data
model, a storage category is defined for each physical document class. The storage
category in turn is linked to a content repository (archive or database). This specifies
uniquely for each SAP document where it is to be stored.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 179
ER160208-CCS-EN-01
Chapter 13 Archiving via the SAP Knowledge Provider infrastructure

Figure 13-1: Customizing content management

To set up the storage of content management documents in an archive, you must


modify the storage category of the physical document class used for each SAP
application.

Note: If you want to export the documents from a content management system
later using the OpenText Rendition Server, you must define an archive as a
storage category for the appropriate physical document classes. Only if
documents are stored on the OpenText Archive Center, they can be exported.

To modify the storage category of a physical document class:

1. Find out which physical document class has been used up to now for archiving
the documents:

a. Search in the SAP application for any content management document for
the required SAP application, or create a new one.
b. Select the document in the hierarchy, right-click it and select Properties
from the context menu.

Note: Do not use the Properties button in the document zone in the
right pane of the window.

180 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
13.1. Customizing content management

c. Browse to the Technical Information tab. There you find the physical
Doc.class under Physical Document.
To illustrate this, we use PDK_1 in the following as an example for this
physical document class.

2. Use the physical document class that was found to set the associated storage
category used for this application:

a. Open the DMWB transaction.


b. Open the CRM > PHIO-class entity.
c. Find the identified PDK_1 physical document class in the hierarchy and
double-click it.
d. On the Standard properties tab you find the STORAGE_CATEGORY_MAINT
attribute. Make sure that this attribute contains an X as its value.
e. The STORAGE_CATEGORY attribute specifies the name of the storage category
used for the business object.
In the following example, we use STC_DB.

3. Define a logical HTTP archive using the OAC0 transaction (see “Maintaining
HTTP content repository in the SAP application” on page 78). You do not need
a document area.
In the following example, we call the archive ARCHIV_1.

4. Create a new storage category (content category) for this archive:

a. Open the OACT transaction.


b. Create a new entry for the archive storage category. Enter the created
archive ARCHIV_1 as the content repository.
In the following example, we use STC_ARCH.

5. Finally, you must change the assignment of the storage category for the physical
document class (PDK_1) of the SAP application, so that the new archive storage
category is used.

a. Open the SKPR08 transaction.


b. Find the entry for the physical document class used.
In the Previous cat. column, you find the previously assigned storage
category (STC_DB).
c. In the New cat. column, enter the name of the new archive storage category
(STC_ARCH).

In doing so, you have changed the storage category assignment in such a way that
the CM documents with the physical document class PDK_1 are from now on stored
in the ARCHIV_1 archive. At the same time, you still have access to the documents of
this physical document class that were stored in the database (STC_DB storage
category).

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 181
ER160208-CCS-EN-01
Chapter 13 Archiving via the SAP Knowledge Provider infrastructure

13.2 Migrating KPro documents using function


modules
The /IXOS/RT_KPRO_BASIS function module is included in the /IXOS/RT_KPRO
function group and enables you to transfer individual KPro documents to different
content repositories.

Note: Migration is only possible if the HTTP protocol is used, and only SAP
data bases and structure repositories are supported as SAP Content Servers.

This function module can be performed, for example, in the SE37 transaction and
requires the following parameters:

PI_CATDST
Content repository to which the document is to be migrated.
PI_DOK_OBJECT
Object ID and class of the document you want to migrate

You can also use this function module to automate the migration; for example,
documents can automatically be copied or moved to an archive for permanent
storage depending on a certain status transition. This was implemented for a sample
project in DocuLink, for example; for details see the corresponding documentation.

13.3 Automation of migrating KPro documents using


reports
You can also automate migration of KPro documents by using the application-
independent /IXOS/RT_KPRO_SCENARIO report. With this report you can migrate all
documents in a particular content repository simultaneously, for example, or you
can schedule a job to perform the migration in regular intervals.

Note: Migration is only possible if the HTTP protocol is used, and only SAP
data bases and structure repositories are supported as SAP Content Servers.

This report is included in the /IXOS/RT_KPRO development class and can be


performed, for example, in the SA38 transaction.

182 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
13.3. Automation of migrating KPro documents using reports

Figure 13-2: Automation of migrating KPro documents

During execution, enter the following parameters:

Archived date
Specify an archiving date for the documents you want to migrate.

Document area
Enter the document area for the KPro documents.

Document class
Enter the document class for the KPro documents.

Source Category of Document


Enter the storage category that contains the documents.

Target Category of Document


Enter the content repository the documents are to be migrated to.

Tip: For large amounts of data, we recommend executing the report as a


background process.

As a result, the report returns a protocol which indicates how many Phios, that is
physical documents, were migrated successfully and for which documents the
migration was aborted with an error. If you double-click a row in the protocol,
details from the log file are displayed.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 183
ER160208-CCS-EN-01
Chapter 14

Archiving via the ODMA interface (DesktopLink)

To be able to archive via the Open Document Management (ODMA) interface,


DesktopLink must be installed.

14.1 Setting up DesktopLink


Before you can use DesktopLink, the following conditions must be met:

On the user workstation:


DesktopLink must be installed. This installation forms part of the Windows
Viewer installation and is described in the OpenText Imaging Viewers and
DesktopLink - Installation and Administration Guide (CL-IGD).

In the SAP application:


The ABAP Basis Add on for Archiving and Document Access for SAP Solutions
OTEXBAS must be installed and the configuration completed. For a more detailed
description see Section 3.5 “DesktopLink” in OpenText Archiving and Document
Access for SAP Solutions - Installation and Upgrade Guide (ER-IGD). Details about
the configuration are explained in the following sections. In addition, the
standard ArchiveLink scenarios must be configured, if necessary (see
“Archiving via the ArchiveLink interface“ on page 127). Configuring
DesktopLink consists of the following stages:

1. Creating document types. This assigns the document class.

2. Creating multi-document types for multiple storage.

3. Optional: Assign the target format and specify the converter to be used to
transfer the original document to a non-editable TIFF or PDF format.

4. Linking document types with their associated object types and the logical
archives

5. Optional: Maintaining the workflow settings of the document types and


assigning the default setting; if necessary, creating a default setting
beforehand

6. Optional: Configuring attribute transfer

7. Optional: Configuring special scenarios

8. Optional: Defining user-specific settings

9. Optional (SAP ERP only): Enhancing SAP object types

10. Optional: Defining SAP authorizations

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 185
ER160208-CCS-EN-01
Chapter 14 Archiving via the ODMA interface (DesktopLink)

Notes

• Note for internal project developers


For information on user exits in DesktopLink, a technical documentation can
be requested from your OpenText contact person. Be aware that user exits
may only be used by OpenText to develop projects.
• Support of ArchiveLink enhancement
DesktopLink supports the usage of SAP's ArchiveLink enhancement with
table TOAAT as described in SAP OSS Note 1451769.
You can enable the feature in transaction OAG1 selecting the check box
Reserve1 of table TOACU. See also OSS Note 1451769.
The file name is stored in table TOAAT without full path. This feature is
provided with OSS Note 1451769. The file name can be displayed in the GOS
attachment list. This is the standard behavior when uploading a document
from GOS without DesktopLink. If DesktopLink is customized to convert the
uploaded file via client or rendition management and the original file shall
be preserved, then for both entries the name of the original file name is
stored. DesktopLink supports this feature for all launch options, for example
from GOS, DocuLink or Desktop.
Additionally, DesktopLink stores the timestamp when the file is uploaded
and the SAP user login who performed the upload.

14.1.1 Accessing DesktopLink customizing


DesktopLink customizing is available in the IMG branch OpenText Archiving and
Document Access for SAP Solutions > DesktopLink and Archiving for SAP
Solutions. Transaction J8A7 which contained DesktopLink customizing in previous
versions is still available. It now opens the relevant customizing branch of the IMG.

New: You can now access DesktopLink customizing in the IMG.

To access DesktopLink customizing:

1. Start transaction SPRO to open the IMG.

2. Click SAP Reference IMG.

3. Open the OpenText Archiving and Document Access for SAP Solutions >
DesktopLink and Archiving for SAP Solutions > DesktopLink branch.

186 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
14.1. Setting up DesktopLink

14.1.2 Maintaining document types


Even when archiving via DesktopLink, you must create the appropriate document
types for each scenario. You may need several document types, depending on the
formats you wish to use for storage.

Note: Archiving and Document Access for SAP Solutions supplies special
function modules and reports for document conversion (Rendition
Management). These are implemented for PLM DMS documents within the
PLM DMS archiving scenario by default; within the framework of a project,
they can also be used for further document types. See “Document entry via
DesktopLink” on page 231, and“Rendition Management“ on page 279.

Archiving in the original format


Create a document class of the original format.
Archiving in TIFF or PDF format (Printing with OpenText TIFF Converter or
OpenText PDF Converter)
Create a document class with the FAX or PDF document class. In this case the
converted document and not the original format is received directly by the SAP
application.
Archiving in TIFF/PDF format and optionally in original format in one step
Create two document types, one with the FAX or PDF document class and one
with the document class of the original format. The two document types must be
linked (see “Configuring client-side (classic) conversion to TIFF or PDF”
on page 197).
This procedure can be used for all scenarios. For the Storing for subsequent
entry and Store and enter workflow scenarios, the document is transferred
directly in its original format with the work item. The associated TIFF or PDF
document is stored in the J_8A3T0001 table and subsequently linked to the
business object by the J_8A3P01 report. OpenText recommends scheduling a job
for this report.
User selects the storage format (TIFF/PDF or original)
Create three document types, one with the FAX or PDF document class and two
with the document class of the original format. An original document type must
be linked to the conversion document type. There are two document types
available to you. By selecting the document type, you are indirectly selecting the
storage format.

Note: If the document class you require does not yet exist, you can create it
using the OAD2 transaction.

You create document types with the OAC2 transaction. For a more detailed
description see “Maintaining global document types” on page 81.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 187
ER160208-CCS-EN-01
Chapter 14 Archiving via the ODMA interface (DesktopLink)

14.1.3 Standard customizing


14.1.3.1 User-specific settings in the SAP application for DesktopLink
You can customize the storage steps in the SAP application to your user
requirements. For example, if you only want to use the Assign then store scenario,
you do not need to display the Select Scenario dialog box at all.

1. In the IMG, start the DesktopLink > Standard Customizing > Maintain User
Customizing activity and select a user. Alternatively, you can use the J8A3
transaction.

• If you have the required authorization to change settings for other users as
well, a user selection screen is displayed. Your user name is automatically
entered in the User field.
Select one or more users or click Standard User to edit the settings for the
standard user.
• If you have no authorization to change settings for other users, the Change
User Settings dialog opens directly.

Click OK.

2. The Change User Settings dialog box opens.

188 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
14.1. Setting up DesktopLink

Figure 14-1: User-specific settings in the SAP application for DesktopLink

3. Enter your settings:

Scenario
Select one of the following options:

• Last scenario:
The cursor is always positioned on the scenario that was selected the last
time DesktopLink was called up.
• Last scenario + automatic selection:
The Select scenario dialog is no longer displayed the next time
DesktopLink is started. The last scenario selected is automatically used.
• Scenario ... + automatic selection:
Here you can select a scenario that is subsequently used by default. The
Select scenario dialog box is no longer displayed.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 189
ER160208-CCS-EN-01
Chapter 14 Archiving via the ODMA interface (DesktopLink)

Document Types
Select one of the following options:

• Last document types: The cursor is always positioned on the document


type that was selected the last time DesktopLink was called up.
• Last document types + automatic selection: The Select document type
dialog is no longer displayed the next time DesktopLink is started. The
last document type selected is automatically used.

Object Key

• Create Objectkey from ODMA attributes: Activates attribute extraction


(see “Configuring attribute transfer” on page 192). The dialog with the
extracted attributes for the key fields is not opened, the related business
object is displayed (only if the Confirm method is assigned to the object
type).
• No confirmation for object key: Activates automatic attribute transfer
to the SAP application. The original document is archived and assigned
without displaying the key fields or the business object.

Tree

• Technical info in tree: Activates the display of technical information on


the document type, for example, the technical document type name (in
addition to the description), as well as the assigned business object or
the corresponding link table

The Default settings button resets the fields to the predefined standard. Even if
you accept these standard settings for the user without modifications, the user
still possesses personal settings. Changes concerning the Standard user do not
affect that.
If you click , users lose their individual settings. Instead, the standard user's
default settings are used.

4. Click Ok to confirm the settings.

190 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
14.1. Setting up DesktopLink

14.1.3.2 Creating multi-document types


A multi-document type combines a number of document types. When you select the
default settings and document types, you only see the multi-document type and not
the individual document types behind it.

Multi-document types must be maintained if you wish to support multiple storage


for the Store and assign scenario. With multiple storage, multiple documents that
may have different file formats are archived using the Send to menu or Drag &
Drop on the Save to SAP solutions desktop icon, and linked with the same SAP
business object in one indexing step. The storage of the documents is controlled by
the internal assignment to the individual document type.

Note: All scenarios allow archiving multiple documents using the Send to
menu or Drag & Drop and to index each individually in the SAP application.
For more information, see Section 4 “Working with DesktopLink” in OpenText
DesktopLink - User Guide (CLDL-UGD).

To create multi-document types:

1. In the IMG, start the DesktopLink and Archiving ... > ArchiveLink > Maintain
Document Types activity. Alternatively, you can use the OAC2 transaction.

• Document type: For example, ZRCOD6MUL1


• Description: For example, Multi-document type for D6
• Document Class: MULTI
2. If you have not yet created the single document types, do this now. For details
see “Maintaining global document types” on page 81.
3. To generally enable the support of multi-document types, run the DesktopLink
and Archiving ... > DesktopLink > Expert Customizing > Maintain
DesktopLink Technical Settings activity. In the General area, select the Multi-
Document Support check box.
4. To enable the support of multi-document types for the respective DesktopLink
scenario, run the DesktopLink and Archiving ... > DesktopLink > Expert
Customizing > Maintain DesktopLink Scenarios activity. In the detailed view
for your scenario, select the Multi-Document Support check box.
5. In the IMG, start the DesktopLink and Archiving ... > DesktopLink > Standard
Customizing > Maintain Multi-Document Types activity. Alternatively, you
can maintain table J_8A3T0003 with transaction SM30.
6. Create a new entry with the following settings:

• Multi-Document Type: Short text of the multi-document type to which the


single document type is assigned.
• Document Class: Document class of the single document type.
• Single-Document Type: Short text of the single document type.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 191
ER160208-CCS-EN-01
Chapter 14 Archiving via the ODMA interface (DesktopLink)

7. Click Enter.
8. Repeat steps 6 and 7 and assign all required single document types to the multi-
document type.

14.1.3.3 Maintaining links


All document types to be archived are assigned to the storage systems, object types
and link tables in the usual fashion. Multi-document types must also be linked and
archived, since the information is required by the object type. Specifying the archive
and link table for multi-document types is useful, because the archives are linked to
the single document types.

Note: If you want to use separate link tables for DesktopLink documents, you
can create these with the OAD3 transaction.

You maintain links with the OAC3 transaction. For a more detailed description see
“Maintaining links” on page 84.

14.1.3.4 Determining the workflow and default settings


When using the Storing for subsequent entry, Storing for subsequent
assignment, Store and enter, Store and assign and Assign then store
scenarios, you must maintain the document types to be archived as workflow
document types. For a more detailed description see “Workflow parameters”
on page 142.

14.1.3.5 Configuring attribute transfer


Files that were created with an ODMA-compatible application such as Microsoft
Word or Microsoft Excel, contain attributes. These attributes or file properties can be
set automatically or defined by the user, for example, file name or author. Attributes
can be used for identifying, classifying and indexing the file. In Microsoft Office
applications, the attributes are contained on the File tab.

User-defined ODMA attributes (properties), which were defined in the email


application, can be transferred to an SAP system as well when archiving via
ExchangeLink or NotesLink.

At archiving, attributes can be copied to the SAP application with DesktopLink and
can be processed further there.

• The key fields and their values are entered in the document as attributes and
evaluated in the SAP application for assignment to the SAP business object.
• You can freely define attributes in the document and add values to be copied to
the SAP application and evaluated there.
• The attributes are copied from the document to the SAP application and stored in
a table.
• The attributes are copied from the document to the SAP application and included
in a work item text.

192 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
14.1. Setting up DesktopLink

• The attributes are used temporarily for document creation, for example, in order
to open a specific DocuLink view. This is described in “Using ODMA attributes
in DocuLink using DesktopLink” on page 210.

In order to be able to transfer attributes with DesktopLink, they must be maintained


carefully in the documents (usually with Microsoft Office applications) and
appropriately customized in the SAP system.

14.1.3.5.1 Preassigning key fields

You can enter and transfer attributes to simplify or automate the assignment of
Microsoft Office documents to SAP business objects. This is possible for the Store
and assign and Assign then store scenarios. Use the key fields in the object type
as attribute names in the documents, using precisely the field or key field names as
they were defined in the SAP system.

To identify reference fields in an object type:

1. In the SWO1 transaction, enter the object type, for example BKPF.

2. Click Display.

3. Double-click Key fields. The Key field and Field columns contain the names
that you can use for attribute names.

Figure 14-2: Key fields for object types

Enter the file properties of a Microsoft Office document. For example, in Microsoft
Word 2010, select File > Info. On the right, click Properties and select Advanced
Properties.

You can also store the attributes in the document template, so that the user only
needs to enter current values.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 193
ER160208-CCS-EN-01
Chapter 14 Archiving via the ODMA interface (DesktopLink)

Figure 14-3: File properties of a Microsoft Office document

Note: If you want to transfer the key fields and use your own attribute names
instead of the SAP names, you need to perform customizing as described
under “Transferring user-defined attributes” on page 196.

When a user archives a document via DesktopLink with attribute transfer, the key
field entry dialog box in the SAP application already contains the transferred values.
You can switch off the display of this dialog box in the user settings of DesktopLink
and thus reduce the number of procedural steps.

To specify user settings for the attribute transfer:

1. In the IMG, start the DesktopLink > Standard Customizing > Maintain User
Customizing activity and select a user. Alternatively, you can use the J8A3
transaction.

2. In the Object Key section, you find options that affect the conversion of
attributes into the object key. You can select one or both of the following
options:

194 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
14.1. Setting up DesktopLink

• Create object key from ODMA attributes: The dialog box containing the
transferred values for the key fields is not displayed; instead the associated
document appears, but only if the Confirm method is assigned to the object
type.
• No confirmation for object key: The document is archived and assigned
without displaying the key fields and the document.

14.1.3.5.2 Transferring and saving attributes

Attributes from Microsoft Office applications can be saved in the SAP application for
other evaluations, such as integration in DocuLink. To do this, you specify which
attributes are to be stored in the SAP application for which document type. The
transferred attributes are stored in the J_8A3T0013 table. As a prerequisite, you
must maintain the DesktopLink scenario table J_8A3T0010.

To save attributes:

1. In the IMG, start the DesktopLink > Standard Customizing > Maintain ODMA
Attributes Saved in Database activity.

2. Create a new entry with the following settings:

• Object Type: Object type with which the document type is linked.
• Single-Document Type: Document type for which an attribute is to be
saved.
• Scenario Type: Enter * if the attribute is to be saved for all scenarios, or
select a scenario. Use the WFEA, WFEI, WFLA, WFLI and ZUAB scenario
types, as well as DC30, if you use DocuLink.

Note: The FRUE, GLEI and SPAE scenario types are deprecated.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 195
ER160208-CCS-EN-01
Chapter 14 Archiving via the ODMA interface (DesktopLink)

Figure 14-4: Storage scenarios

• ODMA Attribute: Name of the attribute, as entered in the Microsoft Office


application.

Tip: You can use transaction SE16 to display the attributes in the J_8A3T0013
table.

14.1.3.5.3 Transferring user-defined attributes

User-defined attributes can also be transferred to the SAP application and evaluated
using the SET/GET parameter, for example for the workflow, for direct integration
in DocuLink, or if you wish to use your own names instead of the SAP names for the
key field attributes.

To transfer user-defined attributes:

1. In the IMG, start the DesktopLink > Standard Customizing > Maintain
Transfer of User-defined Attributes to SET/GET Parameters.

2. Create a new entry with the following settings:

• ODMA Attribute: Name of the attribute as entered in the Microsoft Office


application.
• Parameter ID: SET/GET parameter for the field in which the attribute value
is to be transferred.

Example: In a Microsoft Office document you have entered a custom property company,
which is not directly mapped to the key field CompanyCode or the reference field BUKRS of
the object type BKPF. However, you can create an entry with ODMA attribute = company and
SET/GET Parameter = BUK to obtain this parameter at runtime.

196 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
14.1. Setting up DesktopLink

14.1.3.5.4 Inserting attributes in work item texts

Attributes from Microsoft Office applications can be transferred to the SAP


application and inserted in work item texts. In this case, you must define which
attributes are to be inserted in the work item text for which document types.

To insert attributes in work item texts:

1. In the IMG, start the DesktopLink > Expert Customizing > Maintain Work
Item Text activity.

2. Create a new entry with the following settings:

• User Name: User for whom the work item is to be created. To use the work
item for all users, enter %ALL.
• Single-Document Type: Document type for which this work item is created.
• Work item Text: Text that will be sent as a work item. Insert ODMA
attributes enclosed by &, for example &Date&.

When a work item is created for the selected document type, the contents of the
specified ODMA attributes are automatically inserted.

14.1.4 Document conversion customizing


14.1.4.1 Configuring client-side (classic) conversion to TIFF or PDF
If you want to convert office documents to a long-term format, which will store them
in their original state for a long time, you need two document types: one with the
FAX or PDF document class and one with the document class of the original format.
You already created these in the previous section. Now both document types must
be linked. Finally, you specify the converter for the conversion.

To assign TIFF or PDF as a target format:

1. In the IMG, start the DesktopLink and Archiving ... > DesktopLink >
Document Conversion Customizing > Maintain Target Document Types
activity. Alternatively, you can use the J8AO transaction.

2. Click New Entries and create the following entry:

• Source Document Type: Document type for the source format.


• Target Document Type: Document type for the target format.
• Store Original Document: Enter an X here if you want the document to be
archived in its original format together with the converted document. The
relationship between the original and the TIFF/PDF document is stored in
the J_8A3T0018 table. You can display the table with transaction SE16.

3. Click Save .

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 197
ER160208-CCS-EN-01
Chapter 14 Archiving via the ODMA interface (DesktopLink)

A different converter is assigned for converting to TIFF and PDF format. You must
perform the assignment once for each document class and each target format.

Note: For using converters TOTIFF and TOPDF, the TIFF and PDF converters
must be installed on the DesktopLink client.

To assign the converter:

1. In the IMG, start the DesktopLink and Archiving ... > DesktopLink >
Document Conversion Customizing > Maintain Converter activity.
Alternatively, you can use the J8AN transaction.

2. Click New Entries and create the following entry:

3. Specify the Source Document Class (source format), the Target Document
Class (target format) and the converter TOTIFF or TOPDF.

4. Click Save .

14.1.4.2 Configuring rendition server conversion to TIFF or PDF

Note: Starting with version 10, DesktopLink also supports the use of rendering
profiles of the OpenText Rendition Server. This supports, for example, the
conversion to PDF/A.

You may choose to use the Rendition Server as an alternative to the client-side
conversion to long-term formats. Rendition Server must have version 9.6 or higher.
In general, any source document class that can be converted by Rendition Server
may be converted to TIFF or PDF this way. The conversion of Microsoft Office
documents, including Microsoft Outlook (extension and document class MSG) and
Lotus Notes emails (extension and document class NSF; a Lotus Notes client has to
be installed on the Rendition Server) has been tested for the DesktopLink conversion
scenario.

Note: Contact the OpenText support if you like to convert other formats that
are supported by Rendition Server but cannot be converted using the
DesktopLink conversion scenario.

As already described for the “classic” client-side conversion you need two document
types: one with the FAX or PDF document class and two with the document class of
the original format. You already created these in the previous section. Now both
document types must be linked. Then in the same way as for the client side you
specify the converter for the conversion. After that you have to check whether you
already have defined a rendition server ID or create a new one. Finally you
configure the rendition server ID for each target document type.

To assign TIFF or PDF as a target format:

1. In the IMG, start the DesktopLink and Archiving ... > DesktopLink >
Document Conversion Customizing > Maintain Target Document Types
activity. Alternatively, you can use the J8AO transaction.

198 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
14.1. Setting up DesktopLink

2. Click New entries.


3. Enter in an empty table row:

Source Document Type


Document type for the source format.
Target Document Type
Document type for the target format.
Store Original Document
Enter an X here if you want the document to be archived in its original
format with the converted document. The relationship between the original
and the TIFF/PDF document is stored in the J_8A3T0018 table (can be
displayed using the SE16 transaction).

4. Click Save.

There is a converter for the usage of the OpenText Rendition Server. You must
perform the assignment once for each document class and usage of Rendition
Server.

Note: For using converter LARS (OpenText Archive Rendition Server), the
OpenText Rendition Server must be installed.

To assign the converter:

1. In the IMG, start the DesktopLink and Archiving ... > DesktopLink >
Document Conversion Customizing > Maintain Converter activity.
Alternatively, you can use the J8AN transaction.
2. Click New entries.
3. Specify the source format in Source Document Class, the target format in
Target Document Class and the converter LARS.
4. Click Save.

To define rendition server ID:

1. In the IMG, start the DesktopLink and Archiving ... > DesktopLink >
Document Conversion Customizing > Maintain Rendition Servers activity.
2. Create a new entry with the settings of your rendition server.
3. Click Save.

To configure the rendition server ID and profile assignment for each target
document type:

1. In the IMG, start the DesktopLink > Document Conversion Customizing >
Assign Target Document Type to Rendition Server activity.
2. Create a new entry with the following settings:

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 199
ER160208-CCS-EN-01
Chapter 14 Archiving via the ODMA interface (DesktopLink)

• Target Document Type as defined for the conversion. For more information,
see “Configuring client-side (classic) conversion to TIFF or PDF”
on page 197.
• Rendition Server ID: Rendition server ID as defined in the previous
procedure. Thus a distinctive rendition server may be used to convert source
document types to the specified target document type.
• Server Side Rendition Server Profile: Name of a profile to create a
rendering profile on OpenText Rendition Server. In this way, you can, for
example, set the watermarks or the conversion to PDF/A. For more
information about rendering profiles, see OpenText Rendition Server -
Installation and Administration Guide (RS-IGD).

3. Save your changes.

14.1.5 Expert customizing


14.1.5.1 Maintaining DesktopLink scenarios
You can maintain the list of DesktopLink scenarios when running DesktopLink.

Note: If this list is empty, you can run, for example, transaction J8AM to
populate it automatically with a default list of DesktopLink scenarios.

To maintain DesktopLink scenarios:

1. In the IMG, start the DesktopLink > Expert Customizing > Maintain
DesktopLink Scenarios activity.

2. Click New Entries and edit the following settings:

• Scenario Type: usually one of the default scenario types filled by


DesktopLink, if the table is empty. See Archiving and Document Access
Scenario Guide for more details.
• Active: select the check box to enable the scenario.
• Scenario Text: enter a description text.
• Function Module GET Object Key: enter ABAP function module to get the
object key for the ArchiveLink entry.
• Function Module Insert Link (INS): enter ABAP function module to insert a
link in the ArchiveLink insert table.
• From/To SAP Release: enter an SAP release, for example, 45A, to restrict the
scenario depending on the SAP release version.
• Workflow Scenario: select the check box if the scenario processes a simple
workflow.
• Multi-Document Support: select the check box if the scenario supports
multi-document processing.

200 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
14.1. Setting up DesktopLink

• Old Interface for Parameter Table: this check box is deprecated. Do not
select it.

14.1.5.2 Maintaining DesktopLink technical settings


You can perform the specific technical customizing for DesktopLink for users. To
create the standard user entry with user key %ALL, run DesktopLink at least once, for
example, with transaction J8AM. For specific users, you must customize specific
entries.

To maintain DesktopLink technical settings:

1. In the IMG, start the DesktopLink > Expert Customizing > Maintain
DesktopLink Technical Settings activity.

2. Click New Entries and edit the following settings:

• Customizing for User: enter the user name.


• Scenario area: customize the layout of scenario selection dialog.
• Tree area: customize the layout of document type selection tree dialog.
• Positioning area: customize start column and row of scenario and document
type selection windows.
• User Settings area: customize layout of user settings dialog (transaction
J8A3 or IMG activity Maintain User Customizing).

• ODMA Select Document Type, ODMA Select SAP Object, ODMA Select
Hitlist areas: customize layout of further selection dialogs.
• General area: customize the following settings:

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 201
ER160208-CCS-EN-01
Chapter 14 Archiving via the ODMA interface (DesktopLink)

– Store File Name and User Name: select the check box if you want to
provide DesktopLink table J_8A3T0004 with file and user name
information for each stored document.
– Multi-Document Support: select the check box to enable multi document
types.
– Close SAP GUI Mode after Desktop Link: select the check box if SAP
GUI should explicitly close the RFC session.
– Logging to Table J_8A3T0002: select the check box if DesktopLink
should write in the specific log table J_8A3T0002. To display the table,
click DesktopLink > Tools > Show Logging.

Note: DesktopLink always writes error messages to the SAP


application log SLG1. Logging in table J_8A3T0002 is an additional
tracing that usually can be switched off.

14.1.5.3 Maintaining work item text


Attributes from Microsoft Office applications can be transferred to the SAP
application inserted in work item texts. You must define which attributes are to be
inserted in the work item text for which document types.

To maintain work item text:

1. In the IMG, start the DesktopLink > Expert Customizing > Maintain Workitem
Text activity.

2. Click New Entries.

3. Specify the following settings:

• User Name: specify the users for which you want to create the work item.
Enter %ALL if you want to use the work item for all users.
• Single-Document Type: enter the document type for which you want to
create the work item.
• Workitem Text: enter the text that will be sent as a work item. To insert
ODMA attributes, enter the attribute name enclosed by &, for example, &
Date&.

When a work item is created for the selected document type, the contents of the
specified ODMA attributes will automatically be inserted.

202 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
14.1. Setting up DesktopLink

14.1.5.4 Maintaining behavior for FAX/TIF documents


In case of archiving FAX or TIF documents, DesktopLink will offer only the
corresponding document types. You can define that DesktopLink offers FAX and
TIF document types for each FAX/TIF document.

To maintain behavior for FAX/TIF documents

1. In the IMG, start the DesktopLink > Expert Customizing > Maintain Behavior
for FAX/TIF Documents activity.
2. Click New Entries.

3. To enable DesktopLink to offer FAX and TIF document types for each FAX/TIF
document, select the FAX and TIF Customizing check box.

14.1.5.5 Maintaining customer exits


You can define custom function modules to be processed by DesktopLink in
different stages of document upload.

Note: The custom function modules are not part of OpenText product support.

To maintain customer exits:

1. In the IMG, start the DesktopLink > Expert Customizing > Maintain Customer
Exits activity.

2. Click New Entries.

3. Specify the following settings:

• Customer Exit: select an entry from the F4 help list of customer exits.
• Scenario Type: enter * for all scenarios or select an entry from the F4 help
list of DesktopLink scenarios.
• SAP Object: enter a business object type for which the customer exit will be
processed. If you want to define all business object types, enter *.
• Function Module: enter the name of the custom function module. You can
use a copy of the template function J_8A3_C_USERX_TEMPLATE.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 203
ER160208-CCS-EN-01
Chapter 14 Archiving via the ODMA interface (DesktopLink)

14.1.5.6 Closing the SAP GUI mode automatically


If DesktopLink is started from a non-SAP application, an SAP GUI mode is opened.
If you want this mode to be closed automatically after the DesktopLink activity is
completed, you must configure this separately.

To close the SAP GUI mode automatically:

1. In the IMG, start the DesktopLink > Expert Customizing > Maintain
DesktopLink Technical Settings activity.

2. In the General area, select the Close SAP GUI Mode after DestopLink check
box.

14.1.6 Tools
14.1.6.1 Linking TIFF/PDF with original
Program J_8A3P01 processes all entries of table J_8A3T0001 and creates links to the
business object. For more information, see “Maintaining document types”
on page 187.
OpenText recommends scheduling a regular job for this program.

Example: In the case of document conversion and if both the original and converted
document are stored, the two document types must be linked. For the Storing for
subsequent entry and Store and enter workflow scenarios, the document is
transferred directly in its original format with the work item. The associated TIFF or PDF
document is stored in the J_8A3T0001 table and subsequently linked to the business object
by the J_8A3P01 program.

Program J_8A3P01 does the following:

1. Each document in table J_8A3T0001 is searched in the list of existing


ArchiveLink entries.
2. The corresponding target document is inserted in the ArchiveLink connection
tables.
3. If the search is

• successful, the link between original and target document is also stored to
table J_8A3T0018.
• not successful, the entry of J_8A3T0001 is copied to table J_8A3T0019.
4. Each processed entry is deleted from J_8A3T0001.

To run program J_8A3P01:

1. In the IMG, start the DesktopLink > Tools > Link TIFF/PDF with original
activity.

2. You can customize a start parameter Select up to number of rows. Enter a


value to restrict the selection of table J_8A3T0001 up to this number of rows.

204 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
14.1. Setting up DesktopLink

3. Click Execute.

If there are no more entries in table J_8A3T0001, you can run the Move Links from
table J_8A3T0019 to table J_8A3T0001 activity to move the entries that were not
successfully linked from table J_8A3T0019 back to table J_8A3T0001.

To move links back to table J_8A3T0001:

1. In the IMG, start the DesktopLink > Tools > Move Links from table
J_8A3T0019 to table J_8A3T0001 activity.

2. A report listing the moved entries is displayed.

If you run program J_8A3P01 again, the failed document entries are moved back
from table J_8A3T0001 to J_8A3T0019.

14.1.6.2 Showing current DesktopLink version


To show the About Desktop box:

1. In the IMG, start the DesktopLink > Tools > Show DesktopLink Version
activity.

2. Click Transport Overview to display a list of transports including


DesktopLink objects.

14.1.6.3 Showing DesktopLink logging


You can enable and display log entries stored to table J_8A3T0002.

Note: Independently from the special logging written to table J_8A3T0002,


DesktopLink always writes to the SAP application log SLG1.

To enable and display the logging:

1. To enable the logging, start the DesktopLink > Expert Customizing > Maintain
DesktopLink Technical Settings activity. In the General area, select the
Logging to Table J_8A3T0002 check box.

2. In the IMG, start the DesktopLink > Tools > Show Logging activity.

3. Enter Date, Time, and User to specify the logging range you want to display.

4. Click Execute to display the corresponding log entries stored to table


J_8A3T0002.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 205
ER160208-CCS-EN-01
Chapter 14 Archiving via the ODMA interface (DesktopLink)

14.1.7 Configuring special scenarios


In addition to the standard ArchiveLink scenarios, DesktopLink supports other
archiving scenarios via the ODMA interface, which require further configuration:

• SAP PLM, see “Document entry via DesktopLink” on page 231


• DocuLink

DocuLink scenario

To store DesktopLink documents in DocuLink, and if necessary, to index records for


them at the same time, the following scenarios are available:

Assign then store


To launch the create screen for an attribute object within a project or to specify
the key fields of an existing attribute record
DocuLink
To enable free navigation or to restrict the view automatically using user-
defined properties

14.1.7.1 Assign then store scenario


Prerequisites To use this scenario, the following prerequisites must be fulfilled:

• The object type contains the event assigned (inherited from the interface type
IFARCH21)

• The method confirm exists;


Redefine the confirm method if necessary and remove the error message from
the program. (SWO1 transaction).
• The ExistenceCheck method, which is contained in IFARCH21, must be
redefined and implemented (otherwise no check for duplicates is carried out on
the records).

206 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
14.1. Setting up DesktopLink

Figure 14-5: Customizing the Assign then store scenario

To customize the Assign then store scenario:

1. Create a document type using the OAC2 transaction.


2. Workflow parameters
Only for record entry:
Maintain the workflow parameter for this document type (OACA transaction):

• DOCULINK_PROJECT: project in which the record is to be entered.


• DOCULINK_DATASOURCE: attribute object for which a record is to be entered.
• optional: DOCULINK_VERSION: version in which a record is to be entered. If
this is not specified, then the following versions are used in the sequence
specified below:

– productive version (active or inactive)


– the last modified development version
– any other version

If no version exists then an error message is output.


3. Workflow settings
Maintain the following workflow settings in the SOA0 transaction:

• Object type: /IXOS/DC_R or user-specific object type with the interface /


IXOS/DC_I
• Method: PROCESS
• Task: TS7869
4. Using the OAC3 transaction, enter the link for the object type of the attribute
object; enter the archive ID and the link table.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 207
ER160208-CCS-EN-01
Chapter 14 Archiving via the ODMA interface (DesktopLink)

5. Only for record entry:

a. Maintain project, attribute object, object type and data structure. The entry
of documents for this attribute object must be permitted. For more
information, see Section 10.3.1.1 “General” in OpenText DocuLink for SAP
Solutions - Customizing and Administration Guide (DC-CGD).
If you subsequently assign documents, it is not necessary to reference the
project and attribute object, since assignment can be performed on the basis
of the selected document type and the entered key fields.
b. Insert the following entries in the SM30 transaction in the J_8AMUSERX table:

GET <SAP_OBJECT> X /IXOS/DC_K_DESKTOPLINK_CREATE


INSE <SAP_OBJECT> X /IXOS/DC_K_DESKTOPLINK_INSERT2

208 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
14.1. Setting up DesktopLink

14.1.7.2 DocuLink scenario

Figure 14-6: Customizing the DocuLink scenario

To customize the DocuLink scenario:

1. Create a document type using the OAC2 transaction.

2. Using the OAC3 transaction, enter the link for the object type of the attribute
object; enter the archive ID and the link table.

3. Maintain the project, attribute object, object type and data structure in
DocuLink. The entry of documents for this attribute object must be permitted.
For more information, see Section 10.3.1.3 “Archiving” in OpenText DocuLink for
SAP Solutions - Customizing and Administration Guide (DC-CGD).

In this scenario, DocuLink is started with the most recently opened project, if no
other project was specified using an user-defined property (see “Using ODMA
attributes in DocuLink using DesktopLink” on page 210).

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 209
ER160208-CCS-EN-01
Chapter 14 Archiving via the ODMA interface (DesktopLink)

14.1.7.3 Using ODMA attributes in DocuLink using DesktopLink


You can use ODMA attributes for example to provide presettings in the create
screen in DocuLink, or to automatically restrict the DocuLink view. The values for
these properties can either be stored permanently (for example, information on key
fields), or temporarily for the duration of entering a document (for example, opening
a particular DocuLink view). This requires additional customizing steps.

Using ODMA attributes and storing them permanently

If the ODMA attribute values must be stored permanently, for example to display
them as node type text in DocuLink later, the properties must be maintained in a
special table.

To use ODMA attributes:

1. Enter the properties that are to be saved in DesktopLink in the J_8A3T0012


table. For more information, see “Transferring and saving attributes”
on page 195.

2. In the ODMA-compatible application, define Text type user-defined properties


for the documents you want to enter. The property names must be identical to
the assigned selection fields in DocuLink. In addition, these special selection
fields have the prefix @ in DocuLink.

3. You can use the values from the document properties as presettings in the
DocuLink create screen when entering documents via DesktopLink. To do so,
activate automatic filling of fields in DocuLink . For more information, see
Section 10.3.3 “Assigning selection fields to attribute object fields” in OpenText
DocuLink for SAP Solutions - Customizing and Administration Guide (DC-CGD).

Using ODMA attribute values in DocuLink temporarily

In applications supporting ODMA, you can define user-defined Text type


properties in the menu option File > Properties > Customize tab. When you enter a
document from these applications using DesktopLink and store it in DocuLink,
these properties are evaluated. In this way, you can use properties that are already
known in the application, for example, the customer or product name, to restrict the
displayed DocuLink view. For the user, the navigation to the required node becomes
easier and faster. For this purpose, the ODMA attribute values only need to be
available temporarily, namely for the time of entry.

The possible properties and their effects are described in the following table.

Property name Value Result


%SZ_TYP DC30 Opens DocuLink in a
separate window
$PROJECT <Project name>, Opens the specified
for example, $EX_LINK DocuLink project[a]

210 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
14.1. Setting up DesktopLink

Property name Value Result


$TREENUM <View number>, Opens the specified
for example, 01 DocuLink view
$OPEN_NODETYPE <Node type>, The specified node in the
for example, DocuLink view is
ALL_CUSTOMERS automatically expanded, all
parent nodes up to the root
node are opened.
<Selection field name>, for Possible value for the Uses the property value as a
example, SF_CUST_NAME selection field, selection criterion and
for example, OpenText restricts the DocuLinkview
accordingly, that is only the
corresponding node is
expanded, in this example:
only the customer OpenText
[a] The most current version is used, that is in this order:
a. productive version (active or inactive)
b. the last modified development version
c. any other version
If no version exists then an error message is output.

Note the following naming convention when defining ODMA attributes:

Icon list

Prefix Used for


% OpenText specific property
$ DocuLink-specific property
SF Recommended for defining selection fields in DocuLink

Example 14-1: Using ODMA attribute values to restrict the DocuLink


view

In the following screenshot you can see how user-defined properties were
defined for a Word document, which are evaluated when the DocuLink view
is displayed. The view with expanded nodes for the specified customer
name and product number is displayed.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 211
ER160208-CCS-EN-01
Chapter 14 Archiving via the ODMA interface (DesktopLink)

Figure 14-7: Using ODMA attribute values to restrict the DocuLink view

Entering several documents at the same time

If several documents are selected simultaneously for entry and ODMA attributes
have been defined for several documents, the behavior depends on the particular
constellation. The following cases are possible:

Case Result
The values are identical for all documents. The settings are valid for all documents.
Some of the documents have identical values The settings are valid for all documents,
for the property, for the rest no values are including those for which no values were
specified for it. specified.
The documents have different values for the The most recently opened DocuLink view is
$PROJECT and/or $TREENUM property. opened; if that is not possible, the user must
select the project.
Values for selection fields are defined, The most recently opened DocuLink view is
however not for the $PROJECT and opened; if that is not possible, the user must
$TREENUM properties. select the project. The selection field settings
are ignored.
Different values are specified for the same The different values are evaluated as a multi-
selection field in different documents, for selection for the selection criterion (OR
example, SF_CUST_NAME = “IXOS” and operator); the view is opened and all
SF_CUST_NAME = “SAP”. specified values are displayed; in the
example the customers IXOS and SAP.

212 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
14.1. Setting up DesktopLink

Case Result
Values for different selection fields are The values are evaluated as different
specified in different documents, for selection criteria (AND operator); the view is
example, SF_CUST_NAME = “IXOS” in one opened and the node which fits all criteria is
document and SF_PROD_NAME = expanded; in the example the customer IXOS
“DocuLink” in another. with the product DocuLink.

14.1.8 Enhancements for DesktopLink


14.1.8.1 Enhancing SAP object types (for SAP ERP only)
DesktopLink offers enhanced functions for SAP ERP for some object types in the
form of subobjects. If you wish to use these, assign these subobject types to the
corresponding object types. You can display the subobject type configuration with
the object navigator. OpenText supplies the following enhanced subobject types:

SAP object type DesktopLink subobject type


LIPS J_8A3_LIPS
EKKO J_8A3_EKKO
DRAW J_8A3_DRAW
PREL J_8A3_PREL
PAPL J_8A3_PAPL
SOOD J_8A3_SOOD

To create further subobject types:

1. Run the SWO1 transaction.

2. Enter a name for the new (sub-) object type, and click Create.

3. In the Create dialog, enter the business object you want to extend in the
Supertype field.

4. Click OK. The new object type is displayed.

5. If the ArchiveLink interface (IFARCH21) does not yet exist under Interfaces, add
it.

6. If the method Confirm does not yet exist under Methods, add it.

Tip: You can use the method for the J_8A3_EKKO object type as a template.

7. Change the release status for the new object component:

a. Select the Methods folder.


b. Select the Edit > Change Release Status > Object type component > To
released menu option.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 213
ER160208-CCS-EN-01
Chapter 14 Archiving via the ODMA interface (DesktopLink)

8. Change the release status for the new object: select the Edit > Change Release
Status > Object type > To released menu item.

To assign subobject types:

1. Run the SWO6 transaction.

2. Click New entries.

3. Enter:

Object type
SAP object type, for example, BKPF.

Person responsible
Name of the employee responsible for customizing the object type.

Delegation type
DesktopLink subobject type to be assigned to the object type.

4. Repeat steps 3 and 4 for all object types you wish to enhance.

To display the subobject type configuration:

1. Run the SE80 transaction.


The object navigator is displayed.

2. Enter the J8A3 development class.

3. Click Business Engineering - Business Object type.


You see the subobject types and their short descriptions.

4. Double-click an object type to display the details. Enhancements are highlighted


in white.

14.1.8.2 Authorizations
You can use authorizations to restrict the documents that users can archive and link
to SAP documents. DesktopLink offers a range of standard authorization profiles
that you can assign to users, saving you the trouble of defining your own profiles.
These are the following:

Profile Containing Description


authorizatio
n
J_8AM_ALL J_8AM_ALL Authorizes the user to archive all object types.
J_8AM_USER
J_8AM_FI J_8AM_USER Authorizes the user to archive documents linked to FI-
J_8AM_BKPF specific object types.

214 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
14.2. ExchangeLink and NotesLink

Profile Containing Description


authorizatio
n
J_8AM_SD J_8AM_USER Authorizes the user to archive documents linked to SD-
J_8AM_VBAK specific object types.
J_8AM_LIPS
J_8AM_LIKP
J_8AM_HR J_8AM_USER Authorizes the user to archive documents linked to HR-
J_8AM_PAPL specific object types.
J_8AM_PREL
J_8AM_MM J_8AM_USER Authorizes the user to archive documents linked to MM-
J_8AM_EKKO specific object types.
J_8AM_SO J_8AM_USER Authorizes the user to archive documents linked to SO-
J_8AM_SOOD specific object types.
J_8AM_DVS J_8AM_USER Authorizes the user to archive documents linked to DVS-
J_8AM_DRAW specific object types.
J_8AM_ADM J_8AM_CUST Authorizes all utilization and customizing rights of
J_8AM_ALL DesktopLink, including converting document formats
J_8AM_ADM and assigning target document classes.

For more information on authorizations see “Authorizations in SAP applications”


on page 52.

14.2 ExchangeLink and NotesLink


With DesktopLink, you can also set up a connection from ExchangeLink and
NotesLink to the SAP application, so that you can archiveMicrosoft Outlook or
Lotus Notes objects (typically emails) and link them to SAP business objects. This
functionality is also called ExchangeLink or NotesLink.

To enable this link, the following conditions must be met:

• ExchangeLink or NotesLink are installed and configured correctly (see OpenText


Enterprise Library - Installation and Upgrade Guide (EL-IGD) or OpenText Imaging
NotesLink - Installation Guide (NL-IGD)).
• DesktopLink was fully configured for the required archiving scenarios (see
“Setting up DesktopLink” on page 185).
• For each type of mail attachment, and for the whole mail object, a matching
document type must be maintained in the SAP system (MSG for Microsoft
Exchange, NSF for Lotus Notes) and linked with an SAP object (and thereby also
with a logical archive); see also “Maintaining links” on page 84.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 215
ER160208-CCS-EN-01
Chapter 15
Archiving using generic object services (GOS) (for
SAP ERP only)

Generic object services (GOS) can be called independently of the SAP application.
Thus, the OpenText component DesktopLink can be opened directly from within an
SAP-specific transaction, and the underlying business object data for the transaction
can be used when archiving the document.

DocuLink can also be provided as a GOS. Thus, a preconfigured DocuLink view can
be displayed depending on the current business object data. There the familiar
DocuLink functionality is available as well, for example, archiving documents to an
object.

15.1 Setting up DesktopLink as a generic object


service (GOS)
To provide DesktopLink as a generic object service (GOS) in the SAP system, you
must perform the following steps:

1. Import the appropriate service; see Section 3.5 “DesktopLink” in OpenText


Archiving and Document Access for SAP Solutions - Installation and Upgrade Guide
(ER-IGD).
2. Create an entry for the object service in the GOS menu.

To create an entry for the DesktopLink object service in the GOS menu:

1. Open the SGOSATTR table, for example, in the SM30 transaction.

2. Create an entry for the DesktopLink service (IXOS_DL), if it doesn’t already


exist.

3. In the SGOSATTR table, select the Barcode entry , and open it in edit mode.
In the Next service field, enter IXOS_DL. This causes the DesktopLink entry to
follow the Barcode entry in the GOS menu.

4. In the SGOSATTR table, select the IXOS_DL entry and open it in edit mode.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 217
ER160208-CCS-EN-01
Chapter 15 Archiving using generic object services (GOS) (for SAP ERP only)

The value in the Class f.Gen.Service field must be /IXOS/CL_GOS_SERVICE_DL.

Important
In the Service type field, enter Single service. This is important as
otherwise the entry does not appear in the GOS menu.

5. Save your changes.


The DesktopLink GOS service is now available in all SAP applications.

15.2 Providing DocuLink as a generic object service


(GOS)
You can define DocuLink as a generic object service (GOS) and provide it in the GOS
menu. When you run this service for a specific business object in another
transaction, the specified view with the corresponding DocuLink data is displayed
in a separate window.

Note: Note that users require the authorization for the DocuLink project
opened by the GOS. Otherwise they cannot access the view despite the
available GOS function.

To provide DocuLink as a GOS:

1. Adapt the entry for the DocuLink object service in the GOS menu.

2. Define the assignment between the object type, for which the service is to be
provided, and the DocuLink view to be displayed. This assignment is project-
specific.

218 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
15.2. Providing DocuLink as a generic object service (GOS)

Note: To display Content Server documents in DocuLink views, the


VIEW_ATTA Attachment list GOS service must be configured for the employed
attribute objects, see Section 15.2 “Using GOS in DocuLink” in OpenText
DocuLink for SAP Solutions - Customizing and Administration Guide (DC-CGD).

To adapt the entry for the DocuLink object service in the GOS menu:

1. Open the SGOSATTR table, for example, in the SM30 transaction.

2. Make sure the DocuLink service IXOS_DC is included in the table.

3. In the SGOSATTR table, select the entry INFO_SERVICE, if available, otherwise


Barcode, and open it in edit mode.
In the Next service field, enter IXOS_DC. This causes the DocuLink entry to
follow the INFO_SERVICE or Barcode entries in the GOS menu.

4. In the SGOSATTR table, select the entry IXOS_DC, and open it in edit mode. In the
Class f.Gen.Service box, enter /IXOS/DC46_CL_GOS_SERVICE.

Important
In the Service type box, enter Single service. This is important as
otherwise the entry will not appear in the GOS menu.

5. Save your changes.


The DocuLink GOS services is now available in all SAP applications.

Note: The menu option is available in all SAP applications. However, if no


assignment is maintained for the object type used in the transaction to a
DocuLink view (in the /IXOS/DC46_TBGOS table, see “To define the
assignment between the object type and the DocuLink view:“
on page 219), or if the user does not have the required authorization for
the view, the function cannot be performed.

To define the assignment between the object type and the DocuLink view:

1. Run the DocuLink J6NP customizing transaction .

2. Select the DocuLink project and version you want to define the assignment for.

3. In the toolbar of the view editor, click GOS.

4. Add an entry in the table for each business object type for which you want to
provide the service, and enter the following values for it:

Note: If you create several entries for the same object type, a list of
available views is displayed when the GOS service is requested.

View
View number of the DocuLink view to be displayed

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 219
ER160208-CCS-EN-01
Chapter 15 Archiving using generic object services (GOS) (for SAP ERP only)

Node type
Node type to which the hierarchy tree is expanded when displayed. Usually
this is the document node that contains the documents assigned to the SAP
document.
Attribute object
Attribute object assigned to the SAP object type.
Object type
The business object, for example, BKPF. Corresponds with the SAP object
type in the attribute object settings.

220 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
Chapter 16

Archiving in SAP Records Management

Another possibility to archive documents is from within the SAP Records


Management. In this case, documents are linked to electronic records.

16.1 Document entry via DesktopLink


Using DesktopLink, you can also enter documents into a SAP Records Management
system directly from within Windows applications, and assign them to already
existing SAP records. Therefore, a new scenario called SAP Records Management is
available in the scenario selection dialog. The assignment between the scenario and a
particular Records Management system is specified in a special customizing view.

Note: Customizing for DesktopLink for Records Management has been


modified to allow for storage of documents to different types of records. The
user can select the required type during storage. The assignment to an archive
is now determined by the object type and the document type. The description
of the stored document in the record is derived from the description of the
document type, extended by the storage date.

To set up DesktopLink for Records Management, proceed as follows:

To define parameters for the assignment to a SAP Records Management


system:

1. Run the /IXOS/RM_CUST transaction.

2. Click RM DesktopLink Customizing (1).

3. Create an entry for each required assignment with the following values:

RMS ID
Record Management system ID in which the documents are to be stored, for
example, /IXOS/RM_COLD_PROJECT for the supplied sample RMS.

Element type ID for the record


The element type ID for the Record Service Provider, for example,
SRM_SPS_RECORD or /IXOS/RM_SPS_RECORD_INVOICES for the supplied
sample RMS.
This element type ID defines the service provider which enables inserting
new records in the specified Record Management system.

Anchor
Value of an anchor which defines the place where an ArchiveLink
document is to be inserted in the specified record.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 221
ER160208-CCS-EN-01
Chapter 16 Archiving in SAP Records Management

For each model node in record models you can specify a value for the
Anchor attribute. With the help of this anchor, new elements that are
automatically linked to a record can be inserted at a specified position.
Language
The language in which the description texts is to be output.
Element type ID for the ArchiveLink document
The element type ID for the Record Service Provider, for example,
SRM_SPS_AL_DOCUMENT (Standard-SAP) or /IXOS/
RM_SPS_AL_DOC_INVOICES from the supplied sample RMS.
This element type ID defines the service provider which enables inserting
new records in the specified Record Management system.
Description for the anchor
The description is displayed for the anchor selection when a document is
stored to a record. Enter the description of the assigned element type for
ArchiveLink documents, for example.

4. Store your entries and return to the start view in the /IXOS/RM_CUST
transaction.

5. In a second customizing step, define the assignment to the object type and the
document type. Thus the assignment to the storage system is also uniquely
defined (see “ArchiveLink management concept” on page 76).
Click RM DesktopLink Customizing (2).

6. Create an entry for each required assignment with the following values:

RMS ID
Record Management system ID in which the documents are to be stored, for
example, /IXOS/RM_COLD_PROJECT for the supplied sample RMS.
Element type ID for the record
The element type ID for the Record Service Provider, z.B. SRM_SPS_RECORD
(Standard-SAP) oder /IXOS/RM_SPS_RECORD_INVOICES aus dem
mitgelieferten Beispiel-RMS.
This element type ID defines the service provider which enables inserting
new records in the specified Record Management system.
Anchor
Value of an anchor which defines the place where a record or an
ArchiveLink document is to be inserted in the specified RMS.
For each model node in record models you can specify a value for the
Anchor attribute. Using this anchor, new elements that are automatically
linked to a record can be inserted at a specified position.
Doc.type
Object type of the document to be stored, usually RECORD.
Doc.type
Document type of the document to be stored.

222 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
16.2. Storing via mail applications

7. Maintain the assignment of the object type/the document type to the storage
system (OAC3).

Note: The description of the stored document in the record is derived from the
description of the document type.

16.2 Storing via mail applications


To store emails (and file attachments) directly from within Microsoft Outlook or
Lotus Notes and to link them to already existing Records Management records, you
must perform the following customizing steps:

1. Defining parameters for the assignment to a SAP Records Management system


(see “To define parameters for the assignment to a SAP Records Management
system:“ on page 221). Thus you define which records to link the mail file to.
This assignment is part of the general DesktopLink configuration for Records
Management.
2. For each type of mail attachment, and for the whole mail object, a matching
document type must be maintained in the SAP system (MSG for Microsoft
Exchange, NSF for Lotus Notes) and linked with an SAP object (and thereby also
with a logical archive); see also “Maintaining links” on page 84.
3. Maintain document types (for correct storage) and registry entries (for display)
for mail files.

Tip: User-defined ODMA attributes (properties), which were defined in the


mail application, can be transferred to an SAP system as well when archiving
via ExchangeLink or NotesLink.

For details see “Configuring attribute transfer” on page 192, and OpenText
Imaging ExchangeLink - User Guide (EXLK-UGD) or Section 1.2 “DesktopLink”
in OpenText Imaging NotesLink - User Guide (NL-UGD)

To maintain document types and registry entries for mail files:

1. Create entries for the required mail document types MSG or NSF) in the OAD2
transaction. This enables correct storage of these document types.

2. Make sure the following entries are available in the Windows registry, in order
to display the document types in the required application:

• [HKEY_CLASSES_ROOT\MIME\Database\Content Type\application/x-
msg]
"Extension"="msg"
"CLSID"="{0006F032-0000-0000-C000-000000000046}"
• [HKEY_CURRENT_USER\Software\IXOS\IXOS_ARCHIVE\Profile\Default
\CWin\AdapterService\Commands\open\TypeMapping]
"application/outlook"="msgfile"
"outlook"="msgfile"

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 223
ER160208-CCS-EN-01
Chapter 16 Archiving in SAP Records Management

16.3 Automatic (batch) import


You can import several documents in to the SAP Records Management system at the
same time and link them to an existing SAP record, or import several SAP records
with linked documents into an RMS at the same time.

To set up automatic import, proceed as follows:

1. Provide an element type for the record model in the Records Management
system
2. Configure the assignment to the Records Management system
3. Create the folder structure for batch import

16.3.1 Providing element types in the SAP Records


Management system
When archiving in the SAP Records Management system, several different element
types are required. Element types are the starting point for checking new elements
into Records Management or searching for them in Records Management. From a
technical point of view, an element type is a division of the elements of a service
provider. The element type sets the parameters for the service provider. You can
only use a service provider if at least one element type exists in this service provider.
For archiving you have the following possibilities:

• You can use the SAP default element types


• You can use the sample element types supplied by OpenText
• You can create your own element types and use them

The required element types are described shortly using the supplied sample element
types. For a detailed description see the SAP documentation on Records
Management.

To provide element types in the SAP Records Management system:

1. Create a new Records Management system ID (RMS_ID) for the S_AREA_RMS area
in the SRMREGEDIT transaction.
For example: /IXOS/RM_COLD_PROJECT
2. Create an element type for the service provider for record models
(SRM_SPS_Model)
For example: /IXOS/RM_SPS_MODEL_INVOICES for COLD invoices

a. Assign the RMS ID to this element type by entering the ID as a parameter


in the classification data. Then this element type appears in the ORGANIZER
transaction.
b. Assign a KPro LOIO class to the element type in order to store the
attributes of the record model in KPro.
3. Create an element type for records (SRM_SPS_RECORD service provider)

224 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
16.3. Automatic (batch) import

For example: /IXOS/RM_SPS_RECORD_INVOICES for the record type COLD


invoices

a. Assign the RMS ID to this element type by entering the ID as a parameter


in the classification data. Then this element type appears in the ORGANIZER
transaction.
b. Assign a KPro LOIO class to the element type, as well as a record model, in
order to store the attributes of the records in KPro.

4. Create an element type for ArchiveLink documents (SRM_SPS_AL_DOCUMENT


service provider)
For example: /IXOS/RM_SPS_AL_DOC_INVOICES for archived documents to
COLD invoices

a. Assign the project-specific ArchiveLink parameters to the element type.


b. Assign the RMS ID to this element type by entering the ID as a parameter
in the classification data. Then this element type appears in the ORGANIZER
transaction.

5. Create a concrete record model in the ORGANIZER transaction.


Assign the ArchiveLink element type and an anchor to the model.

6. If necessary, create your own LOIO and PHIO classes using the wizard in the
SRMCMCREATE transaction. Select the content model template.

7. If necessary, add other, user-specific attributes to the LOIO and PHIO classes
you created, for example, an invoice date and an invoice number.

a. Run the DMWB transaction.


b. Create a new entry for the used document area.
c. Define the required IO attributes. For example, you receive a reference to
the DDIC table by specifying the TABLE_NAME attribute.
d. Add further attributes to the LOIO or PHIIO class. These attributes will be
available during storage and retrieval later.

16.3.2 Configuring the assignment to the Records


Management system
To configure the assignment to the Records Management system:

1. Run the /IXOS/RM_CUST transaction.

2. Click RM Batch Import Customizing.

3. Define an entry for each configuration with the following parameters for
import:

Configuration
Name for this particular configuration of parameters

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 225
ER160208-CCS-EN-01
Chapter 16 Archiving in SAP Records Management

This is stored in the /IXOS/RM_TCOLD table and used during storage in the
RMS via the OpenText Document Pipeline.
Scenario type
The following scenarios are currently supported for batch import in Records
Management:

• Storing documents to an existing record


• Creating a new record with a document

RMS ID for SAP Records Management


ID of the Record Management system in which the record or the documents
are to be stored
Element type ID for the record
The element type ID for the Record Service Provider, for example,
SRM_SPS_RECORD or /IXOS/RM_SPS_RECORD_INVOICES for the supplied
sample RMS.
This element type ID defines the service provider which enables inserting
new records in the specified Record Management system.
For information on creating new element types seeOpenText DocuLink for
SAP Solutions - Customizing and Administration Guide (DC-CGD).
Element type ID for the ArchiveLink document
The element type ID for the Record Service Provider, for example,
SRM_SPS_AL_DOC or /IXOS/RM_SPS_AL_DOC_INVOICES for the supplied
sample RMS.
This element type ID defines the service provider which enables inserting
new records in the specified Record Management system.
Element type ID for a model
The element type ID for the record model, for example, SRM_SPS_MODEL or /
IXOS/RM_SPS_MODEL_INVOICES from the supplied sample RMS.
This element type ID defines the service provider which enables inserting
new record models in the specified Record Management system.
Document ID for a model
Model ID in which the record or the document is to be inserted.
Anchor
Value of an anchor which defines the place where an ArchiveLink
document is to be inserted in the specified record.
For each model node in record models you can specify a value for the
Anchor attribute. With the help of this anchor, new elements that are
automatically linked to a record can be inserted at a specified position.
Number range object, Number range number
optional: to enable automatic numbering of records
If no values are entered here, a record number must be defined explicitly in
the IXATTR file (see “Creating the folder structure for batch import”
on page 227).

226 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
16.3. Automatic (batch) import

Record description
This text appears as the record description in Records Management.
You can use system fields as variables in the text which are automatically
filled during creation (Transferring COLD attributes, see OpenText Document
Pipelines - Overview and Import Interfaces (AR-CDP)). In this case, enter the
system field (identical to the COLD attribute name), delimited by &, for
example, &invoicenr& for the invoice number. The system field itself may
not contain an &.

Document description
This text appears as the document description in Records Management.
As with the record description, variables can be used here as well.

4. Save the settings.

16.3.3 Creating the folder structure for batch import


During automatic import, a specified directory is searched for special subfolders that
contain the original document as well as an attribute file (IXATTR). If such subfolders
are found, the file contained within is stored and assigned to the SAP record
specified in the attribute file. In the Commands file you define, among other things,
which configuration parameters (which were defined in the last section,
“Configuring the assignment to the Records Management system” on page 225) are
to be used.
To store several documents at the same time, a special file structure must be created
in the so-called exchange directory ($EXT_DIR).
Only the special settings for batch import in SAP Records Management are
described here. For a complete description and details on batch import see Section 7
“Batch import interfaces” in OpenText Document Pipelines - Overview and Import
Interfaces (AR-CDP).

To create the folder structure for batch import:

1. COMMANDS file
In the Commands file, define the following additional parameters:

R3_RM_CONFIG_ID
A configuration ID which was defined in “Configuring the assignment to
the Records Management system” on page 225; specifies the assignment of
the document to be stored to the Records Management system

USE_VR4WFL
Enter the value 5, this specifies RFC mode

2. RFC mode
This RFC mode must be maintained once in the J_6NGTE26 table (for example,
in the SE16 transaction):

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 227
ER160208-CCS-EN-01
Chapter 16 Archiving in SAP Records Management

RFC_MODE 5
FUNCNAME /IXOS/RM_BATCH_IMPORT

3. IXATTR file
Add the following line to the attribute file IXATTR to create the link to the
configuration ID:
COMMANDS_VALUE dummy|R3_RM_CONFIG_ID|CC|R3-RM_CONFIG_ID

4. If no number range object and number were defined at the assignment to the
RMS (see “Configuring the assignment to the Records Management system”
on page 225), you must explicitly define a record number in the IXATTR file. To
do so, enter a line according to this sample:
ATTRIBUTES <table> | RECORDNUMBER | CC | <field value>,
for example, ATTRIBUTES dummy| RECORDNUMBER| CC | 70, to link the document
to the record number 70.

16.3.4 Troubleshooting in case of duplicates


During batch import in SAP Records Management, documents may be inserted in
already existing SAP records. Sometimes a document is to be inserted in a record
that already contains a duplicate of the document. In this case, the document is not
only inserted in the record, but also in the /IXOS/RM_TPROT table, together with
additional information. Using the SAP function module
BAPI_RECORD_DELETEELEMENTS (Delete Multiple Elements From Record) you
can then delete the duplicates from the corresponding records.

228 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
Chapter 17
Archiving in SAP PLM DMS (for SAP ERP only)

To archive via the SAP PLM Document Management System (DMS), SAP PLM DMS
must be fully installed and configured. This is not described in this manual, see the
SAP documentation for that. In the following, the configuration of the SAP system
for the special SAP PLM DMS archiving scenarios is described. The following
settings can be made in the /IXOS/PLM transaction:

Important: Workstation application and document type must be defined

In particular, in the specification of the Document types for the PLM DMS
document, the Use KPro option must be activated.
To activate the Use KPro option, run the SPRO transaction, click SAP Reference
IMG, and navigate to the Cross-Application Components > Document
Management > Control Data > Define Document Types menu option.

Furthermore, the corresponding workstation application for the document type


you want to archive must be configured in the SAP system. You can perform
this customizing in the SAP Reference IMG under Cross-Application
Components > Document Management > General Data > Define Workstation
Application and Cross-Application Components > Document Management >
General Data > Define Data Carrier.

17.1 Scanning into SAP PLM DMS


You can enter and assign an original document to an already existing PLM DMS
document by scanning it. To set up scanning, proceed as follows:

To scan into SAP PLM DMS:

1. Run the /IXOS/PLM transaction.


2. Select the Customizing > Scanning menu option.
3. Select the user you want to make the settings for, for example, the default user
%ALL.

4. If you want to delete the scanned document from the scan application
automatically after entry, activate the Delete doc. option.
5. Enter the storage category for the original document. You can only specify
storage categories for which the document area DMS was defined (OACT
transaction). If you use the F4 help, only such storage categories are listed.
If you do not specify a storage category here, a dialog appears for each scan
process in which the user must enter the storage category.
6. Save the settings.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 229
ER160208-CCS-EN-01
Chapter 17 Archiving in SAP PLM DMS (for SAP ERP only)

Additionally, you must add an entry in the registry of the scan client to ensure that
fax documents are displayed correctly in SAP PLM DMS. Add the following entry:

HKEY_CURRENT_USER\Software\IXOS\IXOS_ARCHIVE\Scan\iXSc2SAP
Single Page Format=multipage.fax

17.2 Setting up automatic (batch) import


You can import several documents into the SAP PLM DMS at once, and assign them
to already existing PLM DMS documents.

During automatic import, a specified directory is searched for special subfolders that
contain the original document as well as an attribute file. If such subfolders are
found, the file contained within is stored and assigned to the PLM DMS document
specified in the attribute file (for details on batch import see Section 7 “Batch import
interfaces” in OpenText Document Pipelines - Overview and Import Interfaces (AR-
CDP)).

To set up automatic import:

1. Run the /IXOS/PLM transaction.

2. Select the Customizing > Automatic Import menu option.

3. Select the user you want to make the settings for, for example, the default user
%ALL.

4. Define the following parameters for import:

Import directory
Specify the directory that will be searched for special subfolders. The
documents contained in them will then be imported.
Attribute file
Enter the name of the attribute file. Each document designated for import
requires a corresponding attribute file which contains the name of the PLM
DMS document for assignment. A file with the name specified here must be
included in each subfolder, otherwise import of this document will fail.
The attribute file must have the following contents:
DOCUMENT_FILENAME = <File name of the original document>
DOKNR = <PLM DMS document number>
DOKAR = <PLM DMS document type>
DOKVR = <PLM DMS document version>
DOKTL = <PLM DMS document part>

Example 17-1: Sample attribute file

DOCUMENT_FILENAME = salesorder.doc
DOKNR = jklfas083408jslk09328540
DOKAR = T1_21_03

230 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
17.3. Document entry via DesktopLink

DOKVR = 00
DOKTL = 000

Show dialog
If the PLM DMS document specified in the attribute file does not exist, the
import fails. If you want a dialog to be displayed in this case, so that the
user can specify a correct document, activate this option. Otherwise import
of this document is aborted and an error message is inserted in the log file.
Delete files
If you want the subfolders including the files they contain to be deleted
after the successful import, activate this option. In this case, no new log files
will be inserted for these documents.
Storage cat. orig.
Enter the storage category for the original document. You can only specify
storage categories for which the document area DMS was defined (OACT
transaction). If you use the F4 help, only such storage categories are listed.
If you do not specify a storage category here, a dialog appears for each
import process in which the user must enter the storage category.

5. Save the settings.

17.3 Document entry via DesktopLink


Using DesktopLink, you can also enter documents into the SAP PLM DMS directly
from within Windows applications, and assign them to already existing PLM DMS
documents. Therefore, a new scenario called SAP PLM is available in the scenario
selection dialog. If necessary, you can also store further document formats
(renditions) together with the original. To specify the PLM DMS object, you can use
ODMA attributes from the original documents.

To set up DesktopLink for SAP PLM DMS:

1. Run the /IXOS/PLM transaction.


2. Select the Customizing > DesktopLink for PLM menu option.
3. Define the following parameters for entry via DesktopLink for SAP PLM DMS:

Don't store original


By default, the original document is stored. If you do not want it to be
stored, for example, because only a rendition, that is a converted document,
is to be stored, activate this option.
Store rendition
If you convert the original document into a different format and want to
store that rendition, activate this option. The rendition can either be stored
in addition to or instead of the original document, depending on the Don't
store original option.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 231
ER160208-CCS-EN-01
Chapter 17 Archiving in SAP PLM DMS (for SAP ERP only)

Format rendition
If the original document is to be stored in a different or further format,
define the format of the rendition here.
Storage cat. orig.
Enter the storage category for the original document. You can only specify
storage categories for which the document area DMS was defined (OACT
transaction). If you use the F4 help, only such storage categories are listed.
If you do not specify a storage category here, a dialog appears for each
entry process in which the user must enter the storage category.
Storage cat. rend.
Enter the storage category for the converted document. You can only
specify storage categories for which the document area DMS was defined
(OACT transaction). If you use the F4 help, only such storage categories are
listed.
If you do not specify a storage category here, a dialog appears for each
entry process in which the user must enter the storage category.

4. Save the settings.

Tip: You can preconfigure the SAP PLM DMS scenario so that no scenario
selection dialog is displayed for the users. For more information see “User-
specific settings in the SAP application for DesktopLink” on page 188.

Automatic acquisition of ODMA attributes for specifying the PLM DMS object

You can configure DesktopLink so that the PLM DMS document keys for
assignment are automatically acquired from the ODMA attributes of the original
document. Thus the user need not enter the key explicitly during entry.

To configure attribute acquisition:

1. In the Microsoft Office application, define the following attributes:


DOKNR (= PLM DMS document number)
DOKAR = (PLM DMS document type)
DOKVR (= PLM DMS document version)
DOKTL (= PLM DMS document part)

2. Configure attribute acquisition as described in “Configuring attribute transfer”


on page 192.

232 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
Chapter 18

OpenText Forms Management

OpenText Forms Management is an additional component for managing scanned


standard forms and for displaying with outgoing SAP documents (such as orders,
order confirmations, delivery notes). In addition, you can display COLD document
lists and their forms using this component.

In the SAP system, outgoing documents (that is documents created by SAP reports)
are normally printed in standard forms, in order to obtain legible, attractive pages
into which graphical elements such as company logos can be integrated. This means
that the standard forms are filled with data generated by the SAP reports.

If you archive these documents and display them in the ArchiveLink Viewer, you
only see the data, not the form.

You can solve this problem by scanning in the forms and saving them in the archive.
You can then display the archived documents in their own forms.

Before you can usefully archive forms, you need to perform a few administrative
tasks. For SAP versions you also need to change an ABAP program code in the SAP
application. The steps required for this are explained in the following sections.

18.1 Components
OpenText Forms Management for SAP Solutions consists of the following
components:

• The software integrated in the SAP application, which is started with the J8AF
transaction from the main window of the SAP application. It is installed on the
SAP system using a transport file. For a more detailed description see Section 3.4
“Forms Management” in OpenText Archiving and Document Access for SAP
Solutions - Installation and Upgrade Guide (ER-IGD).
• Function module J_8AFM_GET_FORM or J_8AFM_GET_SMART_FORM These modules
supply the archive ID and document ID for a form and can be called either from
the SAP application or from an external application via RFC.

Note: The function module J_8AFM_GET_SMART_FORM requires the


following:

– Smart Forms to be used instead of the standard SAPscript forms that


were used previously
– the corresponding program for the Smart Form to be used and modified
(see “Modifying and linking the SAP ABAP program” on page 244).

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 233
ER160208-CCS-EN-01
Chapter 18 OpenText Forms Management

So that documents can be displayed with their associated forms, must be installed
on users' computers. This contains an enhanced link module for ArchiveLink.

18.2 Rights for OpenText Forms Management


To manage forms you need an user account for the SAP application with the
J_8AFM_ALL or J_8AFM_ADM profile. These profiles must be assigned to the user
responsible for administering and configuring the OpenText Forms Management.

To assign a profile to an user, run the SU01 transaction. Enter the user name and
click Change. On the Profile tab, enter J_8AFM_ALL (all rights) or J_8AFM_ADM (all
rights apart from Delete) in the list.

Notes

• Make sure the authorization profile is active before assigning it to an user.


• The new user rights become effective the next time the user logs on.

If you want to check the authorizations defined for OpenText Forms Management,
go to the object class J8AF or iXOS-ARCHIVE/fm object class and look for the iXOS-
ARCHIVE/fm authorization object.

The authorization list contains the authorizations defined for OpenText Forms
Management. The following activities are assigned to the authorizations:

• 01 Create form
• 02 Change form
• 03 Display form
• 04 Print form
• 05 (not allocated)
• 06 Delete form
• 07 Activate form

For more details see “Authorizations in SAP applications” on page 52.

18.3 Adding a form


The layout defined in the SAP application for an (archived) document can be
overlaid with an user-defined image, for example a company logo on a delivery
note. In this case, the document ID of the image (form) to archive must be
transferred with the document at generation, in addition to the SAP form (layout
description). Later you must modify the generation program, so that the archived
image is processed with the SAP layout description.

To add a new form to the system, you must perform the following tasks:

1. Starting OpenText Forms Management

234 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
18.3. Adding a form

2. Creating logical archives


3. Creating the form record
4. Assigning the form pages to OTF data pages
5. Scanning and archiving the forms
6. Activating the form
7. For SAP ERP:
Changing the report (in the program code) which generates the outgoing
documents, so that they contain the form's archive and document ID.
For SAP CRM:
Creating the processing class and method for the PPF which generates the
outgoing documents, so that they contain the form's archive and document ID.
8. Adjusting the alignment of the form pages until the OTF data is correctly
inserted.

Note: The procedure for OpenText Forms Management is described using SAP
ERP version 6.0. In other SAP releases, the individual menu options and in
particular the screen displays may differ from this description.

18.3.1 Starting OpenText Forms Management


Log on to the SAP system and run the J8AF transaction. The following screen is
displayed:

Figure 18-1: OpenText Forms Management: Form list

In this example several forms have already been integrated and activated. Reports
for creating outgoing documents can contain links to these forms. The scanned
forms are archived in the OpenText Archive Center. Double-click an entry to display
details about the form. The archive ID and document ID identify the archived form
uniquely.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 235
ER160208-CCS-EN-01
Chapter 18 OpenText Forms Management

The fields in the Form list window have the following meaning:

A
If a check mark appears in this column, the form is active.

Layout set
Enter the name for the page layout of the SAP script form or of the SAP
SmartForm. The page layout contains both the graphical elements in the form
and the text fields on each page.

Note: Whatever you enter in this field must match the entry in the SAP
ABAP program or in the action profile. See “Modifying and linking the
SAP ABAP program” on page 244 or “Creating an action profile”
on page 159.

Code
Distinguishes between forms that have the same layout, but which are available
in different languages, for example. A code might also indicate the enterprise
area for which the form was created.

Vers.
The version number is automatically incremented by 1 when you change a form.
The form with the highest version number is used automatically, if multiple
versions of the same form have been archived.
In the above example you can see that there are two versions of form
ZVORDER01.

Description
Long text describing the form.

18.3.2 Creating logical archivescollections


As for the ArchiveLink scenario, you create a collection in transaction oac0. For
details, see “Maintaining HTTP content repository in the SAP application”
on page 78.

18.3.3 Creating the form record


First you create a record with information about the new form. Here the name of the
assigned SAP form (that is the layout description) is assigned to the actual form (that
is the image to be archived). If documents with the same layout description but
different forms are to be provided, you can include an additional code to
differentiate the forms. Finally, you can also create different versions of a form,
although only one version of it can be valid (active) at any one time.

To create a new form, work in either the Form list (J8AF transaction) or in the Form
details view (select a form and click Detail). There are three ways of adding a new
form:

236 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
18.3. Adding a form

Create a new version of an existing form


Use this option, for example, if you want to use a form in the same way as
before, but the image needs to be updated.
In the form list, click the radio button at the left of the form and click New
version. The form details are displayed. The Layout set and Code fields are
write-protected, and the value in the Version field shows the next available
number.
Create a new form from an existing form
Use this option if you want to create a new form very similar to an existing form,
for example, a German version of an existing English form for the same type of
document.
In the form list, activate the radio button to the left of the form you wish to copy
and click Copy as in the standard toolbar. The form details are displayed. The
Layout set, Code and Description fields already contain the values of the copied
form. The Version field contains 0001, and Created by contains the current user
name.
Create a completely new form
Use this option if you need to create a form for a document to which no forms
have yet been assigned.
In the form list, click New. The form details are displayed. By default the
Archive id field contains the last value used, the Code field contains the value 0
and the Version field contains0001. The name of the current user and today's
date are also displayed.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 237
ER160208-CCS-EN-01
Chapter 18 OpenText Forms Management

Figure 18-2: OpenText Forms Management: Creating forms

When creating a completely new form, you need to enter the following form details:

Layout set
Here you must enter an SAP layout description for the output document, for
which an SAP processing program already exists. This is because the same
program that processes this layout description will also store the document with
the archived image (see also “Modifying and linking the SAP ABAP program”
on page 244).
If you use Smart Forms:
Enter the name of a Smart Form for which a processing method has been
defined.
Click this field and press F4. This displays a list of all Smart Forms defined on
the current client. Select an entry from the list. The name of this Smart Form is
copied to the Layout set field.
Note: The entry in this field must match the entry in the SAP ABAP
program or in the action profile. See “Modifying and linking the SAP
ABAP program” on page 244 or “Creating an action profile” on page 159.
Note that form names are always written in capitals in SAP!

238 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
18.3. Adding a form

Code
The Code field is important if no 1:1 relationship exists between the SAPscript
form or Smart Form and the form from OpenText Forms Management (for
example, if the same SAPscript form is used for an English and a German form.)
In this case, enter the organizational data such as sales code or purchasing
organization in the field that is used for identification. The system uses this
entry to assign an unique key to the form. If this is not required, you can accept
the default value 0000.

Example 18-1: Using codes to differentiate forms in SAP ERP


If you want to use different forms for different company codes, you can
assign the current company code in the generation program of the code
variables. You do this by inserting the following line in front of the
J_8AFM_GET_FORM function (see “Notes for function module
J_8AFM_GET_FORM” on page 249):
get parameter ´BUK´ field code.
By entering the appropriate value in the Code field for the different
forms, this form is used each time to display the OTF document.
If you want to use certain forms each time for certain company codes or
similar, you can assign the value to the code variable with a simple
select instruction.
This could look like this:
tables vbak.
select single * from vbak where vbeln = nast-objky.
if sy-subrc = 0.
code = vbak-vkorg.
endif.

Archive ID
Here you enter the archive in which the form is to be saved (see also “Creating
logical archivescollections” on page 236). Press F4 to display all available
archives. In this example the archive ID DU was selected.
Document ID
The document ID of the form to be archived is inserted automatically in the
following steps:

Continue with the Assign form pages.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 239
ER160208-CCS-EN-01
Chapter 18 OpenText Forms Management

18.3.4 Assigning form pages to document pages


Documents with multiple pages can be assigned to multiple-page forms. This
becomes necessary if the pages of a document are not identical and require different
forms to display and print the pages properly.

With this kind of document, the individual form pages need to be scanned in and
assigned to the pages of the document or a range of pages.

In the Form details window, click Assign form pages. The following window is
displayed:

Figure 18-3: OpenText Forms Management: Page assignment

By default it is assumed that only one form page exists, which is attached to all (N)
front pages of the document. A form can contain up to ten pages. Each page can be
assigned to a range of front (F) or back (B) pages of a document. The “N” value is
used as a placeholder for the number of document pages, if this number is not
known. You can also use ranges such as (1,N),(N,N) or (1,1).

Notes

• The system checks the entry in the assignment window for correct syntax,
but not for completeness or consistency. Thus it is possible to specify
overlapping page ranges, which has undesirable consequences when the
documents are displayed.

240 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
18.3. Adding a form

• Back pages to which no form is assigned are not displayed in the Windows
Viewer (because the back page of a document contains no data, a blank page
would otherwise be displayed).

Example 18-2: Assigning form pages to data pages

The order confirmation form should have two pages. The first page of the
form should be assigned to all front pages and the second to all back pages
of the document. The assignment for order confirmation looks like this:

Click Continue to save the form page assignment.

As soon as the link is created, the form details are displayed again, but now the Get
scanned form and Get form files buttons are available, in place of the Assign form
pages button. Continue with entering and archiving the form pages.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 241
ER160208-CCS-EN-01
Chapter 18 OpenText Forms Management

18.3.5 Entering and archiving form pages


You have completed the assignment of form pages to data pages. The next step
consists simply of entering and archiving the physical form pages, and linking the
archived form with the form record. The form pages can be entered in two ways:

• by scanning the pages

• by importing the pages from the file system.

18.3.5.1 Scanning form pages


You can use Enterprise Scan or the DesktopScan function in Windows Viewer to
scan in forms. A scanner must be connected and configured.

See the appropriate user documentation on how to scan with Windows Viewer. To
scan in Enterprise Scan, proceed as follows:

1. Scan the forms in the correct sequence.

2. Check the quality of the scanned images, making sure they are legible and have
adequate resolution.

3. In the scanning application, assign all form pages to one document and update
the document by clicking on the document header.

4. In the form detail window of the SAP application, click Get scanned form.
This sends a request to the scanning application to archive the current
document. The scanning software sends the document to the OpenText Archive
Center and returns the document ID for the form document. The creation of the
new form is now complete.

18.3.5.2 Form pages from the file system


If you do not have access to a scanner, you must create the form in another way. To
do this, the following conditions must be met:

• Each page must be saved in its own file. Consider to use either a TIFF file as
uncompressed, fax-compressed FAX Group 3 or 4 or a JPG file. Although the
OpenText viewers are quite tolerant regarding mixed formats, we recommend to
use either TIFF or JPG for all pages.
• The files must be saved on the local PC.

• Access to the exchange directory (see also “Creating an exchange directory”


on page 69) must be ensured from the workstation.

Once these conditions have been met, you can import the files as a form document.
Click Get form files. The following dialog box appears:

242 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
18.3. Adding a form

Figure 18-4: OpenText Forms Management: Importing form pages

Enter the path for the files containing the form pages, in the same order as they were
previously assigned to the data pages. Press F4 to display a dialog box where you
can select the path.

Once all the path names have been entered, click Preview to check the pages of
the new form in the OpenText viewer. In the Get form files dialog box, click
Continue and confirm. The pages are loaded onto the application server and
transferred from there to the OpenText Archive Center. The OpenText Archive
Center assigns the form document a document ID. The status bar of the form list
shows you whether the form was successfully created:

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 243
ER160208-CCS-EN-01
Chapter 18 OpenText Forms Management

Note: The file upload checks file extensions. It accepts TIF, FAX, JPG or JPEG
extensions. If a file without or with unknown extension is selected, the
program will ask the user for confirmation. The program does no type
conversions of single page files. If one or more files are uploaded with JPG or
JPEG extension, the program will set the MIME type according to the MIME
type definition of document class JPG. In all other cases the MIME type
according to document class TIF is used.

18.3.6 Activating the form


At first the new form is not activated for the goods issue slip, for example, it is not
yet valid. To activate it, select the WA_SCHEINVERS1 entry and click Active ↔
Inactive. You are then prompted to enter a date in the Activate form dialog box.

Figure 18-5: OpenText Forms Management: Activating the form

When you confirm the entry, the form becomes active from the date specified. The
default value is the next day. If you want to use the documents on the same day,
enter the current date.

Note: A program can only access forms that are activated and for which the
Active from date was set to the current date or earlier.

This step completes the creation of a new form. Now you still need to modify the
SAP program or the processing method of the action profile, so that the outgoing or
archived documents are overlaid with the new form.

18.3.7 Modifying and linking the SAP ABAP program


This work phase consists of four steps. The first step is only necessary if forms are to
be linked immediately when generating outgoing documents. To enable this, the
program that generates the documents must be modified. The following steps are
carried out in the SAP standard windows.

Overview of the steps and their aims:

1. Modifying the SAP ABAP program that generates outgoing documents. Each
outgoing document generated by this program contains in its header the archive
ID and the document ID of the form being used.
You only need to carry out this step if a form is to be assigned when an outgoing
document is generated. To enable this, modify the program so that the archive

244 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
18.3. Adding a form

ID and the document ID of the form are contained in the document type. When
the document is generated, a permanent link is created between the form and
the document.

Note: An outgoing document is created and given OTF or PDF format or


document class. A document class can be linked to any number of document
types. In this step, a document type is linked to a particular form.
2. Specify output determination. This links the program to the output type for the
document type.
3. Update the output type of the document type to include storage (only if the
document is to be archived).
4. Specify table in which the links between the documents and the form are to be
saved.

In the following we describe these steps using three examples.

18.3.7.1 SD module - using an SAPscript form


The following example refers to the following standard values:

• Order confirmation. The document type to be generated and linked to a form.


• Name. The form to be linked to order confirmations.
• ZVADOR01. This program generates the order confirmation. It creates certain
outgoing documents and accesses an include program, which starts the two
modules described below. These elements of the program must be modified in
order to link a form to a generated document. You generate a copy of the SAP
standard program and modify it to access a different include program.
• ZVADOPFO. include program. RVADOPFO is created as a copy of the include
program. This program must be modified.
• J_8AFM_GET_FORM. The first module started by the include program. The module
inserts the archive ID and the document ID in the header of the generated
document. (See TOA_DARA structure under the J_8AFM_GET_FORM module, which
is described below)
• OPEN_FORM. The second module started by the include program. This module
inserts storage information in the header of the generated document. The so-
called DARA row contains fields for the archive ID and the document ID of the
form.

To identify the program:

To find the program belonging to the document type, look for the link between
document type and program in the message control. The exact procedure for
identifying the output types can vary greatly between different SAP ERP versions.
This example shows the procedure for SAP ERP version 6.0.

1. Run the SPRO transaction and double-click SAP Reference IMG.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 245
ER160208-CCS-EN-01
Chapter 18 OpenText Forms Management

2. Select [+] Sales and Distribution > [+] Basic Functions > [+] Output Control >
[+] Output Determination > [+] Output Determination Using the Condition
Technique > [+]Maintain Output Determination for Sales Documents.

3. Click IMG Activity next to Maintain Output Types.

4. Select the appropriate output type for Order confirmation and double-click
Processing routines in the folder structure in the left pane of the window.
A table containing the processing routine is displayed. In this case, the program
is called RVADOR01.

To create and modify the ZVADOR01 program:

This SAP program generates the outgoing documents of the Order confirmation
type. It must be copied and modified. To do this you need a developer key, which
you can obtain from the SAP Service Marketplace.

In this example, we copy the RVADOR01 program and assign it the new name
ZVADOR01. To do this, proceed as follows:

1. In the main SAP application window, run the SE38 transaction.

2. In the Program field, enter the name RVADOR01. Then select Source code, and
click Copy in the standard toolbar. The Copy Program dialog is displayed.

3. Enter ZVADOR01 here as the target program and click Copy.

4. Activate Includes in the subsequent dialog box so that the include programs are
also copied. Click Copy.

5. The include programs are displayed in another dialog box. Activate at least the
RVADOPFO checkbox and enter the name ZVADOPFO. To comply with the naming
conventions for user-defined components, the name must begin with Z. This
ensures that these components are not overwritten when the system is updated
or expanded.
Click Copy again.

6. In the next dialog box, type your entry in the Development class field or click
Local Object at the bottom.

7. In the original SAP application window, enter the name of the program you just
generated in the Program field, select the Source code and click Change. The
program code is displayed and can be edited.

8. Check whether the include rvadopfo row in include zvadopfo has been
modified.

FORM FORM_OPEN *
*----------------------------------------------------*
* Start of printing the form *
*-------------------------------------------------------------*
* --> US_SCREEN Output on screen *
* ' ' = printer *

246 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
18.3. Adding a form

* 'X' = screen *
* --> US_COUNTRY County for telecommunication and SET COUNTRY*
*-------------------------------------------------------------*

FORM FORM_OPEN USING US_SCREEN US_COUNTRY.

INCLUDE ZVADOPFO.

ENDFORM.

9. Save and close the file.

To modify the ZVADOPFO include program:

1. In the previous step you already copied the RVADOPFO include program under
the name ZVADOPFO. Now the program is modified in order to start the
J_8AFM_GET_FORM module and process the returned data. The include program
also starts the OPEN_FORM module.
J_8AFM_GET_FORM supplies the archive ID and the document ID of the form in
the FORMARCHIV and FORM_ID fields of the TOA_DARA structure. The TOA_DARA
structure of the OPEN_FORM module contains the data for the DARA rows.

Important
SY-SUBRC must be checked. If the value after starting OpenText Forms
Management is not 0, you must take appropriate measures. A value other
than 0 for SY-SUBRC means that no active form was found and that the
order confirmation was not archived. Unfortunately, this cannot be left to
error handling in the code, because no one is informed if no active form is
found.

In this example, no rows from the RVADOPFO include source program were
deleted. To insert the function module in the ABAP editor, use the Insert
Pattern function. You should call up J_8AFM_GET_FORM immediately before
calling up OPEN_FORM.

Important
If you want to copy the new text and insert it directly in the ABAP Editor,
remember to first insert the required number of empty rows at the
appropriate position. Otherwise the inserted text overwrites the existing
code!

a. Open the ZVADOR01 include file in the ABAP editor.


b. Open the ZVADOPFO include file by double-clicking it.
2. The rows that must be added to start J_8AFM_GET_FORM, are highlighted in the
example below.
Modify the program as follows:

***INCLUDE ZVADOPFO .

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 247
ER160208-CCS-EN-01
Chapter 18 OpenText Forms Management

DATA: LVS_ITCPO TYPE ITCPO,


LVF_DEVICE(30) TYPE C,
LVF_DIALOG(1) TYPE C VALUE ' ',
LVS_RECIPIENT LIKE SWOTOBJID,
LVS_SENDER LIKE SWOTOBJID,
LVS_SNAST TYPE SNAST,
LVF_PROGRAM LIKE SY-REPID,
LVS_COMM_TYPE TYPE AD_COMM,
LVS_COMM_VALUES TYPE SZADR_COMM_VALUES.

* IXOS /fm code inserted by ...


data: ret_code like sy-subrc,
code like j_8afm-code value '0000'.

* [...]

* fill structure itcpo


ITCPO = LVS_ITCPO.

* IXOS /fm code inserted by ...


CALL FUNCTION 'J_8AFM_GET_FORM'
EXPORTING
* CLIENT = SY-MANDT
CODE = code
LAYOUT_SET = tnapr-fonam
* VERSION = ' '
IMPORTING
FORM_ARCH_ID = toa_dara-formarchiv
FORM_DOC_ID = toa_dara-form_id
RETURN_CODE = ret_code
EXCEPTIONS
CODE_DOES_NOT_EXIST = 1
FORM_DOES_NOT_EXIST = 2
VERSION_DOES_NOT_EXIST = 3
OTHERS = 4
.
IF SY-SUBRC <> 0.
* MESSAGE ID SY-MSGID TYPE SY-MSGTY NUMBER SY-MSGNO
* WITH SY-MSGV1 SY-MSGV2 SY-MSGV3 SY-MSGV4.
retcode = sy-subrc.
perform protocol_update.
ENDIF.

* open form
CALL FUNCTION 'OPEN_FORM'
EXPORTING
archive_index = toa_dara
* [...]

3. Save this file.

248 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
18.3. Adding a form

Notes for function module J_8AFM_GET_FORM

This function module inserts the archive ID and the document ID of the form in the
header of the generated document. In the Importing code section, modify the
program to include the desired form (Layout_set) and its code.

Specify the TOA_DARA structure in the Exporting section. Make sure you use the
same TOA_DARA structure here as the one used in the OPEN_FORM function call
described above.

Open the source code for the J_8AFM_GET_FORM function module by double-clicking
it in the ABAP editor.

The source code header looks like this:

FUNCTION J_8AFM_GET_FORM.
*"-------------------------------------------------------------------
---
*"*"Local interface:
*" IMPORTING
*" VALUE(CLIENT) LIKE J_8AFM-MANDT DEFAULT SY-MANDT
*" VALUE(CODE) LIKE J_8AFM-CODE
*" VALUE(LAYOUT_SET) LIKE J_8AFI-LAYOUT_SET
*" VALUE(VERSION) LIKE J_8AFM-VERSION DEFAULT ' '
*" EXPORTING
*" VALUE(FORM_ARCH_ID) LIKE TOA_DARA-FORMARCHIV
*" VALUE(FORM_DOC_ID) LIKE TOA_DARA-FORM_ID
*" VALUE(RETURN_CODE) LIKE SY-SUBRC
*" EXCEPTIONS
*" CODE_DOES_NOT_EXIST
*" FORM_DOES_NOT_EXIST
*" VERSION_DOES_NOT_EXIST

The CLIENT parameter is optional. By default, the active client is used. The VERSION
parameter is also optional. If it is not set, the archive ID and the document ID for the
active form are returned with the highest version number. This ensures that the
current form version is always used without having to update each program every
time the form is changed. By specifying an activation date for a new form version
you can control when the newest version comes into effect (see also “Activating the
form” on page 244).

To assign the ABAP program (Adjusting output determination):

If you want to change the generation of a document, as we do in our example to


insert a form overlay, you must link a new program with the corresponding
document type, that is you must adapt the output determination.

In the above example you have created a new program called ZVADOR01 on the basis
of the RVADOR01 program. Now specify the ZVADOR01 program as the output
determination for the Order confirmation document type.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 249
ER160208-CCS-EN-01
Chapter 18 OpenText Forms Management

1. In the main SAP application window, run the VOK2 transaction. The Maintain
Output Determination window is displayed.

2. Select the Output > Processing programs > Sales menu item and in the
Determine Work Area: Entry dialog, enter the output type BA00.

3. The Change View 'Processing Routines': Overview dialog is displayed.

Figure 18-6: OpenText Forms Management: Processing routines SD

4. Find the row with the Print output Medium and in this row change the name
of the Program, in this example from SD_SDOC_PRINT01 to ZVADOR01. The entry
should be written in capitals in accordance with SAP convention.

5. Check that the name of the SAP form for which the original program was
written is in the Form column. Note that form names are always written in
capitals in SAP!

6. Save your entries.

If you also want to archive order confirmations, you must also modify the BA00
standard output type.

To modify the BA00 standard output type:

1. In the main SAP application window, run the VOK2 transaction.

2. Select the SD Document > Sales Document > Condition type menu item.

250 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
18.3. Adding a form

3. In the following Change output types: details view, click Display →


Change in the toolbar. This displays a list of output types, which can be edited.

4. Scroll to the BA00 Output type, and double-click it. The View output types:
details view is displayed for the BA00 message type.

5. Select the Storage system tab. Enter one of the following values in the
Archiving mode field:

• 2: Archive only: for storage only


• 3: Print and archive: for printing and storage

6. Enter the Document type with which the program is to be linked, in our
example, this is SDOORDER.

Tip: You can also create a special document type for documents with
forms. To do this, copy the SDOORDER document type to the OAC2
transaction, for example, to ZSDOORDER. Define PDF as the Document class.

7. Click Save in the standard toolbar.

Maintaining the link

In this step, you combine the document type with an archive (content repository), an
object type and a link table. To do this, run the OAC3 transaction (for more details see
“Maintaining links” on page 84). For the example document type SDOORDER, use the
VBAK object type.

To generate the document linked to the form:

All the prerequisites are now available to create a new order confirmation or to
archive an existing one using our example:

1. Select the Logistics > Sales and Distribution > Sales > Order menu item of the
SAP menu.

2. Click Create. The Create Sales Order window is displayed.

3. Enter the data required for the order confirmation. When you confirm your
entries, the archive ID and the document ID of the form are inserted in the OTF
data and the order confirmation is archived. Run the OAM1 transaction to
monitor the process.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 251
ER160208-CCS-EN-01
Chapter 18 OpenText Forms Management

18.3.7.2 SD module - using a Smart Form


In SAP ERP 6.0, a Smart Form (LE_SHP_DELNOTE) is defined for the Delivery note
message type in the Distribution module by default.

The following example refers to the following standard values:

• Delivery. The document type to be generated and linked to a form.


• Name. The form to be linked to order confirmations.
• RLE_DELNOTE. This program generates the Delivery. It creates certain outgoing
documents and accesses an include program, which starts the two modules
described below. These elements of the program must be modified in order to
link a form to a generated document. You create a copy of the SAP standard
program and modify it.
• J_8AFM_GET_SMART_FORM. The module inserts the archive ID and the document
ID in the header of the generated document. (See the TOA_DARA structure in the
J_8AFM_GET_SMART_FORM module, which is described below)

• LF_FM_NAME. This module inserts storage information in the header of the


generated document. The so-called DARA row contains fields for the archive ID
and the document ID of the form.

To identify the program:

To find the program belonging to the document type, look for the link between
document type and program in the message control. The exact procedure for
identifying the output types can vary greatly between different SAP ERP versions.
This example shows the procedure for SAP ERP version 6.0.

1. Run the SPRO transaction and double-click SAP Reference IMG.

2. Select [+] Logistics Execution > [+] Shipping > [+] Basic Shipping Functions >
[+] Output Control > [+] Output Determination > [+] Maintain Output
Determination for Outbound Deliveries.

3. Click IMG Activity next to Maintain Output Types.

4. Select the appropriate output type for the Delivery note (LD00) and double-
click Processing routines in the folder structure in the left pane of the window.
A table containing the processing routine is displayed. In this case, the program
is called RLE_DELNOTE.

To create and modify the RLE_DELNOTE program:

This ABAP program generates the outgoing documents of the Delivery type. It
must be copied and modified. To do this you need a developer key, which you can
obtain from the SAP Service Marketplace.

In this example, we copy the RLE_DELNOTE program and assign it the new name
ZRLE_DELNOTE. To do this, proceed as follows:

252 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
18.3. Adding a form

1. In the main SAP application window, run the SE38 transaction.


2. In the Program field, enter the name RLE_DELNOTE. Then select Source code,
and click Copy in the standard toolbar. The Copy Program dialog is displayed.
3. Enter ZRLE_DELNOTE here as the target program and click Copy.
The Includes dialog does not need to be activated in this case, as no include
programs will be modified.
4. In the next dialog box, type your entry in the Development class field or click
Local Object at the bottom.
5. In the original SAP application window, enter the name of the program you just
generated in the Program field, select the Source code and click Change. The
program code is displayed and can be edited.
6. Now the program is modified in order to start the J_8AFM_GET_SMART_FORM
module and process the returned data.
J_8AFM_GET_SMART_FORM supplies the archive ID and the document ID of the
form in the FORMARCHIV and FORM_ID fields of the TOA_DARA structure. The
TOA_DARA structure of the LF_FM_NAME module contains the data for the DARA
rows.

Important
SY-SUBRC must be checked. If the value after starting OpenText Forms
Management is not 0, you must take appropriate measures. A value other
than 0 for SY-SUBRC means that no active form was found and that the
order confirmation was not archived. Unfortunately, this cannot be left to
error handling in the code, because no one is informed if no active form is
found.

In this example, no rows from the RLE_DELNOTE source program were deleted.
To insert the function module in the ABAP editor, use the Insert Pattern
function. You should call up J_8AFM_GET_SMART_FORM immediately before
calling up LF_FM_NAME.

Important
If you want to copy the new text and insert it directly in the ABAP Editor,
remember to first insert the required number of empty rows at the
appropriate position. Otherwise the inserted text overwrites the existing
code!
7. The rows that must be added to start J_8AFM_GET_SMART_FORM, are highlighted
in the example below.
Modify the ZRLE_DELNOTE program as follows:

*----------------------------------------------------------------
------** Print of a delivery note by SAPscript SMART FORMS *
*----------------------------------------------------------------
-----*
REPORT ZRLE_DELNOTE.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 253
ER160208-CCS-EN-01
Chapter 18 OpenText Forms Management

* declaration of data
INCLUDE RLE_DELNOTE_DATA_DECLARE.
* definition of forms
INCLUDE RLE_DELNOTE_FORMS.
INCLUDE RLE_PRINT_FORMS.

...

IF CF_RETCODE = 0.

* get form
data: l_rc type SY-SUBRC.

CALL FUNCTION 'J_8AFM_GET_SMART_FORM'


EXPORTING
* CLIENT = SY-MANDT
CODE = '0000'
LAYOUT_SET = LF_FORMNAME
* VERSION = ' '
IMPORTING
FORM_ARCH_ID = TOA_DARA-FORMARCHIV
FORM_DOC_ID = TOA_DARA-FORM_ID
RETURN_CODE = l_rc
EXCEPTIONS
CODE_DOES_NOT_EXIST = 1
FORM_DOES_NOT_EXIST = 2
VERSION_DOES_NOT_EXIST = 3
OTHERS = 4 .

IF SY-SUBRC <> 0.
* error handling
CF_RETCODE = SY-SUBRC.
PERFORM PROTOCOL_UPDATE.

* MESSAGE ID SY-MSGID TYPE SY-MSGTY NUMBER SY-MSGNO


* WITH SY-MSGV1 SY-MSGV2 SY-MSGV3 SY-MSGV4.
ENDIF.
* end form

* call smartform delivery note


CALL FUNCTION LF_FM_NAME
EXPORTING
ARCHIVE_INDEX = TOA_DARA

8. Save this file.

254 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
18.3. Adding a form

Notes for function module J_8AFM_GET_SMART_FORM

This function module inserts the archive ID and the document ID of the form in the
header of the generated document. In the Importing code section, modify the
program to include the desired form (Layout_set) and its code.

Specify the TOA_DARA structure in the Exporting section. Make sure you use the
same TOA_DARA structure here as the one used in the LF_FM_NAME function call
described above.

Open the source code for the J_8AFM_GET_SMART_FORM function module by double-
clicking it in the ABAP editor.

The source code header looks like this:

FUNCTION J_8AFM_GET_SMART_FORM.
*"-------------------------------------------------------------------
---
*"*"Local interface:
*" IMPORTING
*" VALUE(CLIENT) LIKE J_8AFM-MANDT DEFAULT SY-MANDT
*" VALUE(CODE) LIKE J_8AFM-CODE
*" VALUE(LAYOUT_SET) LIKE J_8AFM-LAYOUT_SET
*" VALUE(VERSION) LIKE J_8AFM-VERSION DEFAULT ' '
*" EXPORTING
*" VALUE(FORM_ARCH_ID) LIKE TOA_DARA-FORMARCHIV
*" VALUE(FORM_DOC_ID) LIKE TOA_DARA-FORM_ID
*" VALUE(RETURN_CODE) LIKE SY-SUBRC
*" EXCEPTIONS
*" CODE_DOES_NOT_EXIST
*" FORM_DOES_NOT_EXIST
*" VERSION_DOES_NOT_EXIST
*"-------------------------------------------------------------------
---

The CLIENT parameter is optional. By default, the active client is used. The VERSION
parameter is also optional. If it is not set, the archive ID and the document ID for the
active form are returned with the highest version number. This ensures that the
current form version is always used without having to update each program every
time the form is changed. By specifying an activation date for a new form version
you can control when the newest version comes into effect (see also “Activating the
form” on page 244).

To assign the ABAP program (adjusting output determination):

If you want to change the generation of a document, as we do in our example to


insert a form overlay, you must link a new program with the corresponding
document type, that is you must adapt the output determination.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 255
ER160208-CCS-EN-01
Chapter 18 OpenText Forms Management

In the above example you have created a new program called ZRLE_DELNOTE on the
basis of the RLE_DELNOTE program. Now you define the ZRLE_DELNOTE program as
the output determination of the Delivery document type. To do this, proceed as
follows:

1. In the main SAP application window, run the VOK2 transaction. The Maintain
Output Determination window is displayed.
2. Select the Output > Processing programs > Shipment menu item and in the
Determine Work Area: Entry dialog, enter the output type LD00 ein.
The Change View 'Processing Routines': Overview dialog is displayed.

3. Look for the row with the Medium Print output and in this row, change the
name of the Program, in this case from RLE_DELNOTE to ZRLE_DELNOTE. The
entry should be written in capitals in accordance with SAP convention.
4. Check that the name of the SAP form for which the original program was
written is in the SmartForm column.

Note: In SAP, form names are always written in capitals.

5. Save your entries.

If you also want to archive order confirmations, you must also modify the LD00
standard output type.

To modify the LD00 standard output type:

1. In the main SAP application window, run the VOK2 transaction.

256 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
18.3. Adding a form

2. Select the SD document > Delivery > Condition type menu item.
3. In the following Change output types: details view, click Display →
Change in the toolbar. This view displays a list of output types that can be
edited.

4. Scroll to the LD00 Output type and double-click it. The View output types:
details view is displayed for the LD00 message type.

5. Select the Storage system tab. Enter one of the following values in the
Archiving mode field:

• 2: Archive only: for storage only


• 3: Print and archive: for printing and storage

6. Enter the Document type with which the program is to be linked, in our
example, this is SDODELNOTE.

Tip: You can also create a special document type for documents with
forms. To do this, copy the SDODELNOTE document type to the OAC2
transaction, for example, to ZSDODELNOTE. Define PDF as the Document
class.

7. Click Save in the standard toolbar.

Maintaining the link

In this step, you combine the document type with an archive (content repository), an
object type and a link table. To do this, run the OAC3 transaction (for more details see
“Maintaining links” on page 84). For the example document type SDODELNOTE, use
the LIKP object type.

To generate the delivery linked to the form:

All the prerequisites are now available to create a new delivery or to archive an
existing one using our example:

1. Select the Logistics > Sales and Distribution > Shipping and Transportation >
Shipment > Create > Single documents option from the SAP menu and click
one of the Create functions to create a delivery.

2. Enter the data required for the delivery. When you confirm your entries, the
archive ID and the document ID of the form are inserted in the OTF data and
the delivery is archived. Run the OAM1 transaction to monitor the process.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 257
ER160208-CCS-EN-01
Chapter 18 OpenText Forms Management

18.3.7.3 MM module
The following example refers to the following standard values:

• Purchase order. The document type to be generated and linked to a form.


• Name. The form to be linked to order confirmations.
• ZSAPFM06P. This program generates the Purchase Order. It creates certain
outgoing documents and accesses an include program, which starts the two
modules described below. These elements of the program must be modified in
order to link a form to a generated document. You generate a copy of the SAP
standard program and modify it to access a different include program.
• ZFM06PE02. include program. FM06PE02 is created as a copy of the include
program. This program must be modified.
• J_8AFM_GET_FORM. The first module started by the include program. The module
inserts the archive ID and the document ID in the header of the generated
document. (See TOA_DARA structure under the J_8AFM_GET_FORM module, which
is described below)
• ME_PRINT_PO. The second module started by the include program. This module
inserts storage information in the header of the generated document. The so-
called DARA row contains fields for the archive ID and the document ID of the
form.

To identify the program:

To find the program belonging to the document type, look for the link between
document type and program in the message control. The exact procedure for
identifying the output types can vary greatly between different SAP ERP versions.
This example shows the procedure for SAP ERP version 6.0.

1. Run the SPRO transaction and double-click SAP Reference IMG.

2. Select [+] Materials Management > [+] Purchasing > [+] Messages > [+] Output
Control > [+] Message Types.

3. Click IMG Activity next to Define Message Types for Purchase Order.

4. Double-click Maintain Message Types for PO.

5. Select the appropriate output type for purchase orders and double-click
Processing routines in the folder structure in the left pane of the window.
A table with the required program (in this case SAPFM06P) is displayed.

To create and modify the ZSAPFM06P program:

This ABAP program generates the outgoing documents of the Purchase Order type.
It must be copied and modified. To do this you need a developer key, which you can
obtain from the SAP Service Marketplace.

258 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
18.3. Adding a form

In this example, we copy the SAPFM06P program and assign it the new name
ZSAPFM06P. To do this, proceed as follows:

1. In the main SAP application window, run the SE38 transaction.


2. In the Program field, enter the name SAPFM06P. Then select Source code, and
click the Copy in the standard toolbar. The Copy Program dialog is displayed.
3. Enter ZSAPFM06P here as the target program and click Copy.
4. Activate Includes in the subsequent dialog box so that the include programs are
also copied. Click Copy.
5. The include programs are now displayed in another dialog box. Activate at least
the FM06PE02 checkbox and enter the name ZFM06PE02. To comply with the
naming conventions for user-defined components, the name must begin with Z.
This ensures that these components are not overwritten when the system is
updated or expanded.
Click Copy again.
6. In the next dialog box, type your entry in the Development class field or click
Local Object at the bottom.
7. In the original SAP application window, enter the name of the program you just
generated in the Program field, select the Source code and click Change. The
program code is displayed and can be edited.
8. Make sure the INCLUDE FM06PE02 row was renamed to INCLUDE ZFM06PE02.

*****************************************************************
*******
* Druckroutinen für Einkaufsbelege *
*****************************************************************
*******

*----------------------------------------------------------------
------*
* Datenteil
*----------------------------------------------------------------
------*
INCLUDE FM06PTOP.

*----------------------------------------------------------------
------*
* Datenbeschaffung
*----------------------------------------------------------------
------*
INCLUDE FM06PF01.
...

INCLUDE ZFM06PE02.

9. Save and close the file.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 259
ER160208-CCS-EN-01
Chapter 18 OpenText Forms Management

To modify the FM06PE02 include program:

1. In the previous step you already copied the FM06PE02 include program as
ZFM06PE02. Now the program is modified in order to start the
J_8AFM_GET_FORM module and process the returned data. The include program
also starts the ME_PRINT_PO module.
J_8AFM_GET_FORM supplies the archive ID and the document ID of the form in
the FORMARCHIV and FORM_ID fields of the TOA_DARA structure. The TOA_DARA
structure of the ME_PRINT_PO module contains the data for the DARA rows.

Important
SY-SUBRC must be checked. If the value after starting OpenText Forms
Management is not 0, you must take appropriate measures. A value other
than 0 for SY-SUBRC means that no active form was found and that the
order confirmation was not archived. Unfortunately, this cannot be left to
error handling in the code, because no one is informed if no active form is
found.

In this example, no rows from the ZFM06PE02 include source program were
deleted. To insert the function module in the ABAP editor, use the Insert
Pattern function. You should call up J_8AFM_GET_FORM immediately before
calling up ME_PRINT_PO.

Important
If you want to copy the new text and insert it directly in the ABAP Editor,
remember to first insert the required number of empty rows at the
appropriate position. Otherwise the inserted text overwrites the existing
code!

a. Open the ZSAPFM06P program in the ABAP editor.


b. Open the ZFM06PE02 include file by double-clicking on it.
2. The rows that must be added to start J_8AFM_GET_FORM, are highlighted in the
example below.
Modify the ZFM06PE02 include file as follows:

form entry_neu using ent_retco ent_screen. data: l_druvo like


t166k-druvo, l_nast like nast, l_from_memory, l_doc type
meein_purchase_doc_print. * --> begin ixos forms overlay Data:
l_RETURN_CODE LIKE SY-SUBRC, l_CODE LIKE J_8AFM-CODE VALUE
'0000'.

clear ent_retco. if nast-aende eq space. l_druvo = '1'. else.


l_druvo = '2'. endif.

call function 'ME_READ_PO_FOR_PRINTING' EXPORTING ix_nast =


nast ix_screen = ent_screen IMPORTING ex_retco = ent_retco
ex_nast = l_nast doc = l_doc CHANGING cx_druvo = l_druvo
cx_from_memory = l_from_memory. check ent_retco eq 0.

260 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
18.3. Adding a form

CALL FUNCTION 'J_8AFM_GET_FORM' EXPORTING *


CLIENT = SY-MANDT
CODE = l_CODE
LAYOUT_SET = tnapr-fonam *
VERSION = ' ' IMPORTING
FORM_ARCH_ID = toa_dara-formarchiv
FORM_DOC_ID = toa_dara-FORM_ID
RETURN_CODE = l_RETURN_CODE EXCEPTIONS
CODE_DOES_NOT_EXIST = 1 FORM_DOES_NOT_EXIST =
2 VERSION_DOES_NOT_EXIST = 3 OTHERS
= 4. IF SY-SUBRC <> 0 or l_RETURN_CODE <> 0. ent_retco = 32.
ENDIF. check ent_retco = 0. * --> end ixos forms overlay

call function 'ME_PRINT_PO' EXPORTING ix_nast = l_nast


ix_druvo = l_druvo doc = l_doc ix_screen = ent_screen
ix_from_memory = l_from_memory ix_toa_dara = toa_dara
ix_arc_params = arc_params ix_fonam = tnapr-fonam "HW
214570 IMPORTING ex_retco = ent_retco. endform.

3. Save and activate this file.

Notes for function module J_8AFM_GET_FORM

This function module inserts the archive ID and the document ID of the form in the
header of the generated document. In the Importing code section, modify the
program to include the desired form (Layout_set) and its code.

Specify the TOA_DARA structure in the Exporting section. Make sure you use the
same TOA_DARA structure here as the one used in the OPEN_FORM function call
described above.

Open the source code for the J_8AFM_GET_FORM function module by double-clicking
on it in the ABAP editor.

The source code header looks like this:

FUNCTION J_8AFM_GET_FORM.
*"-------------------------------------------------------------------
---
*"*"Local interface:
*" IMPORTING
*" VALUE(CLIENT) LIKE J_8AFM-MANDT DEFAULT SY-MANDT
*" VALUE(CODE) LIKE J_8AFM-CODE
*" VALUE(LAYOUT_SET) LIKE J_8AFI-LAYOUT_SET
*" VALUE(VERSION) LIKE J_8AFM-VERSION DEFAULT ' '
*" EXPORTING
*" VALUE(FORM_ARCH_ID) LIKE TOA_DARA-FORMARCHIV
*" VALUE(FORM_DOC_ID) LIKE TOA_DARA-FORM_ID
*" VALUE(RETURN_CODE) LIKE SY-SUBRC
*" EXCEPTIONS
*" CODE_DOES_NOT_EXIST
*" FORM_DOES_NOT_EXIST

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 261
ER160208-CCS-EN-01
Chapter 18 OpenText Forms Management

*" VERSION_DOES_NOT_EXIST
*"-------------------------------------------------------------------
---

The CLIENT parameter is optional. By default, the active client is used. The VERSION
parameter is also optional. If it is not set, the archive ID and the document ID for the
active form are returned with the highest version number. This ensures that the
current form version is always used without having to update each program every
time the form is changed. By specifying an activation date for a new form version
you can control when the newest version comes into effect (see also “Activating the
form” on page 244).

To assign the ABAP program (adjusting output determination):

If you want to change the generation of a document, as we do in our example to


insert a form overlay, you must link a new program with the corresponding
document type, that is you must adapt the output determination.

In the above example you have created a new program called ZSAPFM06P on the
basis of the SAPFM06P program. Now you define the ZSAPFM06P program as the
output determination of the Purchase Order document type. To do this, proceed as
follows:

1. In the main SAP application window, run the V/G9 transaction. The Determine
Work Area: Entry window is displayed.
2. Select the NEU output type and the EF application and confirm by pressing the
ENTER key.
The Change View 'Processing Routines': Overview dialog is displayed.

262 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
18.3. Adding a form

3. Find the row with the Medium Print output and in this row change the name
of the Program, in this case from SAPFM06P to ZSAPFM06P. The entry should be
written in capitals in accordance with SAP convention.

4. Check that the name of the SAP form for which the original program was
written is in the Form column. Note that form names are always written in
capitals in SAP!

5. Save your entries.

If you also want to archive order confirmations, you must also modify the NEU
standard output type.

To modify the NEU standard output type:

1. In the main SAP application window, run the NACT transaction.

2. Enter EF as the application and click Display.

3. In the following Change output types: details view, click Display →


Change in the toolbar. This displays a list of output types, which can be edited.

4. Scroll to the NEU Output type, and double-click it. The View output types:
details view is displayed for the NEU message type.

5. Select the Storage system tab. Enter one of the following values in the
Archiving mode field:

• 2: Archive only: for storage only


• 3: Print and archive: for printing and storage

6. Enter the Document type with which the program is to be linked, in our
example, this is MEOORDER.

Tip: You can also create a special document type for documents with
forms. To do this, copy the MEOORDER document type to the OAC2
transaction, for example, to ZMEOORDER. Define PDF as the Document class.

7. Click Save icon in the standard toolbar.

Maintaining the link

In this step, you combine the document type with an archive (content repository), an
object type and a link table. To do this, run the OAC3 transaction (for more details see
“Maintaining links” on page 84). For the example document type MEOORDER, use the
EKKO object type.

To generate the purchase order linked to the form:

All the prerequisites are now available to create a new purchase order or to archive
an existing one using our example:

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 263
ER160208-CCS-EN-01
Chapter 18 OpenText Forms Management

1. Select the Logistics > Materials Management > Purchasing > Purchase Order
menu option of the SAP menu and click one of the Create functions to create a
purchase order.

2. Enter the data required for the order confirmation. When you confirm your
entries, the archive ID and the document ID of the form are inserted in the OTF
data and the purchase order is archived. Run the OAM1 transaction to monitor
the process.

18.3.8 Defining a processing method for the PPF and


specifying it in the action profile
In SAP CRM document output is managed by the processing method in a processing
class. The method and class must be entered when you define the action profile for
outgoing documents in the PPF (see “Creating an action profile” on page 159Step
16).

To create and edit the processing method:

1. Copy the template for the CL_DOC_PROCESSING_CRM_ORDER processing class


with the CRM_ORDER_EXEC_SMART_FORM processing method.

2. In the method code, look for this line:

* -------> ls_archive_index-object_id = ls_orderadm_h-GUID

3. Remove the comment sign for this line.

4. Replace the ls_orderadm_h-GUID entry with the object ID of the object type
that corresponds to the outgoing document.

5. Below this line, enter the following code in the method:

* get form
data:
l_rc type SY-SUBRC.

CALL FUNCTION 'J_8AFM_GET_SMART_FORM'


EXPORTING
* CLIENT = SY-MANDT
CODE = '0000'
LAYOUT_SET = IP_SMART_FORM
* VERSION = ' '
IMPORTING
FORM_ARCH_ID = ls_archive_index-FORMARCHIV
FORM_DOC_ID = ls_archive_index-FORM_ID
RETURN_CODE = l_rc
EXCEPTIONS
CODE_DOES_NOT_EXIST = 1
FORM_DOES_NOT_EXIST = 2
VERSION_DOES_NOT_EXIST = 3
OTHERS = 4

264 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
18.3. Adding a form

.
IF SY-SUBRC <> 0.
* MESSAGE ID SY-MSGID TYPE SY-MSGTY NUMBER SY-MSGNO
* WITH SY-MSGV1 SY-MSGV2 SY-MSGV3 SY-MSGV4.
ENDIF.
* end form

Note: IP_SMART_FORM for the name of the Smart Form is now used as
input for the LAYOUT_SET parameter. The previous J_8AFM_GET_FORM
function can only process Smart Forms with names containing up to 16
characters.

6. Now you need to amend the action profile used to output the documents (see
also “Creating an action profile” on page 159Step 16):

a. Run the CRMC_ACTION_DEF transaction or use the wizard in the IMG:


Customer Relationship Management > Basic Functions > Actions > Create
Actions with Wizard.
b. Enter the following parameters in the Print processing type settings:

Form name
Name of the form created in Section 18.3.3; Note that form names are
always written in capitals in SAP!
Processing class
Name of the (copied) processing class with the edited processing
method
Processing method
Name of the edited processing method from Step 5.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 265
ER160208-CCS-EN-01
Chapter 18 OpenText Forms Management

Figure 18-7: OpenText Forms Management: Processing method

7. Save your entries.

18.4 Defining offset and layout of forms


Sometimes the form and the SAP data are not exactly aligned when initially
displayed after archiving. This is due to the fact that, when printing the document,
the SAP application uses printer-specific information which is not accessible to
Windows Viewer; it may also occur when a document is not in the proper position
during scanning.
For more information on customizing forms in the SAP application, see “Adding a
form” on page 234.

18.4.1 Adjusting forms


You can adjust the form manually so that it is aligned with its contents by moving it
in Windows Viewer. The archive administrator can correct the offset values in the
SAP application later.

Note: Adjusting forms in Windows Viewer is not possible for PDF documents.

To adjust forms:

1. Customize a new form in the SAP application.

266 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
18.4. Defining offset and layout of forms

It is possible to scan and archive the form in Windows Viewer.

2. Archive a document linked with the new form.

3. Open the archived document in Windows Viewer.

4. In the Tools menu, click Move Form.

5. In the Move Form dialog box, define the settings:

Form´s Offset
Defines the offset values for the form so that it is aligned with its contents.
Horizontal
Defines the space between the content and the left-hand edge of the
form.
Vertical
Defines the space between the content and the upper edge of the form.

Units
Specifies the unit used for the offset settings. You can choose between:

• Twips (the equivalent of 1/1440 inches)


• 1/10 mm
• Mils (1/1000 inch)

6. Click Apply.
The form is moved in accordance with your settings.

7. Repeat steps 2 and 3 until you are satisfied with the results.
Or, you can click in the document and move the form by holding down the
mouse button. The defined values are automatically passed to the dialog box.

8. Transfer the resulting offset values to your SAP application.

18.4.2 Adjusting the form layout for COLD documents


(FORM.INFO)
To assign forms to COLD documents you have to use the FORM.INFO file. The offset
and layout values of the form are defined in this file. The values can be set using a
wizard in Windows Viewer.

To adjust the form layout for COLD documents:

1. Open an ASCII document with an underlying form from the archive, one that is
similar to the document for which you wish to store form and format
information.

2. On the Tools menu, click Set-up Layout.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 267
ER160208-CCS-EN-01
Chapter 18 OpenText Forms Management

Note: This menu item is only available when the EnableFormEdit=1 entry
is set in the Registry under
HKEY_CURRENT_USER\Software\IXOS\IXOS_ARCHIVE\Viewer\General.

3. In the Form and Format Management dialog box, select the unit to be used for
the offset settings, and then click Next. You can choose between:

• Twips (the equivalent of 1/1440 inches)


• 1/100 mm
• Mils (1/1000 inch)

Note: Every dialog box of the form wizard contains the buttons Apply
and Back. Click Apply to view the effects of your input on the appearance
of the document. Click Back to return to the previous dialog box.

4. In the Skip pages dialog box, in the Number of pages to skip field, specify any
pages you wish to skip at the beginning of the document, and then click Next.

5. In the Assignment of form pages to document pages dialog box, specify which
pages of the document should be linked to which page of the form, and then
click Next.

Form Page
Lists the individual pages of the underlying form.

Doc. Page Range


Defines a range of pages in the document that are linked to the relevant
page of the form.

Side
Specifies whether a given page of a form is a front or reverse side.

6. In the Form page column, select a form page, and then right-click:

• New
Creates a new link.
• Edit
Edits the selected link.
• Delete
Deletes the selected link.

7. To create a new link, right-click New, or to edit an existing link, right-click Edit.

8. In the Page Range dialog box, assign pages and then click OK.

Form page
Defines the page number of the form for which the assignment is being
made.

268 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
18.4. Defining offset and layout of forms

Page Range
Specifies the page range to which this form page will be assigned.

From
Specifies the first page that will be assigned to this form page.

To
Specifies the last page that will be assigned to this form page.
The * symbol is a wildcard for the last page of the document.

Side
Specifies whether the front or reverse side of the page will be assigned
to this form page.

9. In the Assignment of form pages to document pages dialog box, click Next.

10. In the Page size and orientation dialog box opens, specify the paper size, and
then click Next.

Note: This dialog box is only displayed if the open ASCII document has
no underlying form.

Format
Specifies the paper size.
If you select user-defined, the Width, and Height fields are enabled and
you can specify the page size dimensions there.

Orientation
Specifies the orientation of the page.

Custom
Specifies the user-defined paper size.

11. In the Document offset dialog box, specify the document's offset, that is the
offset of the form from the document content, and then click Next.

Document offset
Specifies the offset of the form from the document content.

Horizontal
Specifies the space between the file content and the left-hand edge of
the page.

Vertical
Specifies the space between the file content and the upper edge of the
page.

12. In the Text layout dialog box, specify the visual appearance of the text, and then
click Next.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 269
ER160208-CCS-EN-01
Chapter 18 OpenText Forms Management

Text layout
Specify the visual appearance of the text.
Font height
Specifies the font height.
Font width
Specifies the font width.
Characters per line
Specifies the number of characters per line.
Line distance
Specifies the line length.

13. Optional In the Save form and format definition dialog box, click Print to print
out the document with the settings you have defined. Make sure the Form
option is activated in the Print with section of the Print dialog.
14. To save the settings in the file system as FORM.INFO, click Finish.
In the future you can use this file for archiving COLD documents. The edited
document template remains unchanged in the archive.

18.5 Assigning forms to COLD documents


You only have to carry out this step if you want to display COLD documents with
forms. There are two types of COLD documents: Document lists and print lists.
Since these are not SAP application documents, do not use SAPscript form names.

The following description uses the example of a document list with individual
invoices. Follow the procedure described above (see “Creating the form record”
on page 236) to create a form with the name FG_SINGLE.

In order to integrate the form with the COLD document list, the OpenText
Document Pipeline requires the archive ID and the document ID of the form. To do
so, the corresponding COLD document type is added in the COMMANDS file. Add a
line with the following contents:
COMP FORM.INFO ASCII FORMULAR_INFO

The file must also contain another line to form the link to OpenText Forms
Management:
FORMULAR_ID FG_SINGLE

where FG_SINGLE is the name of the example form.

The R3Formid DocTool uses this data to call up the archive ID and the document ID
using an RFC call from the J_8AFM_GET_FORM function module of OpenText Forms
Management (the J_8AFM_GET_SMART_FORM function module is not supported here).

Note: Form names cannot contain more than 16 characters.

270 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
18.6. Options for OpenText Forms Management

The DocTool inserts these IDs in the FORMULAR_INFO file. However, you still need to
enter the form page assignment and the x and y offset values.

Note: Note that the page assignment used to create a form in OpenText Forms
Management is not used here. Changing the offsets described in the “Adjusting
the form layout for COLD documents (FORM.INFO)” on page 267 section has
no effect. Other parameters for aligning the form to the document are
contained in the FORMULAR_INFO file. These include: page format, line spacing
and character size.

Specify the page assignment and orientation in the Windows Viewer using the Form
and Format management wizard (see “Adjusting the form layout for COLD
documents (FORM.INFO)” on page 267).

18.6 Options for OpenText Forms Management


18.6.1 Copying forms
18.6.1.1 Client and archive copy
Forms are normally created with a test client. The above example used the 800
client. When you are satisfied with the results of your work, you can copy the form
to the production client and save it in the production archive. The following
example uses the 810 client as the production client.

After you log on and run the J8AF transaction, the list of forms available for this
client is still empty. To copy the forms from the 800 client, select Form list > Copy
from. This displays a dialog box which prompts you to enter the test client and the
archive ID of the production client.

Press F4 to see a list of valid entries. If the to Archive field is left blank, the archive
ID of the forms to be copied is used.

If you use a different archive ID, the forms are copied to the new archive and
assigned new document IDs. If the archive IDs are identical, only the entries in the
J_8AFM form table are copied from the test client to the production client.

Click Continue when you have made your entries. This displays a dialog box
containing the forms available to the specified client.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 271
ER160208-CCS-EN-01
Chapter 18 OpenText Forms Management

Figure 18-8: OpenText Forms Management: Client and archive copy

Use the checkboxes to select the forms to be copied (in our example these are
MEDRUCK and WA_SCHEINVERS1).

Click Copy. All selected forms are copied to the production client. (If a form already
exists on the production client, it is not overwritten.)

Figure 18-9: OpenText Forms Management: Form list

The new forms are displayed in the form list. The bottom line of the dialog box
specifies the number of forms copied.

272 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
18.6. Options for OpenText Forms Management

18.6.1.2 Archive copies of forms


If different SAP systems exist for testing and production, you may wish to copy
forms between them. The client remains the same, but the forms must be copied to
the production archive. In the following example the 800 client is used.

To copy forms to the production archive:

1. Log on to the test system client.


2. Run the J8AF transaction and select Form list > Copy from from the menu.
3. In the dialog box, select the 800 client and the archive ID of the production
archive (RD in the example).
4. Click Continue. The forms available on the test client are displayed.
5. Select the FIIINVOICE and RVORDER01 forms to copy them to the production
archive.
6. Click Copy.
The version number of the copied forms is increased by 1. In order to identify
the forms more easily, the old version number is added to the description.

Figure 18-10: OpenText Forms Management: Form list

If several versions of a form are to be copied, the copied versions of the form receive
the next higher version numbers not yet assigned for the existing form.

Example 18-3: Copying form versions

Let's say the production archive already contains versions 0001 and 0002 of
form ZVORDER01. Now you need to copy versions 0002 and 0003 of form

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 273
ER160208-CCS-EN-01
Chapter 18 OpenText Forms Management

ZVORDER01 to the production archive. The copied versions of the form then
receive version numbers 0003 and 0004 in the production archive, because
these are the next higher version numbers that have not yet been allocated
for this form. So there are now versions 0001,0002 (existing), 0003 and 0004
(new) of form ZVORDER01 in the production archive.

In the next step, you need to copy table J_8AFM to another SAP system. You will
then be able to delete the forms in the test archive.

18.6.1.3 Copying the form table


To copy the contents of the J_8AFM table with its form information to another SAP
system, select Form list > Transport.

You can select the entries and assign them to a transport request. Once you have
made your selection, a list of forms appears, as shown below:

Figure 18-11: OpenText Forms Management: Transporting forms

Select all the forms whose information you wish to transfer, and click Transport. The
SAP dialog box for inputting a change request number appears.

You can either select an existing change request number, or click Create Request.
The following dialog box appears:

Enter a description, for example, Correction to table J8AF. The system then
assigns a new number and enters it in the change request dialog box, S46K900112 in
the example.

Click Continue. The selected table entries are added to the correction file, and the
OpenText Forms Management start window appears once more. The number of
forms added and the associated correction file are displayed in the status bar at the
bottom of the window.

The change request, in this case S46K900112, can now be transferred to the new SAP
system in the usual way.

274 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
18.6. Options for OpenText Forms Management

18.6.2 Checking the status of a form


Click Check in the J8AF transaction. This sends a request to the archive system
querying the status of the selected form. The status is then displayed at the bottom
of the dialog box.

If the status is ONLINE, the form can be accessed and you can view it by clicking
View. This starts the Windows Viewer and the form is displayed.

18.6.3 Deleting forms


You can delete a form from the list view. In the J8AF transaction, select the entry you
want to delete and click Delete.

Important
Be very careful when you delete a form, because this may prevent outgoing
documents from being created. First make sure that there are no programs that
still access the version of the form that you intend to delete.

When you delete a form, you only delete the link in the SAP application. No
delete instruction is forwarded to the archive (content repository), and the
form itself is retained.

18.6.4 Activating and deactivating forms


A form must be activated before it can be accessed by a program. At first a new form
(or a new version of a form) is not activated. To switch on the activation status, select
the form in the OpenText Forms Management start window (J8AF transaction) and
click Active↔ Inactive. The date on which the form becomes active must have been
entered, otherwise you cannot activate the form. The form list specifies whether a
form is active or not. The activation date is displayed in the form detail view.

Important
Proceed with care when you deactivate a form, because programs cannot
access deactivated forms.

Note: If several versions of the same form were activated, the version used is
the one with the highest number and an activation date that is already past.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 275
ER160208-CCS-EN-01
Chapter 18 OpenText Forms Management

18.6.5 Printing a form list


You can print the form list by selecting Form list > Print from the menu. Specify the
fields to print and the sequence in the dialog box that opens.

18.6.6 Detail view of an entry


Only the most important information about a form is displayed in the start window
(J8AF transaction). To get further details you must select the entry and click either
Detail or double-click a field in the form. A detail view looks like this:

Figure 18-12: OpenText Forms Management: Form details

The following information is also displayed:

• Name of the user who created the form and the creation date
• Name of the user who activated/deactivated the form and the activation/
deactivation date.
• Logical archive ID and document ID of the scanned form.

276 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
18.6. Options for OpenText Forms Management

Click Form list > Print to show the assignment of the form pages to the data pages
(see “Assigning form pages to document pages” on page 240).

Click Change Offset to move the data page of the SAP document in relation to the
form when it is displayed. See “Adjusting the form layout for COLD documents
(FORM.INFO)” on page 267).

18.6.7 Tracking changes in OpenText Forms Management


The creation, deletion and activation of forms is logged in the J_8AFM change
document.

Select Goto > Change documents from the menu in the J8AF transaction. The SAP
change documents start window appears. Click Display by number or Display by
field to display a selection window for change requests of the J_8AFM object class.
When you run the program, all the change requests created in OpenText Forms
Management are displayed

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 277
ER160208-CCS-EN-01
Chapter 19
Rendition Management

Using the rendition functionality requires a complete OpenText Rendition Server


(Rendition Server) installation. On the use of the OpenText Rendition Server
functionality, the following information is available:

• For scenarios using DesktopLink, see “Archiving via the ODMA interface
(DesktopLink)“ on page 185 and “Configuring client-side (classic) conversion to
TIFF or PDF” on page 197.
• For scenarios using DocuLink, see Section 23 “Maintaining Rendition Server” in
OpenText DocuLink for SAP Solutions - Customizing and Administration Guide (DC-
CGD).
• For procedures using DocuLink, see Section 10 “Exporting documents (OpenText
Rendition Server)” in OpenText DocuLink for SAP Solutions - User Guide (DC-
UGD).

Note: For more details on Rendition Server, see OpenText Rendition Server -
Installation and Administration Guide (RS-IGD).

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 279
ER160208-CCS-EN-01
Chapter 20
Displaying and processing documents with
OpenText viewers

Depending on the required functionality and system requirements, OpenText offers


the following viewers:

Windows Viewer
Viewer with full functionality, including scanning, archiving and document
processing. Requires installation at the client.
Java Viewer
Viewer with restricted functionality, no scanning or archiving. Requires no
installation, however a Java Virtual Machine is necessary.
Web Viewer
Viewer with limited functionality, no scanning, archiving or text processing in
the document. Requires no installation or special components other than a Web
browser on the client.

Depending on the employed viewer, some additional configuration settings are


required.

You can access the customizing in SAP IMG > OpenText Archiving and Document
Access for SAP Solutions > Imaging (Viewer) Integration.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 281
ER160208-CCS-EN-01
Chapter 20 Displaying and processing documents with OpenText viewers

20.1 Configuration for the Windows Viewer


20.1.1 Communication
20.1.1.1 Communication protocols in SAP applications
Windows Viewer and SAP applications recognize and handle archived documents
according to their document class. The association with a document class is
determined by the format in which a document is saved. The document class
determines the program used to recall and display the document. Windows Viewer
currently supports these document classes: ALF, FAX, PDF, OTF, JPG (see
“Document class” on page 72). It also displays ASCII documents. ASCII is a simple
text format which contains no formatting apart from blank characters, line breaks
and form feeds. For more details see Section 1.3 “Supported document formats and
functions” in OpenText Imaging Windows Viewer - User Guide (CLWVW-UGD).

How a document class is handled is defined in a protocol in SAP applications (OAA3


transaction). A protocol is assigned to an archive (content repository, archive) . This
ensures that all documents of a document class held in the same archive (content
repository) are handled in the same way.

You maintain and create ArchiveLink applications in the OAA4 transaction.

282 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
20.1. Configuration for the Windows Viewer

For information about handling and setting up communication protocols, see


Section 12 “Handling communication protocols” in OpenText Archiving and Document
Access for SAP Solutions - Installation and Upgrade Guide (ER-IGD).
For an additional description see “Protocol” on page 73.

Note: OpenText recommends using the OT-... protocols supplied.

Communication The ODMA takes over all the communication between the Windows Viewer and the
between OpenText Archive Center. This communication within the OpenText system can run
OpenText
components
via RPC or HTTP. Whether RPC or HTTP is used is specified on the OpenText
Imaging Clients using a parameter.

Enhanced When running communication between OpenText Imaging Clients and OpenText
security Archive Center via HTTP, you must secure the communication between the
individual components; see “Protocol” on page 73.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 283
ER160208-CCS-EN-01
Chapter 20 Displaying and processing documents with OpenText viewers

20.1.1.2 Communicating via OLE

Figure 20-1: Communicating via OLE

If you are using OT_OLEU1 protocol, the communication when displaying an


archived document runs like this:

1. The SAP GUI receives the document ID (ARC_DOC_ID), the name of the archive
(ARCHIV_ID) and the document class from the SAP server.

2. The SAP GUI transmits the request to the Windows Viewer to call up the
archived document via OLE. If necessary, the SAP GUI starts the Windows
Viewer.

3. The Windows Viewer addresses the ODMA component. First it looks on the
Administration Server to identify the OpenText Archive Center on which the
archive (content repository) resides. Which Administration Server is accessed
by ODMA is defined by a parameter:
In OpenText Imaging Configuration:

a. Start the OpenText Imaging Configuration using the cladmcli.exe


command in the command line.
b. Select the profile and click Open - Whole profile in the context menu.
c. Select one of the following procedures:

1. Select CWin / ArchiveLink and select the HTTP FollowURl checkbox.


2. In the Registry:

284 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
20.1. Configuration for the Windows Viewer

HKEY_CURRENT_USER/Software/IXOS/IXOS_ARCHIVE/Profile/
<Profile_name>/CWin/ArchiveLink/HTTP FollowUrl – set value to 1

or

1. Select CWin / ArchiveLink and clear the HTTP FollowURl checkbox.

2. In the Registry:
HKEY_CURRENT_USER/Software/IXOS/IXOS_ARCHIVE/Profile/
<Profile_name>/CWin/ArchiveLink/HTTP FollowUrl – set value to 0
or is not set.

3. Select CWin / ArchiveLink / Archive-0 and enter the


ADMServerName.

4. In the Registry:
HKEY_CURRENT_USER/Software/IXOS/IXOS_ARCHIVE/Profiles/
<Profile_name>/CWin/ArchiveLink/Archive-0/ADMServerName

With option HTTP FollowUrl set to 1 (TRUE), the Windows Viewer follows the
URL.
With option HTTP FollowUrl set to 0 (FALSE), the URL to view the document
is build according to the configuration of the Administration Server. For this,
the OpenText Archive Centers must be recognized by the responsible
Administration Server.

4. The Administration Server sends the name of the OpenText Archive Center
(DShost) to the ODMA.

5. The ODMA addresses the Document Service of the named OpenText Archive
Center and asks for the document class.

6. The Document Service supplies the document class.

7. The ODMA addresses the Document Service again and requests the document.

8. The Document Service supplies the document contents. If the Windows Viewer
can display this document class, it now displays the document.

9. - 11. The further steps only take place if the Windows Viewer cannot itself
display the document class. The next step depends on the protocol:

OT_OLEU1

• The Windows Viewer sends a request to the ODMA interface. The


ODMA establishes the MIME type of the document and launches the
required application (not illustrated).

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 285
ER160208-CCS-EN-01
Chapter 20 Displaying and processing documents with OpenText viewers

20.1.1.3 Communicating via HTTP


If you are using the OT_HTTP2 protocol, the communication when displaying an
archived document runs like this:

1. The SAP server generates an URL, which contains the document ID, archive ID
(name of the archive/content repository), component ID, Archive Center and
port and can be signed using the SecKey. This URL is stored via the SAP GUI in
an HTML file in the SAP working directory on the client.
2. The HTML file is called up and opens the browser registered for HTML.
3. The browser sends the URL to the OpenText Archive Center.
4. The Document Service provides the document contents and the MIME type.
5. The browser starts the application registered for the MIME type (see also
“Protocol OT_HTTP2: Registering the Windows Viewer for PDF and JPG”
on page 288). The application displays the document within the browser.

20.1.2 Settings
You find a summary of all parameter setting options in the OpenText Imaging Viewers
and DesktopLink - Configuration Guide (CL-CGD).

20.1.2.1 Settings for document display with Windows Viewer


Defining the Internet browser as the standard viewer

In order to take advantage of the Windows Viewer functionality when displaying


documents from within an SAP application, you must define the Internet browser as
the standard viewer in SAP. Proceed as follows:

To define the Internet browser as the standard viewer:

• In the SAP system:

a. In the IMG, navigate to OpenText Archiving and Document Access for


SAP Solutions > Imaging (Viewer) Integration > Front End
Communication Customizing and run the Set Hit List, Display and
Storage parameters activity. Alternatively, you can run the OAG1
transaction.
b. In the Display Settings panel, select the Call Internet Browser option in
sections

• Windows Viewer Settings – affects ArchiveLink calls in SAP GUI for


Windows.
• Viewer Settings WEBGUI – affects calls in SAP GUI for HTML.
c. Save the settings.

Selecting several documents for display

If you try to display several documents at once, then by default, since SAP basis 6.x,
all documents are opened directly, that is without displaying a selection list

286 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
20.1. Configuration for the Windows Viewer

beforehand. If you would like a selection list of all possible documents to be


displayed by default, of which only the selected documents will be displayed, like in
previous SAP versions, you must activate the corresponding setting:

To select several documents for display:

1. In the IMG, navigate to OpenText Archiving and Document Access for SAP
Solutions > Imaging (Viewer) Integration > Front End Communication
Customizing and run the Set Hit List, Display and Storage parameters
activity. Alternatively, you can run the OAG1 transaction.

2. Select the Simple Hit List option and save the setting.

20.1.2.2 Print lists with hyperlinks

Note: These settings are only required for OpenText Imaging Windows Viewer
< 6.x.

To set up the display of print lists with hyperlinks, check the following registry
entry:
HKEY_CURRENT_USER/Software/IXOS/IXOS_ARCHIVE/Profile/<Profile_name>/
Viewer/Display ALF/InternalHyperlink

To display print lists with hyperlinks:

1. Set the parameter InternalHyperlink:

• In OpenText Imaging Configuration (cladmcil.exe):


Point to the profile and click Open – Whole profile in the context menu.
Select Viewer / Display ALF and check InternalHyperlink.
• In the Registry:
HKEY_CURRENT_USER/Software/IXOS/IXOS_ARCHIVE/Profile/
<Profile_name>/Viewer/Display ALF/InternalHyperlink

2. By default the value is set to 1(on), which means the Windows Viewer is used
to display the linked documents.
The 0(off) value means that archlink.exe is responsible for the display.

20.1.2.3 Log level and language


You can make some adjustments directly in the Windows Viewer. Select the Settings
item from the Edit menu.

LogLevel
On the Advanced tab, you can select one of three levels of logging: Error
logging only, Detailed logging or Detailed + ODMA logging. The latter two
options are useful when searching for problems and should not otherwise be
used, since the ixclient.log log file can grow very quickly. For more details
see Section 8.3.2.1 “Setting log levels” in OpenText Imaging Viewers and
DesktopLink - Installation and Administration Guide (CL-IGD).

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 287
ER160208-CCS-EN-01
Chapter 20 Displaying and processing documents with OpenText viewers

Language
On the General tab you can also select the installed languages. The change
becomes effective after you restart Windows Viewer.
If Windows Viewer is started from the SAP GUI, the language used in Windows
Viewer will normally be the same as in the SAP GUI, provided this language is
supported. Details and help in the event of problems can be found in the ESC.

20.1.2.4 Protocol OT_HTTP2: Registering the Windows Viewer for PDF


and JPG
When using the OT_HTTP2 protocol, you need to make further settings, so that the
Windows Viewer registers itself for the image/pjpeg and application/pdf MIME
types. This registration causes the Windows Viewer to be used also to display PDF
and JPG document classes within Internet Explorer. The Windows Viewer functions
are thus available, enabling you in particular to create annotations and notes.

To register the Windows Viewer for PDF and JPG:

1. Set the variables for the MIME types.

a. In OpenText Imaging Configuration (cladmcil.exe): Point to the profile


and click Open – Whole profile in the context menu.
b. Select Viewer / General.
c. Enter the RegisterMIMETypePJPEG and RegisterMIMETypePDF variables
by clicking their icons.
d. Switch these variables on.

2. If this setting is to be made on a large number of workstations, you can


distribute the profile to the workstations using the OpenText Imaging
Configuration (upload to Administration Server). For more details see OpenText
Imaging Viewers and DesktopLink - Installation and Administration Guide (CL-IGD).

3. Register the Windows Viewer for the MIME types. You have two options:

• Enter in the command line of each workstation:

alviewer.exe /regserver

.
• In OpenText Imaging Configuration: Open the profile and select Viewer /
General. Enter the variable AlwaysRegister and switch it on. Distribute the
profile to the workstations using the OpenText Imaging Configuration.

Note: Switching on this variable causes the Windows Viewer to re-


register itself every time it starts, even for its standard formats. If for
example you defined a different application to display the image/tiff
MIME type, this change is lost.

288 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
20.2. Configuration for Java Viewer or Web Viewer

20.2 Configuration for Java Viewer or Web Viewer


Note: The customizing procedure with the /ixos/oa_cust table has been
superseded by the parameters defined in the new /ixos/oa_cust_a table.

By default, documents that are opened from within the SAP GUI are displayed in
the SAP viewer, or, if it is installed, in Windows Viewer. Compared to the SAP
viewer, Windows Viewer offers additional functionality to edit documents,
however, it requires an additional client installation. If you would like to take
advantage of additional viewer functionality without an additional installation
process, you can use the Java Viewer or Web Viewer.

To do so, you may configure the viewer integration on the SAP server in a way that
the required viewer will be used.

To maintain the imaging integration:

• Activate the user exit to use a different viewer other than the standard SAP
viewer:

a. Run the SE16 transaction and open the TOAEX table.


b. Create a new entry with these values:
EXIT_ID = OA_OBJECTDISPLAY_01
ACTIVE = X
EXIT_FUB = /IXOS/OA_X_OA_OBJECTDISPLAY_01
c. To use a different viewer also for SAPGUI for JAVA create the following
entries with these values:
EXIT_ID = OA_DISPLAYJAVA_01
ACTIVE = X
EXIT_FUB = /IXOS/OA_X_OA_OBJECTDISPLAY_01

After installation, the viewer components must be configured and customized using
the following tables:

• /ixos/oa_cust_a
Legacy table - it is still evaluated, but do not use it anymore. A description can be
found in guides of version 10.5 SP1 or older.
• /ixos/oa_doctype
Document classes and their viewer types (if not defined, the default viewer for
ArchiveLink documents will be used)
• /ixos/oa_locales
Languages used (optional, for Web Viewer only)
• /ixos/oa_iprange
IP settings used to optimize network performance (optional, for Web Viewer
only)
• /ixos/oa_cust3

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 289
ER160208-CCS-EN-01
Chapter 20 Displaying and processing documents with OpenText viewers

Force MimeType settings to display documents

To configure the external viewer:

1. In the IMG, navigate to OpenText Archiving and Document Access for SAP
Solutions > Imaging (Viewer) Integration > Standard Customizing and run
the Maintain Viewer Usage and Settings activity. Alternatively, you can run
the SM30 transaction and open the /ixos/oa_cust_a table.

2. Define the following settings:

Path and Script/appl


Path name and script/application name to call either Web Viewer or Java
Viewer:

• Web Viewer: the source code of the Web Viewer must be located
directly below the application directory of the web server. Therefore, the
application name is WebViewer.

290 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
20.2. Configuration for Java Viewer or Web Viewer

• Java Viewer: the Java Viewer is called by a perl script that is located in a
subdirectory of the Content Server cgi-bin directory. Therefore, by
default the application name is /cgi-bin/JAVAVW/ixosjv.pl. If you
host the Java Viewer as Web Application, enter /JAVAVW/JavaViewer.

Viewer Usage
Possible values:
No
No external viewer is used.
Yes, if winviewer is not installed locally
The external viewer specified in the Viewer Type field is used if the
Windows Viewer is not installed locally.
Yes, if SET/GET parameter /IXOS/OA_JV = X
User-specific configuration; if the SET/GET parameter /IXOS/OA_JV = X
(defined in the user profile), the external viewer specified in the Viewer
Type field is used.
Yes
The external viewer specified in the Viewer Type field is always used.

Viewer Type
Possible values:
Java Viewer
Java Viewer
Web Viewer
Web Viewer.

Disable Caching
Specifies whether the information on the cache server stored in ArchiveLink
Cache customizing is used when generating the URL.
Disable Applet Inpl.
For the Java Viewer only: Specifies whether the Java Viewer is started in its
own browser window.
The height and width of this window can be defined using the subsequent
Viewer Window Width and Viewer Window Height parameters.
Use Cached Build
For the Java Viewer only: Deprecated parameter that does not work with Java
Viewer 9.5.x or later. If you use Java Viewer 9.5.x or later, ignore this
parameter.
Use HTTPS Protocol
If activated, the secure HTTPS protocol is used when the script is run.

3. If you selected the Web Viewer option above in the Viewer Type field, you can
specify the following additional parameters for default settings in the Web
Viewer Settings area:

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 291
ER160208-CCS-EN-01
Chapter 20 Displaying and processing documents with OpenText viewers

Do not show Thumbs


Deactivates the default display of thumbnails.
Do not show Header
Deactivates the default display of the header line.
Show Notes
Activates the default display of document notes.
Open in curr. Window
Stops Web Viewer from opening a new browser window; viewer uses
current window instead.
Authority Check
Activates evaluation of authorization object J_6NV_WEBV which defines
rules for accessing and processing documents.
Use Signature
Restricts the usage and acceptance of URLs to signed Web Viewer URLs
only.

To configure the document classes:

1. In the IMG, navigate to OpenText Archiving and Document Access for SAP
Solutions > Imaging (Viewer) Integration > Standard Customizing and run
the Maintain Document Classes for Viewer activity. Alternatively, you can run
the SM30 transaction and open the /ixos/oa_doctype table.

2. Define the following settings:

Document Type
Enter the document extension without leading dot, for example, JPG for
JPEG image documents.
Viewer Type
Enter the viewer type which will be used to display a specific type of
document. The available values are Java Viewer or Web Viewer.
Important
Only document types maintained in the table /IXOS/OA_DOCTYPE are
opened with the JavaViewer or the Web Viewer; for all other
documents, the default viewer for ArchiveLink documents will be
used.
Document
After activation of BC set /OTEXBAS/VIEWER_CUSTOMIZING, the following
document and viewer type combinations are maintained by default:

Document Java Viewer Web Viewer


ALF x x
ASCII x x

292 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
20.2. Configuration for Java Viewer or Web Viewer

Document Java Viewer Web Viewer


FAX x x
GIF x x
JPEG x x
JPG x x
OTF x x
PDF x
TIF x x
TIFF x x

To configure the viewer languages:

1. In the IMG, navigate to OpenText Archiving and Document Access for SAP
Solutions > Imaging (Viewer) Integration > Standard Customizing and run
the Maintain Languages for Viewer activity. Alternatively, you can run the
SM30 transaction and open the /ixos/oa_locales table.

2. Select the required languages for the viewer.

Note: This setting does only apply to the Web Viewer and does not
influence the standard locale set for SAP.

3. To create an entry, click New Entries and specify the parameters for the new
element.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 293
ER160208-CCS-EN-01
Chapter 20 Displaying and processing documents with OpenText viewers

In order to optimize the network performance, you can assign specific IP address
ranges of a repository to a specific server. If the IP address of a client is within this
specific range, then the Web viewer from the local server specified in the fields
Servername:Port and Path and Script/appl is used to view documents.

To assign IP address ranges:

1. In the IMG, navigate to OpenText Archiving and Document Access for SAP
Solutions > Imaging (Viewer) Integration > Standard Customizing and run
the Maintain IP Ranges for Viewer activity. Alternatively, you can run the
SM30 transaction and open the /ixos/oa_iprange table.

2. Specify the content repository and the range of the IP addresses.

3. Specify the server and the required script in the Servername:Port field and the
Path and Script/appl field respectively.

To configure the Force MimeType settings to display documents:

1. Run the SE16 transaction and open the /ixos/oa_cust3 table.

2. Define the following parameters:

AR_OBJECT
Document type for which the settings are defined.
FORCEMIMETYPE
MIME type which should be used on a client to display documents for the
corresponding document type. The MIME type settings (for example, app/
LLVIEW ) have to be specified in the client registry.
An example for the client registry setting could be:
[HKEY_CLASSES_ROOT\MIME\Database\Content Type\app/LLVIEW]
''extension''=''.fax''

294 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
20.3. Application related customizing

20.3 Application related customizing


Maintaining Application ID for Imaging Integration
You can define application ID's for specific contexts. The table has specific
namespaces. Namespaces used by OpenText start with /IXOS/*, /OT* or /OPT/*.
You also have the option to define your own ID's in the Y* or Z* namespaces. If an
ID is defined in this table, it can be matched with the optional parameter
PI_APPLICATION_ID of function module /IXOS/OA_X_OA_OBJECTDISPLAY_01. In
this way, a leading application can call this function module with a specific value of
PI_APPLICATION_ID.

To maintain application ID:

1. In the IMG, navigate to OpenText Archiving and Document Access for SAP
Solutions > Imaging (Viewer) Integration > Application Related Customizing
and run the Maintain Application ID for Imaging Integration activity.

2. Enter the Application ID and a description.

3. Save your entry.

Fiori App of OpenText ArchiveLink PLUS

The ID /OTX/ALF_DOC_UI is used by the Fiori App of OpenText ArchiveLink


PLUS.
If the flag to use the default setting has been set to X ( = true):

• The imaging integration called by the Fiori App uses the application ID
accordingly.
• If table entries with application ID = /OTX/ALF_DOC_UI exist in tables /
IXOS/OA_CUST_B, these settings are used to calculate a display URL for a
document.
• Maintenance table /IXOS/OA_IPRANG2, which is also prepared to overwrite
IP range behavior for a given application ID, does not support Fiori
application ID /OTX/ALF_DOC_UI. In this case, the remote address of the
Fiori client is not propagated to the ABAP backend.
• If no matching table entries exist, the default tables /IXOS/OA_CUST_A and /
IXOS/OA_IPRANGE are checked for matching entries.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 295
ER160208-CCS-EN-01
Chapter 20 Displaying and processing documents with OpenText viewers

If still no matching entries can be found, the system also checks in legacy
tables /IXOS/OA_CUST and /IXOS/OA_CUST2 for matching settings.
If the leading application ID is /OTX/ALF_DOC_UI, the settings of /IXOS/
OA_IPRANGE will be ignored, because the remote address of the Fiori client is
not propagated to the ABAP backend.

Maintaining Viewer usage and settings for application ID


You maintain the same settings as in Maintain Viewer Usage and Settings.
Additionally, you must also assign an application ID. This setting is used whenever
a leading application calls the imaging integration with the same application ID.

To maintain Viewer usage and settings for an application ID:

1. In the IMG, navigate to OpenText Archiving and Document Access for SAP
Solutions > Imaging (Viewer) Integration > Application Related Customizing
and run the Maintain Viewer Usage and Settings for Application ID activity.

2. Enter your Application ID and edit the other settings as described in


“Configuration for Java Viewer or Web Viewer” on page 289.

Example 20-1:

The OpenText ArchiveLink PLUS Fiori App uses settings with application
ID /OTX/ALF_DOC_UI to display business documents.

296 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
Chapter 21
Document processing between SAP and OpenText
Enterprise Process Services

Within the SAP Business Workflow it is also possible to perform some of the
workflow steps in OpenText Enterprise Process Services. In this case, the standard
XML workflow interface, as well as the standard XML service, are used.

Web activity To do so, maintain a web activity in the Workflow Builder (SWDD transaction) with
the URL of the OpenText Enterprise Process Services system.

Prerequisites The following prerequisites must be fulfilled for the cooperation of SAP systems and
Enterprise Process Services:

• Fully configured Web server for sending XML workflow documents


• Fully configured SAP Web Application Server (SAP Web AS) for 6.x basis
systems. Your SAP system must react correctly to XML documents and XML
reply documents.
• Activated XML service: on SAP ITS the WF_HANDLER service, on the SAP Web AS
the WORKFLOW_XMLservice (SCIC transaction)
• The user with which the service logs in must exist on the SAP system.

For details on workflow customizing in SAP systems see the SAP documentation.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 297
ER160208-CCS-EN-01
Part 4
Using the scenarios
Chapter 22

Starting the archiving procedure

22.1 Starting archiving from the SAP application


There are a number of options for starting archiving from the SAP application. You
can use:

• the SAP OAWD transaction (Store Documents)

• the SAP transaction of the individual business objects (document lists)

• the SAP transaction for Archiving and Document Access for SAP Solutions PLM
(/IXOS/PLM)

• the DesktopLink J8AM transaction (Archive from filesystem)

• the Content Management interface

• the generic object services (GOS)

• configuration for outgoing documents

• the configuration of links between document types and archiving (print list
storage)

Note: Archiving outgoing documents and print lists is not a task for the end
user. Only test samples for administrators are described here, in order to test
the correct configuration of the SAP system.

Regardless of the selected scenario, archiving in the SAP application always requires
the same steps:

• Logon to the SAP application:


Select the SAP system and logon with your user name and password if you have
not already done so.

• Select scenario, default settings and document type (index):


The time of archiving determines the scenario selection. By selecting the default
setting and the document type you specify the archiving conditions (for example,
the archive to which the documents will be stored). The settings are either those
predefined in the SAP standard or are adapted by your SAP administrator. For
detailed information on this topic, ask your SAP administrator.

• Archiving according to the selected scenario:


After you have selected the archiving conditions, you initiate the actual archiving
operation. The procedure may vary depending on the scenario.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 301
ER160208-CCS-EN-01
Chapter 22 Starting the archiving procedure

22.1.1 Archiving via the standard SAP transaction


The SAP application itself provides a standard transaction for archiving documents.

To archive using the standard SAP transaction:

1. Run the OAWD transaction in the SAP GUI.

2. Perform indexing according to the archiving scenario (see “Indexing and


archiving“ on page 327).
The original document is archived.

22.1.2 Archiving using the generic object services (GOS)


The generic object services (GOS) can also be used to archive documents. This
requires the services to be imported during installation, as well as a full
configuration (see “Archiving using generic object services (GOS) (for SAP ERP
only) “ on page 217).

This archiving procedure is equivalent to archiving using document lists in previous


SAP versions.

To archive documents using GOS:

1. Run the transaction for the respective business object (for example, FB03 for
accounting documents or BP for Business partners).

2. Select the business object to which you want to link the original document.

3. Click to display the GOS toolbar and then click , or click and
select the Create option from the Services for Object menu.

302 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
22.1. Starting archiving from the SAP application

Figure 22-1: Archiving using the GOS

4. Select the

• Enter Barcode option to store using bar code or


• DesktopLink to store using the standard scenarios (see “Scenarios for
document archiving“ on page 29).
• Create external document (URL), to create a link to an URL, for example, a
Content Server document

Note: If you use the Create attachment option from the GOS menu to
archive documents, the document appears in the attachment list for the
object, however, it does not appear in a DocuLink view for this object. In
order to access the archived documents from within DocuLink as well, use
the DesktopLink or Enter Barcode options for archiving.

5. Perform indexing according to the archiving scenario (see “Indexing and


archiving“ on page 327).
The original document is archived.

DocuLink as a generic object service (GOS)


DocuLink can be provided as a generic object service (GOS) now, as well. Thus, a
pre-configured DocuLink view can be displayed depending on the current business

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 303
ER160208-CCS-EN-01
Chapter 22 Starting the archiving procedure

object data. There the familiar DocuLink functionality is available as well, for
example, archiving documents to an object. You can also store documents in
DocuLink indirectly, using GOS.

To use the DocuLink service, select the OpenText DocuLink option from the GOS
menu. If several different views were configured for the current object type, a
selection list is displayed for you to choose the required view.

This requires configuration data to be maintained for the current object; see
“Providing DocuLink as a generic object service (GOS)” on page 218. For a
description of the functionality in DocuLink see OpenText DocuLink for SAP Solutions
- User Guide (DC-UGD).

22.1.3 Archiving using the DesktopLink transaction J8AM


The possible applications of DesktopLink are described in the Section 4 “Working
with DesktopLink” in OpenText DesktopLink - User Guide (CLDL-UGD) as well as in
the online help.

DesktopLink supports the following SAP scenarios.

• Storing for subsequent entry


• Storing for subsequent assignment
• Store and enter
• Store and assign
• Assign then store
• SAP PLM
• SAP Records Management

Use the J8AM transaction to first select the document to be archived and then specify
the business object to which the document is to be connected.

To archive using the DesktopLink transaction:

1. Run the J8AM transaction.


The IXOS: Archive from the filesystem: Select File dialog box opens.

304 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
22.1. Starting archiving from the SAP application

Figure 22-2: IXOS: Archive from file system: Select file

2. Select the document to be stored and confirm your selection with Open.

Important
Files of size 0 can not be imported!

The Select scenario dialog box opens.

Figure 22-3: Archiving scenarios

3. Perform indexing according to the archiving scenario (see “Indexing and


archiving“ on page 327).
The original document is archived. You can monitor the process status using the
OpenText Desktop Monitor (see OpenText DesktopLink - User Guide (CLDL-UGD)).

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 305
ER160208-CCS-EN-01
Chapter 22 Starting the archiving procedure

22.1.4 Document overview (in SAP ERP only)


When archiving using the SAP document overview, first select the business object to
which to link the original document and then the appropriate archive function.

1. Log on to your SAP system.

2. Select the business object to which you want to link the original document.

3. The Archiving from filesystem: File selection dialog box opens.


Select the file to archive and click OK.

4. Perform indexing according to the archiving scenario (see “Indexing and


archiving“ on page 327).
The original document is archived. You can monitor the process status using the
OpenText Desktop Monitor (see OpenText DesktopLink - User Guide (CLDL-UGD)).

22.1.5 Archiving outgoing documents


22.1.5.1 Testing output determination
To test the storage of outgoing documents, either create a suitable test posting or use
the OALINES report.

The OALINES report generates a test document for the document type to be tested,
which is treated by ArchiveLink and the archive as if it were an outgoing document.

To test using test posting:

1. Enter a test posting and display the message list, as described in “Checking
creation of outgoing documents” on page 155.

2. Select the message and click Further data.

3. Click Displ. facsimile to display the stored original document.

To test using the OALINES report:

1. Run the SA38 transaction.

2. Enter the program name: OALINES and click Execute.

3. Enter the document type and the object type you specified in “Creating and
linking a document type” on page 154.

4. Enter the output device, for example, LP01, and click Print.
The Spool order 0 was generated system message appears.

5. Run the OAAD transaction.

6. Under Documents, click Technical Search.

306 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
22.1. Starting archiving from the SAP application

7. Enter the search criteria, for example, storage date or document type and object
type, and click Execute.

8. The stored original document should appear in the hit list and you can display
it using the Display from storage system icon.

22.1.5.2 Testing the Post Processing Framework


In the example described below, we have configured the Post Processing Framework
(PPF) so that the Order confirmation action profile is performed for an IXOS
telesales type sales transaction, but only if the AGENT01 user creates the SAP
document. This means that for every sales order created by this user, the SAP
document is automatically printed and stored as a PDF file.

The prerequisites for correct processing of the outgoing document are:

• For E-mail/fax delivery: correct recipient data


• For mail delivery: valid user mail ID
• For print output: valid printer details
• For storing in the archive: correct archive details

To test the PPF using the example:

1. Start the sales transaction in the CRMD_ORDER transaction.

2. Create a valid IXOS telesales order.

3. Save the transaction data.

4. When you save the SAP document, the action profile should be processed.
Check this on the Actions tab.
You will see a list of the actions performed for this sales transaction and their
status.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 307
ER160208-CCS-EN-01
Chapter 22 Starting the archiving procedure

Figure 22-4: PPF test

5. Click Preview to display a preview of the outgoing document.

Figure 22-5: Document preview for CM documents

308 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
22.1. Starting archiving from the SAP application

6. If the action is only started after expiration and evaluation by a report


(Processing via selection report option in the action definition), start the
action manually:

Note: If you activated the Executable in dialog mode option in the action
definition, you can also run the action directly on the transaction of the
business object (Actions tab).

a. Run the SPPFP transaction.


You see a list for Selecting and processing actions. Check that the
scheduled action is listed.

Figure 22-6: PPF Selecting and processing actions

b. Select the action that was scheduled but not yet started and click
Process.

7. Check the archive to see whether or not the outgoing document was stored
there:

a. Run the OAAD transaction.

b. Under Documents, click Technical Search.

c. Enter the search criteria, for example, storage date or document type and
object type, and click Execute.

d. The stored original document should appear in the hit list and you can
display it using the Display from repository icon.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 309
ER160208-CCS-EN-01
Chapter 22 Starting the archiving procedure

Figure 22-7: PPF Displaying documents

Note: Using the Windows Viewer, you can search for information in the
outgoing original documents using a text or attribute search. For more details
see OpenText Imaging Windows Viewer - User Guide (CLWVW-UGD).

310 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
22.1. Starting archiving from the SAP application

22.1.6 Archiving print lists in SAP ERP


No scenario-specific adjustments are required for print list storage. Print list storage
can therefore be used as a test for the three customizing steps - Initial Customizing,
Communications Setup and Basis Customizing.

Testing the settings for archiving print lists are shown here using the list of
document types as an example.

22.1.6.1 Preparation
1. Run the OAC2 transaction and create a global document type (for more details see
“Maintaining global document types” on page 81).

Document type ZPRILITEST


Document type (Description) Print list test
Doc.class ALF
2. Run the OAC3 transaction and enter the link (for more details see “Maintaining
links” on page 84).

Object type DRAW


Document type ZPRILITEST
Status X
Cont.Rep.ID YE
Relationship TOA01

22.1.6.2 Generating a test list


1. Run the OAC2 transaction.
2. In the menu, click Table view > Print.
The list is displayed.
3. In the menu, click List > Print.
4. Enter the following print parameters:
Output device
Enter the LP01 printer or an active SAP printer.
Spool control
Activate the following options:
Print immediately
Delete after output. This option should only be activated for testing
purposes.
New spool request

Archive mode
Select Store from the selection list.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 311
ER160208-CCS-EN-01
Chapter 22 Starting the archiving procedure

5. Click Continue.
If a message is displayed, confirm it.
6. Enter the following storage parameters:

Figure 22-8: Storage parameters for print lists

Object type
DRAW

Doc.type
ZPRILITEST

Information
Your initials or another ID
Text
Short description (optional)

7. Click Storage.
A spool order is generated and placed in the CARA storage queue.

312 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
22.1. Starting archiving from the SAP application

22.1.6.3 Storing a test list


1. Run the OAM1 transaction.
The SAP ArchiveLink monitor is displayed.
2. Under Queues, click Storage.
The dialog box displays all the orders that are awaiting transfer to an archive.
The ArchiveLink job automatically performs transfers or processing at regular
intervals, but they can also be started manually. The most recent orders are at
the end of the list.
3. Double-click the order with the test list. The details for this order are displayed.
4. Click Execute.

Note: Alternatively, you can select the job directly in the job list and start it
by clicking Execute.
5. If a system message is displayed, confirm it.

If an error occurs on storage, the order appears in the ArchiveLink monitor under
Asynchronous requests in the Open list. Here you see notes on the cause of the
error.

22.1.6.4 Displaying a test list


1. Run the OAM1 transaction.
2. Click Environment > Archived documents.
Under Print lists, click find.
3. Enter one or more selection criteria, for example, information, storage date,
archive or document type.
4. Click Execute.
The print lists found are listed. If the print list you are looking for is not
contained, the storage request has probably not been completed or an error has
occurred.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 313
ER160208-CCS-EN-01
Chapter 22 Starting the archiving procedure

Figure 22-9: Print list test

5. Select your hit item. To display the print list, click Display from storage system.
The print list is displayed in a separate window.

Note: Using the Windows Viewer, you can influence the legibility of print lists
by setting the font and the hyperlink display, and you can search for
information in print lists using the text or attribute search. For more details see
OpenText Imaging Windows Viewer - User Guide (CLWVW-UGD).

314 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
22.1. Starting archiving from the SAP application

22.1.7 Archiving print lists in SAP CRM


No scenario-specific adjustments are required for print list storage in SAP CRM,
either.

Testing the settings for archiving print lists are shown here using the list of
document types as an example.

22.1.7.1 Preparation
1. Run the OAC2 transaction and create a global document type (for more details see
“Maintaining global document types” on page 81).

Document type ZPRILITEST


Document type (Description) Print list test
Doc.class ALF
2. Run the OAC3 transaction and enter the link (for more details see “Maintaining
links” on page 84).

Object type PRINTLIST


Document type ZPRILITEST
Status X
Cont.Rep.ID YE
Relationship TOA01

22.1.7.2 Generating a test list


1. Run the OAC2 transaction.
2. In the menu, click Table view > Print:
The list is displayed.
3. In the menu, click List > Print.
4. Enter the required print parameters:

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 315
ER160208-CCS-EN-01
Chapter 22 Starting the archiving procedure

Figure 22-10: Print parameters for print lists

Note: If you cannot find the parameters displayed here in the start view of
the transaction, click Properties and select the required parameters from
the overview. Expand folders to do so if necessary. The path for each
parameter is given in the following overview.

Output device
Enter the LP01 printer or an active SAP printer.

General attributes
Select Time of printing Print immediately.

General attributes > Output options


Activate the following options:
Delete immediately after printing:
(This option should only be activated for testing purposes.)
New spool request

General attributes > Output options > Storage mode


Select Store from the selection list.
Enter the storage parameters:

316 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
22.1. Starting archiving from the SAP application

Object type
PRINTLIST

Document type
ZPRILITEST

Information
Your initials or another ID

Text
Short description (optional)

5. Click Continue.
A spool order is generated and placed in the CARA storage queue.

22.1.7.3 Storing a test list


1. Run the OAM3 transaction. The SAP ArchiveLink monitor is displayed.

2. Under Queues, click Storage.


The dialog box displays all the orders that are awaiting transfer to an archive.
The ArchiveLink job automatically performs transfers or processing at regular
intervals, but they can also be started manually. The most recent orders are at
the end of the list.

3. Double-click the order with the test list. The details for this order are displayed.

4. Click Execute.

Note: Alternatively, you can select the job directly in the job list and start it
by clicking Execute.

5. If a system message is displayed, confirm it.

If an error occurs on storage, the order appears in the ArchiveLink monitor under
Asynchronous requests in the Open list. Here you see notes on the cause of the
error.

22.1.7.4 Displaying a test list


1. Run the OAM3 transaction.

2. Click Environment > Archived documents.

3. Under Print lists, click Technical Search.

4. Enter one or more selection criteria, for example, information, storage date,
archive or document type.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 317
ER160208-CCS-EN-01
Chapter 22 Starting the archiving procedure

5. Click Execute. The print lists found are listed. If the print list you are looking
for is not among them, the storage request has probably not been completed or
an error has occurred.

6. Select the hit you want. To display the print list, click Display from storage
system.
The print list is displayed in a separate window.

Note: Using the Windows Viewer, you can influence the legibility of print lists
by setting the font and the hyperlink display, and you can search for
information in print lists using the text or attribute search. For more details see
OpenText Imaging Windows Viewer - User Guide (CLWVW-UGD).

318 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
22.1. Starting archiving from the SAP application

22.1.8 Archiving using SAP PLM DMS (in SAP ERP only)
Another possibility to archive documents is from within the SAP Product Lifecycle
Management. In this case, the SAP PLM DMS (Document management system) is
used. The following scenarios can be performed using the /IXOS/PLM transaction:

Scanning into SAP PLM DMS


You can enter and assign an original document to an already existing PLM DMS
document by scanning it.

Automatic (batch) import


You can import several documents into the SAP PLM DMS at once, and assign
them to already existing PLM DMS documents.

Document entry using DesktopLink


Using DesktopLink, you can also enter documents into the SAP PLM DMS
directly from within Windows applications, and assign them to already existing
PLM DMS documents.

22.1.8.1 Scanning into SAP PLM DMS

To scan original documents and assign them to PLM DMS documents:

1. In the SAP GUI, run the /IXOS/PLM transaction.

2. Click Scan documents.

3. The scan application is started. Scan the desired document and select it in the
scan application.

4. In the SAP GUI, enter the key for the PLM DMS document you want to assign
the original document to. This key consists of 4 parameters:

• Document

• Document type

• Document part

• Document version

5. Click Save.

6. In case the storage category for the document was not pre-configured, enter it in
the dialog.

The original document is stored and assigned to the PLM DMS document. It appears
in the document list in the SAP PLM DMS.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 319
ER160208-CCS-EN-01
Chapter 22 Starting the archiving procedure

22.1.8.2 Automatic (batch) import


To automatically import original documents and assign them to PLM DMS
documents:

1. Create a subfolder in the specified import directory for each document you
want to import. You can choose any name for this subfolder.

2. Create an attribute file with the specified name for each document. The file
must have the following contents:
DOCUMENT_FILENAME = <File name of the original document>
DOKNR = <PLM DMS document number>
DOKAR = <PLM DMS document type>
DOKVR = <PLM DMS document version>
DOKTL = <PLM DMS document part>

Example 22-1: Sample attribute file


DOCUMENT_FILENAME = salesorder.doc
DOKNR = jklfas083408jslk09328540
DOKAR = T1_21_03
DOKVR = 00
DOKTL = 000

3. Place the document and the corresponding attribute file in the subfolder.

4. In the SAP GUI, run the /IXOS/PLM transaction.

5. Click Automatic import.

6. In case the storage category for the document was not pre-configured, enter it in
the dialog.

The import directory is searched for subfolders, and the respective documents are
imported and assigned to the PLM DMS documents. If the import failed, a log file
with an error message is inserted in the corresponding subfolder. Furthermore, a
protocol of the import is displayed in the SAP GUI. If you double-click a row, a list
of the affected subfolders appears.

320 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
22.1. Starting archiving from the SAP application

Figure 22-11: Importing SAP PLM DMS documents

The original document is stored and assigned to the PLM DMS document. It appears
in the document list in the SAP PLM DMS.

22.1.8.3 Document entry using DesktopLink


To enter original documents using DesktopLink and assign them to PLM DMS
documents:

1. In the SAP GUI, run the /IXOS/PLM transaction.

2. Click DesktopLink.

3. If necessary, select SAP PLM in the scenario selection dialog.

4. If necessary, enter the key for the PLM DMS document you want to assign the
original document to in the SAP GUI. This key consists of 4 parameters:

• Document
• Document type
• Document part
• Document version

The original document is stored and assigned to the PLM DMS document. It appears
in the document list in the SAP PLM DMS.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 321
ER160208-CCS-EN-01
Chapter 22 Starting the archiving procedure

22.2 Archiving from Windows applications


DesktopLink provides a range of options for archiving files using applications other
than SAP applications. For details, see OpenText DesktopLink - User Guide (CLDL-
UGD).

Windows Viewer
Using the standard menu items Save or Save as and selecting the destination
SAP.

Microsoft Office applications


Using a special menu item File > Save to OpenText DesktopLink.
All Windows applications

• Via the context menu Save to > SAP in the Windows Explorer
• Via drag and drop on the Save to SAP solutions Desktop icon
• Via a special printer driver that first converts the file into PDF or TIFF format
and then archives it (OpenText PDF Converter SAP or OpenText TIFF
Converter SAP)

Note: Automatic attribute extraction may be configured for archiving


Microsoft Office documents. This can considerably reduce the user
interaction with the SAP system in terms of archiving. For more details see
“Configuring attribute transfer” on page 192.

Important
If the archive process for a PowerPoint document within the SAP
application is canceled, the file to be archived may be write-protected and
you can no longer start a new archive process. First save the file in the file
system and resume archiving.

Irrespective of which application you start archiving from, further processing


(indexing) takes place via one of the SAP archiving scenarios (see “Indexing and
archiving“ on page 327). The scenario specifies how and where the original
document is stored and further processed. According to the configuration of
DesktopLink and the SAP application, the user can select during the archiving
process which scenario is used, or it is taken from a default setting. For more
information, see “User-specific settings in the SAP application for DesktopLink”
on page 188.

322 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
22.3. Archiving from mail applications

22.2.1 Archiving multiple documents in SAP applications


If you start archiving via Send to or drag and drop, you can store several documents
with just one single indexing process. However, this is only possible for the SAP
scenario Store and assign.

To store several documents with one single indexing process:

1. Start archiving multiple documents via Send to or drag and drop.


The Select scenario dialog is displayed.

The scenarios that are configured for multiple archiving are marked with the
icon (mass archiving). For other scenarios marked with the icon, you must
index each document individually (batch processing).

2. Double-click .
The CPIC and RFC Control dialog is displayed.

3. Perform indexing as usual for Store and assign (see “Indexing and archiving“
on page 327).
All marked documents are stored with the same attributes.

22.3 Archiving from mail applications


You can also archive original documents from various mail programs and link them
to SAP objects.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 323
ER160208-CCS-EN-01
Chapter 22 Starting the archiving procedure

22.3.1 ExchangeLink
To link complete Exchange objects with the MSG document class to an SAP record, a
corresponding document type must be maintained. In the same way you can link
individual Exchange object file attachments with their corresponding document
class (for example, DOC) to an SAP record. For example, you can link a purchase
order sent via email as a file attachment to an SAP record in this way.

You can link an email or its attachment to a record in a SAP Records Management
system. In this case, use the SAP Records Management scenario for archiving.

To link an object (email, file attachment etc.) to an SAP record, select the Tools |
Archive object using ExchangeLink menu option when archiving in the mail
application, then select SAP as the destination and after login to the SAP system,
select the required SAP archiving scenario. At this point, the process is the same as
the usual scenarios (see “Indexing and archiving“ on page 327).

To display the archived email again, simply search for the linked record as usual in
the Records Management transaction (see “Document retrieval in SAP Records
Management” on page 346).

22.3.2 NotesLink
To link complete Lotus Notes objects with the NSF document class to an SAP record,
a corresponding document type must be maintained. In the same way, you can link
individual Lotus Notes object file attachments with their corresponding document
class (for example, DOC) to an SAP record. This link can be defined using the menu
option in the mail application (5.5: Actions / IXOS-eCONserver / Archive
Advanced, 6.0: Actions / IXOS NotesLink).

You can link an email or its attachment to a record in a SAP Records Management
system. In this case, use the SAP Records Management scenario for archiving.

To link an object (email, file attachment, etc.) with an SAP record, the user selects the
SAP destination when archiving, and after login to the SAP system, the SAP
archiving scenario. At this point, the process is the same as the usual scenarios (see
“Indexing and archiving“ on page 327).

To display the archived email again, simply search for the linked record as usual in
the Records Management transaction (see “Document retrieval in SAP Records
Management” on page 346).

Note: To display an email in Lotus Notes, the application must already be


started when you search for the record.

324 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
22.4. Archiving in Windows Viewer

22.4 Archiving in Windows Viewer


In Windows Viewer, you can create new original documents and post-process and
archive existing ones.

You can create original documents in two ways:

• File import from the file system


• Scanning

Afterwards you can edit the documents or add notes or annotations.

To store documents:

1. In the Document menu, click Archive.


The SAP application logon dialog opens.

2. Indexing takes place in the same way as for standard scenarios in the SAP
application (see “Indexing and archiving“ on page 327).

The Windows Viewer supports a number of archiving scenarios via DesktopLink


(see “Scenario processes and the OpenText components involved” on page 33).

For more details on Windows Viewer see OpenText Imaging Windows Viewer - User
Guide (CLWVW-UGD).

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 325
ER160208-CCS-EN-01
Chapter 23
Indexing and archiving

In order to assign an archived original document uniquely to an SAP document so


that it can be retrieved from the archive at a later time, it must be accompanied by a
specific set of information. This is done through indexing, which includes the
definition of the document type, a default setting and a scenario for archiving an
original document. Indexing can either be initiated by the SAP application itself, or
via the DesktopLink component.

Tip: For specific examples of archiving scenarios, see “Test example -


Archiving incoming documents with workflow” on page 337 and “Test
example Late archiving with bar codes” on page 338.

23.1 Select scenario, default setting and document


type
To specify the archiving conditions (for example, the archive in which the original
document is to be stored), select the scenario, default setting and document type.
You can adjust default settings and document types by customizing the SAP
scenarios (see “Indexing and archiving“ on page 327).

Archiving in the SAP system using the OAWD transaction

If you start archiving via the OAWD transaction, you directly select the presetting and
the scenario for a specific document type, with which the document will be
archived.

Archiving from the client using DesktopLink

When archiving from the client using DesktopLink, the Select scenario dialog is
opened after you login to the SAP system.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 327
ER160208-CCS-EN-01
Chapter 23 Indexing and archiving

This lists the SAP standard scenarios.

1. Select the desired scenario.

2. Click execute to confirm your selection.


The Store documents dialog box opens.

Here the default settings and document types available for archiving are listed.

3. Expand the required default setting.

4. Select the desired document type.

5. Click execute to confirm your selection.


The document type selected specifies whether the document is archived in
original, TIFF and/or PDF format. If you select a document type that has been
adapted for archiving in TIFF/PDF format, the original document is converted to
TIFF/PDF format.
If the classic client-side conversion is used, the IXOS-DesktopLink - Conversion
dialog opens. For more details, see OpenText DesktopLink - User Guide (CLDL-
UGD). Click OK to continue archiving.
If the Rendition Server-based conversion is used, wait until the hourglass cursor
has disappeared.

Note: If you frequently perform the same archiving steps, you can shorten the
archiving process by defining the appropriate settings as the default. For more
details, see “User-specific settings in the SAP application for DesktopLink”
on page 188.

328 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
23.2. Executing archiving

23.2 Executing archiving


After logging on to the SAP system and specifying the archiving conditions, the
archiving operation is carried out. Depending on the selected scenario, the archiving
operation itself is performed differently.

23.2.1 Storing for subsequent entry


The procedure for this scenario differs depending on whether you start archiving
from a client or from the SAP system in the OAWD transaction.

To archive in the SAP system using the OAWD transaction:

1. In the SAP GUI, select the document type, the default setting and the scenario,
as described in “Select scenario, default setting and document type”
on page 327.
2. To archive an individual original document, click Continue. To archive all
original documents in a document stack, click Mass archiving.
3. File upload: The file selection dialog appears. Select the file to store and click
Open.
This starts the archiving operation which consists of three separate actions:

• The selected document type is assigned to the original documents to be


archived.
• A work item is created and sent to the specified organizational unit.
• The original document is archived.

The dialog box remains on your screen after the archiving procedure is
completed. You can now start another archiving operation.
Scanning:

a. If you want to archive individual original documents, click Continue to


archive the next original document in the document stack: either the
original document that is now in the first position in the document stack or
one that you previously selected.
b. When you have archived all the original documents of the document stack,
you can select a different document stack in Enterprise Scan and continue
or click Cancel in the SAP dialog box to end your task.
Next you can select another document type and start a new archiving
session.
4. After an original document is successfully archived, a system message appears
to indicate that a work item was created. The transaction user can find the work
item in their in-box.
5. The transaction user can perform the work item later, display the original
document and enter an appropriate SAP document.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 329
ER160208-CCS-EN-01
Chapter 23 Indexing and archiving

To archive from the client using DesktopLink:

1. In the SAP GUI, select the document type, the default setting and the scenario,
as described in “Select scenario, default setting and document type”
on page 327.
2. If you choose to archive an original document in TIFF or PDF format, the IXOS-
DesktopLink - Conversion dialog box opens (see OpenText DesktopLink - User
Guide (CLDL-UGD)). Click OK to continue archiving.
If selected, the document is converted and then stored.
3. Next you can select another document type and start a new archiving session.
4. After an original document is successfully archived, a system message appears
to indicate that a work item was created. The transaction user can find the work
item in their in-box.
5. The transaction user can perform the work item later, display the original
document and enter an appropriate SAP document.

23.2.2 Store and enter


Here the document is created and archived simultaneously. You can then trigger the
workflow. After you select the document type, the document is converted (if
selected) and then archived.

To use Store and enter scenario:

1. Archiving using the OAWD transaction: In the SAP GUI, select the document type,
the default setting and the DocuLink scenario, as described in “Select scenario,
default setting and document type” on page 327. Depending on the document
type, either the file selection dialog is displayed (for file upload), or the
scanning application. Select the document to archive.
Archiving from a client: In the SAP GUI, select the document type, the default
setting and the DocuLink scenario, as described in “Select scenario, default
setting and document type” on page 327.
2. The selected original document is displayed in the viewer and the Process
document (Create SAP document) dialog appears at the same time.
3. Click Continue.
4. In the SAP GUI, create the business object to which you want to link the original
document to be archived.
5. Only when archiving using DesktopLink:if you choose to archive an original
document in TIFF or PDF format, the IXOS-DesktopLink - Conversion dialog
box opens (see OpenText DesktopLink - User Guide (CLDL-UGD)). Click OK to
continue archiving.
The document is converted (if selected) and then stored.
6. What happens next depends on the business object that you have selected.

330 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
23.2. Executing archiving

In the FI module you get this dialog box:

Figure 23-1: Process document type

7. Click Process.
The Post document: Header Data dialog box opens.

Figure 23-2: Post document: Header Data

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 331
ER160208-CCS-EN-01
Chapter 23 Indexing and archiving

8. Click execute to confirm the settings for the business object.


The business object is saved and automatically linked to the archived original
document.

23.2.3 Storing for subsequent assignment


The incoming document refers to an existing application document. The original
document is scanned in by someone at the mail depot (unless it is already available
in electronic format) and stored. A link to the document is forwarded to the
transaction user through SAP Business Workflow. He or she assigns it to the existing
SAP document.

To use the Storing for subsequent assignment scenario:

1. Scan an original document. Leave the scan application activated so that you can
see the electronic original.
2. In the SAP GUI, select the document type, the default setting and the scenario,
as described in “Select scenario, default setting and document type”
on page 327.
3. Confirm the document type dialog box with Continue or Create.
A system message confirms that the work item was created. The transaction
user can find the work item in their inbox.
4. Only when archiving using DesktopLink: if you choose to archive an original
document in TIFF or PDF format, the IXOS-DesktopLink - Conversion dialog
box opens (see OpenText DesktopLink - User Guide (CLDL-UGD)). Click OK to
continue archiving.
The document is converted (if selected) and then stored.
5. The transaction user can perform the work item later, display the original
document and assign the original document to an SAP document.

23.2.4 Store and assign


After archiving, a workflow is created that is performed immediately.

From a technical and Enterprise Scan point of view, the scenario is identical to the
Storing for subsequent entry scenario.

To use the Store and assign scenario:

1. Scan an original document. Leave the scan application activated so that you can
see the electronic original.
2. In the SAP GUI, select the document type, the default setting and the scenario,
as described in “Select scenario, default setting and document type”
on page 327.
3. Click Continue or Create to confirm the document type dialog box.

332 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
23.2. Executing archiving

4. After selecting the document type, the document is archived. If you have
archived using DesktopLink and converting selected, the document is
converted before it is archived. The Process document type (assign document)
dialog box opens.

Figure 23-3: Assigning a document

5. Confirm it with Continue or Create.

6. Select the business object to which you want to link the document to be
archived.

Example 23-1: FI module


Enter the company code, SAP document number and fiscal year of the
business object and click execute.
The Store original accounting document dialog box opens.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 333
ER160208-CCS-EN-01
Chapter 23 Indexing and archiving

7. To link the selected business object with the document to be archived, click
Confirm or OK.
The link is stored and the workflow is performed.

23.2.5 Assign then store


Archiving takes place after the actual processing of the original document in the SAP
application.

After you have selected the document type, the document is converted (if selected)
and then archived.

To use the Assign then store scenario:

1. In the SAP GUI, select the document type, the default setting and the scenario,
as described in “Select scenario, default setting and document type”
on page 327.

2. Select the business object to which you want to link the original document.
What happens next depends on the selected SAP module. In the FI module, the
following dialog box opens:

Figure 23-4: Accounting document

Example 23-2: FI module


Enter the company code, SAP document number and fiscal year of the
business object and click Confirm.
The Store original accounting document dialog box opens.

334 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
23.2. Executing archiving

3. Click Confirm or .

4. The file display frame opens. Select the file to store and click Open.
The original document is stored and linked with the business object.

5. Only when archiving using DesktopLink: if you want to archive an original


document in TIFF or PDF format, the IXOS-DesktopLink - Conversion dialog
box opens (see OpenText DesktopLink - User Guide (CLDL-UGD)). Click OK to
continue archiving.
The document is converted (if selected) and then stored.

23.2.6 DocuLink
To store an original document in a DocuLink view:

1. In the SAP GUI, select the document type, the default setting and the DocuLink
scenario, as described in “Select scenario, default setting and document type”
on page 327 for archiving from a client using DesktopLink.
The pre-configured or most recently opened DocuLink view is displayed.

2. In the displayed view, navigate to the folder or record to which you want to add
a new element, and select the corresponding node.

3. In DocuLink, click Create.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 335
ER160208-CCS-EN-01
Chapter 23 Indexing and archiving

4. If necessary, select the object you want to create from the selection list and the
document type.

5. If necessary, enter the missing attribute values for the document or the record in
the Create screen and click Create.
Possibly the attribute values are taken directly from the current object data; in
this case, this step is not necessary.
The record or document is inserted in the DocuLink view.

6. To close the DocuLink window, click OK.

23.2.7 SAP Records Management


To store a document to an existing SAP record in a Records Management
system:

1. In the SAP GUI, select the document type, the default setting and the DocuLink
scenario, as described in “Select scenario, default setting and document type”
on page 327 for archiving from a client using DesktopLink.

2. If necessary, select the required record type (element type) that you want to
assign the document to.

3. Search for the record to which you want to store the document.

4. If necessary, select the required anchor, that is the element type of the document
you want to store.

5. If necessary, select the required document type for the document you want to
store.

The original document is added to the record. As a description, the description of


the document type and the storage date is used.

23.2.8 SAP PLM


To store documents in the SAP PLM DMS:

1. In the SAP GUI, select the document type, the default setting, and the DocuLink
scenario, as described in “Select scenario, default setting and document type”
on page 327 for archiving from a client using DesktopLink.

2. If necessary, enter the key for the PLM DMS document you want to assign the
original document to in the SAP GUI. This key consists of the following
parameters:

• Document
• Document type
• Document part
• Document version

336 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
23.3. Test example - Archiving incoming documents with workflow

The original document is stored and assigned to the PLM DMS document. It appears
in the document list in the SAP PLM DMS.

23.3 Test example - Archiving incoming documents


with workflow
The test includes scanning an original document using Enterprise Scan or Windows
Viewer, archiving it using SAP GUI and checking that further processing is correctly
called up in the workflow.

To archive incoming documents with workflow:

1. Scan an original document. Leave the scan application activated so that you can
see the electronic original.

2. Run the OAWD transaction in the SAP GUI.

3. Select the default setting by double-clicking.

Figure 23-5: Default settings

Note: The icons for the Store and enter /Assign and Assign then store
scenarios are only available if the user belongs to the user group or was
assigned as a single user.

4. Select the scenario by clicking the appropriate icon or double-clicking on the


name of the document type and making a selection in the dialog box.

5. Further processing is scenario-dependent:

Storing for subsequent entry and Storing for subsequent assignment


Click Continue or Continue to confirm.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 337
ER160208-CCS-EN-01
Chapter 23 Indexing and archiving

Figure 23-6: Storing for subsequent entry

A system message confirms that the work item was created. The transaction
user can find the work item in their inbox.
Store and enter
Click Continue or Create to confirm. The Process document type message
is displayed. The data input view is displayed according to the transaction
specified for data entry. In our example, this is VA01.
Store and assign
The Process document type message is displayed. Confirm the message. In
the following dialog box, you can assign the original document to an SAP
business object.
Assign then store
Enter the SAP business object to which the original document is to be
assigned.
Click Create, check the object data, and confirm.

6. Click Cancel to end the test.

23.4 Test example Late archiving with bar codes


After the pages have been scanned to Enterprise Scan, checked, sorted and put into
groups, the archiving procedure is carried out.

FI example

The Late storing with bar codes scenario will be tested using the example of an
incoming invoice based on the settings of the IDES client (FI module). To test your
specific settings and the customizing in other modules, adapt the test data
accordingly.

To perform test:

1. Run the F-43 transaction.


2. Enter the posting data, for example:

Document date Current date

338 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
23.4. Test example Late archiving with bar codes

Type KR
Company code 1000
Currency/rate EUR 1.95583 (in two fields)
PstKy 31 (posting key, at the bottom of
the window)
Account 1000 (at the bottom of the
window)

Figure 23-7: Post document: Header Data (Invoice)

3. To confirm your entries, click Enter.

4. Enter the invoice data:

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 339
ER160208-CCS-EN-01
Chapter 23 Indexing and archiving

Amount 115
Calculate tax Switch on field
PstKy 40
Account 476100

5. In the menu, click Document > Post.

6. Enter the offsetting entry:

Amount 115
Tax code VN
Cost center 1000

7. In the menu, click Document > Post.

8. Enter the bar code number for the document, check the document type, and
confirm.

Figure 23-8: Bar code entry

This takes you back to the posting entry. A message appears in the status bar,
confirming that document # (10 digits) was posted to company code 1000.

Tip: Make a note of the document number for the verification that will take
place later.

The bar code is entered in the table of open internal bar codes. Run the OAM1
transaction to check the entry in the ArchiveLink monitor.

9. Copy the bar code that you have just entered to your test document.

10. Scan the document using Enterprise Scan. The document then appears in the
document stack.

340 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
23.4. Test example Late archiving with bar codes

11. Click the header of the scanned document at the beginning of the line. This
selects the document and highlights all associated pages. The bar code number
appears in the document header.

12. In the Document menu, click Archive into Document Pipeline. Select the
Current document only option and confirm. The document is removed from the
document stack, archived, and linked to the posting.

13. Run the OAM1 transaction to check the list of open bar codes in the ArchiveLink
monitor. If the archived document is linked successfully to the posting
document, the bar code entry is deleted from the Internal list.
You can display the archived document in the ArchiveLink monitor. Select the
Administration > Document Administration menu item. In the Documents area,
click Display. Select the document and click Display from storage system.
Alternatively, you can display the document if the matching posting document
is open. Run the FB03 transaction to open the SAP document. From the menu,
select System > Services for Object, Attachment list.

Example 23-3: CRM example

Processing for the scenario Late archiving with bar codes will be
displayed using the example of a business partner.

1. Run the BP transaction to create a new business partner.


2. Enter the data.
3. Click Enter to confirm your entries.
4. Select System > Services for object from the menu to display the generic
object services, and then click Create > Enter bar code.
5. Enter the bar code number for the document, check the document type,
and confirm.
This takes you back to the posting entry. A message appears in the status
bar, confirming that document # (10 digits) was posted to company code
1000.

Tip: Make a note of the document number for the verification that
will take place later.

The bar code is entered in the table of open internal bar codes. Run the
OAM1 transaction to check the entry in the ArchiveLink monitor.
6. Copy the bar code you just entered to your test document.
7. Scan the document using Enterprise Scan. The document then appears in
the document stack.
8. Click the header of the scanned document at the beginning of the line.
This selects the document and highlights all associated pages. The bar
code number appears in the document header.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 341
ER160208-CCS-EN-01
Chapter 23 Indexing and archiving

9. In the Document menu, click Archive in document pipeline. Select the


Current document only option and confirm. The document is removed
from the document stack, archived and linked to the posting.

10. Run the OAM1 transaction to check the list of open bar codes in the
ArchiveLink monitor. If the archived document is linked successfully to
the posting document, the bar code entry is deleted from the Internal
list.

To display the archived document in the ArchiveLink monitor:

1. Select the Administration > Document Administration menu item.

2. Click the Documents area on Technical Search.

3. Enter the search parameters for the document and click Execute.

4. Select the document and click Display from attachment list.

Alternatively, you can display the document if the matching posting


document is open. Run the BP to open the document. Select the
Attachment list from the generic object services. Select the document
and click Display.

Was each SAP application entry linked to its electronic document?

Each original document is scanned in, indexed and archived together with the SAP
application documents generated for it.

At the end of the archiving procedure, the original documents archived using
Enterprise Scan must be linked to the corresponding SAP application documents.
Otherwise, the session cannot be completed correctly.

There are different options in the SAP applications, which provide information and
can be used for this check:

• If you indexed and archived the electronic documents using bar codes, check in
the ArchiveLink monitor in the SAP application to see if there are still any open
bar codes.
• If you indexed the original documents manually with the SAP application
document numbers, you must check in the to see if there are any SAP documents
to which no electronic documents have been assigned. In the document, select
the Display electronic original option. If the original document cannot be
displayed, this is because no connection has been established. This may mean
that the original document was not yet archived and is still in the Enterprise Scan
document pipeline or on the Archive Center. Contact your system administrator
if this problem occurs.

342 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
Chapter 24
Displaying and processing (archived) original
documents

24.1 Searching for documents in SAP applications


In all OpenText Imaging ODMA-compatible Microsoft Office applications, as in the
Windows Viewer, you have the option of searching for original documents in the
SAP application using the File - Open menu option. This enables you to use an
original document that was already archived as a template for a new original
document by editing it and saving or archiving it.

The procedure is described below for Microsoft Word as an example.

Note: The following description also applies for SAP CRM, even if, for
technical reasons, some GUI terms are still called SAP ERP.

1. Select File - Open.


The Select document type dialog box opens.
2. Select the SAP destination and click OK to confirm your selection.

Figure 24-1: File selection dialog

Note: You can specify the selection in the IXOS-DesktopLink-Settings as


the standard. For more information, see “User-specific settings in the SAP

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 343
ER160208-CCS-EN-01
Chapter 24 Displaying and processing (archived) original documents

application for DesktopLink” on page 188. In this case the Select document
dialog box is not opened.

The SAP ERP logon dialog opens.

3. Log on to the SAP system.


The Select document type dialog box opens.

Figure 24-2: Document type selection

4. Search for the original document.


You have two search options:

• Select a document type and click execute.


You can select the archived document via company code, document number
and fiscal year.
• Click . Here you can perform an extended search within the business
object.

The requested original document is displayed.

24.2 Displaying original documents in Windows


Viewer
If you display archived original documents in the Windows Viewer, you have
several options for working with the data stored there.

• Original document information: You can get information from the archive for any
archived document. Through the signature you can verify the authenticity of the
document, the archive information gives you information on the archive and the
time of archiving.
• Information search: You can search for information in outgoing original
documents and print lists using a text or attribute search.
• Data exchange with other programs: You can select and copy segments, text, pages
and entire original documents and process them in other applications.

344 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
24.2. Displaying original documents in Windows Viewer

• Send original documents by email: You can send a link to an original document in
the archive or a copy of an original document by email.
• Adding notes and annotations: You can add comments to a document as notes, or
create annotations directly on the document and store them.

Note: For technical reasons, when you use the IXHTTP protocol with the
Windows Viewer, the actual author of a note cannot be determined in SAP.
• Print: The Windows print function has been expanded in the Windows Viewer to
include OpenText-specific functions. You can print notes, annotations and
archive information or change the size of the original document for printing.

When displaying original documents, you can change the display and navigate
within or between original documents. For more details see OpenText Imaging
Windows Viewer - User Guide (CLWVW-UGD).

24.2.1 Authorizations in SAP applications


In Windows Viewer it is possible to search for documents in SAP applications using
the Open menu option. The DesktopLink component is used for this.

1. Select the Open menu option in the Windows Viewer.


The Select document dialog box opens.
2. Select the SAP destination and click OK to confirm your selection.

Note: You can specify the selection as the standard in the IXOS-
DesktopLink-Settings (see OpenText DesktopLink - User Guide (CLDL-
UGD)). In this case the Select document dialog box is not opened.

The SAP ERP logon dialog box opens.


3. Log on to the SAP system.
The Select document type dialog box opens.

4. Search for the original document.


You have two search options:

• Select a document type and click OK.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 345
ER160208-CCS-EN-01
Chapter 24 Displaying and processing (archived) original documents

You can now select the archived document via company code, document
number and fiscal year.
• Click .
Here you can perform an extended search within the business object.

The requested original document is displayed.

24.2.2 Document retrieval in SAP Records Management


Documents that were automatically stored to records in a SAP Records Management
system via batch import, as well as emails that were linked to an SAP record by an
user from within a mail application, can be displayed in the SAP Records
Management system any time.

To display documents stored to SAP records:

1. Run the ORGANIZER transaction.

2. If necessary, enter the Records Management system ID (RMS_ID) in which the


document was stored.

3. Open the Records folder and double-click the record type the document was
stored to.

4. Search for the record to which the document was stored. When you have found
the required record, it is displayed in the right window with all linked
documents.

5. Double-click a document to display it in the appropriate application.


If an error occurs during display, check the registry settings concerning the
mime type assignment.

24.3 Displaying forms


If you open a document with forms overlay in the SAP application or in the
Windows Viewer the form and the contents are displayed by default.

To display an original document with a form in the SAP application:

1. Run the transaction for the corresponding SAP documents to which an original
document is assigned.

2. Display the SAP document.

3. Click the icon for the generic object services and select Attachment list.

4. If several original documents are assigned, select one from the list of original
documents.
The Windows Viewer is launched and the archived original document is
displayed.

346 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
24.3. Displaying forms

Note: Blank pages are not displayed in the Windows Viewer, that is not
the back pages of SAP documents to which no form was assigned.

To find out how to set up the display to your user-specific requirements see the
OpenText Imaging Windows Viewer - User Guide (CLWVW-UGD).

Example 24-1: Displaying an order confirmation with form

To display the order confirmation:

1. In the main menu, select the VA00 transaction (Sales).

2. Select the Order > Display option and enter the number of the sales
order.

3. Select Environment > Document flow.

4. Select the order and select Environment > Display originals.


The Windows Viewer is launched and the archived original document is
displayed. It is similar to the one shown below.

Displaying a form in PDF format

To do this, you need Acrobat Reader version 4.0 or higher.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 347
ER160208-CCS-EN-01
Chapter 24 Displaying and processing (archived) original documents

Outgoing SAP documents are only saved in PDF format. OpenText Forms
Management provides a plug-in for Acrobat Reader 4.0, which enables overlying
PDF forms to be displayed in Acrobat Reader. The offset settings are also used for
overlying SAP documents in PDF format, if the .PDF file extension is linked to the
Windows Viewer.

24.4 Displaying original documents in Java Viewer/


Web Viewer/
If your SAP system was configured accordingly, the Java Viewer, or Web Viewer is
used to display documents. These viewers are opened via an Internet or Intranet
page in your Web browser. Click a link to the desired document in your application
(for example, in the SAP GUI). The program is then automatically downloaded from
a server and the selected document is displayed.

In addition to displaying the document, these viewers offer further convenient


functionality regarding the document, for example:

• Rotating and changing the size of individual or all pages of a document [all]
• Displaying documents with forms [Java Viewer, Web Viewer]
• Search functions [all]
• Printing functions [all]
• Adding notes and annotations [all]

Note: For technical reasons, the actual author of a note cannot be


determined in SAP when you use the IXHTTP protocol with the Windows
Viewer.

For more details see OpenText Imaging Windows Viewer - User Guide (CLWVW-UGD).

24.5 Launching DocuLink views via generic object


services (GOS)
DocuLink can also be launched as a generic object service (GOS). That way you can
display DocuLink data for a particular business object directly from within other
SAP applications. The business object data can automatically be used as selection
criteria for the DocuLink view.

This requires this service to be imported during installation, as well as a full


configuration (see “Providing DocuLink as a generic object service (GOS)”
on page 218).

To launch DocuLink views via GOS:

1. Run the transaction for the respective business object (for example, FB03 for
accounting documents or BP for Business partners).

348 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
24.5. Launching DocuLink views via generic object services (GOS)

2. From the GOS menu, select DocuLink.

Figure 24-3: GOS menu

The configured DocuLink view opens.

Displaying Content Server documents

Using GOS, you can also display Content Server documents from the
attachment list. To do so, select the Attachment list option from the context
menu of a node which is configured accordingly, and then select the required
document.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 349
ER160208-CCS-EN-01
Chapter 25
ArchiveLink PLUS and OpenText Business Content

25.1 ArchiveLink Full Text Search


The ArchiveLink Full Text Search application provides a full-text search capability
for ArchiveLink documents in the Content Server. The application pays attention to
the SAP authorization model and is available as a transaction in your SAP system. In
SAP systems with ABAP Web Dynpro Framework (SAP NW 7.0 or higher) it is also
available as Web Dynpro application and can be started directly in a web browser.

With the help of a search template, you can define the behavior of the SAP search
application in a most flexible way. Thus, this application provides a generic
framework for configuring a variety of full text searches based on OpenText Content
Server for your project-specific purposes.

The following sections describe the required customizing steps in a generic way. To
view a more specific example application for a full text search scenario, see OpenText
Extended ECM for SAP Solutions - Customizing Guide (ERLK-CGD). In that scenario, a
technical user for impersonation is used to meet specific security requirements. To
set up such a technical user, see “Setting up technical user and impersonation
(optional)” on page 353.

In the search template, you can also configure an advanced search to search for
metadata attached to the documents.

The search results are shown in a simple ALV grid in the SAP GUI and in a web
browser in the Web Dynpro UI application.

25.1.1 Prerequisites
Before you can start using the search application and setting up a search template,
you must ensure that the following requirements are met:

• Technical prerequisites
• Configuring ArchiveLink document declaration
• Configuring Content Server search

Optionally you can set up a technical user and impersonation to meet specific
security requirements. For more information, see “Setting up technical user and
impersonation (optional)” on page 353.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 351
ER160208-CCS-EN-01
Chapter 25 ArchiveLink PLUS and OpenText Business Content

25.1.1.1 Technical prerequisites


OpenText Extended ECM for SAP Solutions allows putting ArchiveLink documents
under the control of the Content Server. This step is necessary for the search
application to find these documents.

Therefore, the following prerequisites must be fulfilled:

• The Add-On packages OTEXBAS and OTEXRL must be installed and configured
in your SAP system.
The OTEXRL package for SAP Basis/Netweaver 7.0 also contains the Web
Dynpro search application.

• An OpenText Content Server must be installed and running.

• Your Content Server must utilize authentication with the help of OpenText
Content Server Directory Services as outlined in OpenText Extended ECM for SAP
Solutions - User Management and Access Control Scenarios (ERLK-CUM).

• An OpenText Archive Center with Enterprise Library Services must be installed


and running.

• Web Dynpro Configuration


To use the Web Dynpro search application, you must configure the Web Dynpro
framework in your SAP system. Perform the following steps:

– customize the general Web Dynpro configuration of the web application


server(s), for example configuration of the ICM, activation of services, etc. For
details, see the SAP documentation.

– check the activation of the following services by running the SICF transaction:
<path of Web Dynpro services>/otx/rm_seawd_search
<path of BSP services>/otx/rm_seawd_bp_hdr
If the second service is not activated, the banner logo and the background
logo of the Web Dynpro UI are not displayed.

For more information, see the documentation of OpenText Extended ECM for SAP
Solutions 10.0. SP2.

25.1.1.2 Configuring ArchiveLink document declaration


To make ArchiveLink documents known to the OpenText Content Server, you must
declare them as records in Extended ECM for SAP Solutions. You can do this also
without using Retention Management.

For the necessary configuration steps, see Section 6.2 “Enabling document
declaration for ArchiveLink documents” in OpenText Extended ECM for SAP Solutions
- Customizing Guide (ERLK-CGD).

352 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
25.1. ArchiveLink Full Text Search

25.1.1.3 Configuring Content Server search


Check the following steps:

• To make ArchiveLink documents available for the ArchiveLink search


application, they must be also searchable in the Content Server full text search.
For the necessary configuration steps, see Section 1.11 “Administering
Searching” in OpenText Content Server Admin Online Help - Search Administration
(LLESWBS-H-AGD).
Make sure that the Enterprise Library Services related module for Search is
installed.
• In Content Server, the category attributes are populated by business property
providers. To make these attributes available for the ArchiveLink search
application, you have to make them also searchable in the Content Server search.
• Set the Show in Search option to true for each attribute of the Content Server
Categories that you want to make queryable in the search.
• Ensure that at least one document is declared as indexed in the FullText Index to
make the related Category attributes visible in the Search Regions list.
• Ensure that all regions that you want to use in your search are queryable and
displayable. You can configure these settings in the Enterprise Search Manager in
the Content Server administration. Click Enterprise Search Manager >
Properties > Regions.

25.1.1.4 Setting up technical user and impersonation (optional)


In the standard case, the search application uses the connection properties defined in
the Logical Destination parameter in the Extended ECM Connections. In this case,
the search application runs the SAP logon ticket. The SAP logon ticket is then
evaluated by the OpenText Content Server Directory Services (OTDS), which maps
the SAP logon user to a Content Server user of the same name. In this way, the SAP
user is able to search and find the same list of documents as the Content Server user
of the same name. In the search template, you can define an authorization user exit
which can restrict the list of the retrieved documents in the SAP system.

For scenarios where SAP users have also direct access to the web page of the
Content Server and which need stricter restrictions, the ArchiveLink Full Text search
application provides impersonation.

To set up the connection with impersonation, perform the following steps:

1. Set up a technical user in the SAP system.


2. Configure a user with the same ID on the OTDS, which has all permissions to
declare and search the ArchivLink documents in the Content Server.
3. Define a logical RFC connection. This RFC connection must be entered in the
Logical Destination for Impersonation setting in the search template that you
want to use for the impersonation connection type.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 353
ER160208-CCS-EN-01
Chapter 25 ArchiveLink PLUS and OpenText Business Content

4. Set permissions to allow SAP users to use the RFC connection.


5. Define the authorization user-exit to restrict the list of search results.

For a specific example how to use the search framework including the
impersonation connection type, see OpenText Employee File Management for SAP
Solutions - Administration Guide (EIM-AGD).

To set up an impersonation connection:

1. Creating technical user


Create a technical user in your SAP system and set the permission for the
authorization object S_RFC. Edit the following parameters:

• ACTVT – Enable execute.


• RFC_NAME – Set name to /OTX/RM_SEAX_AUTH.
• RFC_TYPE – Enable the FUGR setting.

Depending on other actions set for this user, for example creating and updating
ArchiveLink declarations, additional permissions may be required as well, for
example, for ArchiveLink access with the authorization object S_WFAR_OBJ.
2. Create a user with the same ID in the Content Server:

1. Use the OpenText Administration Client and add the user in Directory
Services > User Partitions.
2. Use the Consolidate function to create the user in the Content Server.
3. For the user, set Add Items and Delete permissions for the folders storing
the declared ArchiveLink documents.
3. Creating logical RFC connection for the technical user
In the IMG, click the Create HTTP Connections activity.

354 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
25.1. ArchiveLink Full Text Search

4. Select Logical Connections and click create.

5. Proceed as follows:

1. Enter a name in the RFC Destination box.


2. In the Logon & Security tab, enter the Client, User and Password for the
technical user.
In the Security Options, set a value for Authorization for Destination to
restrict access to this destination for other users for which the authorization
object S_ICF is set accordingly. For example, this value can be MYSEARCH.
3. Click Save.
4. Click Connection Test. The test should be successful.
6. Setting Logical Destination for Impersonation in search template
In your search template, enter the new RFC connection for the Logical
Destination for Impersonation parameter. See “Customizing search templates”
on page 356 in the Template definition section for details.
With this setting, the search application does an RFC impersonation on the SAP
system before connecting to Content Server. This way, the logon of the technical
user and its SAP logon ticket is used for the authentication against OTDS.
7. Restricting usage of impersonation connection
If you have defined a value, for example MYSEARCH in the Authorization for
Destination setting in step 5.2, the SAP system automatically restricts the usage

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 355
ER160208-CCS-EN-01
Chapter 25 ArchiveLink PLUS and OpenText Business Content

of the connection to SAP users with the following permissions for the
authorization object S_ICF:

• ICF_FIELD – set to DEST


• ICF_VALUE – set to the value for the Authorization for Destination setting,
for example MYSEARCH.

8. Setting up authorization user-exit in search template


In addition to the Logical Destination for Impersonation setting, you can use
the Auth. User-Exit setting to define a function module that checks further
permissions for the search result list. This way, you can narrow down the search
result list that is retrieved from Content Server for the technical user to a smaller
list that matches the actual permissions of the current SAP user. As an example,
see the sample function module /OTX/SEA_AUTH_EXIT_AL_AUTH, which
checks plain ArchiveLink permissions.

25.1.2 Customizing search templates


You can use the configured search template in the SAP GUI and in the Web Dynpro
search application.

1. Run the SPRO transaction and then click SAP Reference IMG.

2. Under OpenText Extended ECM for SAP Solutions > Extended ECM, run the
Maintain Search Templates activity to access the Template definition
overview.

356 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
25.1. ArchiveLink Full Text Search

3. You have the following options:

• To edit an existing template from the Template definition list, double-click


your selected entry.
• To create a new template, click New Entries.

To customize the search template:

1. Template definition
In the Template definition dialog box, edit the following properties:

Search ID
Enter a search ID. You can assign a free value. Do not use blanks.
Title
Enter a title for your search template. The title can be translated. Click Goto
> Translation to select a language.
Connection ID
Enter a Connection ID. The Connection ID collects all parameters for a
connection to an Enterprise Library Services server. You can create a
Connection ID in Display IMG > Maintain Extended ECM Connections.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 357
ER160208-CCS-EN-01
Chapter 25 ArchiveLink PLUS and OpenText Business Content

For details, see Section 23.2.5 “Maintaining Extended ECM connections” in


OpenText Extended ECM for SAP Solutions - Installation and Upgrade Guide
(ERLK-IGD).
Logical Destination in Extended ECM Connections
In the Extended ECM Connections referenced by the Connection ID
in the search template definition, you must enter a Logical
Destination that contains the connection to the Content Server that is
relevant for your search.

To create a Logical Destination for the search, see “Creating a Logical


Destination in Extended ECM Connections” on page 367.
Number of Hits
Enter a value for the number of results that you want to retrieve from
Content Server with the first request, as well as for each time that you click
More in the result list.

358 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
25.1. ArchiveLink Full Text Search

Logical Destination for Impersonation


Enter a Logical Destination if you want to use different users in your SAP
system and Content Server for security reasons, respectively. When you
define a Logical Destination, the logon to the Content Server is performed
with a different user. Leave the box empty if you want to use the standard
OTDS single sign-on feature.
For details how to set up a Logical Destination for Impersonation, see
“Setting up technical user and impersonation (optional)” on page 353.
CS node ID
This field provides a search help to select a Content Server node ID from the
enterprise workspace to start the search from. Alternatively, the node ID
can be entered manually. After setting the node ID, the search in Web
Dynpro and Dynpro UI is applied recursively at this node. The search
results are shown as a search from here at this node.
Auth. User-Exit
Select an Authorization User-Exit. With this user exit, you can run
additional authorization checks on the search result list from Content
Server. You can either select the user exit /OTX/SEA_AUTH_EXIT_AL_AUTH
processing the standard ArchiveLink authorization object, or you can set up
your own project-specific Authorization User-Exit. For this purpose,
OpenText provides a template /OTX/SEA_AUTH_EXIT_TEMPLATE in the /
OTX/RM_SEA > /OTX/RM_SEAPI > /OTX/RM_SEAB_AUTHEXIT package.
To activate the user exit, you have to select the User-Exit Enabled checkbox.
User-Exit Enabled
Select the User-Exit Enabled checkbox to enable the execution of the
Authorization User-Exit.

2. Region definition
Double-click Region definition. Here you can create or remove search fields for
your search. You have two options:

• Click New Entries to create a new Region definition.


• To edit an entry, double-click it in the Region definition.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 359
ER160208-CCS-EN-01
Chapter 25 ArchiveLink PLUS and OpenText Business Content

3. Edit the following properties:

Search ID
You can select only the Search ID to which the current template belongs.
Attribute ID
Enter a free value for the search attribute ID. Use only alphanumeric values
and do not use blanks.
This ID is used in the background to refer to an attribute in the search API.
Order in display
Enter a value for the place in the order in which you want to display the
regions in the search result list and in the search filter panel.
Region name
Enter the technical Content Server region name.
You can look up the technical region name in the Content Server
administration. In the Content Server administration, click Search
Administration > Open the System Object Volume > Enterprise Data
Source Folder. In the Enterprise Search Manager item, click Properties >
Regions. Copy the Name of the region you want to use in your search
template. Do not use the Display Name.
You can use the same Content Server region in more than one Region
definition.

360 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
25.1. ArchiveLink Full Text Search

Data element
Enter an appropriate data element. You can either select a matching data
element from your SAP system or create an own data element. Note that the
data element provides the header of the search result list column for your
region. If you want to define a certain header, you have to create an own
data element for your region.
If you leave the data element field empty, the region name is displayed as
header in the result list column.
Default value
In this box, you can enter a fixed value for the search filter. You must
provide the value in the Content Server XML format.
Search Help
Define a Search help to be used in the search filter panel as input help. This
search help overrides the Search help on the data element.
F.p. Search Help
Define a freely programmable Search help, to be used in the Web Dynpro
search application only. This freely programmable Search help overrides
the explicit Search help and the search help from the data element in the
Web Dynpro UI.
SH Structure
This feature is only available for the Web Dynpro search application. You
can enable dependent Search helps by defining an appropriate Search help
structure. This Search help overrides the explicit Search help. You also have
to define a Search help component.
SH Component
Define the component of a Search help structure to enable dependent
Search help in the Web Dynpro search application. You also have to define
a Search help structure.
Display
Select the Display checkbox if you want the region to show up in the result
list.
Search
Select the Search checkbox if you want to use the region in the search filter
panel.
Note: You can also select or deselect both checkboxes at the same
time:

• selecting both display and search: the region shows up in the result
list and can be used in the search filter panel.
• deselecting both display and search: the region does not show up in
the result list and also not in the search filter panel. However, in
some cases a region must nevertheless be set up when it will be
processed in a user exit or provides a certain functionality. For
example, to enable the opening of an ArchiveLink document with a

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 361
ER160208-CCS-EN-01
Chapter 25 ArchiveLink PLUS and OpenText Business Content

double-click, the Doc-ID and the Content Repository ID must be set


up as Region definitions in the search template.
Mandatory
not yet implemented
Functional Name
Enter the Functional name for your region. You can select the appropriate
name from the search help list or create a new one, if no name is available
for your region. A Functional name is a unique name identifying a region
that can be listed in different content server instances under different region
names.
For frequently used regions, the Search help already provides the
Functional name. For example, to implement the standard functionality of
opening ArchiveLink documents, you always need the Doc ID and the
Content Repository ID.
The available Functional names are also listed in the Functional regions list.
If you want to use a certain region and no Functional name is available, you
have to create a new Functional name for that region.
Important
Certain Functional names have to be used in Region definitions of the
search template to perform certain actions on the search results:

• /OTX/ARCHIV_ID: Content Repository ID


• /OTX/ARC_DOC_ID: ArchivLink Document ID
• /OTX/AR_OBJECT: Document Type
• /OTX/OBJECT_ID: SAP Business Object ID
• /OTX/SAP_OBJECT: SAP Business Object Type
• /OTX/OT_SUMMARY: Content summary of the document
• /OTX/OT_NAME: Document name/title. This Functional name is
required for Web UI searches.

For example, you need to create Region definitions using certain


Functional names that are necessary for the following actions:

• to open the document from the search result list displayed in the
SAP GUI: /OTX/ARCHIV_ID and /OTX/ARC_DOC_ID
• for the ArchiveLink authorization: /OTX/ARCHIV_ID, /OTX/
SAP_OBJECT and /OTX/OBJECT_ID .
• to display a content summary for a found document in the Web
Dynpro application: /OTX/OT_SUMMARY.
Output User Exit
Select an appropriate Output User Exit for your region definition.
An Output User Exit provides two options:

362 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
25.1. ArchiveLink Full Text Search

• transforming the result string that comes back from the Content Server
to the required format in the result list in the SAP system.

• providing a text to comment the region field value in the result list.

To make an appropriate Output User Exit available for your Region


definition, you have to set up the corresponding Function Module. For this
purpose, OpenText provides templates in the /OTX/RM_SEA > /OTX/
RM_SEAPI > /OTX/RM_SEAB_OUTEXIT package.
In the Function Module, you have to set up the formatting of the result
string as well as the text comment you want to display together with the
result string.
To enable the user exit, you must customize also the Processing options.

Processing option
Select one of the following options:

• Direct value (no user exit)


The result list displays the original result string that comes directly from
Content Server without using the user exit.

• Description (uses user exit)


The result list displays only the text comment for the result value.

• Converted Value (uses user exit)


The result list displays the result value formatted by the Output User
Exit.

• Converted Value + Description (uses user exit)


The result list displays the formatted result value and the text comment
in separate columns of the result list.

Example 25-1: Using the Output User Exit


You want to display a region as a date in the search result list and
the search filter panel. The original string that comes back as result
from Content Server is formatted as yyyy-mm-dd. When the data
element is applied, the results can possibly be displayed like this:

To format the result correctly, you can apply an Output Format User
Exit and select Converted Value in Processing options to remove
the hyphens from the original result string:

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 363
ER160208-CCS-EN-01
Chapter 25 ArchiveLink PLUS and OpenText Business Content

Now the result values show the required format:

When you select Converting Value + Description in the Processing


options, you can show a text comment describing your result in an
additional column of the result list:

4. User Actions
Double-click User Actions

You have two options:

• Click New Entries to create a new User Action.


• Double-click an entry in the User Actions list to edit an existing User Action.

364 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
25.1. ArchiveLink Full Text Search

Note: In the User Actions dialog, you can apply user exits to your search
template that can process additional user actions for your search result.
Once you have created a User Action in the search template, it will be
provided in the search result list in the context menu of the individual
search result. In this way, you can apply certain actions for your project-
specific purposes on the search result. For your search template, you can
create up to twenty User Actions.

5. Edit the following parameters:

Search ID
Select your search template ID.
Function Code
Select a function code for the User Action. You can assign up to 20 function
codes.
Action title
Enter a short title or description for your User Action. The title can be
translated. Click Goto > Translation to select a language.
Action User-Exit
Select a user exit to process a user action.
Ensure that you have created in advance all Region definitions that the user
exit needs to process the User Action for your search result. For example, to

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 365
ER160208-CCS-EN-01
Chapter 25 ArchiveLink PLUS and OpenText Business Content

perform the sample user exit /OTX/SEA_ACTEXIT_SAMPLE that allows


you to navigate directly from the search result to the corresponding
business object, you need the SAP object ID and the Object type to be
available as Region definitions. Otherwise you will get an error message.
To set up a new Action User-Exit for your project-specific purposes, use
the /OTX/SEA_ACTEXIT_TEMPLATE template in the /OTX/RM_SEA > /
OTX/RM_SEAPI > /OTX/RM_SEAB_ACTEXIT package. You can set up the
User Actions to be performed in the Dynpro UI and the Web Dynpro UI.

6. Template User Exits


In this new maintenance view you can define user exits that are triggered when
a search is performed.

Event
Select After search is submitted on UI: Change filter list.
With this event you can do simple value conversions of the input values
from the Search UI's search panel. The value CHA_FILT_S

• The event is triggered after search button was clicked on the Search UI
• The event is triggered before the list of selection ranges of the search
fields (also known as search regions), which were entered in the search
panel, are converted to query expressions

Active
Select to enable the use of the exit
Function Module
Value of the exit function module.
The user exit must implement the event CHA_FILT_S.
You find examples of the function interface implementation in function
group /OTX/RM_SEAB_TEMPLEXIT.

• Function module /OTX/RM_SEA_T_EXIT_CHA_FILT_S provides the


current interface and contains comments. You can copy it to create the
actual user exit function.
• Function module /OTX/RM_SEA_EX_CHA_FILT_S_MIME is an example to
convert values of selection ranges related to content server search region

366 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
25.1. ArchiveLink Full Text Search

OTMIMEType. It shows a way how to retrieve and change the value


ranges.

7. Functional regions
Double-click Functional regions.
The Functional regions lists all Functional region names available for the search
template. A Functional region name is a unique name identifying a region that
can be listed in different Content Server instances under different region names.
By default, the most frequently used Functional region names are already
provided in the list. When no Functional name is available for your project-
specific purpose, you have to create one for the relevant region.
You specify the functional name in the Region definition.

25.1.2.1 Creating a Logical Destination in Extended ECM Connections


In the Extended ECM Connections referenced by the Connection ID in the search
template definition, you must enter a Logical Destination that contains the
connection to the Content Server that is relevant for your search.

You create and maintain this property in transaction sm59 > Configurations of RFC
Connections > HTTP Connections to External Server. Here you can configure, for
example, logon settings and HTTP proxy options.

To create a Logical Destination:

1. Run the SM59 transaction.

2. In Configuration of RFC Connections, click HTTP Connections to External


Server. Click to create a new connection.
Note that you must enter a Path Prefix that points to your Content Server.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 367
ER160208-CCS-EN-01
Chapter 25 ArchiveLink PLUS and OpenText Business Content

25.1.3 Performing the Search in SAP GUI


To perform the search in the SAP GUI:

1. Run the /otx/sea_ui transaction.

2. From the Search in drop down list, select your search template.

3. In the Search box, enter your search term for a full text search in the available
ArchiveLink documents.

4. Click Perform Search. Your search retrieves every document containing any of
the search terms.

368 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
25.1. ArchiveLink Full Text Search

5. To get more results, click More Results. When you click the button, the next
results from Content Server are appended to the result list.

Notes

• The More Results button appears in the toolbar, when there are more
results available after the first hits have been displayed. When you click
the button, the next search results are requested from Content Server
and appended to the current results. You can configure the number of
hits to be displayed for each query result in the search template
configuration. When there are no more results left, the button
disappears.
• In the ALV grid displaying the search results, you can use the following
ALV buttons to

– – display values of all regions configured in the search template


and the row number for the selected search result.
– – define the sort order of the search results in the ALV grid.
– – find specific search results in the ALV grid.
– – filter the search results that you want to display in the search
result list.
– – print your search results.

6. Using the search filter panel


To refine your search, you can use the search filter panel. Click Open Search
Panel.

7. In the Filter Value box of the corresponding Filter Field, enter the specific value
to which you want to narrow down your search. For example, enter a personnel
number to retrieve all documents for a specific employee. You can use a Search
help, when you have configured one in the search template. The entry is

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 369
ER160208-CCS-EN-01
Chapter 25 ArchiveLink PLUS and OpenText Business Content

formatted according to the data element that has been defined in the Region
definition for this region.

8. Click to save your search filter settings.

9. Click Perform Search.

370 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
25.1. ArchiveLink Full Text Search

25.1.4 Performing the search in Web Dynpro UI


To access the Web Dynpro search application, enter the following URL in your
browser:
http://<host>:<port>/sap/bc/webdynpro/otx/rm_seawd_search?
&SEARCH_TEMPLATE_ID=<search template ID>

If you do not enter the search template ID parameter, the search application opens
with the first template available in the list of templates.

To perform the search in the Web Dynpro application:

1. Select your search template in the Search in drop down list.

2. You can use and/or combine the following search options:

• Full-text search – Enter one or more search terms separated by a space in the
Search box. If you enter more than one search term, the search handles them
as conjunction.
• Refined search for attributes – To refine your search, click to open the
search panel. In the search panel, you can search for certain attribute values.
The attributes have been configured before in the search template as Region
definitions. See “Customizing search templates” on page 356, step 2.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 371
ER160208-CCS-EN-01
Chapter 25 ArchiveLink PLUS and OpenText Business Content

You have the following options:

– To select the correct value for a search attribute, you can use the F4 help/
Search help if you have configured one before in the search template.
– If you have configured a dependent Search help in the search template,
you can link more than one search attribute to further narrow the search.
The dependent Search help works only in the Web Dynpro search
application. See “Customizing search templates” on page 356, step 3.
– Click to use the Advanced Options. For a certain attribute, you can
search in a range of values or search for more than one value at the same
time.
3. To start the search, press Enter in the box in which you have entered a search
term, or click .

25.1.4.1 Layout of search results


A search result is organized as follows:

• Pagination – The search results are divided into pages. You can configure the
number of hits retrieved per search request and the number of hits displayed per
page in the Web Dynpro Configuration, see “Configuring Web Dynpro search
application” on page 374.

Using the pagination:

1. Click the number of the page that you want to view.


2. Click the last page number or ... to request the next set of search results
from Content Server. The pagination stays at the last page or jumps there
from the current page.

372 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
25.1. ArchiveLink Full Text Search

• Summary size – Here you can determine the size of the content summary
displayed for the document under the title.

If you click Less Detail, the document summary will be reduced. Click More
Detail again to see more of the summary. The search term from the full-text
search is highlighted in the summary text.
• Thumbnail preview – On the left, you can find a thumbnail preview of the
document. The preview is only displayed if the document format can be handled
by the OpenText Imaging Web Viewer. For example, a Word document does not
have a preview because its format cannot be rendered by the Web Viewer.
Click the preview or the title link to open the document in the Web Viewer. If the
document format cannot be opened by the Web Viewer, the content of the
document opens in the web browser. For example, a Word document opens in
the Office application in the web browser.
For information about the formats that can be handled by the OpenText Imaging
Web Viewer, see Section 1.3 “Supported document formats and functions” in
OpenText Imaging Web Viewer - User Guide (CLWEBV-UGD) and OpenText Imaging
Web Viewer - Installation and Configuration Guide (CLWEBV-IGD).
• MIME type icon and title link – On the top of the search result, you find the
MIME type icon and the title link of the document.

Click the title to open the document in the Web Viewer. If the document format
cannot be opened by the Web Viewer, the content of the document opens in the
web browser.
• Customer actions – Click to open the list of possible actions you can perform
on the search result.

You have to configure the possible actions in advance as User actions in the
search template. For example, you can search for a personnel number and switch
directly from the search result to an employee file or run a certain transaction.
• Content Summary – Below the title, you can find a content summary for the
search result. You can adjust the size of the summary by clicking View: Less

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 373
ER160208-CCS-EN-01
Chapter 25 ArchiveLink PLUS and OpenText Business Content

Detail or More Detail. Scanned documents like faxes or other documents with
graphic formats do not show a summary.
Note that to obtain a content summary, you must have created a Region
definition with the /OTX/OT_SUMMARY region in the search template before.

25.1.4.2 Configuring Web Dynpro search application


For the Web Dynpro search application, you can configure the following settings:

• Summary state
• Banner and background images for the Web Dynpro search UI

• Pagination and page size

To access the configuration editor:

1. You have the following options to access the Configuration Editor for Web
Dynpro ABAP:

• In the SAP GUI, run the Object Navigator (SE80) transaction.


In the /OTX/RM_SEAWD package, expand Web Dynpro> Web Dynpro
Applicat. > /OTX/RM_SEAWD_SEARCH > Applic. Configurations.
Double-click your configuration and click Start Configurator.

• Enter the following URL in your web browser:


http://<host>:<port>/sap/bc/webdynpro/sap/configure_application?APPL_NAME=/
OTX/RM_SEAWD_SEARCH&CONFIG_ID=<configuration ID>

2. Click Display.

374 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
25.1. ArchiveLink Full Text Search

To configure your settings:

1. In the Assignment of Component Configurations select the root component


and click Go to Component Configuration.
2. Summary state and banner/background images
In the Context Node Hierarchy, select Configuration.

Edit the following attributes:

• summaryState – This attribute defines the initial setting of the summary


size. Enter 0 = Less Details or 1 = More Details.
• bannerImage – Enter the name of the image file that contains the banner
image or logo that you want to show on the search UI.
• backgroundImage – Enter the name of the image file that contains the
background image that you want to show on the search UI.
3. Click Apply Changes.
4. Pagination and page sizes
Select Page_Sizes.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 375
ER160208-CCS-EN-01
Chapter 25 ArchiveLink PLUS and OpenText Business Content

5. Select the default checkbox to select a line, or create a new line. Note that

• value – is the number of search results per page


• paginationSize – is the number of pages that is displayed for each set of
search results retrieved from Content Server.

The result of multiplying value with paginationSize defines the number of


search results retrieved from Content Server with each new search request.
6. Click Apply Changes.
7. Click Save in the Changed Configurations area.

25.1.5 Authorization Object J_6NRL_SEA for the use of search


templates
The authorization object J_6NRL_SEA is checked, when a user invokes a search
template either in the search transaction /OTX/SEA_UI or in the Web Dynpro UI
application.

With the Search Template ID authorization field it is checked if the user has access or
not to a certain search template. To get permission for the use of the search template,
the user needs the combination of Search Template ID and ACTVT = 03. Only the
search templates that the current user has access to, are listed in the Search in drop
down list in the search transaction.

If the user does not have the authorization object or if the search template list
assigned to him is empty, the user can not perform the search transaction at all.

25.2 OpenText Business Content window


OpenText Business Content window is a dialog that is available for the GOS menu
of your business object. It provides the following functions:

• Business Workspace (with Extended ECM only)


You can use this function only if you have a license for OpenText Extended ECM
for SAP Solutions.
If you have created a business workspace for your business object either in SAP
GUI or Content Server, the list tree view displays the items of your Content
Server business workspace. You can perform standard Content Server functions,
including a Content Server full text search. For more details, see “Using the
Business Workspace function” on page 379.
• Business Attachments (with Extended ECM only)
Business attachments are documents and other items that are stored in Content
Server and that you can attach to the business workspace. On the Content Server
side, this document has a link to the respective business object.
• Business Documents
The Business Documents list displays a list of the ArchiveLink documents
attached to the business object. The document links are displayed in an SAP ALV

376 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
25.2. OpenText Business Content window

grid. You can add documents using the standard procedure. After some
customizing steps, you have the option to add additional attributes to your
ArchiveLink documents besides the default ArchiveLink attributes. To use the
Business Documents options, see “Using the Business Documents function”
on page 397.
• Notes
You can add notes to the business workspace, view, edit and delete them.
• Tempo Box and local folders
You can access your local Tempo Box and other local folders in the Business
Content window.

Before users can use the Business Content window, you have to customize an entry
for it in the list of Generic Services attributes.

25.2.1 Customizing OpenText Business Content in list of


Generic Services attributes
Prerequisites You must install the ABAP Add-On OTEXRL 10.0 of Extended ECM for SAP
Solutions in your SAP system.

To make OpenText Business Content available:

1. Run the sm30 transaction and enter SGOSATTR in the Table/View box. Click
Maintain.

2. In the SGOS: Attribute of Generic Services overview, click New Entries to


create a new entry for Business Content.

3. Customize Name of service, Description, and Quick Info.

4. Enter the following class name in the Class f. Gen. Service box: /OTX/
RM_GOS_SRV_ATTACH_LIST.

5. Click Save.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 377
ER160208-CCS-EN-01
Chapter 25 ArchiveLink PLUS and OpenText Business Content

The Business Content window is now available in the GOS menu of your business
object.

378 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
25.2. OpenText Business Content window

25.2.2 Using the Business Workspace function


If you have customized the option to create business workspaces for your SAP
business object type, you can also browse the business workspace in the SAP GUI.
You can view and also use special Content Server workspace items that were not
created in the SAP system such as task lists, emails, other workspaces, cases, binders
and live reports. You can find documents that are connected to your SAP business
object. In your business workspace, you can perform a full text search.

To enable the option to create business workspaces in Content Server, you have to
perform some customizing steps. For more information, see “Customizing steps”
on page 380.

After customizing the business workspace option, the Business Content window
always displays the Business Workspace item in the list tree view.

There are two different ways how a business workspace can be displayed, either in
Classic view or in Smart view. It depends on the business object configuration how
you see the business workspace.

You have the following options:

• Create a business workspace – From the Business Content window, you can
directly create a business workspace for your business object if none is available
yet. For more information, see “Creating business workspaces (SAP view)”
on page 381 or “Adding a business workspace (Smart view)” on page 393.
• View and browse a business workspace – You can browse and view your
business workspace items. For more information, see “Viewing and browsing
business workspace items (SAP view)” on page 382 or “Working with business
workspaces (Smart view)” on page 392.
• Perform actions on the business workspace items – You can perform certain
actions on the business workspace items. For more information, see “Working
with business workspaces and documents (SAP view)” on page 386 or “Working
with business workspaces (Smart view)” on page 392.
• Perform full text search – You can perform a Content Server full text search in
the workspace items. For more information, see “Performing full text search in
Business Workspace” on page 393.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 379
ER160208-CCS-EN-01
Chapter 25 ArchiveLink PLUS and OpenText Business Content

25.2.2.1 Customizing steps


Before you can start using the Business Workspace function, you must ensure that
the following requirements are met:

• You must perform several customizing steps in Content Server and in your SAP
system to generally enable the business workspace creation. For detailed
information, see OpenText Extended ECM for SAP Solutions - Customizing Guide
(ERLK-CGD).
• Your SAP user must be mapped to a Content Server user who is allowed to view
business workspaces. If you want to create a business workspace from the
Business Content window, the user must have sufficient permission.
• You must customize an entry for Business Content in the list of Generic Services
attributes, see “Customizing OpenText Business Content in list of Generic
Services attributes” on page 377.
• You must ensure that the value for the Logical Destination in the Extended
ECM Connections for your business workspace customizing contains the
connection to the relevant Content Server instance to enable the full text search in
the business workspace. For more information, see Logical Destination in
Extended ECM Connections on page 358 and “Creating a Logical Destination in
Extended ECM Connections” on page 367.

25.2.2.2 Customizing container and non-container behavior of business


workspace items
The business workspace navigation behavior inside the Business Content window
discerns between container objects that contain child items and non-container objects
that do not contain any child items.
The customizing in Content Server and the Enterprise Library services determine,
whether a certain document node is recognized as a container object or not.

You can redefine this behavior in the configuration.

To customize container behavior:

1. In the OpenText Administration Client navigate to Enterprise Library Services


> Configuration.
2. You can add a comma-separated list of subtype values to the following
properties:

• elservice.knownContainerTypes
• elservice.knownNonContainerTypes

Example: The Enterprise Library Service parameter elservice.


knownContainerTypes contains the following default list of subtype values: 31066,
310660,31350,3030202,3030301,204,210.
That means that, for example, the node type TaskList with subtype = 204 will be
treated as a container object.

380 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
25.2. OpenText Business Content window

25.2.2.3 Creating business workspaces (SAP view)


The Business Content window always displays the Business Workspace item in its
tree view, even if there is no business workspace available yet for the current
business object. In this case, you can create a business workspace directly from the
Business Content window.

Note: For the business workspace creation, the same settings as configured for
the automatic business workspace creation are used. The settings in the
configuration also determine if a binder, a case, or a business workspace is
created.

To create a business workspace in the Business Content window:

• Right-click the Business Workspace item and select Create Business


Workspace.
The new business workspace is created in the connected Content Server.
In the tree view, any sub items of the new business workspace are displayed.
The document list displays documents.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 381
ER160208-CCS-EN-01
Chapter 25 ArchiveLink PLUS and OpenText Business Content

25.2.2.4 Viewing and browsing business workspace items (SAP view)


You can navigate through the Content Server items in the business workspace using
the tree view and the document list:

• Tree view – The tree view displays the business workspace folders and other
container objects of the business workspace, and their sub items. Only container
objects that can contain child items appear in the tree view. This can also include
other workspaces and special Content Server items such as discussions, email
folders, and task lists.
• Document list – The document list displays the documents and other items that
are present in the business workspace folder or in any other items selected in the
tree view. The document list contains workspace items which do not contain any
further sub items.

To browse the business workspace in the Business Content window:

1. In the GOS menu of your business object, click Business Content.

2. In the tree view, expand the Business Workspace item.

3. In the tree view, select a folder to see its content.


The document list displays the documents and other workspace items it contains.

382 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
25.2. OpenText Business Content window

Folder contains sub items. The sub items can be other sub items that are
shown in the tree view. However, the icon is also displayed if the sub items
are not container objects but, for example, documents that are displayed in
the document list.
Type
The icon indicates the document type, for example an image file, a
Microsoft Word document or another folder.

Sc.
The item is a shortcut to another item on Content Server.
Date, Time
Date and time when the document was uploaded to the business
workspace.

Reserved
Indicates if the item is currently reserved by a Content Server user for
editing.

25.2.2.4.1 Using pagination in Business Content window

Pagination is available if the document list contains more than a certain number of
items. The default number of displayed items is 25 as in Content Server. You can
change the maximum number of items to display.

To change the page size:

1. In the document list, click Show 25 items and expand the list:

2. Select your new page size.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 383
ER160208-CCS-EN-01
Chapter 25 ArchiveLink PLUS and OpenText Business Content

The number of pages is reduced according to the larger page size and the
display switches to page 1 of the new size.

3. To change to another page, you have the following options:

• Select a page button.

• Click either or to go to the next or previous page.


The next page button appears only when you are on a page with a number
greater than 1. The previous page button appears when you are on a page
with a number lesser than the maximal number of pages.

• Click Go to page ... and specify your page number.

Notes

• At the moment the administrator cannot customize the list of page sizes.

• If you switch to another folder in the tree view, the page size is preserved.

• The page size is preserved until you change it.

• If you leave and then restart the Business Content window, the page size is
reset to the default page size of 25.

• For performance reasons, there is no Show all option available.


• If you switch to another page and then change the page size, you start again
with the new page size on the initial page (page 1).

• If you are, for example, on page 3 and switch to another folder and back
again, you start again on the refreshed initial page 1.

384 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
25.2. OpenText Business Content window

25.2.2.4.2 Sorting list items

The sorting process does not run in the local ALV list but in Content Server. You can
sort by the following columns:

• Name
• Date
• Time

If you select one or more columns that cannot be sorted, you receive the message
Sorting workspace documents by selected column is not supported!

Note: Sorting resets the pagination.

Example: If you change to page 3 of a certain sorting and then change the sorting once
more, you will jump back to the initial page 1.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 385
ER160208-CCS-EN-01
Chapter 25 ArchiveLink PLUS and OpenText Business Content

25.2.2.4.3 Displaying the folder list in the tree view

Note the following behavior:

• No pagination available in folder list – There is no pagination available in the


folder list. The number of sub folders that can be displayed all at once on a
certain level is restricted to 1000. OpenText generally recommends that you do
not exceed this number of sub folders on the same level in your folder structure.
You receive a warning message if you have more than 1000 sub folders in a
parent folder.
• Refreshing folder structure – Every time you switch between items in the tree
view, the respective document list is refreshed from Content Server.
• Creating new sub folder – Within a folder, the sub folder structure is only
refreshed fully if you have created a new sub folder. After refreshing, the tree
view shows the updated sub folder list sorted in alphabetical order.
• Browsing is preserved after refreshing – If you have been browsing deeper
within the folder structure, the opened folder hierarchy is preserved after
refreshing.
• Deleting folder – After deleting a folder, the updated folder structure is
displayed but not fully refreshed.

25.2.2.5 Working with business workspaces and documents (SAP view)


The context menu of a business workspace item contains all actions that you can
perform for this item. It depends on the business workspace item and the
permissions you have on the Content Server, which options are available in the
context menu of an item.

386 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
25.2. OpenText Business Content window

To add folders and documents to the business workspace:

1. Create a folder
You can create a folder in the tree view only.

a. In the tree view, right-click the item to which you want to add a folder and
click Add folder.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 387
ER160208-CCS-EN-01
Chapter 25 ArchiveLink PLUS and OpenText Business Content

b. In the Content Server Add: Folder dialog box, fill all required fields. For
more information, see the Content Server online help.
2. Add a single document
You can create a document in or upload an existing document to a folder in the
tree view.

a. In the tree view, right-click the folder to which you want to add a
document. Click Add Document.
b. In the Content Server dialog Add: Document, fill in the required fields.
These steps follow standard Content Server procedures. They may vary
according to your system’s settings.
3. Upload folders and documents
You can upload multiple folders with documents in them. When you upload
folders and subfolders, this structure is kept in the business workspace.

a. In the tree view, select the target folder where you want to upload the files
to.
b. Drag the files from your local file system to the upload area at the bottom
of the Business Content window.

Drag and drop


Users can upload a document into a business workspace in the
Business Content window by drag and drop. To use this function, users
need the S_GUI authorization object with ACTVT=60.

388 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
25.2. OpenText Business Content window

For the upload, the following applies:

• You can only upload files by dragging them into the respective field. Other
methods are not supported.
• The number of folders and documents that can be uploaded at once is
limited. An error message is displayed when this limit is reached.
• When you upload a file, which exist already at this location with the same
name in the business workspace, the file is uploaded as a new version of this
file.

To work with folders and documents:

1. Move or copy a folder or document to another business workspace


You can move or copy folders and documents from one business workspace to
another. Moving an item deletes the item in the source business workspace.

Note: When you move or copy a shortcut item, only the shortcut will be
moved or copied, not the original document.

a. Right-click the item that you want to move, either in the tree view or in the
document list.
b. From the context menu, select Move To or Copy To and select a business
object.

c. In the following dialog, enter the key of the target business workspace and
click Continue.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 389
ER160208-CCS-EN-01
Chapter 25 ArchiveLink PLUS and OpenText Business Content

d. In the Select destination container dialog, select the target folder or


container item to which you want to move or copy your item and click
Continue.

2. Copy a folder or document from and to a local folder or Tempo Box folder
You can copy documents and folders by dragging them. You have the following
options:

• From business workspace to local folder or Tempo Box folder (download)


• From business workspace to business documents
• From business documents to local folder or Tempo Box folder (download)
• From business documents to the business workspace
• From one local folder to another local folder or Tempo Box folder
• From a local folder to the business workspace (upload)
• From a local folder to business documents (upload)

To copy to a local folder, drag the document to a folder in the Local Files node.

3. Open a document to read only

Note: Customize your permissions and the behavior of document types


and formats in Content Server before editing and opening documents in
the hit list.

390 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
25.2. OpenText Business Content window

Double-click the document in the document list or select Open from the
document context menu.
The document opens in the application configured for its document type and
format.

4. Open a shortcut

Note: Except for Delete, any action of the Content Server Functions menu
is performed not on the shortcut itself but on the original document.
However, when you Move or Copy a shortcut item, only the shortcut will
be moved and copied, not the original document. Shortcuts to folders are
not supported.

Select the shortcut item or click Open in its context menu. The original
document or file opens in the application configured for this document type
and format.

5. Use actions of the Content Server functions menu


With necessary permissions, you can perform a selection of actions that are also
available on the Content Server Functions menu such as Add Follow up,
Permissions, Reserve/Unreserve, Delete, Properties. When you click the action
in the context menu, the corresponding Content Server dialog box opens. For
more information, see the Content Server online help.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 391
ER160208-CCS-EN-01
Chapter 25 ArchiveLink PLUS and OpenText Business Content

6. Search documents
You can search documents in the business workspace.

a. In the tree view, select the Business Workspace node to search the whole
business workspace. If you want to search in a specific folder, select this
folder.
b. Enter your search term in the Search box and click Start seach.
c. In the search result list, you have the following options which are standard
SAP functions:

Sort in ascending order.

Sort in descending order.

Search for a specific word.

Filter the result list.

Display more search results.

Leave the search result list and return to the document


list.

25.2.2.6 Working with business workspaces (Smart view)


When the business workspace is selected in the navigation area, you see the contents
of the business workspace in the right pane. You have the following options:

Filter
Open the filter side bar. Select the filter.

Add a folder or document


Add a folder or a document to the business workspace. Alternatively, you can
drag and drop files from your file system to the list.

Favorite
Mark the business workspace as favorite or remove the mark. Favorite business
workspaces are listed in the Favorites tile.

Search for a document or folder


Type some letters that are contained in the name of the folder or document. The
list is immediately reduced to entries that contain these letters.

Clear the search


Display all items.

392 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
25.2. OpenText Business Content window

Comment
View and add comments, and reply to other’s comments. With sufficient
permissions, you can also delete comments.

Display details of the item.

25.2.2.6.1 Adding a business workspace (Smart view)

The Business Content window always displays the Business Workspace item in its
tree view, even if no business workspace has been added to the business object. You
can either create a business workspace or complete an existing business workspace.

To create or complete a business workspace in the Business Content window:

1. Select the Business Workspace item in the treeview.


The new business workspace is created in the connected Content Server.
If the business object is configured accordingly, you can complete an existing
business workspace or create a new one.

2. In the Create or complete business workspace window, do one of the


following:

• To create a new business workspace, click Create new. Check the properties
and click Create.
• To complete an existing business workspace, click it in the list. Check the
properties of the business workspace and click Complete.

25.2.2.7 Performing full text search in Business Workspace


In your business workspace, you can perform a full text search. The search in the
Business Content window is equivalent to the Search From Here search in Content
Server. The search runs within the selected container item and in all of its container
sub-items. You do not need to configure a search template.

Prerequisites Before using the full text search, ensure that you meet the following prerequisites:

• Customizing full text search in Content Server – In Content Server, you must
have customized and enabled the full text search as described in the Content
Server documentation.
• Selecting OT standard regions as displayable in Content Server – You must
select certain OT standard regions as displayable in Content Server.
To select OT standard regions as displayable:

1. In the Content Server Administration, click Search Administration > Open


the System Object Volume. Open the Enterprise Data Source Folder.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 393
ER160208-CCS-EN-01
Chapter 25 ArchiveLink PLUS and OpenText Business Content

2. In the Functions menu of the Enterprise Search Manager, click Properties >
Regions.

3. In the list of regions, select the Displayable check box for each of the
following regions:

– OTName
– OTMIMEType
– OTModifyTime
– OTModifyDate
– OTReserved
– OTSubTypeName
– OTObject

Note: In Content Server 10.5, the search engine drops certain regions by
default, for example, time regions. Therefore, regions like OTModifyTime
must be re-enabled. You must customize the config/
LLFieldDefinitions.txt configuration file deleting or commenting out
the related DROP lines.
For OTModifyTime, proceed as follows:
1. Open config/LLFieldDefinitions.txt for edit.
2. Replace the line

DROP OTModifyTime

with

TEXT OTModifyTime

For more information, see also OpenText Content Server Administrator


Online Help (https://knowledge.opentext.com/knowledge/piroot/
llescor/v100500/llescor-h-agd/en/html/).
If this procedure is not successful, proceed as follows:
1. In config/LLFieldDefinitions.txt, change the line

DROP OTModifyTime

to

REMOVE OTModifyTime
2. Restart the Content Server service. Also restart the search processes
under <processes_prefix> Data Flow Manager.
3. In config/LLFieldDefinitions.txt, change the line

REMOVE OTModifyTime

to

394 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
25.2. OpenText Business Content window

TEXT OTModifyTime
4. Restart the Content Server service. Also restart the search processes
under <processes_prefix> Data Flow Manager.
After the first documents are indexed with this setting, the field is expected
to be available in the Properties Regions of the Enterprise Search Manager.
For more information, see also chapter 4.3 in OpenText Content Server
Advanced Indexing and Searching Guide (https://knowledge.opentext.com/
knowledge/piroot/llessrc/v100500/llessrc-ggd/en/html/_manual.htm).
• Maintaining Logical Destination for Extended ECM Connections – You must
ensure that the value for the Logical Destination in the Extended ECM
Connections for your business workspace customizing contains the connection
to the relevant Content Server instance to enable the full text search in the
business workspace. For more information, see Logical Destination in Extended
ECM Connections on page 358 and “Creating a Logical Destination in Extended
ECM Connections” on page 367.

Performing full text search in the business workspace


To perform full text search:

1. In the GOS menu of your business object, clickBusiness Content.

2. In the tree view, click the Business Workspace item. Select the container item in
which you want to perform your search.
Starting from the selected item, the search will be also be conducted in all its
sub-items.

3. In the Search box, enter your search term and click Search or press Enter.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 395
ER160208-CCS-EN-01
Chapter 25 ArchiveLink PLUS and OpenText Business Content

4. The document hit list is replaced by the search result hit list. The list header
displays the search term and the name of the item in which the search was
conducted.

You have the following options:

• To perform actions on the result list items – right-click your search result
item and open the context menu. You can perform the same actions as
described for the items of the document hit list.
• To get more results – if there are more results available than the result list
can display due to the default height of the ALV grid, the More Results
button appears in the tool bar.
Click More Results to get more search results. The next search results are
appended to the current results in the list.

• To return to the document hit list – click Back to Browsing to return to the
document hit list.

396 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
25.2. OpenText Business Content window

25.2.3 Using the Business Documents function


The document hit list displays a list of the ArchiveLink documents attached to the
Business Object. You can add documents to the archive store and perform other
actions, for example, delete documents. If Records Management is enabled for your
business object and document type, you can declare documents as records and view
records details. After some customizing steps, you have the option to add additional
attributes to your ArchiveLink documents besides the standard ArchiveLink
attributes.

Note: Like the standard SAP attachment list, the Business Documents list also
displays the documents linked to the direct supertype of the current business
object.

Example: If you create a document with the business object BUS2030, the documents
linked to its supertype VBAK are also displayed in the Business Documents list.

25.2.3.1 Customizing additional ArchiveLink attributes


For your ArchiveLink documents, you can add additional attributes to the standard
ArchiveLink attributes. The Business Content window displays the document
attributes in the list of archived documents for your business object. An attribute is
stored in a store table that again is assigned to a certain context consisting of a
business object type and a document type. You can create one or more store tables to
include different attributes and you can assign one store table to more than one
context.

Before you start, perform the following steps:

1. Before you start the attribute customizing in your SAP system, define the
attribute set that you want to apply to your documents, and prepare a concept
for the allocation of store tables and contexts.
2. Create one or more store tables containing the new attributes.
3. Assign one or more store table to your context.

To customize ArchiveLink attributes in the SAP GUI:

1. To create a new store table, run the SE11 transaction. In Database table, enter a
name for the new store table and click Create.

2. Click New Entries to create a new field.


Note the following:

• Besides your new ArchiveLink attributes, the store table must contain five
standard fields. You must create five Key fields with the following Field
names and Data elements:

– MANDT with the Data element MANDT


– SAP_OBJECT with the Data element SAEANWDID

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 397
ER160208-CCS-EN-01
Chapter 25 ArchiveLink PLUS and OpenText Business Content

– OBJECT_ID with the Data element SAEOBJID


– ARCHIV_ID with the Data element SAEARCHIVI
– ARC_DOC_ID with the Data element SAEARDOID
• You must define a Data element for each field. Additionally, you can add
other technical parameters.
• Every attribute that is not a Key field is handled as an additional
ArchiveLink attribute.
• You can create one or more store tables to include different attributes,
respectively.
• You can use an attribute in more than one context. However, an attribute
must be unique for a context. If two tables hold the same attribute, they
cannot be customized for the same context.

3. To customize ArchiveLink attributes, run the spro transaction and click SAP
Reference IMG. Expand OpenText Archiving and Document Access for SAP
Solutions > ArchiveLink PLUS. Run the ArchiveLink Attributes activity.

4. Create a new context key consisting of business object type + document type + store
table.
Click New Entries and add the following entries:

ObjectType
Enter a business object type. You have the following options:

• You can use the Search help to enter an exact name for your object type.
• Enter * to assign any available object type to a certain document type
and store table.

Doc. type
Enter a document type. You have the following options:

398 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
25.2. OpenText Business Content window

• You can use the Search help to enter an exact name for your document
type.
• Enter * to assign any available document type to a certain object type
and store table.

Table Name
Enter the name of the store table that you want to assign to the context.

Note the following:

• You can enter the same store table for more than one context.
• For one context, you can enter * either for the object type or the document
type but not for both at the same time.
• A partial masking of entries is not possible. For example, you cannot enter a
value like BK*.
• You can delete a context key only after you have also deleted all entries for
this context in the corresponding store table.

25.2.3.1.1 Mapping external attributes

You can map additional ArchiveLink attributes to external attributes coming from
the document or the file system. In this way, the ArchiveLink attributes can be
preset with the values of external attributes, for example, document metadata, when
you upload and store an ArchiveLink document.

Supported document formats are Microsoft Office Word, PowerPoint and Excel
starting with Office 2007.

The following external attribute types are supported:

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 399
ER160208-CCS-EN-01
Chapter 25 ArchiveLink PLUS and OpenText Business Content

• Built-in attributes – are the built-in properties of the supported document


formats.
Example: In Microsoft Office Word, built-in attributes are, for example, Author, Title,
Subject, Keywords. In the document, you access them via Office Button > Prepare >
Properties.
• Custom attributes – are either predefined custom properties of the supported
document formats or freely defined properties.
Example: In Microsoft Office Word, you access and maintain the Custom attributes as
follows: click the Office Button > Prepare > Properties. Click Document Properties >
Advanced Properties. Click the Custom tab. You can either use the predefined attributes
or create new attributes.
• Special file properties – are predefined properties coming from the file system.
Currently three properties are supported: File name, File Size and File Path.

To map external attributes to AL attributes:

1. Ensure that the following prerequisites are met:

• additional ArchiveLink attributes have been customized


• Microsoft Office has been installed on your client computer
2. Run the SPRO transaction and access the SAP Reference IMG. Navigate to
Open Text Archiving and Document Access for SAP Solutions > ArchiveLink
PLUS and run the Define external attribute mapping activity.
3. Click New Entries to create a new property mapping. Add the following
entries:

• Table Name: Enter the name of the store table that contains the ArchiveLink
attribute that you want to map. Press F4 or click to get a value help.
• Field Name: Enter the store table field name of the AL attribute that you
want to map. Press F4 or click to select a possible field name.
• Ex.a.type: Enter the attribute type of your external attribute. Use the drop-
down list to select the attribute type.

• External attribute: Enter the name of your external attribute. Press F4 or


click to get a value help.

Note: No value check occurs for this type of attribute because Custom
properties can be freely defined.

400 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
25.2. OpenText Business Content window

• Conversion Exit: if necessary, enter a conversion exit that you want to use to
convert the property’s data format to the one used by the SAP system. You
can use the default conversion exit /OTX/AL_CONV_EXT_ATTR_DEF as
template to develop your own function module.

4. Click Save to save your entries.

Important

• Ensure that Microsoft Office is installed on the client computer that you use
to upload and store documents.
• Do not use the key fields in the ArchiveLink store table for mapping.

25.2.3.2 Using the Business Documents function


To access the Business Content window, click the Business Content entry in the
GOS menu of your business object.

In the Business Documents area, only ArchiveLink documents are displayed.


Without added attributes, the document hit list displays only three default
attributes.
A thumbnail preview is displayed for document formats that are supported by the
OpenText Imaging Web Viewer. Before you can use the preview, you have to
configure and maintain the imaging integration for the Web Viewer on the SAP
server. For more details, see “Configuration for Java Viewer or Web Viewer”
on page 289.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 401
ER160208-CCS-EN-01
Chapter 25 ArchiveLink PLUS and OpenText Business Content

Besides the standard attachment list functions, you have the following options:

• Preview
In the document list, select a document to display in the thumbnail preview. A
preview is available for all document formats that are supported by OpenText
Imaging Web Viewer, for example JPG, FAX, PDF, TIF and TXT.
• Add document
You can upload a document to the archive store in your SAP system. In doing so
you can add attributes to your document, if you have performed the attribute
customizing. For more information, see “Customizing additional ArchiveLink
attributes” on page 397.
To add a document:

1. Click > Add Document.


2. In Browse Document, enter the path to the document you want to upload.
You have the following options:

– Enter the document path manually and press ENTER.


– Browse the document in your system and press ENTER after the path
has been inserted in the box.
– Drag the document file from your desktop to the Or Drop Document
Here button. The document path is entered in the Browse Document
box.
3. Select a Document Type from the list. You have the following options:

402 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
25.2. OpenText Business Content window

– If you select a document type for which you have customized attributes,
the Document Attributes dialog box displaying the customized
attributes opens.
Enter values for your attributes and click OK.

After you have filled in attributes for one document, they display in the
document list.

– If you select a document type without attribute customizing you receive


the following message:

Click OK. The document is added to the list without attributes.

• Add document by entering bar code


You can add a document to the list by matching it through a bar code with your
business object and connecting it with a document type. For storing additional
attributes, OpenText Business Content supports only the Early archiving scenario
using bar codes. The document must already exist in the system to make an
attribute storage for a certain archive link possible. After entering the bar code,
the system matches with the respective business object. If the matching was
successful, and if the selected document type was customized correctly before,
the Document Attributes dialog box opens. The document link is added to the
list.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 403
ER160208-CCS-EN-01
Chapter 25 ArchiveLink PLUS and OpenText Business Content

If you use the bar code entering option in the Business Content dialog, note the
following:

– You can add attributes only if one single matching document has been found.
When more than one document could be matched to the same business object,
you will get an info message and all found documents will be added to the
list without attributes.
– You can add attributes only if the selected document type has been
customized accordingly previously before as part of a context key.
– When the matching procedure finds no document, the bar code is stored with
the document type following the standard matching procedure of the Late
archiving scenario. You cannot add any attributes and no document link
appears in the list.

To add a document by entering a bar code:

1. Click > Enter Barcode.

2. In the Bar Code box, enter your bar code.

3. In the Document Type list, select your document type.

4. If the Document Attributes dialog box opens, add your attributes.

5. Click OK.
If a match occurs, the new document link appears in the list. If no match or
more than one match occurs, you receive a corresponding message.
• Edit attributes
Note that you can edit only attributes of documents that have been customized
accordingly.
You can do the following:

– Add attributes subsequently for documents in the list.


– Change existing attributes for a document.

To edit attributes:

1. Click to open the Edit Document Attributes dialog box.

2. Edit your attributes and click .


• Delete
You can delete document links from the list and the document itself from the
archive store. When you delete the document link, the attributes assigned to this
link are automatically removed from the store table. After deleting, the document
list rebuilds. Note that you can delete only documents that are not declared as
records.
To delete documents:

404 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
25.2. OpenText Business Content window

1. In the document list, select a document and click Delete.

2. Confirm one or both of the following messages.


You receive a message, when the attributes have been removed from the
store table.

• Records Management
The Business Content dialog supports OpenText Records Management. Before
you can use it in the Business Content dialog, you have to enable Records
Management for a context consisting of business object type and document type by
customizing a declaration ID in IMG > OpenText Extended ECM for SAP
Solutions > Infrastructure > Maintain Extended ECM Connections > Assign
Declaration ID to Object Type and Document Type. For details, see Section 6.11
“SAP: Assigning a document declaration to a business object and a document
type” in OpenText Extended ECM for SAP Solutions - Customizing Guide (ERLK-
CGD). In the Business Content dialog, Records Management is only available if at
least one configuration for Records Management exists for your particular
business object.
In this case, the Declare as Record and the View Records Details
buttons appear in the toolbar. Furthermore, the Records Management Status
symbol column is added to the document list. Documents that show a status
symbol in the Status column have been declared as records.

The archived documents of your business object are checked against Records
Management. If a document is already declared as record, it shows a status
symbol in the Status column. If the document has no record declaration, the
Status column shows no status symbol. In this case, or if you add a document to
the list, you can declare it as a record if the document has a document type that
has been customized for Records Management.
You have the following options:

– To view record details, select a document that shows a status symbol in the
Status column and click View Records Details. You can also use the
corresponding entry in the context menu. For details, see Section 5.6.1

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 405
ER160208-CCS-EN-01
Chapter 25 ArchiveLink PLUS and OpenText Business Content

“Declaring records ” in OpenText Extended ECM for SAP Solutions - User Guide
(ERLK-UGD).
– To declare a document as record, select a document that shows no symbol in
the Status field and click Declare as Record. You can also use the
corresponding entry in the context menu. To be available for record
declaration, the document must have a document type that has been
previously customized for Records Management. For details, see Section 5.6.1
“Declaring records ” in OpenText Extended ECM for SAP Solutions - User Guide
(ERLK-UGD).

25.2.4 Using the Business Attachment function


Business attachments are documents and other items stored in Content Server that
can be attached to a business workspace.

You have the following options:

• Search the attachment by browsing the whole Content Server structure to the
single item and attach it.
• Search the attachment using the simple search: A predefined search form filters
the list of possible attachments. You can add more than one attachment in one
step.

To add a business attachment:

1. In the Business Content window, select the Business Attachments item in the
tree view.
2. To add an attachment by browsing, do the following:

406 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
25.2. OpenText Business Content window

a. Browse the Content Server structure to find the item that you want to
attach.
b. Select the item and click Continue.
The new business attachment is now listed in the Business Content
window.

3. To add one or more attachments using search, do the following:

a. Click Create Business Attachment > Create Business Attachment using


Search.
b. In the following window, select the required search form and add your
search criteria.
c. From the result list, select the item or items that you want to add as
business attachments. Then click Add Business Attachment.
The business attachment is added to the business workspace.

4. Click Display to view the item in Content Server.

5. Drag the document to a folder in the Local Files node to download it to this
folder.

6. Click to remove the business attachment. This does not delete the document
in Content Server.

25.2.5 Using the Notes function

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 407
ER160208-CCS-EN-01
Chapter 25 ArchiveLink PLUS and OpenText Business Content

To work with notes:

1. In the Business Content window, select the Notes item in the tree view.

2. Click Add Note.

3. In the following window, enter the title and the text of the note and click
Continue

4. Select the item and click Continue.


The new note is now listed in the Business Content window.

5. Manage the notes. You have the following options:

a. Click Display to view the note.


b. Click Change to edit the note.
c. Click to delete the note.

408 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
25.2. OpenText Business Content window

25.2.6 Using the OpenText Tempo Box and Local Files


function
If configured, the Business Content window contains a Local files node which
displays OpenText Tempo Box folders and other folders on the local file system.

Note: If a Tempo Box folder is available, you may be prompted for your
security settings the first time you open the Business Content window.
Depending on your company’s security policy, you can select if and how you
want to grant access to your local file system. To use this function, you must
allow access. If you select Allow this time, you will be prompted each time
you open the Business Content window. For more information, ask your
system manager.

• The Tempo Box folder is displayed automatically when OpenText Tempo Box is
installed on the local computer.
• Other local folders can be added manually by the user.

To work with local files:

1. Open Tempo Box


You can access Tempo Box files from the Business Content window.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 409
ER160208-CCS-EN-01
Chapter 25 ArchiveLink PLUS and OpenText Business Content

a. In the tree view, click Local Files > Tempo Box. You see the content of your
local Tempo Box folder.
b. Select a folder to see its content in the document list.
c. Right-click a document to see the functions that are available: You can open
and edit the file, find it on the local file system, or delete it. You can also
refresh the view.

2. Add a local folder


You can add a folder on your computer or a network share to the Local Files
node.

a. Right-click Local Files and click Add folder.


b. In the following dialog, select a folder or a network share and click OK.
c. Optional In the SAP GUI Security dialog, select an option. To use the local
folder without interruption, allow access. For more information, ask your
system manager.
d. To remove the folder, right-click it and select Remove folder.
e. To update the view, right-click the folder or file and select Refresh.

3. Copy a folder or document from and to a local folder or Tempo Box folder
You can copy documents and folders by dragging them. You have the following
options:

• From business workspace to local folder or Tempo Box folder (download)


• From business workspace to business documents
• From business documents to local folder or Tempo Box folder (download)
• From business documents to the business workspace
• From one local folder to another local folder or Tempo Box folder
• From a local folder to the business workspace (upload)
• From a local folder to business documents (upload)

To copy to a local folder, drag the document to a folder in the Local Files node.

410 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
Chapter 26
Viewing ArchiveLink documents in a Fiori app

OpenText Archiving and Document Access for SAP Solutions provides a Fiori
control, with which users can view and manage business documents enhanced with
ArchiveLinkPLUS attributes.

Drag to upload
Use the fast upload method by dragging documents into the control.

Document list, Records Management


Enhance standard columns with custom columns
Declare document in Records Management

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 411
ER160208-CCS-EN-01
Chapter 26 Viewing ArchiveLink documents in a Fiori app

Barcode
Barcode – Create new documents with barcode scanning. Recommended for use
with mobile devices.

Find documents
Type any part of the document name to find documents really fast.

Sort document list


Sort the document list by a column, ascending or descending.

412 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
ArchiveLink PLUS
Upload documents with or without ArchiveLink PLUS attributes. You can later
edit these attributes.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 413
ER160208-CCS-EN-01
Chapter 26 Viewing ArchiveLink documents in a Fiori app

414 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
Part 5
SAP application log
Chapter 27
Troubleshooting using the SAP application log

The SAP application log can be used to support the troubleshooting process. The
application log shows the SAP view on the error; thus, it only supplies information
which is known on the SAP side.

However, in many cases, the error information on the client side must also be used
to find the reason of a problem. The application log cannot substitute the log file on
the client side. For technical reasons, the application log does not contain every
message which is put out to the user.

The following information sources have to be considered for an error analysis:

• the user (what did he do, what messages did he see?)


• the client log
• the application log.

27.1 SAP application log for DesktopLink scenarios


The SLG1 object for messages related to DesktopLink is /IXOS/DL_LOG. Depending
on the scenario, the following sub-objects are available:

• /IXOS/DL_G sub-object for GOS scenario; see “Archiving using the generic object
services (GOS)” on page 302.
• /IXOS/DL_F sub-object for File Upload scenario; see “Archiving using the
DesktopLink transaction J8AM” on page 304.

If the caller scenario cannot be determined, the sub-object called Common (/IXOS/
DL_U) is used.
Another source is the technical log in table J_8A3T0002, which may also be helpful.

27.1.1 Log entries and log lines


A log entry is identified by a log number and contains one or more log lines. The
following types of log lines are supported:

CALLER line
The CALLER line displays action type and caller information (for example, the
IP address); a CALLER line is present in every log entry.
The following values are used in CALLER lines for the action type:
FILE_IMPORT
GOS and file upload scenarios

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 417
ER160208-CCS-EN-01
Chapter 27 Troubleshooting using the SAP application log

START_INDEXING_MULTIPLE
Client scenario

Empty value
Unidentified scenarios

MESSAGE line
The MESSAGE line writes the specified message as it is visible to the SAP user.

EXCEPTION line
The EXCEPTION line writes a message of the format Exception & at &. An
EXCEPTION line is written when the main control routine for the DesktopLink
scenarios receives an exception.
The following values are used in EXCEPTION lines:

1 no_authority = 1
2 not_found = 2
3 user_cancel = 3
4 error_ole_connection = 4
5 internal_error = 5
6 problem_creating_link_entry = 6
7 problem_creating_work_item = 7
8 document_locked = 8
9 end = 9
10 lars_hostname = 10
11 lars_missing_port = 11
12 lars_missing_service = 12
13 lars_version_not_maintained = 13
14 lars_customizing_missing = 14
15 lars_rendition_error = 15
16 lars_system_failure = 16
17 lars_communication_error = 17
18 lars_error = 18
19 OTHERS = 19

The function module name is J_8A3_SAP_SHORTCUT_SCENARIO.

ARCHIVE line
The ARCHIVE line shows values taken from the parameter table of the
DesktopLink transaction. An ARCHIVE line is written when the transaction
performed by the DesktopLink client returns an error. As the error cannot be
attributed to a specific document, the line is classified as information and
displayed with a green symbol.
The value displayed for the server is not taken from the parameters; instead, it is
the value associated to the archive according to the SAP configuration. If no
value can be found, the message displays x not configured.

All the log lines are written to the application log as message lines. Message lines are
displayed in the user's login language.
If there is an additional long text available, this is indicated by a question mark
symbol. If available, this long text will also be displayed in the user's login language.

418 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
27.2. SAP application log for ArchiveLink Fulltext Search

Double-clicking on a message line shows the message number (for example, 81246
for message class 81, message number 246).

27.2 SAP application log for ArchiveLink Fulltext


Search
The main SLG1 object for messages related to the ArchiveLink Fulltext Search is /
OTX/RM. The following sub-objects are available:

• /OTX/SEAB: sub-object for Fulltext Search Base

• /OTX/SEAPI: sub-object for Fulltext Search API

• /OTX/SEARCH: sub-object for Search report

• /OTX/SEAX: sub-object for Fulltext Search Connector

For details to work with the SAP application log, see Section 23.1.5 “Analyzing the
application log” in OpenText Extended ECM for SAP Solutions - Customizing Guide
(ERLK-CGD).

For errors coming from the Content Server Search API, the details also show the
content of the web page returned from the Content Server.

27.3 SAP application log for ArchiveLink Attributes


The main SLG1 object for messages related to the ArchiveLink Attributes is /OTX/AL.
The following sub-objects are available:

• /OTX/AUTH – sub-object for Authorization check

• /OTX/CORE – sub-object for AL Attribute Core Component

• /OTX/DYN_UI – sub-object for Classical Dynpro UI

Of these sub-objects, only /OTX/CORE and /OTX/DYN_UI are currently in use, because
in this stage of implementation all authorization related issue can be read from
transaction SU53.

27.4 SAP application log for Rendition Management


The main SLG1 object for messages related to Rendition Management is /IXOS/RSA.
The following sub-object is available:

• /IXOS/RSA_RENDER – sub-object to create a rendition

For errors coming from the OpenText Rendition Server, see also the server's logs.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 419
ER160208-CCS-EN-01
Chapter 27 Troubleshooting using the SAP application log

27.5 SAP application log for Business Application


Integration (BAI)
The main SLG1 object for messages related to the Business Application Integration
is /IXOS/AX. The following sub-objects are available:

• /IXOS/AX_COLLECT – Collect
• /IXOS/AX_CONNECTOR – Connector
• /IXOS/AX_TRANSFER – Transfer

27.6 SAP application log for license measurement


The SLG1 object for messages related to license measurement is /OTX/CL with the
sub-object /OTX/CL. Log messages are written by the central evaluation class of
license measurement. Furthermore, the function modules called from the SAP
system measurement are also writing messages to the application log when they are
performed. In the case of the functions called from SAP system measurement,
warnings are written to the application log if the license measurement has found
validation issues.

420 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
Chapter 28
OpenText License Report

With the OpenText Archiving and Document Access for SAP Solutions license
measurement, you assess the number and types of users who are working with an
SAP system. License measurement for Archiving and Document Access and
Extended ECM for SAP Solutions can be integrated in the SAP license measurement
Global License Audit System (GLAS). With this information, you can align your
contract with SAP or OpenText to meet your requirements more accurately.

Important
The OpenText License Cockpit was designed to serve measurement of both
SAP systems and connected Content Servers with Extended ECM. The
following description includes Content Server measurement. If your system
does not have Extended ECM and Content Servers the respective information
is not relevant for you.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 421
ER160208-CCS-EN-01
Chapter 28 OpenText License Report

28.1 Technical overview

Figure 28-1: License Measurement Overview

Extended ECM for SAP Solutions license measurement consists of the following
parts:

Measurement on the SAP system


Measurement on the SAP System is based on a business role with the
J_6NLC_TYP authorization object and an appropriate license type. Business roles
with this authorization object are then evaluated based on their license type
related to the product and depending on the degree of usage.
Important
The authorization object J_6NLC_TYP is not used to grant access
permissions.

Measurement on Content Server


Users and groups are assigned a license type that reflects their quantity of usage.
A privilege is used to count on how many days a user accesses business
workspaces. The license type along with the number of days on which this user
accessed a business workspace in Content Server are passed to the SAP system
where the data is consolidated and presented.

Note: A user is not locked, if the actual days of usage exceed the number
of days that are covered by the assigned license type. This mismatch is
noted in the license report.

The following license types are available, depending on whether they are sold by
SAP or OpenText.

422 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
28.1. Technical overview

Table 28-1: License types

Type Description
Licenses sold by OpenText
OXECMF OpenText Extended ECM for SAP – Professional User
OXECMO OpenText Extended ECM for SAP – Occasional User
OXECMB OpenText Extended ECM for SAP – External B2B User
OXECMC OpenText Extended ECM for SAP – External B2C User
OXECMN OpenText Extended ECM for SAP – Non-SAP User
ODOCF OpenText Document Access – Full Named User
ODOCW OpenText Document Access – Web Named User
ODOCO OpenText Document Access – Occasional User
OARCF OpenText Archiving – Full Named User
OARCW OpenText Archiving – Web Named User
OARCO OpenText Archiving – Occasional User
Licenses sold by SAP
SXECMF SAP Extended ECM by OpenText – Named User
SXECMO SAP Extended ECM by OpenText limited access option
SAP Document Access by OpenText – User: Business Expert, Ltd.
SDOCF
Professional
SAP Document Access by OpenText – User: Employee, Employee Self
SDOCW
Service (ESS) User
SARCF SAP Archiving by OpenText – User: Business Expert, Ltd. Professional
SAP Archiving by OpenText – User: Employee, Employee Self Service (ESS)
SARCW
User
SARCF2 SAP Archiving by OpenText
SARCO SAP Archiving by OpenText limited access option
SDOCF2 SAP Document Access by OpenText
SDOCO SAP Document Access by OpenText limited access option

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 423
ER160208-CCS-EN-01
Chapter 28 OpenText License Report

28.2 Prerequisites
To use the Extended ECM for SAP Solutions license measurement, you must do the
following:

1. On the SAP system, create roles for each license type that you need with the
authorization object and appropriate license type, and assign them to the users.
2. In Content Server, assign the appropriate license type to the users of Extended
ECM for SAP Solutions. For example, a user who rarely needs to work with
business workspaces needs a different license than users that daily work with
business workspaces.

28.3 Preparing license measurement on the SAP


system
To prepare your SAP system for license measurement of OpenText products and
integrate into SAP System Measurement (transaction USMM), you must maintain
system measurement tables. You must also create special business roles that contain
an authorization object for measurement.

28.3.1 Setting up users for measurement


You need the following users for license measurement with the respective
authorizations objects.

424 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
28.3. Preparing license measurement on the SAP system

User type Authorization objects


User who runs license measurement on and • S_TCODE
for the local system TCD = /OTX/LICENSE, SLG1, SM36,
SM37
• S_BTCH_JOB
JOBACTION, JOBGROUP
enabled to your requirement
• S_GUI
ACTVT = 61
to enable generic ALV functions for /
otx/license
• S_USER_GRP
ACTVT = 03
CLASS = *
to fully use transaction /otx/license
and its function (see also documentation
for transaction USMM)
• S_APPL_LOG
ACTVT = 03, 06
ALG_OBJECT = /OTX/CL
ALG_SUBOBJ = /OTX/CL, /OTX/
CL_RM
to enable the user to read the application
log
• S_BDS_DS
ACTVT = 03
CLASSNAME = DEVC_STXD_BITMAP
CLASSTYPE = OT
to allow access to images inside the PDF
output of the license report
Communication user who is called via RFC • S_RFC
from a central license measurement system ACTVT = 16
RFC_NAME = CL_TRANS, RM_LIC_RFC
RFC_TYPE = FUGR
to allow this user to call the RFC enabled
functions of these function groups

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 425
ER160208-CCS-EN-01
Chapter 28 OpenText License Report

User type Authorization objects


User who runs license measurement on the All of the above and the following:
central license measurement system which
• S_ICF
calls remote SAP systems
ICF_FIELD = DEST
ICF_VALUE = <value of field
Authorization for Destination in
the RFC destination>
• S_RFC_ADM
ACTVT = 03
The other fields may differ depending on
how restricted your setup your
environment.

user who runs a license measurement needs a business role with the following
authorization objects:

To set up a user for measurement:

1. Start transaction pfcg to assign the authorization role.

2. Create a role for a user who runs license measurement according to the
information given in the table above.

3. On the systems which are called via RFC, create a role for communication users
who are called via RFC from a central license measurement system.

28.3.2 Maintaining measurement tables


OpenText provides three function modules for the integration into SAP System
Measurement:

• /OTX/CL_GLAS_DOCUMENT_ACCESS – integration function for Document


Access
• /OTX/CL_GLAS_ARCHIVING – integration function for Archiving
• /OTX/RM_LIC_GLAS_XECM – integration function for Extended ECM

The function modules provide the following:

• Writing status, warning and error messages to application log object SLG1.
If validation issues have been found, this shows as a warning message in the log
of each function. You then must check the more detailed license report in
transaction /otx/license.
• Each function module contains an external ID referring to the related application/
product.
• The function modules call a central method of the OpenText license evaluation to
calculate the license counts.

426 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
28.3. Preparing license measurement on the SAP system

To maintain SAP System Measurement tables:

• Start transaction SM30 to add the following tables:

TUAPP (Applications for System Measurement)


Add entries for OpenText applications to the TUAPP table.

Important
Add the following entries only if you purchased your licenses from
SAP. If you purchased your licenses directly from OpenText, set Call?
= false for all these entries.

App. Version Name of Function PeriodType Call?


Application module
name
1140 0 SAP /OTX/ No period true
Archiving CL_GLAS_ assigned
by ARCHIVIN
OpenText G
1144 0 SAP /OTX/ No period true
Document CL_GLAS_ assigned
Access by DOCUMEN
OpenText T_ACCESS
1154 0 SAP Ext. /OTX/ No period true
Enterprise RM_LIC_G assigned
Content LAS_XECM
Mgmt by
OT

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 427
ER160208-CCS-EN-01
Chapter 28 OpenText License Report

TUUNT (Units for System Measurement Objects)


Add the following units for the measurement of OpenText applications to
the TUUNT table.

Unit Measurement
1140 OT: Licensed User: Buss. Expert, Ltd Pro
1141 OT: Licensed User: Employee, ESS User
1144 OT: Licensed User: Buss. Expert, Ltd Pro
1145 OT: Licensed User: Employee, ESS User
1152 OT: User limited access option
1154 OT: User

428 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
28.4. Preparing license measurement on Content Server

28.4 Preparing license measurement on Content


Server
On Content Server, you must do the following to enable license measurement:

• Assign a license type to a user or a group

• Grant the permission to access business workspaces

• For the authentication of this connection, OTDS is required.

To assign a license type to a user or group in Content Server:

1. In Content Server Administration page, click Enterprise > Users & Groups to
open the Content Server user management.

2. Find the user or group that you want to edit.

3. From the Extended ECM License list, select a license type.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 429
ER160208-CCS-EN-01
Chapter 28 OpenText License Report

Note: If there are conflicting license assignments for users, because one of
their groups has a different type, the most comprehensive license type is
counted.

To grant usage privileges for licensing:

Only users with the Access Business Workspaces privilege can access business
workspaces. Each time a user with this privilege accesses business workspace is
counted for the license measurement.

1. On the Content Server Administration page, click Core System – Feature


Configuration > Usage and Transaction Privileges.
2. Edit the restrictions for the usage privilege Extended ECM Operation > Access
Business Workspaces (Mandatory for Licensing) according to your license
model. Mismatches between granted privileges and license type assignment are
displayed in the report.

28.5 Running license measurement


OpenText License Management provides different modes in which you can
configure and run the measurement. You can switch between these modes during
configuration if necessary.

Note: The SAP administrator who runs the license measurement has
administration rights in Content Server.

Standard Mode
Use standard mode for a simple scenario:

• The SAP client on which you run the license dashboard is the only system
that is being measured.
• The Content Server instance that is being measured is customized in the IMG
activity OpenText Extended ECM for SAP Solutions > Infrastructure >
Maintain Extended ECM Connections. You can select a Content Server if
more than one is configured.

Expert Mode
Use the expert mode for an system measurement of more than one SAP client
and possibly more Content Server installations.
You can use expert mode to include Content Servers that are connected to a
remote SAP system.

430 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
28.5. Running license measurement

28.5.1 Running in standard mode


Standard mode only uses the SAP system on which you started the license
measurement. All other SAP servers that you might have configured in expert mode
will be deactivated.

To run license measurement in standard mode:

1. Start transaction /OTX/LICENSE.


OpenText License Measurement Cockpit starts in standard mode.

2. Maintain OpenText Archives on this SAP Server


In the list of content repositories on this SAP server, you can select which
repository is used as an OpenText Archive. Access permissions for the
OpenText archives are used to validate license types. This setting is valid for all
clients on this server.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 431
ER160208-CCS-EN-01
Chapter 28 OpenText License Report

Note: OpenText Archives must be maintained on each remote SAP system


that you include in your measurement.

This section is only visible if Extended ECM is installed and Connection IDs are
maintained in the IMG activity.
Save your settings.

3. OpenText Products Sold by SAP That Have Been Licensed: Select if you
licensed OpenText Employee File Management (EFM) or OpenText Travel
Receipts Management for SAP Solutions (TRM). When you selected an option,
DocuLink projects that are recognized as EFM or TRM projects are ignored
when validating access permissions to DocuLink. In any case, TRM or EFM
DocuLink projects are listed in the license report.

Note: These licensed OpenText products must be maintained on each


remote SAP system that you include in your measurement.

Save your settings.

4. Click Start License Measurement and confirm the creation of the background
job.
The Status section informs you about the status of the measurement. Click
Refresh to update the status. If the measurement was performed without errors,
click Display Latest License Report to view the report.
For more information, see “Understanding the consolidated measurement
results” on page 438.

28.5.2 Running in expert mode


You can use expert mode if you want to include other clients on the same SAP
system or remote SAP systems into the measurement. These SAP systems are
connected via RFC. Content Servers that are connected to these SAP systems can
also be included in the measurement.

In expert mode, you have the following options how license data is retrieved for
consolidation:

• Direct transfer through RFC connection. The remote system must be available
during the measurement.
• Export an XML file from the remote SAP system and import it to the license
measurement cockpit inbox. Use this option if the remote system is not available
during measurement. You can either create and export file manually on the
remote system, save it to a disc, and then upload it to the measuring system, or
you can retrieve the export file through the RFC connection. In both cases, you
must make sure that the age of the retrieved license data does not exceed the
maximum age that you set for license data.
• Content Server connected to an SAP system.

432 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
28.5. Running license measurement

To run license measurement in expert mode:

1. Start License Measurement Cockpit with transaction /OTX/LICENSE.


OpenText License Measurement Cockpit starts in standard mode.
2. Click Change to Expert Mode.
Click Always Start in Expert Mode if you want this option.
3. Maintain OpenText archives and product exclusions.
On the Preparation of SAP System tab, you can identify OpenText archives and
define which products you want to exclude from measurement.

a. Maintain OpenText Archives on this SAP Server


In the list of content repositories on this SAP server, you can select which
repository is used as an OpenText Archive. Access permissions for the
OpenText archives are used to validate license types. This setting is valid
for all clients on this server.

Note: OpenText Archives must be maintained on each remote SAP


system that you include in your measurement.

This section is only visible if Extended ECM is installed and Connection IDs
are maintained in the IMG activity.
Save your settings.
b. OpenText Products Sold by SAP That Have Been Licensed: Select if you
licensed OpenText Employee File Management (EFM) or OpenText Travel
Receipts Management for SAP Solutions (TRM). When you selected an
option, DocuLink projects that are recognized as EFM or TRM projects are
ignored when validating access permissions to DocuLink. In any case, TRM
or EFM DocuLink projects are listed in the license report.

Note: These licensed OpenText products must be maintained on each


remote SAP system that you include in your measurement.

Save your settings.


4. Define systems that you want to measure
On the Server and Inbox Measurement tab, you maintain all SAP systems and
Content Servers that are part of your system landscape and that you want to
measure. For each measurement, you can decide which systems you want to
include in that run. You can activate systems that are currently used and
deactivate systems that you currently do not need.

Note: If there are no active or inactive SAP systems maintained, at least


the SAP system from which you are running the license measurement will
be entered after a refresh.

Server is a SAP system

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 433
ER160208-CCS-EN-01
Chapter 28 OpenText License Report

Server is a Content Server connected to the SAP system

View active / inactive systems


Toggle between active and inactive SAP clients and Content Severs

Activate / deactivate
Activate or deactivate an SAP client or a Content Server. Inactive systems
are only visible in the list of inactive systems. They are not deleted,
though. Measurement data that has been uploaded to the inbox for that
system, is invisible when the system is inactive. It is available again once
you activate the system.

New system
Create a system connection manually. Alternatively, create a destination
through an RFC destination.
For this, you need the following information. Most of the SAP related
information are available in transaction SLICENSE. Content Server related
information are taken from the Maintain Extended ECM Connections
IMG activity.

• SAP system number, installation number, hardware key, and client


• Server type C for Content Server or S for SAP system
• If the system type is C, provide the Connection ID as configured in the
IMG of that system as well a connection information and the RFC
destination.

New system with RFC connection


Add a SAP server or Content Server through an RFC destination.
You can use transaction SM59 to define a new RFC connection with
connection type 3.
If you entered an empty RFC destination, it will be replaced by RFC
destination NONE, which connects to the current SAP client.

Edit entry
Edit an entry.

434 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
28.5. Running license measurement

Set maximum age


Set the tolerable age in days of the uploaded measurement data. Data that
is older than this age, is not included in the measurement. This also
applies to manually uploaded data.

Change RFC destination


Change the RFC connection for one or more active systems

Delete selected entries


Delete a system entry. You can only delete inactive systems. Deleting an
inactive system also deletes corresponding data from the inbox.

5. Provide measurement data.


You can define how the measurement data is provided by the active systems:

• Automatic file transfer: An export file must be prepared on the remote


system. It must not be older than the maximum age you defined. The remote
system must be available and connected. The export file will then be
transferred to the inbox.
• Manual file transfer: The remote system must be in the list of active systems.
An export file must be prepared on the remote system. It must be exported
and it must be available on a disk or file system.

Enable or disable RFC connection


Enable or disable automatic import of measurement data during the
license measurement. You can disable an RFC connection for a
measurement and use manually imported license data from an exported
XML file instead. Nevertheless, the system must remain active in License
Measurement Cockpit. Only active systems are included in a license
measurement, regardless of the status of the RFC connection.

Upload from file system


Select an active system and upload a file with measurement data to the
inbox of the License Measurement Cockpit. The remote system needs not
be connected through RFC connection. You must have exported the
measurement data first on the remote system. For more information, see
“Creating an export file with license data” on page 437.

If the uploaded measurement data origins from a Content Server,


you must upload two files in a specific order. The file type is part of
the file name, if you did not change the name during export.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 435
ER160208-CCS-EN-01
Chapter 28 OpenText License Report

1. File of file type CL


2. File of file type CU

Upload via RFC


Select an active system and import measurement data to the inbox of the
License Measurement Cockpit. The remote system must be connected
through RFC. This action is implicitly carried out when you start a license
measurement run. You can use this manual step for a better monitoring.

Export to file system


Create an export file with license measurement data. For more
information, see “Creating an export file with license data” on page 437.

6. Start License Measurement

a. Click Start License Measurement.


b. Confirm that you want to start a background job for this. While the
background job is running, License Measurement Cockpit is locked for
other activities.
You can use transaction SM37 to monitor the background job. The status of
the background job is also displayed in the title bar of the inbox.
c. Click Refresh to refresh the status.

7. View measurement results.


After the measurement run is finished, you can view the result.

a. Click Display Latest License Report to open the latest report in PDF
format.

Note: This is not necessarily a report of the most recent measurement


if this ended with errors. It is the report of the last measurement that
ended without errors.
b. Open the Status and Results tab to view a consolidated measurement
grouped by license type. For more information, see “License types”
on page 423. You can print the table, save, export or send it .
c. Open the Consolidated Users tab to view a consolidated list of users from
all systems. For more information, see “Understanding the consolidated
measurement results” on page 438.

436 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
28.6. Creating an export file with license data

28.6 Creating an export file with license data


If you want to measure a system that will not be available through an RFC
connection during the actual measurement, you can export the measurement data
from that system to a file and then import this file to the measuring system.

When you create the export file, the remote system must be available through an
RFC connection. The export file will first be uploaded to the inbox and then can be
saved to the local file system.

File types – Measurement data for an SAP system consists of one XML file of file
type SA. Measurement data of a Content Server consists of two files: Content Server
license info of file type CL and Content Server users list of file type CU.

Tip: If the measured system has no connection to the system where you are
going to do the actual measurement, and you cannot create the export file from
remote, you can do the following: In the License Measurement Cockpit of the
measured system, create an entry for an active SAP Client, and then create the
export file and save it to the file system or portable disk. Then import it to the
inbox of the measuring system.

To export a license measurement file:

1. Start License Measurement Cockpit with transaction /OTX/LICENSE.


License Measurement Cockpit starts in standard mode.

2. Click Change to Expert Mode.

3. Select the system, for which you want to create the export file.

4. Click Start License Measurement. License measurement must end without


errors before you can export the file.

5. On the Servers and Inbox for Measurement tab, click Export to File
System.
6. Click Yes to confirm the export.
The export file is created and uploaded to the inbox of the License Measurement
Cockpit. A message box informs you about it.

7. After the import, select a directory to save the export file to.
If you exported measurement data from a Content Server, two files are saved:
First a file of file type CL with the Content Server license, and immediately after
that a file of file type CU with user information.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 437
ER160208-CCS-EN-01
Chapter 28 OpenText License Report

28.7 Understanding the consolidated measurement


results
You can view the results of the license measurement on different levels:

Overview list
On the Status and Result tab, you see the results of the consolidated measurement.
Total number or users, grouped by license type.

Compressed list
On the Consolidated Users tab, you see the Compressed User List of
Consolidation. Users from the measured systems are grouped to unique ID's and
properties. Duplicate users were identified by matching login names. Partition
suffixes of Content Server logins are ignored so that they match the SAP user IDs.

Example: User login on the SAP system is PETER, and user login on Content Server is
peter@partition. Both logins are consolidated into one count.

438 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
28.8. Understanding and resolving licensing issues

The yellow status icon indicates inconsistencies or mismatches in license type


assignment. For more information, see “Understanding and resolving licensing
issues” on page 439.

Column Count of grouped user IDs contains the number of different logins from
the measured systems that were mapped to one entry in the compressed user list.

Complete list
Click Change view and select Grouped users to view the Complete User List of all
Measured Systems.

Important
If the source system is an SAP Client users with classification types T for
technical users and X for specifically excluded users were not transferred. Also
not transferred are users with invalid Valid from or Valid To dates in the user
management.

Aside from detailed information about the measured system and the user, this list
also contains license type information and the number of days in which the user has
used functions of Archiving, Document Access or Extended ECM. This information
is relevant for users with a license type for occasional users. If this number exceeds
52, an issue is displayed.

28.8 Understanding and resolving licensing issues


The license evaluation focusses on issues where a license type assignment is
technically inconsistent or insufficient.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 439
ER160208-CCS-EN-01
Chapter 28 OpenText License Report

28.8.1 Validation issues after consolidation


Validation issues types CA_ARCH, CA_DACC, CA_XECM
This is the same as types CA (Table 28-3) and XEXM_NO_LICENSE (Section 28.8.3).

User has permissions to access features of Archiving, Document Access or Extended


ECM but has not sufficient license types.

In single source systems, a license type of Extended ECM is sufficient for usage of
Archiving, Document Access or Extended ECM; a license type for Document Access
is also sufficient for usage of Archiving.

Validation issues type CO_TRUE


See types CO (Table 28-4) and XECM_MAX_ACCESS_EXCEEDED (Section 28.8.3).

At least in one of the measured systems, the user has accessed Archiving, Document
Access or Extended ECM functions on more than 52 days in the past year but none
of his license types is sufficient.

Validation issue type CL


License types sold by OpenText (type O) are mixed with license types of SAP
reselling (type S).

The license type is assigned to SAP logins by roles. Due to the role assignment, it can
occur that a role related to more than one license type is assigned to a user login.
Validation issue type CL occurs if licenses sold by OpenText and SAP are maintained
at the same time for the same user login and client.

In this case, the license type of the highest priority is preferred:

• Extended ECM > Document Access > Archiving

• Full > Occasional > Web

• Professional > ESS, Employee

• License sold by SAP > sold by OpenText

Table 28-2: Users with an OpenText license and an SAP license

ID Description
CL Users with an OpenText license and an SAP
license

440 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
28.8. Understanding and resolving licensing issues

Important
As the consolidation merges data of duplicate users, it may be that in some
cases issues that were seen in the single source systems disappear. In other
cases, it may be that new issues are raised.

Example: Content Server user hmueller@ECM has no license type assigned and issue
XECM_NO_LICENSE was indicated.

SAP user hmueller has license type SXECMF Extended ECM Full User sold by SAP and issue
CL was found.

After consolidation, both user entries were identified to belong to the same person. The
resulting license type of this unique user is SXECMF. Therefore the issue XECM_NO_LICENSE
is no longer valid, which means that issue CA_XECM will not be raised for that unique ID. But
issue CL persists and is indicated as the inconsistency between seller models could still be a
source of error.

28.8.2 Validation issues types on the SAP system


OpenText license measurement checks if the maintained data is consistent. The
system gathers this information for each user in each client and collects counts. If
inconsistent data occur, a validation issue is counted. The validation issue counts are
listed in the OpenText license report. The report lists different types of validation
issues. Details on user level are shown in the list of evaluated users.
Only validation issues of valid dialog users are counted.

Validation issue type CA


User has access permissions to Archiving, Document Access or Extended ECM but
either no or a an insufficient license type was assigned to this user.

For each user, the license type of the highest priority is obtained from the values of
authorization object J_6NLC_TYP authorization object assigned to this user:

• Extended ECM > Document Access > Archiving


• Full > Occasional > Web

In addition, the program checks for access permissions of the user based on other
authorization objects:

• Archiving – S_WFAR_OBJ, S_WFAR_PRI


• Document Access – J_6NG_DATA (EFM, TRM projects excluded if licensing flags
for EFM and TRM are set), J_6NRL_SEA
• Extended ECM – J_6NRL_DOL, J_6NRL_WSC

The following results cause a validation issue:

• if the user is allowed to access a product but the maintained license type is not
sufficient.
• if no license type was maintained for a user.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 441
ER160208-CCS-EN-01
Chapter 28 OpenText License Report

• if only the wildcard value * is assigned as a license type to a user.

Table 28-3: CA: Maintained OpenText license is not sufficient compared to


license required by access permissions

ID Maintained license type Required product license


ARCH No OpenText license type OpenText Archiving or
maintained SAP Archiving by OpenText
DACC No OpenText license type OpenText Document Access
maintained or
SAP Document Access by
OpenText
XECM No OpenText license type OpenText Extended ECM or
maintained SAP Extended ECM by
OpenText
XECMALL Only wildcard values are OpenText Extended ECM or
maintained for OpenText SAP Extended ECM by
license type OpenText
XECMOARCF OpenText Archiving – Full OpenText Extended ECM or
Named User SAP Extended ECM by
OpenText
XECMOARCW OpenText Archiving – Web OpenText Extended ECM or
Named User SAP Extended ECM by
OpenText

Validation issue type CO


User has an “occasional” license type but has accessed Archiving, Document Access
or Extended ECM functions on the SAP system on more than 52 days in the past
year.

License types for occasional usage are maintained when a user is accessing OpenText
applications only occasionally. This concerns, for example, ESS usage, usage as
Employee, or Web usage.

For license measurement, the maintained license type set in authorization object
J_6NLC_TYP is counted. At the same time, the access log entries not older than the
current date -1 year are cross checked in table /OTX/CL_T_ACCESS.

If the count of entries for a user login in a client is greater than 52, and the license
type is classified as a type for occasional usage, this causes a validation issue of type
CO.

442 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
28.8. Understanding and resolving licensing issues

Table 28-4: CO: Users with occasional license used the product on more than
52 days per year

ID Description
OARCO OpenText Archiving – Occasional User
OARCW OpenText Archiving – Web Named User
SARCW SAP Archiving by OpenText – User:
Employee, ESS User

Validation issue type CL


License types sold by OpenText (type O) are mixed with license types of SAP
reselling (type S).

The license type is assigned to SAP logins by roles. Due to the role assignment, it can
occur that a role related to more than one license type is assigned to a user login.
Validation issue type CL occurs if licenses sold by OpenText and SAP are maintained
at the same time for the same user login and client.

In this case, the license type of the highest priority is preferred:

• Extended ECM > Document Access > Archiving

• Full > Occasional > Web

• Professional > ESS, Employee

• License sold by SAP > sold by OpenText

Table 28-5: Users with an OpenText license and an SAP license

ID Description
CL Users with an OpenText license and an SAP
license

Log table /OTX/CL_T_ACCESS

The log table /OTX/CL_T_ACCESS stores information on daily access to


OpenText ABAP applications per client and user. This data is used in the
license validation. The entries of the table are written by applications
DocuLink, Business Content, Imaging Integration, FullText search, Forms
Management and DesktopLink. Occasional users are entitled to use OpenText
applications up to 52 days/year.

Data older than one year is not required and can be regularly deleted.

To delete log entries older than one year, run transaction se38 to start the
program /OTX/CL_MAINTAIN_ACCESS_LOG. It checks for ACTVT = 03 of
authorization object S_USER_GRP.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 443
ER160208-CCS-EN-01
Chapter 28 OpenText License Report

The data of this log table has no further relevance beyond license validation.

28.8.3 Validation issue types on Content Server


If on Content Server license types are assigned by group assignment, users can have
more than one license type assignment. If multiple license types are assigned to on
user, the most comprehensive license type is used.

XECM_NO_LICENSE
User has access permissions to use Extended ECM features on Content Server but
has no sufficient license type.

Similar issue on SAP side is CA (Table 28-3) with ACCESS_TYPE = XECM.

XECM_MAX_ACCESS_EXCEEDED
User has an “occasional” license type but has accessed Extended ECM functions on
Content Server on more than 52 days in the past year.

Similar issue on SAP side is CO (Table 28-4).

XECM_MULTIPLE_SELLERS
License types sold by OpenText (type O) are mixed with license types of SAP
reselling (type S).

Similar issue on SAP side is CL (Table 28-5).

444 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
Glossary
You can find a short description of the individual OpenText components in “Overview of the
components involved“ on page 25.

Action Definition

A description of the various processing types for an Activity, for example,


different types of communication media or processing method or Smart Form to
be used.

Action Profile

A definition of how Activities are to be processed for business objects. The action
profiles are linked to an activity type. The profile may contain several action
definitions.

Action

A scheduled activity in a business process whose start and execution is controlled


by the Post Processing Framework (PPF).

Administration server

The server that is responsible for administrating the OpenText Archive Center.
Starts the DocumentServices tools when requested by the Administration client.

Archive Content repositories

Storage system to store data and documents permanently

Archive Modes

The archive mode defines the various scenarios for the Scan-Client (for example,
Late archiving with bar codes, Assign then store, Storing for subsequent
entry) and is defined via the OpenText Administration Client.

ArchiveForm

A form required for storing Exchange objects (for example, emails) interactively
on the OpenText Email Archiving for Microsoft Exchange.

ArchiveLink monitor

A general tool to monitor the current operation of ArchiveLink. This allows you
to monitor all components (spool, queues, batch processing etc.) involved in
storage from one central point of view. All steps, especially errors, are logged.
Failed storage jobs can be restarted.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 445
ER160208-CCS-EN-01
Glossary

ArchiveLink

An interface between the SAP system and the archive system. Using ArchiveLink,
mostly static and finished documents are stored (as opposed to the KPro
infrastructure).

Attributes

Attributes are additional information for a document which can originate from
various applications, for example, Word or DocuLink. These attributes or file
properties can be set automatically (for example, file name, author) or defined by
the user. Attributes can be used for identifying, classifying and indexing the file.

Business object

The highest object in the SAP object hierarchy to describe business processes, for
example, business partners (BP).

COLD

Computer Output to Laser Disk - automatically created document lists that are
stored on an optical storage medium.

Communication protocol

The communication protocol defines how the particular document classes are
processed in the SAP application. A protocol is assigned to an archive (content
repository, archive). This ensures that all documents of a document class held in
the same archive (content repository) are handled in the same way.

The protocol also defined which application the end-user may use to scan, as well
as which application will be started via OLE. This setting applies for all archives
that use the protocol.

Content Management documents

Dynamic documents that are still being processed, with additional information
such as versioning and processing status.

Converter

A special print driver that converts the file to PDF- or TIFF format first, and then
stores it (IXOS PDF Converter SAP or IXOS TIFF Converter SAP)

Default settings

A group of document types. Presettings are maintained during customizing. For


each document type, the transaction user responsible for the work item is defined
and the archiving scenario to be used is specified.

DesktopScan

A Windows Viewer functionality to scan individual documents.

446 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
Glossary

DocTools

Programs that perform individual, elementary actions with documents in the


Document Pipeline.

Document class

The technical document format. The document class determines the program
used to recall and display the document. Windows Viewer and SAP applications
recognize and handle archived documents according to their document class.

Document Service

The core of the archive system. It consists of the read component (RC), which
supplies archived documents, and the write component (WC) which archives
documents.

Document type Document type

Classification for documents using characteristic features and the corresponding


organizational processes.

Drag&Relate

A function that allows you to run transactions across system borders by linking
data from one application with data from other applications.

Exchange directory

The directory is used in print list and Forms Management scenarios to


temporarily store data.

Expert Service Center

The IXOS Expert Service Center (ESC) contains up-to-date information that is
continually updated by IXOS employees, for example, technical information,
FAQs, the most recent release information and much more.

Forms

In the SAP system, outgoing documents are normally printed in standard forms,
in order to preserve legible, attractive pages into which graphical elements such
as company logos can be integrated. This means that the standard forms are filled
with data generated by the SAP reports.

General task

General tasks and workflows can be performed or started by any user.

Generic object services (GOS)

Functions that are not application-specific and can generally be used for any
business object, for example, creating or displaying documents.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 447
ER160208-CCS-EN-01
Glossary

GOS
See Generic object services (GOS).

HTTP

The HyperText Transfer Protocol (HTTP) replaced the RFC method and controls
communication between the archive system and the SAP system in newer
versions.

Incoming documents

Documents that are imported to the SAP system from other applications, for
example, emails, faxes, Microsoft Office documents.

Indexing

Definition of storage conditions, for example, the archive to which the document
is to be stored, by selecting the scenario, default settings and document type for
the document to be stored.

Initial customizing

Initial customizing consists of basic settings for SAP ArchiveLink®, which must
be implemented once for each SAP system.

KPro (Knowledge Provider)

KPro is an infrastructure that provides, among other things, document storage


services (for example, Content Management Service). Thus, Content Management
documents in particular can be stored without losing additional information such
as versioning or processing status.

Link tables

Contain the links between the archived documents and the business objects.

Logical archive

The storage area on the Archive Center in which documents can be stored. May
consist of one or more pools.

Migration

Transferring documents from one storage system to another, for example, from
an R/3 data base to an OpenText Archive Center.

Multi-document type

A multi-document type combines a number of document types.

Object type object type

The object type describes an SAP application business object specific to each SAP
module. It describes the structure of the records, including the key fields of the

448 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
Glossary

different tables. The BKPF object type, for example, defines the document
number, company code and fiscal year key fields. In addition, the object type
specifies how the object is processed. Processing is defined by methods, which are
determined for each object type. These methods contain operations that can be
applied to each object. Object types are set up in the SAP application standard
and do not need to be defined in terms of ArchiveLink customizing.

ODMA (Open Document Management API)

An interface used to import documents from Windows applications into an SAP


system.

OpenText Administration Client (= Administration Client)

An administration tool for setting up servers, archives, devices, hard disk buffers,
jobs, archive modes and users.

OpenText Archive Center (= Archive Center)

The server where the DocumentService and the archive data base is installed.

OpenText Document Pipeline Info (= Document Pipeline Info)

A graphical user interface to monitor the OpenText Document Pipeline.

OpenText Document Pipeline

A mechanism that manages document processing with a very high security level
until the documents are handed over to the Document Service.

OSS notes

OSS notes are provided by SAP and 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 homepage for necessary OSS
notes.

Outgoing documents

All documents that were created in the SAP system itself, for example, invoices,
order confirmations etc.

Output determination

After a test to see if the application data fulfills specific conditions, one or more
messages are retrieved which can then be processed (for example, sent
electronically). This method is used, for example, for outgoing documents. (In
CRM systems this was replaced by PPF.)

Post Processing Framework (PPF)

The Post Processing Framework is an interface for triggering conditional


activities, for example, printing delivery notes, faxing order confirmations, or

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 449
ER160208-CCS-EN-01
Glossary

triggering approval procedures. For CRM systems, PPF replaces the output
determination used in previous SAP versions.

PPF
See Post Processing Framework (PPF).

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, for example, batch where-
used lists or cost center reports, or reports from the activity monitor

Processing class

The processing class is responsible for sending the activities to the Smart Forms as
well as processing the activities and is required in order to create outgoing
documents and forms.

Processing method

The method used for data base selection when outgoing documents and forms are
created.

Protocol
See Communication protocol.

Renditions (OpenText Rendition Server)

Documents that are converted to a new format (TIFF, PDF) by the OpenText
Rendition Server to ensure that they are not modified and can be stored long-
term, independently from new software versions.

RFC service

A program used for communication between the SAP application and the archive
system via RFC (Remote Function Calls).

SAP Referenz-IMG

A tool for customizing in the SAP system.

Scheduling condition

According to the scheduling conditions, the system determines which activities it


should plan for the document (within the PPF).

SecKeys

The SecKey ensures that the URL cannot be modified after it was created by the
SAP system. Thus, access to the document is secure and access control is
managed by the SAP system. The document contents are not protected by the
SecKey.

450 OpenText Archiving and Document Access for SAP Solutions – Scenario Guide
ER160208-CCS-EN-01
Glossary

Smart Form

A Smart Form defines the layout of an (outgoing) document.

SSL (Secure Socket Layer)

A standard for secure communication between the client and server via HTTP.

Standard task

An individual job step to be used in workflow definitions. In standard tasks you


can run business object methods.

Start condition

The start condition is tested (within the PPF) before the activity is performed. The
activity is only performed if the start condition is fulfilled.

Transaction type

A transaction type controls the processing of a particular business occurrence and


is assigned to one business object only.

TWIPS

A measurement unit for the offset of a document to a form. 1 TWIPS is about


0.0176mm, 1440 TWIPS = 1 inch.

Work item

An individual workflow step.

Workflow

A sequence of steps (work items) which are processed either by persons or


automatically by the system.

OpenText Archiving and Document Access for SAP Solutions – Scenario Guide 451
ER160208-CCS-EN-01

You might also like