Document Upload and Download Handling in SAP Work Manager_6_0

Document upload and download handling in SAPWork Manager 6.0

Provided by SAP Mobile Customer Experience Group

Applicable Releases:

SAP Work Manager 6.0

Version 1.1

www.sap.com

TABLE OF CONTENTS

WORK MANAGER 6.0 DOCUMENT HANDLING OVERVIEW ....................................................................... 3Summary .......................................................................................................................................................... 3Business Needs ............................................................................................................................................... 3Assumptions .................................................................................................................................................... 3Work Manager Default settings ...................................................................................................................... 3

SECTION 1: CONFIGURATION PANEL SETTINGS ....................................................................................... 4

SECTION 2: MDO OBJECT LEVEL SETTINGS RELEVANT FOR DOCUMENT HANDLING ...................... 5

SECTION 3: WORK ORDER OBJECT DOCUMENT HANDLING ................................................................ 10

SECTION 4: NOTIFICATION HEADER LEVEL ............................................................................................. 11

SECTION 5: EXTERNAL DMS SUSPPORT ................................................................................................. 11

SECTION 6: KPRO SUPPORT ...................................................................................................................... 11

SECTION 7: CLASS HANDELRS AND BAPI WRAPPER USED ................................................................ 13

SECTION 8: ENHANCEMENT SPOTS FOR DOCUMENT HANDLING ...................................................... 14

SECTION 9: REFERENCES ........................................................................................................................... 14

Document Handling Support in Work Manager 6.0

3

WORK MANAGER 6.0 DOCUMENT HANDLING OVERVIEW

This document provides the overview of document / picture upload and downloading in WorkManager 6.0 product for SAP ERP.

Summary

Work Manager supports viewing of master data or transaction data attachments on the mobile device. Thisincludes documents such as Microsoft Office documents, PDF files, and other commonly used businessdocuments, including videos, pictures, and audio files. When you select Attachments, the details screendisplays the attachments that are available for download. By default, the option to download attachments isturned on, but this can be configured through the Configuration Panel based on work order type. If the workorder has any attachments, only limited information regarding the attachments is fetched during an initialsync. The attached content is downloaded to the device via push process only at user request. Allattachments are maintained in a central repository and controlled through the Configuration Panel.

There are various ways how SAP System can be configured to handle documents managementfunctions like BDS, GOS, DMS and external DMS. Work Manager application supports only BDS, GOS andDMS. Please note product comes with default settings to support upload/download of documents which canbe configured based on your requirements by changing settings in configuration panel.

Downloading and uploading attachments are supported for:-x Work Orders (header level)x Work Orders (header level asset)x Work Order Operations via Associated Assetx Work Order Operations via PRTx Notifications (header level)x Notifications (header level asset)x Item via Associated Asset

Business Needs

At times technicians in the field may have need to look at some design drawings, Manufacturerinstructions or photographs assigned to Work Order and Notification directly or indirectly to technical objectsof Work Order or Notification. Work Manager 6.0 products provides options to download attachments/pictures associated with Work order or Notification and option to upload picture or document while workingon Work Order or Notifications.

Assumptions

x Necessary Settings in Customizing for Cross-Application Components under DocumentManagement System is done if planned to use DMS.

x SAP Add-on for Work Manager is installedx SAP PM module is implementedx Down of documents or pictures is supported through push which means Mobile device is always

in connected mode.

x Necessary BDS and GOS configuration is done in SAP.x Document upload /download options work in SAP GUI.x Screen shots shown in this document is from Work Manager 6.0 on EHP5

Work Manager Default settingsBy default Work Manager application supports BDS, GOS at Work Order header level and DMSfor Notification, Technical objects and PRT at Work Order level.


4

SECTION 1: CONFIGURATION PANEL SETTINGS

a) Global Parameter settings relevant for document handling

Mobile Appplication Parameter CommentsSAP_WORK_MANAGER_60 DMS.DocumentPart - referenced by DMS

MDO Object.Default Value 000 Only onecombination ofvalue is supported.

