Skip to Content
Author's profile photo Former Member

SAP Mobile Documents Setup Guide

Introduction

This article will guide you through an easy and secure setup of SAP Mobile Documents on-premise. It is part of the complete step-by-step setup guide for SAP Mobile Documents.

It will show and explain all the necessary steps to get started and will also shed some light at the main features and the architecture.

It will guide you through the setup of a single server installation which is suitable for smaller installations. As NetWeaver is the platform for Mobile Documents, of course bigger installations like high-availability clusters as well as using multiple network zones is supported, but this is out of scope for this instruction.

This guide is based on the SAP Mobile Documents 1.0 SP2 release and the screenshots in this guide were taken on a SAP NetWeaver AS Java 7.3 including enhancement package 1 and the links concerning AS Java and SAP KM respectively point to the 7.31 release.

Architecture

Before we start with the installation and configuration, let’s have a quick look at the architecture.

The main components of the SAP Mobile Documents solution are the clients, the server, and the document repositories. By using the open standard CMIS (Content Management Interoperability Services) for all communications from the clients to the server as well as from the server to the connected document repositories, a high level of flexibility and interoperability is achieved. The on-premise version of SAP Mobile Documents uses SAP Knowledge Management as document repository for the special scenarios “My Documents” and “Shared Documents”. Part of the SAP Mobile Documents server component is also a CMIS connector for SAP KM. The CMIS connector is also available as a standalone component, in case you want to connect a KM system that is running on a different NetWeaver installation.

/wp-content/uploads/2014/03/architecture_overall_418107.png

Other document servers with CMIS-capable interfaces can be connected and their repositories can be integrated into SAP Mobile Documents as “Corporate Documents”.

My Documents Repository

The My Documents Repository is the repository where every Mobile Documents User can store his personal documents and sync it to all connected clients. Every user has a folder that is marked as his so-called home folder. All folders and documents inside this home folder are only visible and accessible by the user himself.

Shared Documents

This repository offers the possibility to share documents with other Mobile Documents users and external users. If “Shared Documents” is enabled on the server, every user can create shares, invite members to collaborate and manage their access rights. It is also possible to create public links to a share with security settings like expiration date, password, etc. A public link is accessible through a dedicated non-guessable URL that additionally can be password-protected. If enabled, anonymous users can also upload or delete documents in a public folder.

Installation

As a first step you have to download and install the newest version of SAP Mobile Documents. For your on-premise server installation you need an SAP NetWeaver AS Java as a platform.

You can find detailled installation description for this:

– How to install SAP NetWeaver Application Server Java

– How to install SAP Mobile Documents using the Software Update Manager (SUM)

These implementation steps (including this document) are listed in the step-by-step installation guide.

