Professional Documents
Culture Documents
2 What's New in SAP Mobile Documents 1.0 Cloud Version (Release Notes). . . . . . . . . . . . . . . . . . . 6
2.1 Support Package 00, Patch 01 (Cloud). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.2 Support Package 01 (Cloud). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Support Package 01 - Documentation Corrections (Cloud). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8
2.3 Support Package 02 (Cloud). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Support Package 02 - Documentation Corrections (Cloud). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
2.4 Support Package 03 (Cloud). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Support Package 03 - Documentation Corrections (Cloud). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14
Support Package 03 - Patch 01. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
2.5 Support Package 04 (Cloud). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
2.6 Support Package 05 (Cloud). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Support Package 05 - Documentation Update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
2.7 February 2016 Release Notes for SAP Mobile Documents Cloud Version. . . . . . . . . . . . . . . . . . . . . . . .18
2.8 March 2016 Release Notes for SAP Mobile Documents Cloud Version. . . . . . . . . . . . . . . . . . . . . . . . . .19
2.9 April 2016 Release Notes for SAP Mobile Documents Cloud Version. . . . . . . . . . . . . . . . . . . . . . . . . . 20
2.10 May 2016 Release Notes for SAP Mobile Documents Cloud Version. . . . . . . . . . . . . . . . . . . . . . . . . . . 21
3 Limitations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
4 General. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
4.1 Glossary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
5 Getting Started. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
5.1 Launching the End User Web App. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
5.2 Enabling Easy File Sharing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
5.3 Using Member Shares. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
5.4 Connecting Apps. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Connecting Your iOS App. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Connecting Your Android App. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Connecting Your Desktop App. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Connecting Your Native Windows App. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
6 Administrator's Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
6.1 Assigning Users to Roles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
6.2 Configuring the Server and App Settings (Cloud). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Configuring the General Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
7 Document Classification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
7.1 Security Policies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
The help library of SAP Mobile Documents (cloud version) contains the complete description of this product.
It protects your content in easy-to-use native applications. You can run it on the following:
Microsoft Windows
Apple Mac OS
Apple iPad and Apple iPhone
Android
HTML5-enabled browsers
Windows phone and Windows tablet
This document describes the cloud edition of SAP Mobile Documents. You use the cloud administration user
interface to manage the cloud component of SAP Mobile Documents. For example, you can assign users to roles
and monitor the usage statistics on the HOME tab.
If you are interested in the on-premise use case, see the Master Guide on SAP Help Portal.
Prerequisites
The release notes give you an overview of the new features and functions in the cloud version of SAP Mobile
Documents 1.0.
February 2016 Release Notes for SAP Mobile Documents Cloud Version [page 18]
March 2016 Release Notes for SAP Mobile Documents Cloud Version [page 19]
April 2016 Release Notes for SAP Mobile Documents Cloud Version [page 20]
May 2016 Release Notes for SAP Mobile Documents Cloud Version [page 21]
The release note gives you an overview of changes and enhancements in release 1 SP0 Patch 01 of the cloud
version for SAP Mobile Documents.
Table 1:
Function Type of Change Description
List of PAM links New Added direct links to the Product Availa
bility Maps for SAP Mobile Documents.
This Support Package for the cloud version of SAP Mobile Documents comprises changes and improvements to
the Web user interface as well as for the SAP Mobile Documents iOS apps. In addition, we deliver the all new SAP
Mobile Documents Android app.
In addition to some small improvements, the Web application has the following new features:
Users can upload documents or folders in asynchronous mode from the Mobile Docs folder in the browser
(not Microsoft Internet Explorer) to other repositories, for example, to the MY DOCUMENTS or PUBLISHED
DOCUMENTS repositories, using drag and drop or copy and paste. This function is also available in the
anonymous sharing UI that the recipients of the users shared link access.
Thanks to the asynchronous handling of the delete, upload, copy, move, create, and publish operations, long
lasting operations no longer interfere with other tasks users execute in the web UI.
The users receive notifications, for example, about file uploads or file deletions. By double-clicking these
notifications, the users can display a detailed progress view where the users could also cancel the action.
The user interfaces for the iOS apps were redesigned, and the iPhone is now also supported.
You can use custom theming for branding on the iOS apps.
The presentation mode for the iPad, which enables users to present PDFs on external devices, was
redesigned for better user interaction.
The new Android app is available through Google Play. It offers similar features as the iOS app.
In addition, the SD card is supported. If the user switches to or from an SD card for storage, the cached and
synced documents are moved between the two, instead of requiring a re-download.
Table 2:
Function Type of Change Description
This Support Package for the cloud version of SAP Mobile Documents comprises changes and improvements to
the Web user interface as well as to the SAP Mobile Documents mobile apps.
Note
If you have used Published Documents in a prior release, existing public folders have been migrated to be
compatible with the new sharing solution. Users can find their existing public folders in a special share
called Migrated Public Folders and all the public folder settings, including the public URL, are still valid.
For more information, see the Sharing Files sections in the User Guide.
A redesign of the Web app is available with a mobile-compliant, SAP Fiori-like user interface, including a
loading indicator and breadcrumbs.
Access to Corporate Documents repositories.
New sharing process.
The Web app displays up to 50,000 files per folder. If your folder contains more files than this, you can view
them using the desktop app.
An overview of the most important document changes of the cloud version library of SAP Mobile Documents .
Table 3:
Function Type of Change Description
This Support Package for the cloud version of SAP Mobile Documents comprises changes and improvements to
the Web user interface as well as to the SAP Mobile Documents desktop app and the SAP Mobile Documents
mobile apps.
URL Scheme
You can build URLs that perform actions in the SAP Mobile Documents app and that can be used for app-to-
app integration or as links in emails.
For more information, see URLs for App-to-App Integration of SAP Mobile Documents (Cloud) [page 112].
SAP Mobile Documents ABAP Connector
Using the Microsoft Outlook Add-In, you can restrict access to a newly created mail attachment share to the
recipients of the mail. In the Mobile Docs Preferences window, the Validity field was renamed to Expires In. For
more information, see Sending Mail Attachments Using the Microsoft Outlook Add-In in the User Guide.
You can display any file or folder available in your Mobile Docs folder in the Web app.
For more information, see Open File or Folder in Web App in the User Guide.
The notification that users receive if their desktop app version is lower than the one defined by the
administrator can now contain a download link set by the administrator. For more information, see .
You can choose a location for your Mobile Docs folder other than the default location. For more information,
see Configuring SAP Mobile Documents in the User Guide.
You can now set a separate synchronization interval for the Shared Documents and the Corporate Documents
repositories. For more information, see the Configuring SAP Mobile Documents section in the Desktop
Application How-Tos of the User Guide.
You can display the last 50 files and folders that have been synchronized to your desktop app. For more
information, see Displaying Recently Synchronized Files and Folders in the User Guide.
You can delete folders once they are deselected for auto-sync.
There is a dedicated tray icon ( ) that indicates that the user has logged off.
Invitations to Shares
Administrators and contributors of a share can invite other users to become share members. If new users
who have never logged on to SAP Mobile Documents before are invited to a share, they are displayed in the
members list of the share as pending users until they log on to SAP Mobile Documents for the first time.
You can also set up an invitation notification process that automatically sends mail notifications to the newly
added members of a share. For more information, see and Receiving an Invitation to a Share in the User Guide.
You can remove your own name from a share to which you have been invited.
For more information, see Receiving an Invitation to a Share in the User Guide.
ZIP files download
You can now download ZIP files using the Web app. For more information, see Downloading Folders in the
User Guide.
Adding a Public Link to a Share
You can create a public link for an existing share. For more information, see Adding a Public Link to a Share in
the User Guide.
The following corrections have been made to the SP03 version of this guide.
Table 4:
Type of Change Description
Updated Added the specification for the CMIS extension for search to
the Developer's Guides. For more information, see CMIS Ex
tension for Search [page 133].
The following corrections have been made to the SP03 version of SAP Mobile Documents.
The SAP Mobile Documents Modern UI of the desktop app presents the files and folders that the desktop app
synchronizes in a more touch-friendly way. The UI is available for Intel-based tablets running on Microsoft
Windows 8.1 on which the SAP Mobile Documents desktop app is installed.
This support package of SAP Mobile Documents comprises changes and improvements to the Web user interface
as well as to the SAP Mobile Documents desktop app and the SAP Mobile Documents mobile apps. Features that
are available for only one deployment option are marked accordingly.
The Web app and the Microsoft Outlook Add-In offer a simplified sharing workflow.
For more information, see Sharing Files (Web app) and Sharing Files (Outlook Add-In) in the User Guide.
To optimize content distribution, administrators can select public shares to be cached on a Content Delivery
Network (CDN). Users get the files from the CDN servers instead of from the SAP Mobile Documents server
directly.
For more information, see .
For the cloud version, there is a new corporate repository type Local Repository Connection to create
repositories in the SAP HANA Cloud Platform document service. The subfolders of these repositories use the
document service permissions for granting the users access to the files and folders. Permissions for these
repositories can be managed directly in the Web app.
For more information, see Managing Folders in Document Service Repositories [page 85].
The SAP Mobile Documents ABAP connector now fully supports the CMIS 1.1 interface.
When connected to an on-premise server, the desktop app displays user names instead of user IDs , for
example, on the Recently Changed Documents screen.
The Selective Sync option is now directly accessible from the context menu of the tray icon.
The desktop app supports pushed content to ensure that the user automatically receives documents
provided by the content administrator. The Pushed Documents folders are available on the corporate
repository level and are displayed on the Selective Sync screen.
For more information, see Synchronizing Selected Folders in the User Guide.
Users can indicate the number of log files they want to keep before the oldest log file is deleted.
For more information, see Configuring SAP Mobile Documents in the User Guide.
The Microsoft Outlook Add-in for the desktop app has a new and improved workflow with a redesigned user
and administration interface.
For more information, see Sending Mail Attachments Using the Microsoft Outlook Add-In in the User Guide.
The performance of the desktop app has been enhanced using technical improvements and updates.
For the Web app and the sharing UI, administrators can now configure links to a copyright page and a privacy
page. For more information, see Configuring the General Settings in the User Guide.
The read all feature ( ) has been updated for Android and iOS with the option to deactivate (and reactivate)
the confirmation dialog.
Depending on the server configuration, users can now log on using the OAuth logon method.
Users can edit additional properties for documents and folders.
For more information, see Viewing and Editing Properties of Files and Folders in the User Guide.
Android App
Users can refresh the list of files and folders on any screen by pulling it down.
The Android app displays user names instead of user IDs when connected to an on-premise server.
Users have quick access to the most common actions.
iOS App
There is a new executive mode with a clear, simplified user interface.
For more information, see Starting and Using Executive Mode for iOS in the User Guide.
Users can annotate PDF files.
For more information, see Editing PDF Files on iOS in the User Guide.
Users can create and edit text files.
For more information, see Adding and Deleting Files and Folders in the User Guide.
Users can upload multiple files, photos, or videos. If some files were already imported, you can decide to
overwrite the existing ones.
There is native support for iPhone 6 and iPhone 6 Plus devices.
There is a new icon indicating the connection status of the iPad app and running synchronization tasks.
For more information, see Checking the App Connection Status (iPad) in the User Guide.
This support package of SAP Mobile Documents comprises changes and improvements to the Web user interface
as well as to the SAP Mobile Documents desktop app and the SAP Mobile Documents mobile apps. Features that
are available for only one deployment option are marked accordingly.
For the cloud edition, there is now a repository-specific recycle bin with which users can restore files and
folders that were deleted.
For more information, see Using the Recycle Bin in the User Guide and Activating the Repository Recycle Bin
[page 87] in the administration guide.
When a user has opened a share, there is a new Share Details button available to change the share settings.
For shares for members, there is a new E-Mail Addresses button available that displays all email addresses of
the share members. Every share member can copy the addresses and insert them in the address field of a
mail containing the link to a share.
UI5 no longer supports Internet Explorer 8. Therefore, you have to use a modern browser, for example,
Internet Explorer 9 or higher, or Chrome, or Firefox.
iOS App
Swipe actions have been implemented for the most commonly used actions.
For more information, see Working with Selected Files in the Documents List in the User Guide.
Users can now access files from other applications supporting Apples Document Provider extension to open
files and save them back in SAP Mobile Documents. Users are able to import documents directly to SAP
Mobile Documents from other applications supporting Apples Document Picker.
For more information, see Open Files From Outside of SAP Mobile Documents in the User Guide and Allowing
iOS Users to Access Files from Outside of SAP Mobile Documents [page 87].
Users can now use the Apple Watch to control the presentations.
For more information, see Presenting PDF Files on iOS in the User Guide.
Android App
The performance and stability of the desktop app have been improved.
Users can now log on using OAuth.
For more information, see Installing the Desktop App for Microsoft Windows and Installing the Desktop App for
Mac OS in the User Guide.
The logon user interface has been redesigned.
This is a completely new app for SAP Mobile Documents on Windows phones and Windows tablets.
For more information, see Installing the Microsoft Windows App and Microsoft Windows Application How-Tos
in the User Guide.
The following changes have been applied to the SP05 version of SAP Mobile Documents.
The new Getting Started guide is linked to the tile of the SAP Mobile Documents service in the SAP HANA
Cloud Platform cockpit.
Applications can use MIME type mapping to provide own icons for the documents they expose to SAP Mobile
Documents.
For more information, see Using Your Own Icons for File Types (Cloud) [page 72]
A group of custom properties can have a display text configured.
For more information, see Custom Groups in Properties [page 124].
Administrators can view the up-to-date usage of an individual user with the Recalculate Usage button in the
administrators user interface.
There is a Getting Started guide that helps administrators to set up SAP Mobile Documents.
For more information, see Getting Started [page 25].
Users can easily access the download location of the desktop app. The URL for this location is specified by the
administrator.
For more information, see and Configuring the Desktop App Settings [page 59].
There is a new troubleshooting section that provides help for errors in the desktop app.
For more information, see .
In the browser and on the sharing UI, users can easily download multiple files and folders as a ZIP file.
For more information, see .
The term "client" was replaced with the term "app" for the desktop, iOS, Android, and Microsoft Windows apps.
For the Outlook add-in "client", the term client was removed and it is now called Windows Outlook add-in.
The Outlook add-in has better error handling on the share creation screen. In addition, the share table screen
that is displayed in the e-mails is now improved.
Users can now sync files to Microsoft Windows PCs even if their file paths are more than 255 characters long.
If a user tries to set an expiration date for a public link and this date is too far in the future, the system
automatically sets the expiration date to the maximum date allowed by the administrator.
The initial start of the iOS app now only requires the user to enter an app passcode if the administrator
enforces app passcodes.
For more information, see Installing the iPad or the iPhone App in the User Guide.
When opening a PDF file that has a table of contents, users can now navigate directly to a specific chapter or
bookmark.
For more information about creating such a link, see URLs for App-to-App Integration of SAP Mobile
Documents (Cloud) [page 112].
This delivery is mainly focused on performance, reliability, and health of the different apps. This includes
customer-specific and app-specific technical improvements, fixes, and enhanced support of authentication
methods, as well as a stable sync logic.
In addition, we harmonized the apps, by reworking text messages and improving user workflows so the tasks are
more understandable to the users.
Some user expectations are not met with the current release.
Table 6:
iOS In an external application, I want to open files Only works if you do not use an app passcode.
from SAP Mobile Documents or save files in SAP
Mobile Documents.
Web app I am an administrator and want to upload files in Either use a Chrome or Firefox browser to upload
the admin UI under Theme Assets or Mail Assets files in the admin UI. If you are using Internet Ex
using Internet Explorer 9. plorer 9, completely reload the admin UI after the
upload.
Web app After upgrading on-premise installations with Share owners have to disable the public link and
versioned repositories from SP04 to SP05, guest then enable it again to enable guest users to
users can access the public UI using a public link download files from the public UI.
but can no longer download any files.
Web app I want to have a reliable preview for PDF files us Download the PDF file and use a native PDF
ing a browser. viewer.
Outlook add-in In Microsoft Outlook 2010: I disabled the SAP SP04 and SP05: User has to start Microsoft Out
Mobile Documents add-in and restarted Micro look 2010 as an administrator and then disable
soft Outlook. I expect the SAP Mobile Documents the add-in.
add-in to be disabled.
SAP Mobile Documents is a solution that securely puts critical business documents in the palm of your hand. It
gives users anytime, anywhere access to view, edit, and collaborate on corporate and personal documents.
On the SAP Help Portal, you can download a PDF version of this documentation at http://help.sap.com/
mdocs_cloud10.
Related Information
4.1 Glossary
Some of the central terms used in SAP Mobile Documents are defined below.
Content Management OASIS standard that works towards enabling interoperability between content management sys
Interoperability Serv tems.
ices (CMIS)
Corporate Documents Repository containing company documents and non-private documents of the user. The user does
not own these documents.
executive mode Executive mode provides a clear, minimized user interface and only shared content.
mail assets The resources used to configure the mail notifications for new share members in SAP Mobile
Documents. The administrator uploads the configuration files, mail templates, and so on.
My Documents Repository containing the user-specific folder with the user's private documents.
password Secures the user data on the server. Used for basic authentication.
Different passwords are used to secure the access to the link that users create to enable others to
access their share.
public link A link that can be applied to a share. The link makes the share available to anonymous users.
Pushed Documents Repository that contains files and folders that are automatically synchronized to the user's apps. Ad
ministrators can restrict access to this repository to users who are assigned a specific role.
SAP Mobile Documents Application for accessing and sharing your documents and corporate documents on mobile devices,
laptops, and desktops.
SAP Mobile Documents Native mobile application, running on Microsoft Windows, Apple MAC OS, Apple iPad, Apple iPhone,
app Android, Windows Phone and tablet, and on HTML5-enabled browsers.
SAP Mobile Documents Server component running on SAP NetWeaver AS for Java. It grants unified access to repositories.
server
share The root folder that is used for collaboration with other users. It can contain folders and files. Users
can create any number of shares (until their quota is used up).
Shared Documents Repository containing the shared documents and folders of a user.
Sharing UI User interface to which the recipient of the link to the published documents is taken. The recipient
does not need to be a registered user of SAP Mobile Documents.
sync Function for synchronizing documents between the server and the app. This function stores the
documents on the respective device and keeps the documents in sync.
theme assets The resources used to adjust the look and feel or graphical appearance of the user interface. For SAP
Mobile Documents, the administrator can adjust the appearance of the user interface of the Web
app, the iOS apps, and the Android apps to a company's branding by using, for example, logos, back
ground images, and lock-screen images.
Related Information
You can use SAP Mobile Documents as a content service for your SAP HANA Cloud Platform account.
The following tasks contain step-by-step instructions on how to activate and set up SAP Mobile Documents.
Related Information
Once your SAP HANA Cloud Platform account has the SAP Mobile Documents service enabled, you can start the
Web app of SAP Mobile Documents.
Procedure
You can now create folders or upload files, for example, by using drag and drop.
For more information about the features of the Web app, see Web Application How-Tos.
Use your SAP HANA Cloud Platform service, SAP Mobile Documents, for easy file sharing.
Context
To use the ready-to-use file-sharing capabilities of SAP HANA Cloud Platform, you need to enable sharing on the
SAP Mobile Documents administration user interface (UI).
Procedure
For more information, see Configuring the Shared Documents Settings [page 65].
8. Log back on to the end user Web app of SAP Mobile Documents, where you will now see the Shared navigation
area.
Do not select the option Share with members for now. This is described in Using Member Shares [page 33].
Results
The recipient can use this URL to access the files (provided the recipient knows the password).
Create shares that are only available to a select group of people (members). As the share owner, you can only
invite users who are known to the Identity Provider.
Prerequisites
The users who create the shares and will be members of the shares must be available to SAP HANA Cloud
Platform. Therefore, the users must be maintained in the connected Identity Provider.
The users who are added as share members must be assigned the User role so they can access SAP Mobile
Documents.
You have set up a Shared Documents repository. For more information, see Enabling Easy File Sharing [page
27].
Context
The member shares help teams to collaborate on files. Development teams, for example, often share design
documents, mock-ups, and test results with each other. The team members access these documents in different
roles:
The documents stored in team shares contribute to the quota of the share owner.
Procedure
1. Open the SAP Mobile Documents Web app to create team shares.
2. In the Web app, choose Shared. You see all the team shares where a role (administrator, contributor, or
reader) has been assigned to you.
3. Choose + Create.
4. Enter a name for the share.
5. Select Share with members.
a. To add share members, enter the logon ID or the e-mail address of the user you want to add.
Note
If you use logon IDs, users can only be resolved if they have logged on to SAP Mobile Documents at
least once.
c. Choose Add.
d. The members are displayed in a list with subsections for administrators, contributors, and readers. If a
newly added member has never before logged on to SAP Mobile Documents, the name is displayed with
the status Awaiting user's initial logon.
e. To copy the e-mail addresses of the share members, for example, to use them in the To field of an e-mail
containing the share link, choose E-Mail Addresses. In the box that opens, you can then select and copy
the addresses.
6. To make the team share available to people outside the team, create a public link by additionally selecting
Anyone with the link has access. You have the option to configure a password to protect the link, define a
specific time frame during which the link is available, and enable write access.
Once your SAP HANA Cloud Platform account has the SAP Mobile Documents service enabled and you have set
up the Web app of SAP Mobile Documents, you can activate the mobile and desktop apps as well.
For more information about the SAP Mobile Documents apps, see the User Guide.
Related Information
Before you can use the SAP Mobile Documents mobile app on your iOS device, you have to set it up.
Prerequisites
Procedure
1. Download and install the SAP Mobile Documents app by using the App Store app on your Apple device.
2. Open the SAP Mobile Documents app.
3. Choose Skip For Now. You can set the passcode later if you want to.
4. Get the server URL of your SAP HANA Cloud Platform account for SAP Mobile Documents as follows:
a. Log on to the SAP HANA Cloud Platform cockpit.
b. Choose Services in the navigation area.
c. Select the Mobile Documents service.
d. Right-click Go to Service, and copy the link address.
6. Enter your registered e-mail address as the user name, then enter your password and choose Log On.
Before you can use the SAP Mobile Documents mobile app on your Android device, you have to set it up.
Prerequisites
Procedure
1. Download and install the SAP Mobile Documents app from Google Play Store.
2. Open the SAP Mobile Documents app.
3. Choose Skip For Now. You can set the passcode later if you want to.
4. Get the server URL of your SAP HANA Cloud Platform account for SAP Mobile Documents as follows:
a. Log on to the SAP HANA Cloud Platform cockpit.
b. Choose Services in the navigation area.
c. Select the Mobile Documents service.
d. Right-click Go to Service, and copy the link address.
5. Paste the link address into the URL field of the SAP Mobile Documents app, and remove the URL part /
mcm/... so that the URL looks like this: https://<your account>.ondemand.com
Before you can use the SAP Mobile Documents desktop app on your device, you have to set it up.
Procedure
1. Download and install the SAP Mobile Documents desktop app for your OS.
2. Start the SAP Mobile Documents desktop app.
3. Get the server URL of your SAP HANA Cloud Platform account for SAP Mobile Documents as follows:
a. Log on to the SAP HANA Cloud Platform cockpit.
b. Choose Services in the navigation area.
c. Select the Mobile Documents service.
4. Paste the link address into the URL field of the SAP Mobile Documents logon window, and remove the URL
part /mcm/... so that the URL looks like this: https://<your account>.ondemand.com
Before you can use the SAP Mobile Documents native Windows app on your device, you have to set it up.
Prerequisites
1. Download and install the SAP Mobile Documents app from Windows Store.
2. Open the SAP Mobile Documents app.
3. Get the server URL of your SAP HANA Cloud Platform account for SAP Mobile Documents as follows:
a. Log on to the SAP HANA Cloud Platform cockpit.
b. Choose Services in the navigation area.
c. Select the Mobile Documents service.
d. Right-click Go to Service, and copy the link address.
4. In the Log On window, paste the link address into the URL field of the SAP Mobile Documents app, and remove
the URL part /mcm/... so that the URL looks like this: https://<your account>.ondemand.com
5. Enter your registered e-mail address as the user name, then enter your password and choose Log On.
System administrators configure and administrate users and features of SAP Mobile Documents 1.0.
The specific Web roles for SAP Mobile Documents contain the access authorizations for the user interfaces (UIs).
Context
User
Enables the user to use the SAP Mobile Documents application.
Sharing User
Enables the user to access shares in the SAP Mobile Documents sharing UI to which he or she was invited.
The role does not enable the user to create shares.
Administrator
Enables the user to manage the SAP Mobile Documents administration UI. The administrator role contains
the user role. Administrators without the additional analyst role cannot view the STATISTICS page.
Analyst
User for SAP Mobile Documents with access to the SAP Mobile Documents statistics on the admin Web UI.
Analysts without the additional administrator role can only view the STATISTICS page.
Procedure
1. Log on with a user (who is an account member) to the SAP HANA Cloud Platform cockpit, using the relevant
URL for your region as described in the Logon section under Cockpit in the documentation of SAP HANA
Cloud Platform.
2. Assign the necessary role to the user as described in Managing Role Assignments under Assigning Users to
Roles in the documentation of SAP HANA Cloud Platform.
Related Information
The administrator configures the settings that apply to the SAP Mobile Documents server and the apps.
The administrator configures general settings that apply to the SAP Mobile Documents server.
Procedure
1. Log on with an administrative SAP Mobile Documents user to the SAP Mobile Documents administration UI,
using the relevant URL for your region.
https://smd-<account_name>.<data_center>.ondemand.com/mcm/admin
For more information, see the Logon section in SAP HANA Cloud Platform Cockpit.
Disable "My Unselected checkbox If set, the end users do not have a My Documents folder.
Documents" Default
Repository Selected checkbox
Enable Recycle Bin Unselected checkbox Only available for Local Repository Connection.
Default
Only if you enable the recycle bin for the repository can the
Selected checkbox
users restore deleted files and folders of this repository.
Recycle Bin number of days Only available for Local Repository Connection.
Retention Time
If you leave this field blank, it will be Defines a time period in days after which the repository will
(Days)
be emptied by a cleanup job. The maximum retention time
displayed with a value of 0 the next
is 999 days. If you set the number of days to 0, then the re
time you open the Manage Repository
cycle bin will not be emptied.
dialog for this repository.
Default User Quota <numerical value>. Defines the standard size in megabytes for the repository space
(MB) allocated to each user. If the value is 0, there is no space restric
Default value: 0. tion.
User Quota <A number between 0 and Defines the quota size limit at which a notification is sent to the
Warning Level (%) 100>. user that the allocated space is almost used up.
Default value: 80
Default Document Strictly Confidential Sets the classification level for the My Documents and the
Classification Confidential Shared Documents repositories.
Internal
Customer Note
Public All documents in this repository inherit the classification
level of the repository. For more information, see Docu
ment Classification.
Statistics Data Unselected checkbox (default) Enables collection of data about the daily usage, for example, the
Selected checkbox number of active logons, read accesses, and write accesses per day.
URL to "Privacy" <URL> Inserts a button on the landing page and on the sharing UI. If you leave the field blank,
the SAP default values are used. To hide the button, select the checkbox Disable URL
to "Privacy".
URL to "Legal <URL> Inserts a button on the standard landing page and on the sharing UI. If you leave the
Disclosure" field blank, the SAP default values are used. To hide the button, select the checkbox
Disable URL to "Legal Disclosure".
URL to "More Info" <URL> Inserts a button on the standard landing page.
on Landing Page
URL for "Help" Link <URL> Inserts a link button on the Web app using the URL you indicate, for example, to the
in Web App SAP Help Portal page at http://help.sap.com/mdocs. If you leave the field
blank, the SAP default values are used. To hide the button, select the checkbox
Disable URL for "Help" Link in Web App.
Common Download <URL> Replaces the standard download page. To not display any download button, select
URL the checkbox Disable Common Download URL.
Theme Name <SAP UI5 theme Name of the theme you created. Currently, the sap_bluecrystal and
name> sap_hcb (High Contrast Black) themes are supported.
Related Information
SAPUI5 Theming
Security Policies [page 89]
Document Classification [page 89]
SAP HANA Cloud Platform Cockpit
For the iOS, Android, Web, and desktop app, you can define the settings using a properties file instead of setting
them individually.
Context
There are the following use cases for setting properties with a file instead of individually in the administration UI:
You can import the settings defined for one server to another server, for example, when you define all settings
in the test environment and then want to use identical settings in the productive environment.
After you set all properties for the app in the admin UI, you can download this settings file and reimport it into
another server. The properties file is located in the My Documents repository under Settings. The settings are
then applied in the new server. They are displayed in the Additional Settings field and the respective fields on
the settings page of the app are set.
You have a new app with new options and want to use these with a lower server version.
The new app offers more settings than the server admin UI. You can set these additional settings as key-value
pairs in the Additional Settings field.
Procedure
1. Log on with an administrative SAP Mobile Documents user to the SAP Mobile Documents administration UI,
using the relevant URL for your region.
For more information, see the Logon section in SAP HANA Cloud Platform Cockpit.
Using SAP Mobile Documents, administrators define the look and feel of the Web app and adapt it to your
company's branding. Administrators define the page title, the logo, as well as the header logo.
Context
This task is optional and only required if you want to change the default settings provided by the SAP Mobile
Documents server. For the changes to take effect, restart the Web app.
Tip
The size of uploaded logo images is not adapted automatically. If an image is too large it will cover the entire
left-hand side of the Web app. We recommend a size of 80 x 40 pixels.
You set the general theme that applies to the Web app (browser) as well as the Web admin UI on the General tab.
For more information, see Configuring the General Settings [page 46].
Procedure
1. Log on with an administrative SAP Mobile Documents user to the SAP Mobile Documents administration UI,
using the relevant URL for your region.
https://smd-<account_name>.<data_center>.ondemand.com/mcm/admin
For more information, see the Logon section in SAP HANA Cloud Platform Cockpit.
3. To use a custom page title, choose SETTINGS Web App , and then enter your text in the Page Title field.
This title is displayed right after the folder name as the tab title in the browser. Most browsers only display one
or two title characters. To see the full title, users can hover over the tab page. The full tab title is also used in
the browser history to give more details and provide a better overview.
4. To use a custom logo or header logo, choose SETTINGS Web App and select an image from the
dropdown box next to the respective logo field.
Using SAP Mobile Documents, administrators define the default settings for the iOS app.
Context
This section is optional and only required if you want to change the default settings provided by the SAP Mobile
Documents server. For the changes to take effect, you need to restart the application.
Procedure
1. Log on with an administrative SAP Mobile Documents user to the SAP Mobile Documents administration UI,
using the relevant URL for your region.
https://smd-<account_name>.<data_center>.ondemand.com/mcm/admin
For more information, see the Logon section in SAP HANA Cloud Platform Cockpit.
2. Choose SETTINGS IOS App General Settings , and then define default values as appropriate.
Minimum App <3_digit_version_number> Defines the minimum version of the app software.
Version If the app is a lower version, the user is instructed
to upgrade to a higher version before proceeding.
Recommended App <3_digit_version_number> Defines the recommended version of the app soft
Version ware. If the app is a lower version, the user is noti
fied about the higher recommended version.
Maximum Cache No limit Sets the maximum cache size on the device. The
Size Caching is not limited. user can select a smaller but not a larger maximum
Default value. cache size. Synced documents are not taken into
account in the cache size.
None
Disables caching.
Note
50 MB
100 MB No Cache means that the documents are down
1000 MB loaded again every time the document is ac
cessed. This increases the traffic and probably
5000 MB
the costs. On the other hand, No Cache in
creases security as the documents are not
stored on the device.
Disable Support Log Unselected checkbox Allows or disallows users to activate application
The user can activate the support log. logging on their app.
Default value.
Selected checkbox
The user cannot activate the support log.
Mail Address for <Mail address of support person> Defines the mail address for support requests.
Support Requests
Mail Address for <Mail address of support person> Defines the mail address for support requests that
Support Requests in is displayed on the screen of the executive mode.
Executive Mode
Help Link for Support URL of help page Enables you to link to a help page. If set, the Help
Requests Page entry in the help menu is displayed on the iOS
screen.
Disable Automatic Unselected checkbox Defines whether users can prevent synchroniza
Sync Over Cellular The user can activate the support log. tion of their files when they cannot use a WiFi net
Default value. work.
Selected checkbox
The user cannot activate the support log.
Related Information
Using SAP Mobile Documents, administrators define the security requirements that users have to fulfill when
defining their passcodes. In addition, administrators use the security policies to define which actions are available
to users in the mobile apps.
Procedure
1. Log on with an administrative SAP Mobile Documents user to the SAP Mobile Documents administration UI,
using the relevant URL for your region.
https://smd-<account_name>.<data_center>.ondemand.com/mcm/admin
For more information, see the Logon section in SAP HANA Cloud Platform Cockpit.
2. Choose SETTINGS IOS App Security Settings or Security Policies, and then define values as
appropriate.
Passcode Must Checkbox not selected Defines whether the passcode must contain
Contain: The passcode does not have to contain such the listed character.
a character.
Lowercase Char
Default value.
acters
Checkbox selected
Uppercase Char
The passcode must contain such a charac
acters
ter.
Digits
Special Charac
ters
Related Information
Using SAP Mobile Documents, administrators define the look and feel of the iOS apps and adapt them to your
company's branding. Administrators define the highlight color as well as background or lock screen images.
Context
This section is optional and only required if you want to change the default settings provided by the SAP Mobile
Documents server. For the changes to take effect, users need to restart the iOS app.
Procedure
1. Log on with an administrative SAP Mobile Documents user to the SAP Mobile Documents administration UI,
using the relevant URL for your region.
https://smd-<account_name>.<data_center>.ondemand.com/mcm/admin
For more information, see the Logon section in SAP HANA Cloud Platform Cockpit.
2. To upload background or lock screen images, choose Upload under SETTINGS Theme Assets .
3. To define the highlight color and images, choose SETTINGS IOS App Theming .
4. To define the highlight color for the iPad or iPhone app, click inside the entry field and choose a color by
moving the slider, clicking the colors field, or entering values.
5. To set the theme images, select an image from the dropdown box next to the respective resolution field.
You can select different images, for example, for the portrait or landscape mode.
6. Save your entries.
7. For the new settings to take effect, users restart the iPad or iPhone app.
Related Information
Using SAP Mobile Documents, administrators define the default settings for the Android app.
Procedure
1. Log on with an administrative SAP Mobile Documents user to the SAP Mobile Documents administration UI,
using the relevant URL for your region.
https://smd-<account_name>.<data_center>.ondemand.com/mcm/admin
For more information, see the Logon section in SAP HANA Cloud Platform Cockpit.
2. Choose SETTINGS Android App General Settings . and then define default values as appropriate.
Minimum App <Version> Defines the minimum version of the app software. If the app
Version is a lower version, the user is instructed to upgrade to a
higher version before proceeding.
Recommended App <Version> Defines the recommended version of the app software. If
Version the app is a lower version, the user is notified about the
higher recommended version.
Maximum Cache Size No Limit Sets the maximum cache size on the device. The user can
Caching is not limited. select a smaller but not a larger maximum cache size.
Default value. Synced documents are not taken into account in the cache
size.
No Cache
Disables caching.
Note
50 MB
100 MB No Cache means that the documents are downloaded
1000 MB again every time the document is accessed. This in
creases the traffic and probably the costs. On the other
5000 MB
hand, No Cache increases security as the documents are
not stored on the device.
Disable Support Log Unselected checkbox Allows or does not allow users to activate application log
The user can activate the sup ging on their app.
port log.
Default value.
Selected checkbox
The user cannot activate the
support log.
Mail Address for <Mail address of support Defines the e-mail address for support requests.
Support Requests person>
Disable Automatic Unselected checkbox Defines whether users can prevent synchronization of their
Sync Over Cellular The user can activate the sup files when they cannot use a WiFi network.
port log.
Default value.
Selected checkbox
The user cannot activate the
support log.
Cellular Data <integer> Triggers the display of a warning for downloads of or above
Threshold (MB) this threshold size.
Related Information
Using SAP Mobile Documents, administrators define the security requirements that users have to fulfill when
defining their passcodes. In addition, administrators use the security policies to define which actions are available
to users in the mobile apps.
Procedure
1. Log on with an administrative SAP Mobile Documents user to the SAP Mobile Documents administration UI,
using the relevant URL for your region.
https://smd-<account_name>.<data_center>.ondemand.com/mcm/admin
For more information, see the Logon section in SAP HANA Cloud Platform Cockpit.
2. Choose SETTINGS Android App Security Settings , and then define values as appropriate.
Application Checkbox selected Defines whether the application passcode that the
Passcode Required Application passcode is enforced. user sets is enforced.
Default value.
Checkbox not selected
Application passcode is not enforced.
Lock Timeout Immediately Defines the period of inactivity after which users
The user has to enter the passcode im have to re-enter their passcode. The user may se
mediately. lect a shorter but not a longer timeout.
Default value.
60 seconds
300 seconds
600 seconds
Maximum Number 20 Defines how many times users can attempt to enter
of Failed Passcode Default value. their passcode. If all attempts fail, all data is erased
Attempts 3 from the app. The user can set a lower number of
passcode attempts but not a higher number.
5
10
Device Encryption Checkbox selected Defines whether the device must have device-level
Required Default value. encryption enabled by the Android OS to run SAP
Checkbox not selected Mobile Documents.
Disable Use of Checkbox selected Defines whether removable storage, for example,
Removable Storage Default value. an SD card, can be used.
Checkbox not selected
Passcode Must Checkbox not selected Defines whether the passcode must contain the
Contain: The passcode does not have to contain listed character.
Lowercase such a character.
Characters Default value.
Uppercase Checkbox selected
Characters
The passcode must contain such a char
Digits
acter.
Special Charac
ters
Using SAP Mobile Documents, administrators define the look and feel of the Android apps and adapt them to your
company's branding. Administrators define the background or lock-screen images.
Context
This section is optional and only required if you want to change the default settings provided by the SAP Mobile
Documents server. For the changes to take effect, users need to restart the app.
Procedure
1. Log on with an administrative SAP Mobile Documents user to the SAP Mobile Documents administration UI,
using the relevant URL for your region.
https://smd-<account_name>.<data_center>.ondemand.com/mcm/admin
For more information, see the Logon section in SAP HANA Cloud Platform Cockpit.
2. To upload background or lock-screen images, choose Upload under SETTINGS Theme Assets .
3. To set the theme images, select an image from the dropdown box next to the respective resolution field.
You can select different images, for example, for the portrait and landscape mode.
The administrator defines default settings for the desktop app of SAP Mobile Documents.
Context
This section is optional and only required if you want to change the default settings provided by the SAP Mobile
Documents server. For the changes to take effect, users need to restart the application.
Procedure
1. Log on with an administrative SAP Mobile Documents user to the SAP Mobile Documents administration UI,
using the relevant URL for your region.
https://smd-<account_name>.<data_center>.ondemand.com/mcm/admin
For more information, see the Logon section in SAP HANA Cloud Platform Cockpit.
2. Choose SETTINGS Desktop App General Settings , and then define default values as appropriate.
Disable support log Unselected checkbox Allows or does not allow users to acti
The user can activate the support vate the application logging on their
log in the app settings. app.
Default value.
Selected checkbox
The user cannot activate the sup
port log.
Mail Address for Support Requests <Mail address of support Defines the e-mail address for support
person> requests.
Download URL for Desktop App <URL to the download page for The URL must consist of the protocol
Updates the desktop app> http:// or https:// followed by
the host and page location.
Desktop App .
Related Information
You use these settings to define the security requirements that users have to fulfill when defining their passcodes.
Procedure
1. Log on with an administrative SAP Mobile Documents user to the SAP Mobile Documents administration UI,
using the relevant URL for your region.
https://smd-<account_name>.<data_center>.ondemand.com/mcm/admin
For more information, see the Logon section in SAP HANA Cloud Platform Cockpit.
2. Choose SETTINGS Desktop App Security Settings , and then define default values as appropriate.
Allow Local Storage of Mobile Checkbox selected Defines whether the users are allowed to save the
Docs Logon Password Local storage is allowed. logon password locally on the desktop app.
Default value.
Checkbox not selected
Local storage is not allowed.
3. Choose SETTINGS Desktop App Security Policies , and then define default values as appropriate.
Disable Sync for Corporate <Security policy> Defines whether the users are allowed to disable the synchronization
Repositories of files in the corporate content repository on the desktop app.
Related Information
On the SAP Mobile Documents administration UI, you define the default settings of the Outlook Add-In.
Context
This section is optional and only required if you want to change the default settings provided by the SAP Mobile
Documents server. For the changes to take effect, users need to restart the Outlook Add-In.
Procedure
1. Log on with an administrative SAP Mobile Documents user to the SAP Mobile Documents administration UI,
using the relevant URL for your region.
https://smd-<account_name>.<data_center>.ondemand.com/mcm/admin
2. Choose SETTINGS Outlook Add-In , and then define default values as appropriate.
Dialog Header Text <SAP Mobile Documents> Allows you as administrator to enter
the product name that appears in the
sharing dialog header.
Tab Header Text <SAP Mobile Documents> Allows you to define the product name
that appears on all Outlook Add-In
tabs.
Font Color #FFFFFF Allows you to set the tab font color of
the sharing dialog using the color
picker dialog box.
Headers Background Color #009CE3 Allows you to set the headers back
ground color of the sharing dialog us
ing the color picker dialog box.
On the SAP Mobile Documents administration UI, you define the default settings of the Windows App.
Procedure
1. Log on with an administrative SAP Mobile Documents user to the SAP Mobile Documents administration UI,
using the relevant URL for your region.
https://smd-<account_name>.<data_center>.ondemand.com/mcm/admin
For more information, see the Logon section in SAP HANA Cloud Platform Cockpit.
Minimum App 3_digit_version_number Defines the minimum version of the app software.
Version If the app is a lower version, the user is instructed
to upgrade to a higher version before proceeding.
Recommended App 3_digit_version_number Defines the recommended version of the app soft
Version ware. If the app is a lower version, the user is noti
fied about the higher recommended version.
Disable Support Log Unselected checkbox Allows or denies users the option of activating ap
The user can activate the support log. plication logging on their app.
Default value.
Selected checkbox
The user cannot activate the support log.
On the SAP Mobile Documents cloud administration UI, you define the default settings for the Shared Documents
repository.
Context
A Shared Documents repository offers the possibility to share documents with other SAP 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 the access rights of these members. You can also create public links to a
share with security settings such as expiration date, password, and so on. A public link can be accessed through a
dedicated non guessable URL, which can be password protected. If enabled, anonymous users can also upload or
delete documents in a share.
Procedure
1. Log on with an administrative SAP Mobile Documents user to the SAP Mobile Documents administration UI,
using the relevant URL for your region.
https://smd-<account_name>.<data_center>.ondemand.com/mcm/admin
For more information, see the Logon section in SAP HANA Cloud Platform Cockpit.
Maximum <number of days> Defines availability period (in days) of public links.
Expiration
Default: 0 This setting affects only the public access to docu
Time (Days)
ments. Named share members can access docu
0 means that the validity is not limited.
ments in a share for as long as they remain share
members.
Default <number of days> Defines default period (in days) for which public
Expiration links are available. This default is displayed in the
Time (Days) Default: 0 UIs before you enter a value.
0 means that the validity is not limited.
Minimum <minimum number of characters> Defines minimum number of characters in your pub
Password lic link passwords.
Length Default: 8
This setting affects only the public access to docu
0 means that no password is enforced.
ments. Named share members can access docu
ments in a share without presenting a password.
Allow Upload Selected checkbox Enables users to decide whether they want to allow
Enabled. users who are not share members to upload files to
Unselected checkbox their share.
Disabled. Default value. This setting affects only the public access to docu
ments. Named share members can upload docu
ments to a share depending on their member role.
Share Lock <Integer value> Length of time for which the public link is locked for
Time users who are not share members if any one user
(Seconds) enters a wrong password to access the public link.
Invitation Mail Blank Determines which recipients users can send e-mails
Domains Users can send e-mails to any mail address. to.
(Comma- Default value.
Separated)
<Name of your mail domain>
Example
sap.com,sap.de
Enable Recycle Unselected checkbox Only available for Local Repository Connection.
Bin Default
Only if you enable the recycle bin for the repository
Selected checkbox
can the users restore deleted files and folders of this
repository.
Recycle Bin number of days Only available for Local Repository Connection.
Retention Time
(Days) If you leave this field blank, it will be displayed with Defines a time period in days after which the reposi
tory will be emptied by a cleanup job. The maximum
a value of 0 the next time you open the Manage
retention time is 999 days. If you set the number of
Repository dialog for this repository.
days to 0, then the recycle bin will not be emptied.
Maximum Expiration Value Default Expiration Value By default, a new public link expires...
0 0 never
0 21 in 21 days
30 0 in 30 days
30 21 in 21 days
On the SAP Mobile Documents administration UI, you specify which shares can be hosted by a Content Delivery
Network (CDN).
Prerequisites
The share you want to share using a CDN must not be shared with members only but must be accessible by
anybody who receives the link to the share.
The link to the share must not be protected with a password.
Context
Because every gigabyte that is transferred using a CDN raises costs, you define that only specific shares are
allowed to be hosted by a CDN, using a whitelist. You can combine the following options to create the whitelist:
Procedure
1. Log on with an administrative SAP Mobile Documents user to the SAP Mobile Documents administration UI,
using the relevant URL for your region.
https://smd-<account_name>.<data_center>.ondemand.com/mcm/admin
For more information, see the Logon section in SAP HANA Cloud Platform Cockpit.
2. Choose SETTINGS Shared Documents , and then list the respective shares.
Shares of user_id_1; The shares of the owners you list here can be hosted by a CDN.
Owners user_id_2
(User IDs
Separated
by Commas)
Shares (One share_id_1 The shares you list here can be hosted by a CDN. You find the share ID in the Web UI on
Share ID per the Access Settings of Share tab. The last part of the Link to Share entry is the share ID,
Line) share_id_2 that is, everything following shr=.
share_id_3
Example
share_id_4
In this sample URL https://example.com/mcm/public/v1/open?
shr=hSX3tyfls4MWW8zXpvPGpFdnCbrw1M_zUIY5BdwH3HM, the share ID
is hSX3tyfls4MWW8zXpvPGpFdnCbrw1M_zUIY5BdwH3HM.
The SAP Mobile Documents server provides a notification process with configurable HTML mail templates.
Currently, you can automatically send invitation mails to new members of a share if you have executed the
following setup steps:
1. Configure your mail template as described in Configuring the Mail Templates [page 69].
2. Enable the sending of mail invitations to future share members in the General settings.
For more information, see the entries referring to mails in Configuring the Shared Documents Settings [page
65].
3. Enable future share members to access the share:
The future member has a user that is linked to his or her mail address. The user is either created by the
administrator or by the users themselves in a company-specific workflow.
If the SAP Mobile Documents server is configured to send mails, the mail templates have to be configured.
Prerequisites
The SAP Mobile Documents server has been configured to send mails.
A mail template has been uploaded to the SAP Mobile Documents server. See Creating a Mail Template
Configuration File [page 69].
Procedure
1. Log on with an administrative SAP Mobile Documents user to the SAP Mobile Documents administration UI,
using the relevant URL for your region.
https://smd-<account_name>.<data_center>.ondemand.com/mcm/admin
For more information, see the Logon section in SAP HANA Cloud Platform Cockpit.
To send mail notifications in SAP Mobile Documents, you must upload a properties file with a defined name that
contains the configuration of the mail template.
Procedure
1. Create the <template key>.properties configuration file that consists of key/value pairs that build the
configuration.
Table 31:
Template Configuration Keys Comment
The template configuration is a property file that has the name <template key>.properties and consists of
key/value pairs that build the configuration. Java properties are encoded using ISO 8859-1 character
encoding. Therefore, Unicode characters that cannot be directly represented in this encoding must be
escaped.
2. To configure additional MIME resources, for example, inline images or attachments, use the key
resource.<index>.<parameter>.
The index starts with zero and every resource has the same three mandatory parameters.
Table 33:
Resource Parameter Mandatory Comment
template=invitation.html
subject=${sender.displayname} has invited you to the Mobile Documents share "$
{name}"
resource.0.cid=logo
resource.0.name=logo.jpg
resource.0.contentType=image/jpeg
3. To use variables in HTML mail templates as placeholders, use the ${variablename} pattern for variables.
sender.displayname The display name (first name plus last name) of the inviting
user.
recipient.displayname The display name (first name plus last name) of the invited
user.
Example
To use the first name of the invited user in the salutation of the mail template: Hello $
{recipient.firstName}.
Applications can provide their own icons for the files they expose to SAP Mobile Documents. To use customer-
specific icons, you map the icon to a MIME type and upload the mapping file using the administration user
interface.
Prerequisites
You created an icon.json file as described in Creating an Icon.JSON File [page 72].
Context
To provide a flexible solution, the SAP Mobile Documents server can provide additional mappings of MIME types
to the corresponding icons for all SAP Mobile Documents apps. This is not only possible for MIME types, but also
for object types or even single objects. A mapping can also be restricted to certain repositories.
The naming convention for files ensures that the app-specific icon is used, if available. If none is available, no icon
is displayed.
Only the iOS app has a fallback solution: The server looks for a standard icon. If this is also not defined, then the
fallback icon is used, which is displayed for all unkown file types. This icon is also displayed in the following
situation: If you create a mapping to an already known MIME type, for which no icon can be found on the server,
the first fallback solution is to use the default icon for this MIME type. But if this icon does not exist, that is, the
MIME type is not known, the icon for unknown file types is used.
Procedure
1. Log on with an administrative SAP Mobile Documents user to the SAP Mobile Documents administration UI,
using the relevant URL for your region.
https://smd-<account_name>.<data_center>.ondemand.com/mcm/admin
You create an icon.json file using the elements, file syntax, and rules listed below.
Table 35:
Web App iOS App Android App Mac Desktop Windows Desk Windows Na
App top App tive App
-hdpi .scale-150
-xhdpi .scale-160,
-xxhdpi .scale-180
.scale-240
<file
name>.scale
-240.<ext>
The mapping is a rule that consists of one or more of the following key fields:
The key maps to a localized display name and app-specific or generic icon files.
Rules Engine
MIME type
Table 36:
mimeType An array of technical MIME types The values are case-insensitive, for example,
for which the rule is valid, for ex application/pdf is the same as "application/PDF".
ample, application/pdf. Parameters for mime types are not supported and cut
if existing, for example, text/plain;charset=us-
ascii.
Object type
Table 37:
objectType An array of IDs as defined in the The values are matched against the values of the men
CMIS property tioned CMIS properties of the object.
cmis:objectTypeId or
cmis:secondaryObjectTypeId
s, for example, cmis:document.
Object ID
Table 38:
objectId An array of IDs of a folder or a file, The option to define specific object IDs is only for use with
if the mapping should only be valid folders not with documents.
for certain objects, for example,
dRnMfRD5TJCCIQ6TU6aFM2jW8H
BrRKtqeWXp5NycGXs.
Repository
repository An array of IDs of the repository for If no value is specified, the rule is valid for all repositories.
which the rule should be valid, for
example,
be6348c15c552fc071e04515.
Display Name
Table 40:
names A map of localized display names Texts for all supported languages of SAP Mobile
where the key is a two-letter locale Documents should be provided, but the field is op
File Name
Table 41:
fileName A list of icon file names for the spe Possible keys: iOS, android, web, desktop, windows,
specific icon is specified for a app, The specified icon files, including the ones for the dif
for example, iOS : ferent resolutions, have to exist in the Settings reposi
iconInvoice.png. tory under the folder icons.
Mandatory field that must contain at least one key with
a value.
File Format
Code Syntax
{ "icons" :
[{ "mimeType" : ["...","..."],
"objectType" : ["...","..."],
"objectId" : ["...","..."],
"repository" : ["...","..."],
"names" : { "<locale>" : "...", ... },
Sample Code
{ "icons" :
[{ "mimeType" : ["application/invoice","application/order"],
"objectType" : null,
"objectId" : null,
"repository" : ["be6348c15c552fc071e04515"],
"names" : {"en":"Invoice", "de":"Rechnung"},
"fileName" : {"iOS":"invoice-iOS.png", "standard":"invoice.png"}
}]
}
Example 1
Rule 1: MIME type = application/invoice, file name = invoice.png
Rule 2: Object type = cmis:document, file name = document.png
Object: Object type = cmis:document, MIME type = application/invoice
Result: The invoice.png icon is used, because the MIME type is more specific than the object type.
Example 2
Rule 1: MIME type = application/invoice, file name = invoice.png
Rule 2: Object type = cmis:document, repository = 12345, file name = document.png
Object: Object type = cmis:document, MIME type = application/invoice, repository = 12345
Result: The invoice.png icon is used, because the MIME type is more specific than the object type and
repository restriction together.
Example 3
Rule 1: Object ID = abcd1234, file name = demo.png
Rule 2: Object type = cmis:document, MIME type = application/invoice, repository = 12345, file name =
invoice.png
Object: Object type = cmis:document, MIME type = application/invoice, repository = 12345, object ID =
abcd1234
Result: The demo.png icon is used, because the object ID is the most specific key element.
Example 4
Rule 1: Object ID = abcd1234, file name = demo.png
Rule 2: Object ID = abcd1234, file name = invoice.png
Object: Object ID = abcd1234
Result: Invalid state! Should have been prevented before the configuration became active. The app should use
neither of the icons, but display the default fallback icon of the app and log an error.
The administrator can, for example, delete users or recalculate how much of their quota they have used on the
SAP Mobile Documents server.
Procedure
1. Log on with an administrative SAP Mobile Documents user to the SAP Mobile Documents administration UI,
using the relevant URL for your region.
https://smd-<account_name>.<data_center>.ondemand.com/mcm/admin
For more information, see the Logon section in SAP HANA Cloud Platform Cockpit.
2. Choose USER DATA.
3. Select a search criterion from the dropdown list, for example, the logon ID, and enter the user's details.
Note
You can use asterisks (*) as wildcards.
4. To view a user's details, click any of the links underlying the user's logon ID, last name, first name, or e-mail
address.
The popup that appears shows the User Details, including the user's quota. To ensure that the quota value is
definitely up to date, choose Recalculate Usage. The second half of the popup shows the Repository Details for
this user.
Table 42:
ID Description
Home Repository ID ID of the My Documents repository of the SAP Mobile Documents instance.
Home Folder ID ID of the user's personal folder used for his or her My Documents.
Sharing Repository ID ID of the Shared Documents repository of the SAP Mobile Documents instance.
Sharing Folder ID ID of the user's personal folder used for his or her Shared Documents.
Settings Repository ID ID of the settings, which administrators can configure for the SAP Mobile Documents clients.
Settings Folder ID ID of the settings folder used for this user. There is, for example, a settings repository that enfor
ces app passcodes for mobile clients.
Administrators can use this field to assign a specific settings repository to a user.
Caution
Be very careful and only change these fields if you are very sure of what to do.
5. To delete a user, select the row with this user's data, then choose Delete.
Users are automatically added when they first log on to SAP Mobile Documents. Administrators can delete
users, for example, if a user has left the organization. This user's license is freed up and can be reassigned to
another user.
Note
To prevent the user from accessing any files, remove the User. To delete a user, select the row with this
user's role from his or her user profile in your identity management tool.
a. To delete the deleted user's documents from the repositories, select the Also delete user's documents
checkbox in the confirmation dialog.
b. Confirm the deletion with OK.
6. Save your entries.
SAP Mobile Documents enables you to leverage further use cases by enabling the consumption of corporate
content by your on-premise data management systems.
Procedure
Connectivity Service
SAP HANA Cloud Platform Console Client
Setting Up SAP HANA Cloud Platform Console Client
Configuring Destinations from the Console Client
Configuring Connections [page 79]
Prerequisites
Read the parameter list below and define the connections required for your SAP Mobile Documents scenario.
Procedure
1. Log on with an administrative SAP Mobile Documents user to the SAP Mobile Documents administration UI,
using the relevant URL for your region.
https://smd-<account_name>.<data_center>.ondemand.com/mcm/admin
For more information, see the Logon section in SAP HANA Cloud Platform Cockpit.
Display Name <DISPLAY-NAME> Arbitrary display name for the repository connection table to identify
the connection in the repository configuration.
Destination <DESTINATION- Destination name. See To upload a destination for a subscribed applica
NAME> tion... in the Uploading Destinations section of the SAP Mobile
Documents documentation.
Options Key1=Value1 The connection options are key-value pairs. You can use them to define
additional parameters or to override default values. For a detailed table
Key2=Value2 with all possible values, see below.
Related Information
SAP Mobile Documents enables you to set up one or more corporate repositories for your company, containing
company documents that are not owned by the app users.
Prerequisites
Ensure that the required connection for the Corporate Documents repository is available (see Configuring
Connections).
To connect to an on-premise SAP Knowledge Management system, the SAP Mobile Documents KM
Connector must be installed on the remote server. For more information, see SAP Mobile Documents KM
Connector.
If you are using SAP HANA Cloud Platform services and want to connect to an on-premise server that is not
already available over the Internet, you must configure the SAP HANA Cloud Platform Connector.
For more information, see the SAP HANA Cloud Platform documentation.
For the Pushed Content option, the following assumptions apply:
The administrator informs the content managers about the repositories that are pushed (including this
information in the repository description).
Content managers have at least write authorization for these repositories so that they can create, delete,
or update the content there.
Context
The corporate repositories are only displayed in the mobile apps or in a custom app built with the Software
Development Kit (SDK) that enables the function explicitly. In addition, you have the option to push content to a
corporate repository. That is, you can synchronize content on a user's device independently of the user's sync
settings for the respective content.
Procedure
1. Log on with an administrative SAP Mobile Documents user to the SAP Mobile Documents administration UI,
using the relevant URL for your region.
https://smd-<account_name>.<data_center>.ondemand.com/mcm/admin
For more information, see the Logon section in SAP HANA Cloud Platform Cockpit.
Connection <CONNECTION NAME> The dropdown box lists all available connections
defined in Configuring Connections plus the Local
Repository Connection used for SAP HANA Cloud
Platform document service repositories.
Note
Due to the tenant isolation in SAP HANA Cloud
Platform, the document service cockpit cannot
access or view repositories you create in SAP
Mobile Documents or vice versa.
Repository <REPOSITORY NAME> The dropdown box lists all available repositories for
the connection parameter.
Display Name <DISPLAY NAME> Predefines the name of the repository displayed in
the mobile app. To display a custom name for the
repository, adjust the setting.
Pushed Unselected checkbox (default) Defines whether the corporate repository contains
Content Selected checkbox pushed content.
Restricted To <role or a semicolon-separated Defines that only those users who have at least one
list of roles> of these roles can see the pushed content. For
other users the repository is not visible at all.
Show as Unselected checkbox (default) Defines that users who are not assigned any of the
corporate Selected checkbox UME roles that are specified in the Restricted To
content for field can see the repository.
other users
This checkbox is only displayed after the corporate
repository has been marked as Pushed Content, a
role has been specified in the Restricted To field,
and you have clicked into another field.
Enable Recycle Unselected checkbox Only available for Local Repository Connection.
Bin Default
Only if you enable the recycle bin for the repository
Selected checkbox
can the users restore deleted files and folders of
this repository.
Recycle Bin number of days Only available for Local Repository Connection.
Retention Time
If you leave this field blank, it will be displayed with Defines a time period in days after which the repo
(Days)
sitory will be emptied by a cleanup job. The maxi
a value of 0 the next time you open the Manage
mum retention time is 999 days. If you set the
Repository dialog for this repository.
number of days to 0, then the recycle bin will not
be emptied.
Settings Effect
The Pushed Content checkbox is not selected. Pushed content is not used. The repository is visible to all
The Restricted To field is empty. users as a corporate repository.
The Pushed Content checkbox is not selected. Pushed content is not used. The corporate repository is only
The Restricted To field contains the Reviewer role. visible to users who are assigned at least one of the roles listed
in the Restricted To field, in our example the Reviewer role.
The Pushed Content checkbox is selected. All users see the repository as pushed content.
The Restricted To field is empty.
The Pushed Content checkbox is selected. Users who are assigned the Reviewer role see the repository
The Restricted To field contains the Reviewer role. as pushed content. No other users can see the repository.
The Show as corporate content for other users
checkbox is not selected.
The Pushed Content checkbox is selected. Users who are assigned the Reviewer role see the repository
The Restricted To field contains the Reviewer role. as pushed content. All other users see the repository as a nor
The Show as corporate content for other users mal corporate repository.
checkbox is selected.
The apps use the repository information to determine which of the corporate repositories the current user can
view and which of these repositories are marked as pushed content:
Repositories that the current user cannot view are not included in the repository information.
Repositories that are marked as pushed content for the current user have the extension pushedContent:
"true" in the repository information. (Remarks: The value true has type string, not boolean. If a repository
is not marked as pushed content, the pushedContent extension is skipped. There is no such extension as
pushedContent: "false".)
Related Information
Root folder administrators can create subfolders and assign permissions to other users for accessing these
subfolders.
Prerequisites
Your SAP Mobile Documents administrator has set up an SAP HANA Cloud Platform document service
repository.
Your SAP Mobile Documents administrator has assigned the CMIS_ALL (All) permission for the respective
document service repository to you, that is, your user ID is listed in the Managed By field of the repository.
Context
Note
Due to the tenant isolation in SAP HANA Cloud Platform, the document service cockpit cannot access or view
repostories you create in SAP Mobile Documents or vice versa.
You can assign the following permissions, listed from the weakest to the most powerful permission:
Read: Permission to access files and folders and to read their properties, content, and ACLs.
File: Includes the Read permission and in addition the permission to change the children of the folder as well
as the parent of the node.
Write: Includes the File permission and in addition the permission to change the properties and the content of
the children as well as the parent of the node.
Delete: Includes the Write permission and in addition the permission to delete a file or folder.
All: Includes the Delete permission and in addition the permission to change the ACL.
Procedure
2. To create a subfolder in the document service repository, choose Create New Folder .
3. Enter the folder name and confirm with OK.
4. Select the subfolder and choose the Properties icon ( ) to view its properties.
5. Choose the Permissions icon ( ).
6. Choose Edit ( ).
7. Enter the e-mail addresses or the IDs of the users separated by semicolons.
8. Select the permission to assign to these users, and choose Add.
9. In the users list, you can change the permission for each user using the dropdown box.
10. To save your changes, choose Save.
Related Information
As an administrator, you have to allow users to access such files using the following settings:
Users must be allowed to disable their passcodes for SAP Mobile Documents.
To make files accessible in the extension, you have to set the security policy for the document provider in the
administration UI.
Related Information
Configuring the Security Settings and Security Policies for iOS [page 52]
Recycle bins are repository-specific. Your administrator can activate bins for one or more repositories. A recycle
bin contains only the files and folders that were deleted in a specific repository. If you do not restore the objects,
they will be cleaned up automatically after a period of time defined by your administrator. In addition, you can also
permanently delete selected files and folders or all content from a repository recycle bin.
You cannot update a deleted file or create a new version for it unless you restore it first.
Files and folders in the recycle bin must be restored before you can edit or download them.
You can only restore a complete folder with all its content, not parts of it.
If file name conflicts occur, the restore operation fails with a name constraint violation. You have to ensure
manually that no file with the same name exists in the original location. Folders with the same name will be
merged if they do not contain files or folders with the same name.
You find restored files and folders in their former location, that is, the repository that you deleted them from.
The content of the recycle bin is not added to your user quota, but is automatically deleted after a specified
period of time.
The recycle bin contains entries for the following repository types:
My Documents
Deleted files and folders can only be accessed by their owner. You can restore files and folders until the
recycle bin is automatically cleaned up, for example, for a 30-day period.
Shared Documents
Deleted shares, files, and folders can only be restored by their owner. If a share is deleted, it loses all its
properties. Even if you restore it, it remains a plain share without members or public link settings. The share
To activate the recycle bin and set the retention time for the files and folders, see the relevant sections for the
respective repositories:
Administrators can use document classification to control which actions are available to users in the different SAP
Mobile Document apps, based on the document confidentiality level.
The SAP Mobile Documents solution enables users to access corporate documents from a variety of apps,
including a desktop app, a Web app, an iPhone or iPad app, and an Android app. As mobile devices often leave the
company premises and the Web app might be accessed from outside the corporate network, you want to restrict
the possible actions that can be performed on corporate documents based on their document classification.
Therefore, SAP Mobile Documents supports enforcing a secure container for confidential documents.
Security policies based on document classification determine the allowed actions. Therefore, administrators can
control the available actions in the apps, for example, whether a document can be printed, e-mailed, or opened
using a specific program. The policies only apply to documents and repositories, not to folders.
Note
SAP Mobile Documents can only guide the users by providing a security-compliant solution. It cannot prevent
the intentional violation of security policies by users, for example, by taking screenshots.
Currently, document classification supports a fixed set of security classifications for repositories only. The
administrator classifies the confidentiality level for one or all repositories by choosing one of the predefined
confidentiality levels in the app settings of the administration UI:
Strictly Confidential
Confidential
Internal
Customer
Public
The SAP Mobile Documents server adds the confidentiality level as a property to each document. In combination
with the security policies, the effect for the users is that they can still see the disabled action, but it is grayed out
and cannot be executed for the selected document.
In SAP Mobile Documents, administrators use a combination of security policies and the document classification
level of the repositories to define which actions are available to users in the mobile apps.
The security policies are defined for mobile apps in the administration UI. The following policies are available for
the iOS app and the Android app:
Disable Open
Disable Sync
Disable Print
Each of these policies can be disabled for certain document classification levels with the following choice of
settings:
The analyst UI provides an impression of how the users and the user apps use the system. Analysts either use the
dashboard to get an overview of the system usage or they export the raw data file in XML format to carry out
further evaluations of the data.
Prerequisites
To enable data collection, a user with the Administrator role must have activated logging by selecting the
Statistics Data checkbox under SETTINGS General Logging .
You are assigned the Analyst role.
Procedure
1. Log on with an administrative SAP Mobile Documents user to the SAP Mobile Documents administration UI,
using the relevant URL for your region.
https://smd-<account_name>.<data_center>.ondemand.com/mcm/admin
For more information, see the Logon section in SAP HANA Cloud Platform Cockpit.
2. On the STATISTICS page, choose either General Statistics or Usage Statistics.
The General Statistics page displays the same information as the HOME page.
3. On the Usage Statistics page, choose a time interval and a repository from the respective dropdown lists.
4. To display the usage statistics, choose Show Dashboards.
5. To export the data to a file, choose the file format Export Raw Data (xml), Export Raw Data (json), or Export
Raw Data (csv).
The download evaluates the entries in the dropdown boxes and exports a file accordingly.
Results
The XML file contains entries that are created per day, per user agent (usually apps), and per repository. An entry
contains the following data:
The dashboard displays the same data, but the data for newly created and updated documents is shown in a
single graph.
Related Information
You can develop your own clients or servers for SAP Mobile Documents using the respective developer's guide.
Related Information
To develop your own clients, you need to be familiar with the architecture of SAP Mobile Documents, the CMIS
open standard, and its SAP Mobile Documents extensions.
You can develop your own clients that connect to the SAP Mobile Documents server or you can integrate SAP
Mobile Documents functionality into existing platforms.
Related Information
9.1.1 Architecture
The main components of the SAP Mobile Documents solution are the clients, the server, and the document
repositories.
To ensure interoperability and extensibility, the OASIS standard CMIS (Content Management Interoperability
Services) is used for all document-related communication between the clients and the server as well as between
the server and the repositories. In the current version of the solution (1.0 SP2), we deliver clients for the desktop
(Windows and OS-X), for mobile devices (iPhone, iPad, and Android phones), and a JavaScript-based Web UI.
As well as connecting additional (corporate) repositories to the server, SAP Mobile Documents offers dedicated
repositories to the clients:
CMIS (Content Management Interoperability Services) is an open standard that defines a common interface for
various operations offered by content management systems. CMIS defines a domain model and operations for
different binding types.
CMIS is language-independent, which gives it a significant advantage over other specifications, and many vendors
offer (or are going to offer) CMIS interfaces to their systems. In addition, CMIS client libraries already exist in
different programming languages. Many of them are available as Open Source implementations under the
To develop an app or to integrate SAP Mobile Documents functions, developers need to familiarize themselves
with CMIS and Apache Chemistry. If you are a Java developer, OpenCMIS is the tool of choice. Many of the
examples in this guide are based on using OpenCMIS to connect to the SAP Mobile Documents server.
Related Information
Apache Chemistry
OpenCMIS Client API Developer's Guide
CMIS 1.1 Specification on OASIS Web page
Document objects
Folder objects
Relationship objects
Policy objects
Item objects
Currently, SAP Mobile Documents supports only document and folder objects.
A document object is an item of content. The document can have a content stream, which is the actual file
associated with the document. A content stream exists only as part of its containing document object. A content
stream has a mime type associated with it. A document object may contain one or more renditions, which are
alternative views of the content. Document objects are the only objects that are versionable. Each version of a
document has its own object ID. All the versions of a document make up a version series and share a version
series ID. You can create, read, update, and delete documents using OpenCMIS methods.
A folder object is a container used to organize the document objects. A repository has one root folder. All other
folder objects have one parent folder. A folder has a folder path representing its place in the repository's folder
hierarchy. A folder object can have renditions. For example, a folder can have a thumbnail as a rendition
representing the contents of the folder.
SAP Mobile Documents supports two of the three binding types defined in CMIS 1.1: the AtomPub and the JSON-
based browser binding.
This means that you can connect apps with both bindings. It also means that you can connect repositories to the
server that offer one of the two binding types. If you are developing a new app or an extension, opt for the new
browser binding if it is technically feasible, since it has better performance.
For more information about the bindings, see the CMIS 1.1 specifications for AtomPub Binding and Browser
Binding.
<protocol>://<server>:<port>/mcm/json
<protocol>://<server>:<port>/mcm/atom
<protocol>://<server>:<port>/mcm/b/json
<protocol>://<server>:<port>/mcm/b/atom
The "/b" after the context root "/mcm" means that the server requests BASIC authentication.
Related Information
SAP Mobile Documents apps can use the repository information to connect to a repository.
For each repository, the server provides repository information (RepositoryInfo) that describes a repository's
general information and its capabilities. When a app calls a binding service URL without parameters, it gets a list of
RepositoryInfo objects, one for every repository that is connected to SAP Mobile Documents. Apps can then
use the repository ID and the provided navigation information to connect to one of the repositories.
For more information, see the OASIS Web page for getRepositoryInfo.
If you send a GET request to the service URL for AtomPub (/mcm/atom), you get the service document XML,
which contains service definitions and a list of repositories. If you send a GET request to the service URL of the
browser binding (/mcm/json), the server responds with a JSON representation of a list of RepositoryInfo
objects.
Example
Getting the list of RepositoryInfo objects with OpenCMIS
For examples of basic operations such as reading, creating, updating, and deleting objects and folder navigation
with OpenCMIS, see the OpenCMIS Client API Developer's Guide.
Related Information
SAP Mobile Documents comes with CMIS enhancements to enable secure and smooth document management.
The following enhancements are available and are described in the following topics:
The following CMIS enhancement is used to connect to the SAP Mobile Documents server.
To open a session with exactly one repository in an OpenCMIS client, specify a set of session parameters. Then,
connect to the SAP Mobile Documents server.
Example
For examples of basic operations such as reading, creating, updating, and deleting objects, and folder navigation
with OpenCMIS, see the OpenCMIS Client API Developer's Guide.
Let's take a closer look at the AUTHENTICATION_PROVIDER_CLASS session parameter as specified in the
example above. This parameter tells the session to use your custom authentication provider instead of the default
one. In SAP Mobile Documents, using a custom authentication provider is mandatory for the following reasons:
To use SAP Mobile Documents, the app must set cookies in the HTTP header. As the OpenCMIS Java client
hides specifics to bindings and HTTP calls, you cannot set an HTTP request header directly, but you can use
additional headers, which the OpenCMIS Java client provides for the HTTP calls it executes.
Specify a Java class (in the example below it is called CustomAuthenticationProvider) that implements
the org.apache.chemistry.opencmis.commons.spi.AuthenticationProvider interface and
overrides the getHTTPHeaders(String url) method. During an HTTP call to the server,
getHTTPHeaders() is invoked and arbitrary headers can be added to the HTTP request.
Related Information
The SAP Mobile Documents server offers a token-based mechanism to protect against cross-site request forgery
attacks.
Note
The CSRF protection was simplified with SP02. The differences are as follows:
The token is no longer repository-specific. It is valid for a session and for any repository that is connected
within that session.
The token can be fetched with HTTP headers. It is no longer necessary to parse RepositoryInfo.
The HTTP header name was changed to harmonize it with other SAP product names.
With the exception of the call to the service URLs, all calls to the SAP Mobile Documents server require a valid
CSRF token. For the call to the service URLs, the token is provided as an HTTP header (as of version 1.0 SP02). All
other requests require the apps to send the token value via the CSRF-token HTTP header. If the app does not
supply a token or if the token has expired, the server sends the HTTP response 403: INVALID_TOKEN_PROVIDED.
1. When the app creates a session and connects to the server, it first calls getRepositoryInfos. To fetch a
CRSF token, the app must send a request header called X-CSRF-Token with the value fetch in this call.
2. The server generates a token, stores it in the user's session table, and sends the value in the X-CSRF-Token
HTTP response header.
3. The app reads the value of the X-CSRF-Token HTTP response header and stores it for later use.
4. For each call in this CMIS session, the app sends the token value it obtained from the X-CSRF-Token HTTP
header.
Example
Extracting the token with HTTP and browser binding
Example
Token handling in Authentication Provider
Because OpenCMIS executes a call to get the RepositoryInfos when a session is created, this
AuthenticationProvider adds the X-CSRF-Token=fetch HTTP request header. Then the server sends the
In JavaScript-based applications, you first read the repository info by sending a GET request to /mcm/json. Every
other repository contains a token for the communication with this /mcm/json repository. In the following
example, jQuery is used to read the token and set it for all subsequent AJAX requests.
Because the repository ID is a parameter when creating a session with an OpenCMIS client, a app would open a
session on the server for each repository. To avoid multiple server sessions for the same app, we highly
recommend using the same server session for multiple CMIS sessions by re-using the cookies that are used for
the state management between the apps and the server.
To do this, use a static CookieManager instead of one cookie per instance. If a app application opens several
sessions for the same user, it must use the same authentication provider with the static CookieManager.
Additionally, it has to override the putResponseHeaders() and getHandleCookies() methods as described in
the following example.
Overriding the getHandleCookies() method has the effect that the COOKIES session parameter is ignored.
Example
9.1.3.3 My Documents
Every SAP Mobile Documents user has their own home folder in the My Documents repository.
To enable clients to easily get the home folder, the repository used to store the My Documents repository contains
a CMIS extension called myDocuments (namespace: http://www.sap.com/mcm; name: myDocuments). The
value of this extension contains the ID of the home folder of the currently logged-on user. A repository with this
extension is easily identifiable as the My Documents repository.
Example
Getting the My Documents repository
Example
Getting the user's home folder
Example
Getting the user's home folder with browser binding and jQuery
// read repositoryInfos
jQuery.getJSON("/mcm/json").done(function(data){
for(id in data) { // loop repositories and find myDocuments
if(data[id].myDocuments) {
$.ajaxSetup({ // set token for following calls
beforeSend: function(xhr) {
xhr.setRequestHeader("x-token",data["4caf284f-81f4-4b2a-
a77a-3fe7112339c2"].token);
}
});
// read the home folder and alert its displayname
var homeFolderId = data[id].myDocuments;
jQuery.getJSON("/mcm/json/4caf284f-81f4-4b2a-a77a-3fe7112339c2/root?
cmisSelector=object&objectId="+homeFolderId).done(function(data)
{
alert(data.properties["cmis:name"].value);
});
}
}
});
The following table clarifies the terms used to implement Shared Documents.
share The root folder that is used for collaboration with other users. It can contain folders and files. Users
can create any number of shares (until their quota is used up).
owner The user who creates the share automatically becomes its owner. The share's size is billed to the
owner's quota.
public link A link that can be applied to a share, to folders, or to files residing in the share. The link makes the
share, the folder, or the file available to anonymous users.
member Any user that has one of the defined roles for the share and can access it.
For each share, the following roles are available. The table below maps these roles to the respective CMIS
permissions.
administrator Permission to delete a share, to manage user rights, and to allow public cmis:all
links.
contributor Permission to create, to update, and to delete files and folders. This per sap:delete
mission also enables the user to create and to delete public links.
Similar to the My Documents repository, every user has their own personal sharing home folder. Beneath this
home folder are the shares of the user. The ID of the sharing home folder is specified in the RepositoryInfo with
the sharing extension.
If public links are enabled, there are some general settings with which every public link must comply. These
general settings are transported as CMIS extensions in the RepositoryInfo of the sharing repository. In
addition to the general settings, every public link has its own set of properties, where a user can define validity and
security for this public link. In any case, a user is only allowed to define values that are stricter than the general
ones defined by an administrator. If, for example, an administrator defines a minimum password length of four
characters, the user can only choose to use a password with more characters. The user cannot choose to use less
than four characters or even no password at all.
Table 50: CMIS Extensions (on RepositoryInfo Level, Valid for All Public Links)
Name Description Type
sharing Similar to the mydocuments extension, this extension contains the ID of String
the user's Shared Documents home folder.
sharing.uploadAllo Indicates whether the administrator allows uploads by anonymous users or Boolean
wed not.
sharing.baseURL Contains the base URL of the public sharing Web link. The app can use this String
information to create a public link by appending the object ID of the public
link to this base URL.
sharing.maxEpirati The administrator can define the maximum period in days for which anony int
onDays mous users can access a shared folder. This extension contains the num
ber of days.
When a public link is created, the expiration date must not be later than the
current date plus the number of days specified. If the value is 0, no expira
tion date is predefined.
sharing.minPasswor For values greater than 0, the user must set a password for the public links int
dLength of this share. This password must be longer than or of the same length as
the value of this extension.
Table 51: CMIS Extensions (on Folder Level, Valid for All Shares)
Name Description Type
owner.isOutOfSpace Indicates whether the share owner has enough quota left to upload files to Boolean
the share.
You can use app operations for shared documents in SAP Mobile Documents.
To list all shares that a user can access (with any of the roles specified for share access), the app sends a query to
the server. Since shares have the specific mcm:share CMIS type the query is simply: select * from
mcm:share. The result is a list of all shares where the calling user has an entry in the share's access control list
(ACL).
Creating a Share
Shares must be created under a user's sharing home folder. They have the specific mcm:share type with the
cmis:folder base type.
Members are entries in a share's access control list (ACL). An ACL is a list of ACEs (access control entries) that
consist of a principal ID and a list of permissions. The permissions are listed in the roles table in Shared
Documents.
For on-premise installations, the principal ID is a user's unique ID, for SAP HANA Cloud Platform it is the user's
logon ID. You can pass the ACL as an input parameter while creating a share or modify the ACL by calling the
applyAcl CMIS service on an existing share.
When adding a new member to a share, the share administrator wants to use known user attributes, for example,
the name or the e-mail address, but not the user ID. To help apps to search for users and to assemble an ACL with
the correct IDs, SAP Mobile Documents offers a REST API (see REST API).
In the members overview for a share, apps should display user names rather than IDs. To prevent extra server
roundtrips or extra non-CMIS APIs, OpenCMIS offers the possibility to add generic extensions to various objects.
When a app reads the members of a share, technically this is a getObject operation (with ACLs included) on the
folder representing the share. The ACL is a list of ACEs and each ACE contains a principal object. OpenCMIS only
defines an ID for a principal; additional attributes can be added as extensions. The server extends the principal
object with an extension called principal that has the following children as extensions:
_firstName
lastName
email
displayName
logonId
Example
Example response of an ACL with a single contributor.
{
"acl": {
"aces": [
{
"principal": {
"principalId": "USER.PRIVATE_DATASOURCE.un:testuser",
"principal": {
"firstName": "Manfred",
"lastName": "Mustermann",
"email": "Manfred.Mustermann@sap.com",
"logonId": "testuser",
"id": "USER.PRIVATE_DATASOURCE.un:testuser",
"displayName": "Manfred Mustermann"
}
},
"permissions": [
"sap:delete"
],
"isDirect": true
}
]
},
"exactACL": true
}
To make a share accessible to external users using a public link, it must be given a CMIS secondary type called
mcm:publicLink. CMIS defines the standard multi-value cmis:secondaryObjectTypeIds property that can
contain 0..n secondary type IDs. To make a share public, the mcm:publicLink ID must be added to the
cmis:secondaryObjectTypeIds.
Secondary types contain a set of properties that can be attached or detached from an object. Public links have
properties, for example, a password or an expiration date.
Table 52:
Name Description ID Namespace Type
Valid to Defines the date after which the shared documents in this folder mcm:validTo com.sap.mcm DATE
Date are no longer accessible for anonymous users. The creator of the Date TIME
share can still access it.
Share Can be used to protect the access to the shared file with a pass mcm:share com.sap.mcm String
Password word. Administrators can enforce the setting of a password. Password
Note
Because the server never exposes the hashed password to the
apps, the server returns "null" as a value if no password has
been set for an existing folder. If a password has been set the
value is an empty string.
Public Controls whether anonymous users have write access to shared mcm:enableUp com.sap.mcm Boolean
write ac documents. If set to Yes, anonymous users are allowed to create, load
cess update, or delete documents within the share.
Table 53:
Name Description ID Namespace Type
Valid to If users enter the wrong password, they are not allowed to ac mcm:validFrom com.sap.mcm DATE
Date cess the share until the time set in the value of this property. Date TIME
The administrators can configure a default for this setting.
Share Indicates the owner of the share. If quota is enabled, everything mcm:shareOwner com.sap.mcm String
Owner within this share is counted in the owner's quota.
Example
Code Samples: OpenCMIS
Example
Code Samples: JavaScript / jQuery
Apps can only determine the quota and the used disc space of their own logged-on user. However, in the context
of sharing, apps typically also upload files to shares of other users. In this situation, the user who wants to upload
files is not the share owner. It is not possible to get the quota information of another user, but it is possible to
determine if the share owner has enough quota left to upload more files. apps can and should use this information
to inform the user that no more uploads are allowed and to avoid triggering uploads to this share. For all shares
that are folders of type mcm:share the server provides a CMIS extension named owner.isOutOfSpace.
Corporate repositories can have a configured root URI that clients use as a start folder in a repository.
For more information on the root URI, see Configuring Corporate Documents Repositories.
To set the root URI, you configure a path, for example, /folder1/folder2; clients should initially display the
folder structure beneath this path instead of displaying the contents of the root folder. If you configure a root URI,
it is transported to the clients similarly to the user's home folder of My Documents as an extension containing the
ID of the configured path. The extension's name is corporate, so you can apply the same example code as in the
My Documents example. You only need to replace the extension name myDocuments with the extension name
corporate.
Related Information
In general, SAP Mobile Documents adheres to the exception behavior described in the CMIS specification. If the
exception is used to express incorrect user entries, SAP Mobile Documents uses specific messages in the
exception text.
CmisPermissionDeni INVALID_TOKEN_PR The app must provide a token in every operation except
edException OVIDED getRepositoryInfos. If no token or the wrong token is provided, this ex
ception is thrown.
CmisInvalidArgumen PASSWORD_NOT_SET Thrown when creating a public link without a password if the administrative
tException settings require a password.
CmisInvalidArgumen PASSWORD_TOO_SHO Thrown when creating a public link if the provided password does not meet
tException RT the requirements specified in the administrative settings.
CmisInvalidArgumen SHARE_LOCKED<unl Thrown when a password-protected public link is currently locked because
tException ock_date_in_ms> it was accessed with a wrong password. The exception key is followed by
the date when the public link is accessible again (in milliseconds from
1970/1/1).
CmisInvalidArgumen EXPIRATION_DATE_ Thrown when creating a share. The expiration date for the share is a link
tException IN_PAST with a validToDate in the past.
CmisConstraintExce QUOTA_EXCEEDED The quota for the currently logged-on user is used up. No write operations
ption are allowed until the user frees up some space.
CmisConstraintExce Virus When uploading a document, the repository can reject the document if a
ption virus is detected. If the app tries again to upload this document to the
VIRUS
server, the same exception is thrown. Therefore, the app should not retry
virus uploading the document.
User Validation
With this API, apps can validate the existence of principals using attributes. A principal is a user management
object, for example, a user, a group, or a role. The response contains JSON representations of the found principal
Note
For on-premise installations of SAP NetWeaver, principal search uses the user management engine (UME) and
supports the logon ID and the e-mail attributes. For SAP HANA Cloud Platform, principal search currently only
supports the logon ID attribute.
Table 55:
Title Validate Users
URL /mcm/rest/v1/users/validate
Method GET
1...n term parameters are possible. Note that a URL including parameters must not exceed
2000 characters.
{
"foundPrincipals": {
"displayName": "Horst
Sapbox",
"email": "admin@mobidocs.de",
"firstName": "Horst",
"id": "admin",
"lastName": "Sapbox",
"type": "USER"
},
"nothingFoundFor": "d736367"
}
{
"foundPrincipals": [
{
"displayName": "Horst
Sapbox",
"email": "admin@mobidocs.de",
"firstName": "Horst",
"id": "admin",
"lastName": "Sapbox",
"type": "USER"
},
{
"displayName": "Heinz
Ketchup",
"email": "user1@mobidocs.de",
"firstName": "Heinz",
"id": "user1",
"lastName": "Ketchup",
"type": "USER"
}
],
"nothingFoundFor": [
"d736367",
"admin1"
]
}
Error Response Code 400 for bad requests, for example, parameters contain invalid characters.
Code 403 for unauthorized requests, for example, user has no permission to call this
URL.
You can build URLs that perform actions in the SAP Mobile Documents app and that can be used for app-to-app
integration or as links in e-mails.
These URLs are either custom URLs (mobiledocs://) or HTTP URLs. Not all apps support both types. In
addition, there is a distinction between URLs for links for share members and URLs for public links, which can be
accessed by anyone who receives the link (and the password, if any).
App Support
URL Type Web App iOS App Android App Windows Desk Mac Desktop Windows Na
top App App tive App
Custom URL x x x
HTTP URL x x
Action Comment Web App iOS App Android App Windows Mac Desktop Windows Na
Desktop App App tive App
mobiled
ocs://v
1/
select?
rep=123
4567890
&obj=09
8765432
1
https:
//
myhost:
8080/mc
m/
browser
/v1/
select?
rep=123
4567890
&obj=09
8765432
1
mobiled
ocs://v
1/open?
rep=123
4567890
&obj=09
8765432
1
https:
//
myhost:
8080/mc
m/
browser
/v1/
open?
rep=123
4567890
&obj=09
8765432
1
mobiled
ocs://v
1/
present
?
rep=123
4567890
&obj=09
8765432
1
mobiled
ocs://v
1/
configu
re?
server.
url=htt
ps://
myhost:
8080
https:
//
myhost:
8080/mc
m/
browser
/v1/
create?
rep=sha
re
Note
You cannot use the obj and the path parameters in the same URL.
mobiledocs://<version>/<action>?parameters
This URL opens the document with the CMIS object ID 1234 from the SAP Mobile Documents repository with
ID abcdef, using version v1 of the SAP Mobile Documents URL scheme and the open action.
http(s)://<server>:<port>/mcm/browser/<version>/<action>?parameters
Example
https://myhost:8080/mcm/browser/v1/select?rep=1234567890&obj=0987654321
This URL starts the Web app and triggers navigation to the repository 1234567890. The URL then opens all
possible subfolders until object 0987654321 is found. The URL selects this object. The select action does not
differentiate between folders or documents. The respective object is selected in the documents list of SAP Mobile
Documents.
http(s)://<server>:<port>/mcm/public/<version>/<action>?parameters
Example
https://myhost:8080/mcm/browser/v1/select?rep=1234567890&obj=0987654321
For shares with a public link, the share properties only show the URL for share members because the public link is
already available using the link icon ( ).
For an object (folder or file) in a share with a public link, the object properties show the Public URL of the Folder or
Public URL of the Document, as this link is currently not available elsewhere.
Path handling for shares is explicitly switched off, as the user ID would have to be a visible part of the URL, which
is not wanted. In addition, the caller (who is creating the URL and calling it) cannot determine the ID of the user
who owns the share that is addressed.
For objects under My Documents, the user ID must also be part of the URL as stated in the CMIS specification.
However, apps parsing the URL know which ID must be used in the path: the ID of the logged-on user. Therefore,
the path does not need to contain the user ID. When the apps parse the URL, they add the user ID to the beginning
of the path. With this adjusted path, getObjectByPath() works.
Example
The apps receive the following URL:
http://myhost:8080/mcm/browser/v1/select?rep=mydocuments&path=/folder1/folder2
The apps use the following URL to send the getObjectByPath() request:
http://myhost:8080/mcm/browser/v1/select?rep=mydocuments&path=/UserID/folder1/
folder2
Related Information
You can display an SAP Mobile Documents folder in the SAP Fiori launchpad as an embedded element.
Prerequisites
In the SAP HANA Cloud Platform cockpit, the administrator who will perform the below settings is assigned
the Admin role for SAP Mobile Documents.
In the SAP HANA Cloud Platform cockpit, all users who are allowed to access the SAP Mobile Documents
folder are assigned the User role in the mobiledocs app.
In the SAP HANA Cloud Platform cockpit, the SAP Fiori launchpad app is subscribed to the mobiledocs app
and vice versa.
In the SAP HANA Cloud Platform cockpit, users are maintained for the subscriptions. For more information,
see Mapping Users or Groups to Roles (Subscriptions).
Procedure
If your company does not use the automatic server URL configuration available with a Mobile Device Management
(MDM) solution, you can supply the server URL for the SAP Mobile Documents app using a URL scheme and
provide this URL scheme to your users.
The URL scheme syntax for configuring the server URL is:
mobiledocs://v1/configure?server.url=<http(s)>://<host>(:<port>)
Example
mobiledocs://v1/configure?server.url=https://mobiledocs.example.com
This URL configures the server URL https://mobiledocs.example.com of the SAP Mobile Documents app.
You can use your ABAP system as a content source for SAP Mobile Documents.
With an ABAP system as a content source, you can easily access documents stored, for example, in SAP ERP
system repositories. These documents are then available like any other repository file and can be downloaded to a
mobile device for offline access.
Related Information
The SAP Mobile Documents ABAP connector enables ABAP applications to expose a CMIS interface to SAP
Mobile Documents.
Content stored and/or managed in an ABAP system can be retrieved using the SAP Mobile Documents runtime
by any CMIS client. The ABAP CMIS server can provide any kind of folder hierarchy and any kind of metadata.
Both can be mapped to an existing back end or can be virtual and assembled at runtime. The current connector
version only allows reading of data.
The SAP Mobile Documents ABAP connector consists of two parts. The connector provides an ABAP interface
and helper classes to build a CMIS 1.1-compliant server. The data is provided by RFC to the SAP Mobile
Documents server. The other part resides in the SAP Mobile Documents server. It accepts calls from a CMIS
client, converts the data, calls the appropriate RFC, converts the response, and sends it back to the client.
The SAP Mobile Documents ABAP connector connects the SAP Mobile Documents runtime to the SAP ERP
system.
Whenever possible, document content is not routed through SAP NetWeaver AS for ABAP. If content is stored in
an external document store and if that store provides an HTTP interface, the content can be directly pulled from
that store. In this case, the SAP Mobile Documents ABAP connector implementation must provide a URL to the
document instead of sending the content. This allows content streaming and handling of large documents.
To provide documents, content, folder hierarchies, and metadata to SAP Mobile Documents, you must implement
the SAP Mobile Documents ABAP connector.
This interface adheres closely to the CMIS 1.1 specification, that is, there is a method for each CMIS operation.
Each method takes the same parameters and returns data structures similar to those described in the CMIS
specification. There are only a few instances where the input and output deviate from the specification, either to
avoid technical restrictions or to enable optimizations.
The connector allows you to use the full fidelity of the CMIS standard. This freedom increases complexity in some
areas, specifically to the data structures. To mitigate the complexity, the SAP Mobile Documents ABAP connector
also provides an abstract class that implements the interface. It provides convenience code for several methods.
That is, for most scenarios you only have to implement a small set of methods; the abstract class covers
everything else, but can be overridden where necessary.
Tip
We strongly recommend that you extend this abstract class instead of implementing the interface directly.
Additionally, helper and factory classes are provided. These help fill the data structures. Among other things, the
factory provides CMIS-compliant type definitions for documents and folders and provides repository info data
structures for the most common use cases. There is also a simple query parser for the CMIS query language.
To provide a full-featured CMIS interface, some enhancements to the CMIS specification were necessary.
CMIS specifies some recursive structures that cannot be directly mapped to ABAP.
If you are dealing with treelike structures, for example, the extensions, then the corresponding structure contains
two additional fields named TRANSPORT_ID and TRANSPORT_PARENT_ID. With these two fields, you can create
the tree as a flat structure. The transport ID can be any string-like value. You must not set a transport parent ID
for the root element. If you set a transport parent ID it must exist, otherwise the element is discarded as it cannot
be mapped to a parent.
The property structure in CMIS defines only a table of value objects, which can be of any type.
The ABAP implementation of the property structure is different; there is a table containing not single values but
value structures.
Each value structure contains fields for the following data types:
string value
boolean value
int value
decimal value
date time value
Table 58:
Property Type Value Field
boolean BOOLEAN_VALUE
string STRING_VALUE
id STRING_VALUE
integer INT_VALUE
datetime DATE_TIME_VALUE
decimal DECIMAL_VALUE
html STRING_VALUE
uri STRING_VALUE
The repository info has an additional field that contains information about the implementation capabilities.
Currently, the structure that is used in this field contains two values. These contain information about the content
delivery abilities of the repository. The content delivery behavior is determined by what the repository returns for
these values. See the table below for more information.
DEFAULT_CONTENT_DELIVERY
Table 59:
Value Comment
document_specific Content is delivered as stated in the export parameter of the create_document method. To deliver
the content using a URL, use this option.
DEFAULT_CHUNK_SIZE
If the content is delivered in chunks, set the default chunk size for this parameter. The chuck size should not
exceed 1 MB. Chuck sizes over 16 MB are not supported.
The CL_CMIS_PROPERTY_IDS class contains constants for all property IDs that are defined in the CMIS 1.1
specification.
All other constants and enum values used in the specification can be found in the CL_CMIS_CONSTANTS class.
Example
Using Constants
ls_property = cl_cmis_object_factory=>create_string_prop_single
( iv_property_id = cl_cmis_property_ids=>created_by
iv_value = 'Joe'
).
9.2.2.3 Exceptions
The CMIS exceptions defined in the standard are assigned to specific ABAP exceptions. These exceptions are
passed on to the respective app.
Table 60:
CMIS Exception ABAP Exception
invalidArgument CX_CMIS_INVALID_ARGUMENT
notSupported CX_CMIS_NOT_SUPPORTED
objectNotFound CX_CMIS_OBJECT_NOT_FOUND
permissionDenied CX_CMIS_PERMISSION_DENIED
runtime CX_CMIS_RUNTIME
constraint CX_CMIS_CONSTRAINT
contentAlreadyExists CX_CMIS_CONTENT_ALREADY_EXISTS
filterNotValid CX_CMIS_FILTER_NOT_VALID
nameConstraintViolation CX_CMIS_NAME_CONSTRAINT_VIOLATION
storage CX_CMIS_STORAGE
streamNotSupported CX_CMIS_STREAM_NOT_SUPPORTED
updateConflict CX_CMIS_UPDATE_CONFLICT
versioning CX_CMIS_VERSIONING
Read
The GET_CONTENT method can deliver document content in different ways. It can either provide an HTTP URL to
the content or provide the content itself as one or more xstrings.
If a URL is provided, the SAP Mobile Documents server tries to retrieve the content directly from that URL. Keep in
mind that the server must be able to reach the URL and must be authorized to retrieve the content.
If no URL is provided, the SAP Mobile Documents server forwards the content sent in the STREAM export
parameter. If the parameter contains the full content, set the HAS_MORE export parameter to false.
We recommend that you only transfer content of up to 1 MB in this way. The maximum size is 15 MB. Transfer
larger content in chunks. In this way, the GET_CONTENT method only returns the first few bytes in the STREAM
parameter and sets the HAS_MORE parameter to true. The SAP Mobile Documents server then calls the
GET_CONTENT method again with an offset pointing to the next byte after this chunk. The server repeats the call
until the entire content is transferred and HAS_MORE is set to false. To the clients, this looks like one continuous
stream.
Note
The size of a chunk should not exceed 1 MB and must not exceed 15 MB.
The GET_CONTENT method must supply a MIME type for the content. If no MIME type is provided and the content
is pulled from an external store using HTTP, the MIME type provided by the external store is used (HTTP header
Content-Type). If the content source does not provide a MIME type, application/octet-stream is used.
Similarly to the GET_CONTENT method, there are also different ways to create content. The content can be
delivered as one xstring, it can be directly pushed to an HTTP URL, or it can be delivered in chunks. The method
that the repository supports can be expressed with the repository info (see Repository Info (Cloud) [page 124]).
The flow differs depending on the chosen method:
full
In this case, CREATE_CONTENT receives the full content as an xstring within the IS_CONTENT structure and
the HAS_MORE parameter is set to false. The implementation only needs to return the new object ID using the
EV_OBJECT_ID parameter. Use this method if you expect small content (<1 MB, max 15 MB).
chunked
In this case the content is delivered in chunks, the CREATE_DOCUMENT method is called, and the first chunk is
transported using the IS_CONTENT structure. If there is only one chunk, the HAS_MORE parameter is set to
false. If the HAS_MORE parameter is set to true, the CREATE_CONTENT method is then called. The same logic
as for the CREATE_DOCUMENT method applies to the CREATE_CONTENT method: If the HAS_MORE parameter is
set to true, it is called again until the complete content is transferred, as indicated by the HAS_MORE
parameter. In this case it is sufficient for the CREATE_DOCUMENT method to return the object ID using the
EV_OBJECT_ID parameter. Use this method if you expect medium-size content (<100 MB).
document_specific
In this case the CREATE_DOCUMENT method is called with only the document metadata and without content.
The repository must also ensure that the properties are saved and an empty document is created. In addition,
the repository has to send back the ES_CONTENT_DELIVERY_INFO structure that contains the information
on how to deliver the content. If you choose to deliver the content using a URL, then the repository must
provide an HTTP URL and the method (POST/PUT) to use. The content is then directly pushed to that URL.
After the content upload and regardless of whether the upload succeeded or failed, the
ON_CONTENT_UPLOADED method is called. The parameter IV_UPLOAD_RESULT is set to "OK" if the upload
was successful. Any other value indicates an upload failure. If you choose a chunked or a full delivery, the
CREATE_CONTENT method is called either with the complete content or the first chunk of it.
9.2.2.5 Query
The SAP Mobile Documents ABAP connector contains a simple query parser. It splits CMIS queries into the four
main parts of a query: SELECT, FROM, WHERE, and ORDER BY.
It also parses the SELECT, FROM, and ORDER BY parts and provides the results in appropriate data structures.
The WHERE clause is not parsed, but is provided as a single string.
Example
Using the Query Parser
The SAP Mobile Documents end-user clients require the following set of methods to work properly. Other CMIS
clients may require more.
Repository Service
getRepositorie X ro / rw
s
getRepositoryI REP_INFO - ro / rw
nfo
getTypeChildre GET_TYPE_CHILDREN - ro / rw
n
getTypeDecenda GET_TYPE_DESCENDAN X ro / rw
nts TS
getTypeDefinit GET_ - ro / rw
ion TYPE_DEFINITION
createType - -
updateType - -
deleteType - -
Navigation Service
getChildren GET_CHILDREN - ro / rw
getDecendants X -
getFolderTree X -
getFolderParen - ro / rw
t
getObjectParen GET_OBJECT_PARENTS - ro / rw
ts
getCheckedOutD - -
ocs
Object Service
createDocument - rw
createDocument - rw
FromSource
createFolder - rw
createRelation - -
ship
createPolicy - -
createItem - -
getObject GET_OBJECT - ro / rw
getAllowableAc X ro / rw
tions
getProperties X ro / rw
getObjectByPat - ro / rw
h
getContentStre GET_CONTENT - ro / rw
am
getRenditions X -
updateProperti - rw
es
bulkUpdateProp X -
erties
moveObject - ro / rw
deleteObject - ro / rw
deleteTree - ro / rw
setContentStre - ro / rw
am
appendContentS - -
tream
deleteContentS - ro / rw
tream
Versioning Service
checkOut - rw
cancelCheckOut - rw
checkIn - rw
getObjectOfLat - ro / rw
estVersion
getPropertiesO X -
fLatestVersion
getAllVersions - rw
Discovery Service
query QUERY - ro / rw
(metadata query is re
quired, fulltext query is
optional)
getContentChan - -
ges
(used if available)
ACL Service
getACL - -
applyACL - -
Relationship Service
getObjectRelat - -
ionships
Policy Service - -
applyPolicy - -
removePolicy - -
getAppliedPoli
cies
Multifiling Service
addObjectToFol - -
der
removeObjectFr - -
omFolder
Queries
These first steps allow you to create a read-only implementation of the ABAP repository.
Procedure
A repository ID must be unique within the system and can be any case-insensitive string up to 100 characters.
Note
Avoid special characters. The ID will be part of URLs and debugging is easier if the ID does not need to be
encoded or decoded.
3. Add the repository ID and the name of your class to the CMISD_SERVICE table.
4. Implement the GET_REPOSITORY_INFO method in your class.
Make sure that you use the same repository ID that you entered in the CMISD_SERVICE table.
Note
The CL_CMIS_OBJECT_FACTORY class provides a CREATE_REPOSITORY_INFO_READ method that creates
a stub of a repository info structure. The returned structure is sufficient for most read-only repositories.
Repositories that support create and update operations have to modify this structure depending on their
capabilities.
Example
Using the Object Factory to Create a Repository Info Object
es_repository_info = cl_cmis_object_factory=>create_repository_info_read(
iv_name = 'My Repository'
iv_description = 'This is my first repository'
iv_id = 'MY_REPOSITORY_ID'
iv_vendor = 'Example Inc'
iv_product_name = 'Document Store'
iv_product_version = '1.0'
iv_root_folder_id = '783245-837234-23490823'
iv_acl_supported = abap_false
).
These methods are all quite similar. Focus on the properties. Everything else can be added later.
Note
The CL_CMIS_OBJECT_FACTORY class provides methods to fill CMIS_S_PROPERTY structures. These
structures hold property values and you need one for every property value that you have to return.
<XXX> is a placeholder for one of the CMIS data types: ID, String, Integer, Decimal, Boolean, DateTime,
URI, and HTML.
Example
Using the Object Factory to Create a Property Value
ls_name_property = cl_cmis_object_factory=>create_string_prop_single(
iv_property_id = cl_cmis_property_ids=>name
iv_value = 'test.txt'
).
You can reuse a lot of the code from the GET_OBJECT method.
At this point, you can browse through your repository, but the SAP Mobile Documents clients do not allow you
to do anything else.
7. Go back to the GET_OBJECT method and add support for Allowable Actions. If your repository supports ACLs,
also add ACL support.
The SAP Mobile Documents clients use the Allowable Actions to determine which buttons are active and
which buttons are deactivated. Once you have added support for Allowable Actions, the SAP Mobile
Documents clients provide you with more options.
8. Implement the GET_CONTENT method.
Note
It is preferable to send a URL to the content rather than sending the content as an xstring. The
performance is better and the content size is not limited.
You should now be able to use most features of the SAP Mobile Documents clients, except syncing and
querying. These depend on the QUERY method.
This is the most complex task. If you just want to support SAP Mobile Documents clients, only add support for
the queries mentioned above.
The simple query parser that is included in the SAP Mobile Documents ABAP connector helps you identify the
queries and return the correct result set.
Once the query is implemented, this server supports all read-only operations that SAP Mobile Documents
requires.
This specification defines a new predicate function PREVIEW() in the CMIS Query Language that returns a
content snippet with the found match in the searched CMIS objects.
When displaying search results, CMIS clients can display a content snippet with the matched content.
Specification
Usage
This is a predicate function that encapsulates the full-text search capability that may be provided by a
repository. It offers a string content snippet for the matched content in a CMIS object.
Inputs
No inputs must be provided for this predicate function.
Return Value
The PREVIEW () predicate function returns a string with HTML formatting such as <b>matched term</
b>.
Constraints
The PREVIEW () function must only be used in queries that also include a CONTAINS() predicate
function.
The PREVIEW () function must only be used in the SELECT clause of a query. It must not be used in the
WHERE clause or in the ORDER BY clause.
If PREVIEW() is included in the SELECT clause and an alias column name is not provided, then a query
name of SEARCH_PREVIEW is used for the query output, and the property definition id is repository-
specific.
The repository MUST provide the following feature extension in the repository info.
ID http://sap.com/cmis/extension/fulltextsearchpreview
URL n.a.
Description Allows the CMIS query language to support the PREVIEW() function which returns a
content snippet of the matching text in the selected resources.
SAP Mobile Documents supports the following CMIS methods in browser and AtomPub bindings.
Note
For performance reasons, we recommend using the browser binding.
Repository Service
getRepositories Yes
getRepositoryInfo Yes
getTypeChildren Yes
getTypeDecendants Yes
getTypeDefinition Yes
Navigation Service
getChildren Yes
getDecendants Yes
getFolderTree Yes
getFolderParent Yes
getObjectParents Yes
getCheckedOutDocs Yes
Object Service
createDocument Yes
createDocumentFromSource Yes
createFolder Yes
createRelationship No
createPolicy No
getAllowableActions Yes
getObject Yes
getProperties Yes
getObjectByPath Yes
getContentStream Yes
getRenditions No
updateProperties Yes
moveObject Yes
deleteObject Yes
deleteTree Yes
setContentStream Yes
deleteContentStream Yes
Versioning Service
checkOut Yes
cancelCheckOut Yes
checkIn Yes
getObjectOfLatestVersion Yes
getPropertiesOfLatestVersion Yes
getAllVersions Yes
Discovery Service
query Yes
getContentChanges No
ACL Service
getACL Yes
applyACL Yes
Relationship Service
getObjectRelationships No
Policy Service
applyPolicy No
removePolicy No
getAppliedPolicies No
Multifiling Service
addObjectToFolder No
removeObjectFromFolder No
This document contains licensing information relating to SAP's use of free and open-source software with or
within the product identified above (collectively, "FOSS").
Any terms, conditions, and restrictions governing the use or distribution of FOSS that are not contained within the
license(s) governing use and distribution of the FOSS (the "FOSS Licenses") are offered and imposed by SAP
alone. The authors, licensors, and distributors of the FOSS have disclaimed all warranties relating to any liability
arising from the use and distribution of the FOSS.
This document identifies the FOSS components used and the FOSS Licenses that SAP believes govern those
FOSS components. While SAP has sought to provide complete and accurate licensing information for each FOSS
component, SAP does not represent or warrant that the licensing information provided herein is correct or error-
free. Recipients of this product should investigate the identified FOSS components to confirm the accuracy of the
licensing information provided herein. Recipients are also encouraged to notify SAP of any inaccurate information
or errors found in this document.
Certain FOSS Licenses require that SAP make available to recipients the source code corresponding to FOSS
binaries distributed under those licenses. Recipients who would like to receive a copy of such source code should
submit a request to SAP by e-mail to opensource@sap.com.
Please provide the following information in submitted requests: the FOSS components for which you are
requesting source code; the SAP product and version number with which the requested FOSS component is
distributed; an e-mail address at which SAP may contact you regarding the request (if available); and the postal
address for delivery of the requested source code.
Apache Regexp - Reuse from Portal KM (bc.util.public_api-1.0.jar). Approved Apache License v 2.0
from code center
Simple Logging Facade for Java (SLF4J) The MIT License (MIT)
Apache License
Apache License
http://www.apache.org/licenses/
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1
through 9 of this document.
To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by
brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be
enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and
description of purpose be included on the same "printed page" as the copyright notice for easier identification
within third-party archives.
LEGAL CODE
Attribution 2.5
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE LEGAL SERVICES.
DISTRIBUTION OF THIS LICENSE DOES NOT CREATE AN ATTORNEY-CLIENT RELATIONSHIP. CREATIVE
COMMONS PROVIDES THIS INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO
WARRANTIES REGARDING THE INFORMATION PROVIDED, AND DISCLAIMS LIABILITY FOR DAMAGES
RESULTING FROM ITS USE.
License
THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC
LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE
LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS
PROHIBITED.
BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO BE BOUND BY THE
TERMS OF THIS LICENSE. THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION
OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS.
1. Definitions
a. "Collective Work" means a work, such as a periodical issue, anthology or encyclopedia, in which the Work in its
entirety in unmodified form, along with a number of other contributions, constituting separate and independent
b. "Derivative Work" means a work based upon the Work or upon the Work and other pre-existing works, such as a
translation, musical arrangement, dramatization, fictionalization, motion picture version, sound recording, art
reproduction, abridgment, condensation, or any other form in which the Work may be recast, transformed, or
adapted, except that a work that constitutes a Collective Work will not be considered a Derivative Work for the
purpose of this License. For the avoidance of doubt, where the Work is a musical composition or sound recording,
the synchronization of the Work in timed-relation with a moving image ("synching") will be considered a Derivative
Work for the purpose of this License.
c. "Licensor" means the individual or entity that offers the Work under the terms of this License.
d. "Original Author" means the individual or entity who created the Work.
e. "Work" means the copyrightable work of authorship offered under the terms of this License.
f. "You" means an individual or entity exercising rights under this License who has not previously violated the
terms of this License with respect to the Work, or who has received express permission from the Licensor to
exercise rights under this License despite a previous violation.
2. Fair Use Rights. Nothing in this license is intended to reduce, limit, or restrict any rights arising from fair use,
first sale or other limitations on the exclusive rights of the copyright owner under copyright law or other applicable
laws.
3. License Grant. Subject to the terms and conditions of this License, Licensor hereby grants You a worldwide,
royalty-free, non-exclusive, perpetual (for the duration of the applicable copyright) license to exercise the rights in
the Work as stated below:
a. to reproduce the Work, to incorporate the Work into one or more Collective Works, and to reproduce the Work
as incorporated in the Collective Works;
c. to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a
digital audio transmission the Work including as incorporated in Collective Works;
d. to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a
digital audio transmission Derivative Works.
i. Performance Royalties Under Blanket Licenses. Licensor waives the exclusive right to collect, whether
individually or via a performance rights society (e.g. ASCAP, BMI, SESAC), royalties for the public performance or
public digital performance (e.g. webcast) of the Work.
ii. Mechanical Rights and Statutory Royalties. Licensor waives the exclusive right to collect, whether individually or
via a music rights agency or designated agent (e.g. Harry Fox Agency), royalties for any phonorecord You create
from the Work ("cover version") and distribute, subject to the compulsory license created by 17 USC Section 115
of the US Copyright Act (or the equivalent in other jurisdictions).
f. Webcasting Rights and Statutory Royalties. For the avoidance of doubt, where the Work is a sound recording,
Licensor waives the exclusive right to collect, whether individually or via a performance-rights society (e.g.
SoundExchange), royalties for the public digital performance (e.g. webcast) of the Work, subject to the
compulsory license created by 17 USC Section 114 of the US Copyright Act (or the equivalent in other
jurisdictions).
4. Restrictions.The license granted in Section 3 above is expressly made subject to and limited by the following
restrictions:
a. You may distribute, publicly display, publicly perform, or publicly digitally perform the Work only under the
terms of this License, and You must include a copy of, or the Uniform Resource Identifier for, this License with
every copy or phonorecord of the Work You distribute, publicly display, publicly perform, or publicly digitally
perform. You may not offer or impose any terms on the Work that alter or restrict the terms of this License or the
recipients' exercise of the rights granted hereunder. You may not sublicense the Work. You must keep intact all
notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display,
publicly perform, or publicly digitally perform the Work with any technological measures that control access or
use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Work
as incorporated in a Collective Work, but this does not require the Collective Work apart from the Work itself to be
made subject to the terms of this License. If You create a Collective Work, upon notice from any Licensor You
must, to the extent practicable, remove from the Collective Work any credit as required by clause 4(b), as
requested. If You create a Derivative Work, upon notice from any Licensor You must, to the extent practicable,
remove from the Derivative Work any credit as required by clause 4(b), as requested.
b. If you distribute, publicly display, publicly perform, or publicly digitally perform the Work or any Derivative
Works or Collective Works, You must keep intact all copyright notices for the Work and provide, reasonable to the
medium or means You are utilizing: (i) the name of the Original Author (or pseudonym, if applicable) if supplied,
and/or (ii) if the Original Author and/or Licensor designate another party or parties (e.g. a sponsor institute,
publishing entity, journal) for attribution in Licensor's copyright notice, terms of service or by other reasonable
means, the name of such party or parties; the title of the Work if supplied; to the extent reasonably practicable,
the Uniform Resource Identifier, if any, that Licensor specifies to be associated with the Work, unless such URI
does not refer to the copyright notice or licensing information for the Work; and in the case of a Derivative Work, a
credit identifying the use of the Work in the Derivative Work (e.g., "French translation of the Work by Original
Author," or "Screenplay based on original Work by Original Author"). Such credit may be implemented in any
reasonable manner; provided, however, that in the case of a Derivative Work or Collective Work, at a minimum
such credit will appear where any other comparable authorship credit appears and in a manner at least as
prominent as such other comparable authorship credit.
UNLESS OTHERWISE MUTUALLY AGREED TO BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-
IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS,
IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE,
MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF
LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT
DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH
EXCLUSION MAY NOT APPLY TO YOU.
6. Limitation on Liability. EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL
LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL,
PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF
LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. Termination
a. This License and the rights granted hereunder will terminate automatically upon any breach by You of the terms
of this License. Individuals or entities who have received Derivative Works or Collective Works from You under this
b. Subject to the above terms and conditions, the license granted here is perpetual (for the duration of the
applicable copyright in the Work). Notwithstanding the above, Licensor reserves the right to release the Work
under different license terms or to stop distributing the Work at any time; provided, however that any such
election will not serve to withdraw this License (or any other license that has been, or is required to be, granted
under the terms of this License), and this License will continue in full force and effect unless terminated as stated
above.
8. Miscellaneous
a. Each time You distribute or publicly digitally perform the Work or a Collective Work, the Licensor offers to the
recipient a license to the Work on the same terms and conditions as the license granted to You under this License.
b. Each time You distribute or publicly digitally perform a Derivative Work, Licensor offers to the recipient a license
to the original Work on the same terms and conditions as the license granted to You under this License.
c. If any provision of this License is invalid or unenforceable under applicable law, it shall not affect the validity or
enforceability of the remainder of the terms of this License, and without further action by the parties to this
agreement, such provision shall be reformed to the minimum extent necessary to make such provision valid and
enforceable.
d. No term or provision of this License shall be deemed waived and no breach consented to unless such waiver or
consent shall be in writing and signed by the party to be charged with such waiver or consent.
e. This License constitutes the entire agreement between the parties with respect to the Work licensed here.
There are no understandings, agreements or representations with respect to the Work not specified here.
Licensor shall not be bound by any additional provisions that may appear in any communication from You. This
License may not be modified without the mutual written agreement of the Licensor and You.
Creative Commons is not a party to this License, and makes no warranty whatsoever in connection with the Work.
Creative Commons will not be liable to You or any party on any legal theory for any damages whatsoever,
including without limitation any general, special, incidental or consequential damages arising in connection to this
license. Notwithstanding the foregoing two (2) sentences, if Creative Commons has expressly identified itself as
the Licensor hereunder, it shall have all rights and obligations of Licensor.
Except for the limited purpose of indicating to the public that the Work is licensed under the CCPL, neither party
will use the trademark "Creative Commons" or any related trademark or logo of Creative Commons without the
prior written consent of Creative Commons. Any permitted use will be in compliance with Creative Commons'
then-current trademark usage guidelines, as may be published on its website or otherwise made available upon
request from time to time.
April 9, 2014
Usage Of Content
Applicable Licenses
Unless otherwise indicated, all Content made available by the Eclipse Foundation is provided to you under the
terms and conditions of the Eclipse Public License Version 1.0 ("EPL"). A copy of the EPL is provided with this
Content and is also available at http://www.eclipse.org/legal/epl-v10.html. For purposes of the EPL, "Program"
will mean the Content.
Content includes, but is not limited to, source code, object code, documentation and other files maintained in the
Eclipse Foundation source code repository ("Repository") in software modules ("Modules") and made available as
downloadable archives ("Downloads").
Content may be structured and packaged into modules to facilitate delivering, extending, and upgrading the
Content. Typical modules may include plug-ins ("Plug-ins"), plug-in fragments ("Fragments"), and features
("Features").
Each Plug-in or Fragment may be packaged as a sub-directory or JAR (Java ARchive) in a directory named
"plugins".
A Feature is a bundle of one or more Plug-ins and/or Fragments and associated material. Each Feature may
be packaged as a sub-directory in a directory named "features". Within a Feature, files named "feature.xml"
may contain a list of the names and version numbers of the Plug-ins and/or Fragments associated with that
Feature.
Features may also include other Features ("Included Features"). Within a Feature, files named "feature.xml"
may contain a list of the names and version numbers of Included Features.
The terms and conditions governing Plug-ins and Fragments should be contained in files named "about.html"
("Abouts"). The terms and conditions governing Features and Included Features should be contained in files
named "license.html" ("Feature Licenses"). Abouts and Feature Licenses may be located in any directory of a
Download or Module including, but not limited to the following locations:
Note: if a Feature made available by the Eclipse Foundation is installed using the Provisioning Technology (as
defined below), you must agree to a license ("Feature Update License") during the installation process. If the
Feature contains Included Features, the Feature Update License should either provide you with the terms and
conditions governing the Included Features or inform you where you can locate them. Feature Update Licenses
may be found in the "license" property of files named "feature.properties" found within a Feature. Such Abouts,
Feature Licenses, and Feature Update Licenses contain the terms and conditions (or references to such terms
and conditions) that govern your use of the associated Content in that directory.
IT IS YOUR OBLIGATION TO READ AND ACCEPT ALL SUCH TERMS AND CONDITIONS PRIOR TO USE OF THE
CONTENT. If no About, Feature License, or Feature Update License is provided, please contact the Eclipse
Foundation to determine what terms and conditions govern that particular Content.
The Eclipse Foundation makes available provisioning software, examples of which include, but are not limited to,
p2 and the Eclipse Update Manager ("Provisioning Technology") for the purpose of allowing users to install
software, documentation, information and/or other materials (collectively "Installable Software"). This capability
is provided with the intent of allowing such users to install, extend and update Eclipse-based products.
Information about packaging Installable Software is available at http://eclipse.org/equinox/p2/
repository_packaging.html ("Specification").
You may use Provisioning Technology to allow other parties to install Installable Software. You shall be
responsible for enabling the applicable license agreements relating to the Installable Software to be presented to,
and accepted by, the users of the Provisioning Technology in accordance with the Specification. By using
Provisioning Technology in such a manner and making it available in accordance with the Specification, you
further acknowledge your agreement to, and the acquisition of all necessary rights to permit the following:
1. A series of actions may occur ("Provisioning Process") in which a user may execute the Provisioning
Technology on a machine ("Target Machine") with the intent of installing, extending or updating the
functionality of an Eclipse-based product.
2. During the Provisioning Process, the Provisioning Technology may cause third party Installable Software or a
portion thereof to be accessed and copied to the Target Machine.
3. Pursuant to the Specification, you will provide to the user the terms and conditions that govern the use of the
Installable Software ("Installable Software Agreement") and such Installable Software Agreement shall be
accessed from the Target Machine in accordance with the Specification. Such Installable Software Agreement
must inform the user of the terms and conditions that govern the Installable Software and must solicit
acceptance by the end user in the manner prescribed in such Installable Software Agreement. Upon such
indication of agreement by the user, the provisioning Technology will complete installation of the Installable
Software.
Cryptography
Content may contain encryption software. The country in which you are currently may have restrictions on the
import, possession, and use, and/or re-export to another country, of encryption software. BEFORE using any
encryption software, please check the country's laws, regulations and policies concerning the import, possession,
or use, and re-export of encryption software, to see if this is permitted.
Java and all Java-based trademarks are trademarks of Oracle Corporation in the United States, other countries, or
both.
Copyright (c) 1995-2000 by the Hypersonic SQL Group. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
following conditions are met:
Redistributions of source code must retain the above copyright notice, this list of conditions and the following
disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided with the distribution.
All advertising materials mentioning features or use of this software must display the following acknowledgment:
"This product includes Hypersonic SQL."
Products derived from this software may not be called "Hypersonic SQL" nor may "Hypersonic SQL" appear in
their names without prior written permission of the Hypersonic SQL Group.
Redistributions of any form whatsoever must retain the following acknowledgment: "This product includes
Hypersonic SQL."
This software is provided "as is" and any expressed or implied warranties, including, but not limited to, the implied
warranties of merchantability and fitness for a particular purpose are disclaimed.
In no event shall the Hypersonic SQL Group or its contributors be liable for any direct, indirect, incidental, special,
exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services;
loss of use, data, or profits; or business interruption). However caused any on any theory of liability, whether in
contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this
software, even if advised of the possibility of such damage.
This software consists of voluntary contributions made by many individuals on behalf of the Hypersonic SQL
Group.
http://www.mozilla.org/MPL/2.0/
1. Definitions
1. "Contributor"
means each individual or legal entity that creates, contributes to the creation of, or owns Covered
Software.
2. Contributor Version
This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
If a copy of the MPL was not distributed with this file, You can obtain one at http://
mozilla.org/MPL/2.0/.
This Source Code Form is Incompatible With Secondary Licenses, as defined by the
Mozilla Public License, v. 2.0.
http://opensource.org/licenses/BSD-3-Clause
The following is a BSD 3-Clause ("BSD New" or "BSD Simplified") license template. To generate your own license,
change the values of OWNER and YEAR from their original values as given here, and substitute your own.
Note: You may omit clause 3 and still be OSD-conformant. Despite its colloquial name "BSD New", this is not
the newest version of the BSD license; it was followed by the even newer BSD-2-Clause version, sometimes known
as the "Simplified BSD License". On January 9th, 2008 the OSI Board approved BSD-2-Clause, which is used by
FreeBSD and others. It omits the final "no-endorsement" clause and is thus roughly equivalent to the MIT License.
Historical Background: The original license used on BSD Unix had four clauses. The advertising clause (the third of
four clauses) required you to acknowledge use of U.C. Berkeley code in your advertising of any product using that
code. It was officially rescinded by the Director of the Office of Technology Licensing of the University of California
on July 22nd, 1999. He states that clause 3 is "hereby deleted in its entirety." The four clause license has not been
approved by OSI. The license below does not contain the advertising clause.
<YEAR> = 1998
In the original BSD license, both occurrences of the phrase "COPYRIGHT HOLDERS AND CONTRIBUTORS" in the
disclaimer read "REGENTS AND CONTRIBUTORS".
Redistributions of source code must retain the above copyright notice, this list of conditions and the following
disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of the <ORGANIZATION> nor the names of its contributors may be used to endorse or
promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Coding Samples
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system
environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and
completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, unless damages were caused by SAP
intentionally or by SAP's gross negligence.
Accessibility
The information contained in the SAP documentation represents SAP's current view of accessibility criteria as of the date of publication; it is in no way intended to be a
binding guideline on how to ensure accessibility of software products. SAP in particular disclaims any liability in relation to this document. This disclaimer, however, does
not apply in cases of wilful misconduct or gross negligence of SAP. Furthermore, this document does not result in any direct or indirect contractual obligations of SAP.
Gender-Neutral Language
As far as possible, SAP documentation is gender neutral. Depending on the context, the reader is addressed directly with "you", or a gender-neutral noun (such as "sales
person" or "working days") is used. If when referring to members of both sexes, however, the third-person singular cannot be avoided or a gender-neutral noun does not
exist, SAP reserves the right to use the masculine form of the noun and pronoun. This is to ensure that the documentation remains comprehensible.
Internet Hyperlinks
The SAP documentation may contain hyperlinks to the Internet. These hyperlinks are intended to serve as a hint about where to find related information. SAP does not
warrant the availability and correctness of this related information or the ability of this information to serve a particular purpose. SAP shall not be liable for any damages
caused by the use of related information unless damages have been caused by SAP's gross negligence or willful misconduct. All links are categorized for transparency
(see: http://help.sap.com/disclaimer).