SAP_WORK_MANAGER_60 DMS.DocumentType - referenced by DMSMDO Object.

Default Value DRW-Multiple documenttypes are notsupported.

SAP_WORK_MANAGER_60 DMS.DocumentVersion Default Value 00SAP_WORK_MANAGER_60 Equipment. Attachment Enable Attachments

at Equipment Level Default value Y

SAP_WORK_MANAGER_60 FunctionalLocation.Attachment Enable Attachmentsat FL Level Default value Y

SAP_WORK_MANAGER_60 Notif.Attachment Enable Attachmentsat Notification Level Default value Y

SAP_WORK_MANAGER_60 PRT.Attachment Enable Attachmentsat PRT Object level- Default value Y

SAP_WORK_MANAGER_60 WONotifDefaultAttachment Default BDSSAP_WORK_MANAGER_60 Wo.Attachment Enable Attachments

at Work Order level Default value Y

SAP_WORK_MANAGER_60 SWM60_BDS_DOCUMENT_PUSH Push RelevantParameter

SAP_WORK_MANAGER_60 SWM60_DMS_DOCUMENT_PUSH Push RelevantParameter

SAP_WORK_MANAGER_60 SWM60_EMERGENCY_WORKORDER_PUSH Define the stringused for high prioritywork orders pushedto the client

SAP_WORK_MANAGER_60 BUS2007 SIGNATUREdefines inputparameters requiredfor signaturecapture BAPI

SAP_WORK_MANAGER_60 Signature.bmp SIGNATUREdefines inputparameters requiredfor signaturecapture BAPI

The above Client global parameters are Mobile application level settings which takes precedence over anyother settings in the application. Using above settings document handling can be enabled or disable atvarious object level. For example if you want disable document Upload or Download at Equipment level,simply set Parameter value Equipment. Attachmentto N. Once global parameter is disabled, any otherssettings related to the equipment document handling will be ignored in the application.


5

b) Complex Table : SWM60_DMS_BDS_SWITCHES

Complex table to support different document management functions at Work Order type andNotification type level. These settings will supersede any other settings related to document handlingat Work Order types or Notification types. This is the place where you can specify BDS or DMSdocument management function at Work Order Type level or Notification Type.

Above screen shots shows default settings which can be configured to suit your businessrequirement. This complex table is used on client side to know which document management functions areconfigured for various work order type and notification types.

SECTION 2: MDO OBJECT LEVEL SETTINGS RELEVANT FOR DOCUMENT HANDLING

a) SWM60_BDSDOCUMENT_GENERIC MDO Object

BDSDOCUMENT_GENERIC MDO object is common for both BDS and GOS document service.

These settings are read during run time by core framework for BDS and GOS document uploadingto SAP.

Filter Type Settings CommentsBDS_ACTIVE TRUE/FALSE Active BDS Document

ServiceGOS_ACTIVE TRUE/FALSE Active GOS Document

ServiceMAX_FILE_SIZE Default -

9999999999999999999999RELATIONSHIP_TYPE Drop down options - Reference

table OBL_S_RELTDefault only attachments andnotes are enabled


6

b) SWM60_DMS_DOCUMENT_GENERIC MDO Object

BDSDOCUMENT_GENERIC MDO object is used DMS document service.

These settings are read during run time by core framework for DMS document service foruploading document to SAP.

Filter Type Settings CommentsMAX_FILE_SIZE Default -

9999999999999999999999

These settings are applicable where DMS document management function is enable for uploading.


7

c) SWM60_WORKORDER_GENERIC MDO Object

Work Order MDO object level settings are applicable for Work Order header attachments which areread during Work Order fetch by the framework. At Work Order object level you have option toenable or disable BDS, GOS or DMS document management functions depending on yourrequirements.


8

Data Segment Filters

Filter Type Settings CommentsDOC_BDS_ACTIVE TRUE/FALSE Default TRUE Active BDS Document