The system requirements can be found in the Product Availability Matrix (http://service.sap.com/pam). Please also check that you install the required patches that are mentioned in the central SAP Mobile Documents note 1832483 (https://service.sap.com/sap/support/notes/1832483).

The desktop clients for Windows and Mac OS can also be downloaded from SAP Service Marketplace, for the download path and the installation please consult the official help linked above.

The mobile clients can be downloaded from the iTunes App Store and Google Play.

Configuration

AS Java Settings

On AS Java level there are two configurations that are recommended when you use Mobile Documents. First, there is a file size restriction of 100MB in the Internet Connection Manager (ICM) which is really not very desirable when working with documents and second we want to activate HTTP response compression for the communications between clients and server.

Removing the 100 MB restriction in ICM: http://help.sap.com/saphelp_mdocs10/helpdata/en/a3/91f4d8384b46a0a3e72ef2d598d79c/content.htm?frameset=/en/3e/5c152acd004558ae619788e8379bcf/frameset.htm

Enabling gzip compression for HTTP responses: http://help.sap.com/saphelp_mdocs10/helpdata/en/8a/e07df9305d4408ab6de9a8759eb5c1/content.htm?frameset=/en/3e/5c152acd004558ae619788e8379bcf/frameset.htm

Creating KM repositories

In order to use “My Documents” and “Shared Documents” you have to create the repositories in SAP KM first.

Log into your Portal with a user with Administrator privileges by entering http://<yourserver>/irj into your browser’s address bar (Internet Explorer is recommended when working in the Portal).

Navigate to

System Administration -> System Configuration -> Knowledge Management -> Content Management -> Repository Managers -> CM Repository

/wp-content/uploads/2014/03/guide01_418108.png

Click on the button “New” and enter the following parameters:

Name:

mydocuments

Prefix:

/mydocuments

Persistence Mode:

dbfs

Repository ID in Database:

mydocuments

Root Directory:

$(sys.global.dir)/config/cm/mydocuments

Repository Services:

select “properties”

Property Search Manager:

com.sapportals.wcm.repository.manager.cm.CmPropertySearchManager

Security Manager:

AclSecurityManager

ACL Manager Cache:

ca_rsrc_acl

Memory Cache:

ca_cm

NOTE: This repository manager will store documents on the file system and metadata like properties and folder structures in the database.

The root directory that you configure must exist. You can create the folder or you also can configure a mapped network share and adapt the parameter “Root Directory” to your needs.

/wp-content/uploads/2014/03/guide02_418130.png

Click OK.

If you want to check if the repository manager is working navigate to

System Administration -> Monitoring -> Knowledge Management -> Component Monitor -> Repository Managers ->mydocuments

The monitoring page should show a green icon. If the icon is red, you propably configured a non-existing or non-accessible path as “Root Directory”.

Create a second repository for “Shared Documents” by repeating the same steps, but use “shareddocuments” instead of “mydocuments”.

User Administration

Create a service user

Both scenarios – “My Documents” and “Shared Documents” – require a service user that the application uses to do operation on-behalf of the user, for example the initial creation of the users’ home folders. This service user must have privileges to operate in KM repositories despite of ACL permissions and should have a non-expiring password.

In the portal (http://<yourserver>/irj), navigate to User Administration, click “Create User” and enter the following parameters in “General Information”:

Logon ID:

mdocs-service

Define Password:

<super-secret-password>

Confirm Define Password:

<super-secret-password>

Last Name:

Mobile Docs

Security Policy:

Technical User

/wp-content/uploads/2014/03/guide06_418134.png

Assign the Content Admin role by clicking on the tab “Assigned Roles”.

In the box “Available Roles” on the left, enter content_admin_role in the search field and press “Go”.

Select the role pcd:portal_content/administrator/content_admin/content_admin_role and click “Add”

/wp-content/uploads/2014/03/guide07_418135.png

Save the user.

Assign Mobile Documents Roles

Users that want to access Mobile Documents need specific roles. A description of the available roles and an instruction on how to assign them can be found in the official help here: http://help.sap.com/saphelp_mdocs10/helpdata/en/8e/28904fa014430498a2ee03c36fb02e/content.htm?frameset=/en/3e/5c152acd004558ae619788e8379bcf/frameset.htm

For now we assign the role “MCM_Administrator” to your Administrator user in order to be able to use the Mobile Documents Administration. Later on we have to assign the “MCM_User” role to all users that should be able to use Mobile Documents. A best practice is to assign the role to a group, which in most companies is a connected LDAP server like Microsoft Active Directory. That means all you have to do is assign the “MCM_User” role to existing LDAP groups.

TIP: You can use the role assignment to enable or disable Mobile Documents for users.

Configuring Destinations

In order to connect repositories to SAP Mobile Documents you have to configure connection data like server addresses, authentication methods, etc. Mobile Documents utilizes a service of SAP NetWeaver AS Java that is built just for these purposes, the destination service.

Log in to SAP NetWeaver Administrator by entering http://<yourserver>/nwa into the address bar of your browser.

Navigate to Configuration -> Destinations

Click the button “Create” and enter the following parameters:

Hosting System:

Local Java System <SID>

Destination Name:

LOCAL_SERVER

Destination Type:

HTTP

/wp-content/uploads/2014/03/guide03_418133.png

Click “Next”

URL:

http://localhost:<yourport>/cmis/json

NOTE: /cmis/json is the URI to the browser binding endpoint of the KM CMIS Connector

/wp-content/uploads/2014/03/guide04_418139.png

Click “Next”.

Authentication:

Basic (User ID and Password)

Username:

mdocs-service

Password:

<super-secret-password>

/wp-content/uploads/2014/03/guide05_418140.png

Save the destination by clicking “Finish”.

Configuring the repositories in Mobile Documents

All preparations are done by now, let’s open the Mobile Documents Administration by entering http://<yourserver>/mcm/admin into your browser’s address bar (since Mobile Documents uses SAP’s new HTML5 based UI library, I recommend to use Firefox or Chrome).

Navigate to Repositories -> Connections and create a new connection with the following parameters:

Display Name Local Server
Destination LOCAL_SERVER
Connection Type Local KM Connection

/wp-content/uploads/2014/03/guide08_418141.png

NOTE: For “My Documents” and “Shared Documents” only the connection types “Local KM Connection” and “SAP Assertion Ticket Connection” are supported.

Use the local connection for all KM repositories that exist on the same server, use ticket connections for repositories that are residing on remote servers.

After saving the connection, navigate to Repositories -> My Documents.

Select the connection “Local Server” and the Repository “mydocuments”. The value for “Document Classification” does not matter right now, pick any. You can change the default document classification when you want to start working with security policies which affect your clients. You can find more details about document classification here: http://help.sap.com/saphelp_mdocs10/helpdata/en/91/b3044f0a744cda9a980c89dadd5034/content.htm?frameset=/en/3e/5c152acd004558ae619788e8379bcf/frameset.htm

/wp-content/uploads/2014/03/guide09_418144.png

Save your configuration.

The “My Documents” scenario should be up and running now, let’s move on to Repositories -> Shared Documents. As before, select the “Local Server” and this time pick the repository “shareddocuments”. For the document classification pick any, as before.

/wp-content/uploads/2014/03/guide10_418145.png

To actually activate “Shared Documents” you have to configure the following settings. Go to “Settings” -> “Shared Documents”. To activate the sharing scenario, tick the checkbox “Allow Sharing” and save. For a description of the other settings see the help page:

http://help.sap.com/saphelp_mdocs10/helpdata/en/71/5a46a7dd0d4c0d844dcd1b3a53bb51/content.htm?frameset=/en/3e/5c152acd004558ae619788e8379bcf/frameset.htm

/wp-content/uploads/2014/03/guide11_418146.png

In the menu bar you can also find the entry “Repositories” ->“Corporate Content”. Here you can configure additional repositories like new or existing KM repositories or other CMIS-capable systems. How you connect third-party servers to Mobile Documents is out of scope for this guide, but basically you define a destination and a connection, then you can create a corporate repository. See the help for more information.

Authentication Scenarios: http://help.sap.com/saphelp_mdocs10/helpdata/en/16/4ca5ad073a4c02878723f03834f2f3/content.htm?frameset=/en/3e/5c152acd004558ae619788e8379bcf/frameset.htm

Creating Destinations:

http://help.sap.com/saphelp_mdocs10/helpdata/en/8c/2fd028cef6463a92984acf90c7f839/content.htm?frameset=/en/3e/5c152acd004558ae619788e8379bcf/frameset.htm

Creating Corporate Repositories:

http://help.sap.com/saphelp_mdocs10/helpdata/en/f5/d2bce890f74927a4b8db7ef9751a71/content.htm?frameset=/en/3e/5c152acd004558ae619788e8379bcf/frameset.htm

Making your server available in the Internet

SAP Mobile Documents is about accessing the documents you need – everywhere,anytime. To enable this for your users a web infrastructure is needed. Of course it is not desirable to expose your application server directly by putting it to the DMZ. Common setups include firewalls and reverse proxy servers that protect the access to the application server. Mobile Documents needs a special configuration when a reverse proxy is used. The CMIS responses of the server contain absolute URLs that the clients use for further communications. In the setting “External Server URL” you configure the URL that clients use to access Mobile Documents. A detailed description can be found in the help:

http://help.sap.com/saphelp_mdocs10/helpdata/en/c1/ebbe9a8a994942af9e7c7691ab769b/content.htm?frameset=/en/3e/5c152acd004558ae619788e8379bcf/frameset.htm

Securing your setup

This chapter contains some hints on how to improve the security of your SAP Mobile Documents installation.

Setting Permissions in KM repositories

The personal documents that users store in “My Documents” or “Shared Documents” of course should be private. The application protects the documents by using Access Control Lists (ACL). However, Super-Administrators and Content Administrators are able to access all documents using KM UIs despite of ACL permission settings. In a productive system these roles should be assigned very carefully.

Furthermore, the initial permissions of a new repository contain “Full Control” for everyone. Although Mobile Documents removes this permission when the personal folders for users are created, you may also want to remove the “Everyone” permission from your repositories root folder. A description on how to achieve that can be found here:

http://help.sap.com/saphelp_nw73ehp1/helpdata/en/42/89749d882d1422e10000000a114cbd/content.htm?frameset=/en/b3/72eb4fe26740aeb5d355c6c52e2639/frameset.htm

Transport Level Security

Obviously, all communications – from client to server and from server to repository – should be protected with SSL. Regarding the client-server communication, most of the times SSL is terminated at the load balancer. If you need SSL encryption on AS Java, you can find more information in the help portal here:

http://help.sap.com/saphelp_nw73ehp1/helpdata/en/4a/015cc68d863132e10000000a421937/frameset.htm

The server to server communications – means AS Java to repository server should be SSL protected as well. You can setup mutual SSL authentication and create trust relationships for SSO between the servers. Mobile Documents uses the Destination Service, the keys and certificates needed for the setup of SSL to external servers are done in SAP NetWeaver Administrator. Please consult the SAP help portal for details.

The authentication scenarios that are supported by Mobile Documents are listed here:

http://help.sap.com/saphelp_mdocs10/helpdata/en/16/4ca5ad073a4c02878723f03834f2f3/content.htm?frameset=/en/3e/5c152acd004558ae619788e8379bcf/frameset.htm

Backup and Restore

Of course you want to prevent data-loss in case of hardware crashes or other disasters. SAP’s recommendation is to do offline backups once in a week and online backups on a daily basis. This includes backing up the database and the file system. Good information about backup and restore of SAP AS Java can be found here:

http://help.sap.com/saphelp_nw73ehp1/helpdata/en/AB/A24C409CEF4F4FA21F9777CE360B06/content.htm?frameset=/en/48/bc0992ec1b5295e10000000a42189b/frameset.htm

If you configured root directories outside of /usr/sap/<SID> during the creation of the repositories for “My Documents” and “Shared Documents”, these directories have to be included in your file system backup. Since these repositories are DBFS repositories, there is a special backup flow that is described here:

http://help.sap.com/saphelp_nw73ehp1/helpdata/en/82/37d8e1d1a5408ca6c9b9d8b460dfd5/content.htm

Virus Scanning

SAP does not deliver its own anti-virus programs, but SAP KM offers a virus scanner interface which is described here: http://help.sap.com/saphelp_nw73ehp1/helpdata/en/b8/f5af401efd8f2ae10000000a155106/frameset.htm

Assigned Tags

      21 Comments
      You must be Logged on to comment or reply to a post.
      Author's profile photo Former Member
      Former Member

      Great guide Karsten.

      Author's profile photo Ashwani Kumar Sharma
      Ashwani Kumar Sharma

      Useful 🙂

      Author's profile photo Sundar V
      Sundar V

      Karsten...Lovely document 🙂

      But can you please let me know if this requires OData connectivity?

      Author's profile photo Former Member
      Former Member
      Blog Post Author

      Hi. OData is not needed. Regards, Karsten

      Author's profile photo Ingo Kober
      Ingo Kober

      Very useful, nicely done, thanks 🙂

      Author's profile photo Amit Kumar
      Amit Kumar

      Thanks Karsten.. Quite useful 🙂

      Author's profile photo Subhankar Chattopadhyay
      Subhankar Chattopadhyay

      nice one 🙂

      Author's profile photo Former Member
      Former Member

      Great guide, thank you; very helpful!

      Author's profile photo Sundar V
      Sundar V

      Hi...can anyone tell if this is based on OData Connectivity please...

      Author's profile photo Former Member
      Former Member

      Hi Kalyana,

      as far as I know this is not the case; SAP Mobile Documents uses the CMIS standard.

      Regards

      Daniel

      Author's profile photo Ashwani Kumar Sharma
      Ashwani Kumar Sharma

      Hi Kalyana,

      It is CMIS indeed. What are you looking for when you mention oData connectivity ?

      Regards, Ashwani Kr Sharma

      Author's profile photo Former Member
      Former Member

      Excellent guide, thank You so much.

      BR, Igor

      Author's profile photo Aviad Rivlin
      Aviad Rivlin

      Well written. Thanks for sharing! I always like reading about ways to extend the existing SAP Portal capabilities. A cool scenario that I can see is the hybrid scenario (connecting OP and cloud).

      Aviad

      Author's profile photo Former Member
      Former Member

      Great guide. Thanks a lot!

      Author's profile photo Vincent Noiset
      Vincent Noiset

      Great !

      Just a question.  In this documentation : http://help.sap.com/download/mobile/mdocs_sp02-corr2.pdf

      Chapter 4.3.3 there is a way to configure server url and user (MSAD):

      Untitled.png

      We don't use SAP Afaria but use MobileIron to (customize) distribute IOS application.

      --> for this we need and .IPA file.

      We did it for an BI/Mobi application for witch we get the SDK customise parameters then "recompile" as IPA file.

      --> question is:

      - how to configure IOS client without Afaria ?

      - how to get/produce IPA file ?

      If you can help for this.  Thank you.

      Vincent

      Author's profile photo Former Member
      Former Member

      Hi Vincent,

      We are currently in the process of releasing the iOS source code (and binary) to the Service Market Place for exactly this purpose (latest SP). However, this download will only be visible to those colleagues and customers/partners that have gone through the official source code request process.

      We will make a mini announcement once it is available.

      Best regards,

      Jon

      Author's profile photo Vincent Noiset
      Vincent Noiset

      Great !  If it exist a solution we'll follow the path 😉

      Vincent

      Author's profile photo Peter Vanneste
      Peter Vanneste

      Thanks for this quick reference guide.

      We've started implementing mobile docs on premise. Sadly we have some strange issues in de admin portal. please have a look at below screenshot, anyone any ideas why themes are missing? thanks

      issuedocs.PNG

      Author's profile photo Ingo Kober
      Ingo Kober

      Hi Peter,

      we have already investigated here and (as pointed out in the ticket you have created), it seems to be a missing configuration in the KM. So this is not a general issue. We will keep you up to date in the respective ticket.

      best regards,

      Ingo

      Author's profile photo Nitya Narayanan
      Nitya Narayanan

      Hi,
      We are implementing SAP mobile document server and trying to link it with S/4 Document Management System (DMS) to use it for Document info records and to store the files using SAP mobile doc server. Can anyone explain the system landscape, configuration to be performed from both DMS and repositories? Thanks!

      Author's profile photo Former Member
      Former Member

      Hi,

      The following link link is not opening : http://scn.sap.com/docs/DOC-56300.
      Could you let us know the correct link.

      thanks,
      Rajiv