ServiceDOC_DMS_ACTIVE TRUE/FALSE - Default TRUE Active DMS Document

Service

Standard Filters

Filter Type Settings CommentsDOC_GOS_ACTIVE TRUE/FALSE Default TRUE Active GOS Document

ServiceDOC_GOS_RELTYPE Drop down - Reference table

MDOBLROLDOC_LINK_OBJ Default -

9999999999999999999999DOC_TYPE Drop down options - Reference

table OBL_S_RELT

d) SWM60_NOTIFICATION_GENERIC MDO Object

Notification MDO object level settings are applicable for Notification header, Notification item leveltechnical objects, these settings are accessed by framework during notification fetch at the runtime.


9

Data Segment filter settings

Filter Type Settings CommentsDOC_BDS_ACTIVE TRUE/FALSE Default TRUE Active BDS Document

ServiceDOC_DMS_ACTIVE TRUE/FALSE - Default TRUE Active DMS Document

ServiceDOC_GOS_ACTIVE TRUE/FALSE - Default TRUE Active GOS Document

ServiceDOC_GOS_RELTYPE Drop down - Reference table

MDOBLROLDOC_LINK_OBJ Default -


table OBL_S_RELT

e) SWM60_FUNC_LOCATION_GENERIC and SWM60_LAM_FUNC_LOCATION_GENERIC

By default DMS document service is active for functional location.

Note: - SWM60_LAM_FUNC_LOCATION_GENERIC MDO object is used only if you have activatedBC set relevant for EHP5 and above.

Standard Filters

Filter Type Settings CommentsDOC_DMS_ACTIVE TRUE/FALSE Active DMS Document

ServiceDOC_LINK_OBJ Default -


table OBL_S_RELT


10

f) SWM60_EQUIPMENT_GENERIC and SWM60_LAM_EQUIPMENT_GENERIC

By default DMS document service is active for Equipment.

Note: - SWM60_LAM_EQUIPMENT_GENERIC MDO object is used only if you have activated BCset relevant for EHP5 and above.

Standard Filters

Filter Type Settings CommentsDOC_DMS_ACTIVE TRUE/FALSE Active DMS Document

ServiceDOC_LINK_OBJ Default -


table OBL_S_RELT

SECTION 3: WORK ORDER OBJECT DOCUMENT HANDLING

Below settings are default settings in Work Manager base product which are configurable.

a) Work order header level- By default BDS/GOS is active at Work Order header level for both downloadand upload

b) Work order header level technical object -By default DMS active at Work Order technical object for bothdownload and upload

c) Work Order operation level - TECHNICAL object

d) Work Order PRT level


11

SECTION 4: NOTIFICATION HEADER LEVEL

a) Notification header level DMS document typeb) Notification header technical object - DMS document typec) Notification item level Technical object - - DMS document type

SECTION 5: EXTERNAL DMS SUSPPORT

Support for external DMS is not provided in standard Work Manager 6.0 product. You may to look at/SMERP/CL_CORE_KWDOCUMENT_DO BADI to extend support to handle external DMS support.

Refer section: 8 for further details.

SECTION 6: KPRO SUPPORT

KPRO support is not provided in standard Work Manager 6.0 product, by doing some enhancements tobase code as specified below support for KPRO can be extended.

In Method DMS_GET_DOCUMENT_CONTENT of Class /SMERP/CL_CORE_KWDOCUMENT_DO thereis an BADI Enhancement Spot /SMERP/MDO_CORE_DOCUMENTS methodKPRO_DMS_CONTENT_FETCH that is used to retrieve the file content from the KPro Server. Thefunctionality for the BADI requires coding by the customer. Guide lines are presented below.

Implement Method KPRO_DMS_CONTENT_FETCH.

The following is an outline of the required code. It is not provided as a complete solution by SAP.*** This code is intend as an EXAMPLE only and has not been fully tested ***METHOD /smerp/if_core_document_badi~kpro_dms_content_fetch.*** This code is intend as an EXAMPLE only and has not been fully tested ***

DATA: lt_x_data TYPE dms_tbl_file, lv_x_data TYPE LINE OF dms_tbl_file.

DATA: lv_dms_ph_cd1 TYPE dms_ph_cd1.

DATA: lt_file_access_info TYPE TABLE OF sdokfilaci, lv_file_access_info TYPE sdokfilaci, lt_file_content_ascii TYPE TABLE OF sdokcntasc, lv_file_content_ascii TYPE sdokcntasc, lt_file_content_binary TYPE TABLE OF sdokcntbin, lv_file_content_binary TYPE sdokcntbin.

DATA: lv_phios_object_id TYPE sdokobject.

DATA: ls_dms_content TYPE /smerp/core_dms_content_str.

FIELD-SYMBOLS: TYPE dms_rec_file, TYPE dms_rec_phio.

CALL FUNCTION 'CV120_KPRO_MASTER_DATA_GET'EXPORTING

pf_dokar = iv_dms_doc_type pf_doknr = iv_dms_doc_id pf_dokvr = iv_dms_version pf_doktl = iv_dms_part* PF_ACTIVE_ONLY = ' '* PF_ACTIVE_ATTR_ONLY = ' '* PF_COMP_GET = 'X'


12

TABLES ptx_data = lt_x_data

EXCEPTIONS not_found = 1 error = 2

OTHERS = 3.

IF sy-subrc 0.EXIT.

ENDIF.

READ TABLE lt_x_data ASSIGNING INDEX 1.IF sy-subrc = 0.

READ TABLE -tbl_phios ASSIGNING INDEX 1.IF sy-subrc = 0.

* Get the document classSELECT SINGLE * INTO lv_dms_ph_cd1FROM dms_ph_cd1WHERE phio_id = -ph_objid.

* Check record is foundIF sy-subrc = 0.

lv_phios_object_id-class = lv_dms_ph_cd1-ph_class. lv_phios_object_id-objid = lv_dms_ph_cd1-phio_id.

DATA: lt_drao TYPE TABLE OF drao, ls_drao TYPE drao.

CALL FUNCTION 'CV120_KPRO_CHECKOUT_TO_TABLE'EXPORTING

ps_phio_id = lv_phios_object_id* PF_COMP_GET = ' '

tables* PT_COMPONENTS = ptx_content = lt_drao* EXCEPTIONS* ERROR = 1* NO_CONTENT = 2* OTHERS = 3

.IF sy-subrc 0.

* MESSAGE ID SY-MSGID TYPE SY-MSGTY NUMBER SY-MSGNO* WITH SY-MSGV1 SY-MSGV2 SY-MSGV3 SY-MSGV4.

ELSE.LOOP AT lt_drao INTO ls_drao.

ls_dms_content-documenttype = iv_dms_doc_type. ls_dms_content-documentnumber = ls_dms_doc_id. ls_dms_content-documentversion = ls_dms_version. ls_dms_content-documentpart = ls_dms_part. ls_dms_content-originaltype = '1'. ls_dms_content-line = ls_drao-orblk.

APPEND ls_dms_content TO et_dms_content.ENDLOOP.

ENDIF.


13

ENDIF.ENDIF.

ENDIF.ENDMETHOD.

SECTION 7: CLASS HANDELRS AND BAPI WRAPPER USED

CLASS HANDLERS

1) /SMERP/CL_CORE_KWDOCUMENT_DO

BDS related methods:-x GETx BDS_DOCUMENT_CREATE

DMS related methods:-

x GET_DMSx DMS_DOCUMENT_CREATE

2) /SMERP/CL_CORE_DMS_PUSHDOC_DOMethod: GET

3) /SMERP/CL_CORE_BDS_PUSHDOC_DOMethod: GET

BAPI WRAPPERS

x /SMERP/CORE_DOBDSDOCUMENT_GETx /SMERP/CORE_DOBDSDOCUMENT_CRTx /SMERP/CORE_DOPUSH_BDSDOC_GETx /SMERP/CORE_DOBDSDOCUMENT_GETx /SMERP/CORE_DOBDSDOCUMENT_CRTx /SMERP/CORE_DOPUSH_BDSDOC_GETx /SMERP/CORE_CTKWDOC_FLAG_GET


14

SECTION 8: ENHANCEMENT SPOTS FOR DOCUMENT HANDLING

Enhancement spot /SMERP/MDO_CORE_DOCUMENTS is available for Customers for doingenhancements to Work Manager base product code. Here is the list of methods available for customers toimplement their own custom BADI and business logic to meet their requirements.

SECTION 9: REFERENCES

SAP Knowledge Base Articles on Service Market Place:-

1996731 - GOS Attach Document feature is not downloading attach documents for SAP Work Manager6.0.X1996686 - GOS attach document Work Manager 6.0 /SYCLO/CL_CORE_SUBQUEUE_MGR -/SYCLO/CX_CORE_SUBREQ_QUEUE USER_GUID issue1964214 - Attach Document: Setting up the iOS Related Path in Agentry

Important OSS Notes related to SAP Work Manager:-

1928478 - Release Restrictions Note - SAP Work Manager 6.0.01928523 - Software Release Note - SAP Work Manager 6.0

NOTE: - PLEASE WORK MANAGER RELEASE RESTRICTION NOTES FOR SOME OF THELIMITATION RELATED TO DOCUMENT HANDLING. ALSO CHECK CERTIFIED DEVICES LIST ONSERVCIE MARKET PLACE TO VERIFY THAT DEVICE YOURE PLANNING TO USE IS CERTIFIEDBY SAP.

2014 SAP AG. All rights reserved.

SAP, R/3, SAP NetWeaver, Duet, PartnerEdge, ByDesign, SAP

BusinessObjects Explorer, StreamWork, SAP HANA, and other SAP

products and services mentioned herein as well as their respective

logos are trademarks or registered trademarks of SAP AG in Germany

and other countries.

Business Objects and the Business Objects logo, BusinessObjects,

Crystal Reports, Crystal Decisions, Web Intelligence, Xcelsius, and

other Business Objects products and services mentioned herein as

well as their respective logos are trademarks or registered trademarks

of Business Objects Software Ltd. Business Objects is an SAP

company.

Sybase and Adaptive Server, iAnywhere, Sybase 365, SQL

Anywhere, and other Sybase products and services mentioned herein

as well as their respective logos are trademarks or registered

trademarks of Sybase Inc. Sybase is an SAP company.

Crossgate, m@gic EDDY, B2B 360, and B2B 360 Services are

registered trademarks of Crossgate AG in Germany and other

countries. Crossgate is an SAP company.

All other product and service names mentioned are the trademarks of

their respective companies. Data contained in this document serves

informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials

are provided by SAP AG and its affiliated companies ("SAP Group")

for informational purposes only, without representation or warranty of

any kind, and SAP Group shall not be liable for errors or omissions

with respect to the materials. The only warranties for SAP Group

products and services are those that are set forth in the express

warranty statements accompanying such products and services, if

any. Nothing herein should be construed as constituting an additional

warranty.

www.sap.com

WORK MANAGER 6.0 DOCUMENT HANDLING OVERVIEWSummaryBusiness NeedsAssumptionsWork Manager Default settings

SECTION 1: CONFIGURATION PANEL SETTINGSSECTION 2: MDO OBJECT LEVEL SETTINGS RELEVANT FOR DOCUMENT HANDLINGSECTION 3: WORK ORDER OBJECT DOCUMENT HANDLINGSECTION 4: NOTIFICATION HEADER LEVELSECTION 5: EXTERNAL DMS SUSPPORTSECTION 6: KPRO SUPPORTSECTION 7: CLASS HANDELRS AND BAPI WRAPPER USEDSECTION 8: ENHANCEMENT SPOTS FOR DOCUMENT HANDLINGSECTION 9: REFERENCES

Documents

Document Upload and Download Handling in SAP Work Manager_6_0