Read Me First

Welcome to onprint online help. This page will answer most of your questions on how to enrich documents using the onprint Edition Platform. Please refer to our website for details on enrichment concept and onprint model.

Need more Help ? Need to report a problem ?

You’ve been through all this document and still have a question or an issue ? Please send an email to

  • The release notes for the platform are accessible here.
  • Many buttons and menus have tooltips associated : just keep your pointer 3 seconds over an item to see the tooltip.. You can disable tooltips in your preferences.


You can reach the onprint Edition login page at the URL :

You can create your own account to manage your own documents or if you have to manage your company’s documents you should ask your company administrator to create an account for you in the context of that company.

If you don’t remember your password you can ask for password reset using the appropriate "Forgot your password ?" link.

Upon successful login you get directly to the home page, which displays your customers, campaigns and documents.

From any page you can change your password and adjust your preferences by clicking on your id in the header bar of the page, and got to the "My account" menu.

The buttons, options and what you can see or touch vary depending on the roles you have been granted. Please refer to your administrator to modify your roles.


The onprint edition platform is tested and supported for the following environments :

  • Mac, or PC/Windows :

    • Chrome : version 35 minimum.
    • Firefox : version 29 minimum.
    • Safari : version 7 minimum.
    • IE : version 9 minimum.
  • Tablets :

    • iOS : iPad all versions, browser Safari.
    • Android : version 4.4 and above.
  • Smartphones :

    • iOS : version iOS 8 and above.
    • Android : version 4.4 and above.

On any other environments, the platform might work correctly, or with some limitations... or not at all.

Session and My Account dialog

Once connected your session will remain active for a few days (by default). You can disonnect anytime using the top-right menu.

You can change your password or modify your preferences using that samstop-right menu.


The ÉDITION thumbnail is selected by default (top menu bar). This is the main page where you can browse through your customers, folders and documents.

This page is splitted in two main sections :

  • The leftmost column is the browser, to access documents.

  • The rightmost column show the details for the surrent selection (documents, folders, organisations).

Left Column : Document Management

Every document displays its name, number of pages, and status.

  • simple click on a item will select it, and display related information on the right side. You'll see then the possible operations on that item depending on its type.
  • Double-click on an folder or organisation will go down in that item and make it the current location. The breadcrumb in the top section shows this current top item and allow to go back up in the tree structure.
  • You can select mutiple items from the same type (only documents for instance). Depending on that type you'll then be able to apply some operations on all the items selected.
  • The New… menu allows you to add more items at the current location. You need to enter a name for that new item first, and then select in the menu the type of item you want to create. This menu is mostly useful for users on tablet or smartphone. We'll see an easier way to create documents with large screen.

  • An item can be moved to another location either by drag & drop when that other location is visible (a folder or organisation in the list), or using the Move to… menu visible when one or multiple items are selected.

Three views are available in the left side column :

  • Simple list, useful for very large number of items
  • Icons (document's covers)
  • Mixed : each item show its icon, name, type, number of page and status

You can define your usual working directory, with the "pin" icon above, while in that usual directory. You can then go back to that directory in one click, with the second icon.

To rename a document, you selected it and give it a new name in the right section.

On the left side on see all the Organizations/Folders/Documents in the current location. You can go up and down in that tree structure by double-clicking on an item or using thebreadcrumb above the list.

Importing New Documents

To import new documents just drop them (one or many) on the Drop your files here zone. Import process can then last for a few seconds or minutes, depending on the size of your documents. You may import PDF, JPG, GIF or PNG documents (no TIFF).

Right Column : Detailed View

Depending on the type of the item selected, you'll see all the related informations in that section, and the various allowed operations.

Operation details are describes later on.


Here is the main page for enrichment. Enrichments are of two kinds : actions (email, phone call, sms, etc) and links to online content (url, video, audio song, pdf file, flipbook, etc).

Page Flow

From left to right you go deeper into the detail of one doc, one page, one language, one action...

In the top bar you can see the current status of that document (Active or Inactive). If you’re modifying enrichments on an already active doc, modifications are taken into account immediately.

It's a good practice to activated a document as soon as possible, even when empty. You can then test your enrichment as you create them, to make sure everything works fine.

This page is splitted in 4 main zones, on top of the menu bar (for languages, global styles and status) :

  • The horizontal flatplan at the top : to see at a glance all the pages and zones of your document. By default the first page is selected when entering that page.
  • Action creaction section (leftmost column)
  • The "smartphone" view, showing in quasi-wysiwyg mode, the actions as presented on the smartphone.
  • Actions parameters details

The flatplan

Each image or zone shows :

  • it's page number, and zone number, when needed
  • number of actions on that image, for all languages together. This thumbnail is blue or orange: blue when there ois at least one action on that image,
  • number of zones on that page, zones are then displayed right after their "mother image" (example here : page 4 is splitted in 2 zones : 4.1 and 4.2),

The flatplan start from the left with the page zero icon : this is the document level. Actions linked at thet document are inherited and visible from all images in that document. That's why they are called "global actions".

Smartphone View

The Smartphone view displayed a realistic view of what the end user will see on his/her smartphone. You can reorder the action by dragging them over.

Each action have a green circle or an orange losange on its right side. When orange, this action still needs to be completed (parameter or title missing). When green the action is ok.

When an action displays a yellow padlock on the right side, it's a global action inherited from upper level (image or document). This action cannot be edited at this level.

On the Page Zero (document level) its possible to indicate which global actions should appear at the top of the list or bellow all local actions. You do that by dragging the yellow splitter amon the actions.

Warning : On the smartphone view only local action for a specific level are displayed. The end user will see all actions, local and inherited (see below).

Your First Enriched Document

In a few simple steps, create your first enriched document, starting from the home page :

  1. Import a document by drag&drop of the file directly on the drop zone.
  2. Your newly imported document is now displayed in the tree list and selected. "Preparation" will last only a few seconds, depending on the doc size.
  3. One document is ready, select it, rename it if needed,
  4. Click on Enrich to open the enrichment page.
  5. Select "page 1", for instance, in leftmost column,
  6. Enter a title for this page.
  7. Click on the URL button to create a new Url action,
  8. An empty action is created for you, with the default icon and with "Web Page" as a sub-type.
  9. Enter a title for this action, and enter some valid url in the parameter area
  10. Activate that document, using the top-right Activate menu under the "Inactive" status.

You’re done ! You’ve just created your first enriched document.

Notice that a green sign finally appeared on your new button when the action was all set. Before that a warning orange sign indicated that something was still missing. PLease make sure when adding actions that all show a green sign !

From there :

  • You can test that first page (see below)
  • You can add more actions to the same page (as many as you want)
  • You can add more languages and specific actions for this page
  • You can reorder the actions by just dragging them in the order you want
  • You can enrich many pages
  • You can split some pages in several zones, and enrich each of them differently for specific purposes

Don’t forget to Activate your documents when you're done (in the enrichment page or in the main page). People often forget to do that...

Local actions, Global Actions

For many documents, some actions are specific to one page, but some others are common to all pages throughout the whole document. To set these common actions once for all pages, you simply select the first "Page Zero" at the left of the page list in the top section. All actions set on that pseudo-page will appear on all pages

You can reorder them and set their priority, to specify wether they should appear before or after local actions, as shown in the schema below:

The final order for actions presented on the smartphone will be deduced from the "stacking" of all actions at all levels, using that priority notion as explained in th folowwing diagram :

Image Title

All active image should have a title. This is first for validation purpose during test phase, to ensure that the image retrieved is the expected one. And then to help the smartphone user to locate where he/she is. You can set a title on each individual page or zone, but this could be a complex task for long documents. You can as well set a global title on the "Page Zero" global page. This title will then be the default for all page or zone, but can still be modified locally on specific pages/zones.


User’s smartphones can be in any languages, even in a single country or area. It’s a good idea to answer any user in his/her own language. This means that enrichments have to be localized when possible, in as many languages as possible. onprint allows that, and even allows enrichment content to be specific to languages.

You can not only translate page title or button ids, but as well make the enrichment itself to be specific. For instance a button "See our web site" for a company could point to or depending on the user’s language. Same thing for any type of actions.

Each document can be enriched in several languages (using the "flag" menu on the enrichment page).

Upon each smartphone request, an algorithm to pick up the more appropriate language is executed. The language code received is expected to be in the format "ll-CC" where ll is the language code and CC is the country code (ISO).

  • If "ll-CC" exists in the document language list, it is selected.
  • If "ll-CC" does not exists but "ll" is part of other language codes associated with that document, one of them is selected. If the default language is among them, it is selected.
  • If "ll-CC" does not exists but "CC" is part of other language codes associated with that document, one of them is selected. If the default language is among them, it is selected.
  • Otherwise, the default language is selected.

Each document can be enriched in several languages ("flag" menu in the enrichment page). This menu shows the current list of languages for that document. The blue arrow indicate the default language.

The menu "Manage Languages" allow you to add or remove a language, and to select a default language. Be careful : when removing a language, all actions (if any) for that languages are deleted.

The default language for a document is initially set to the organization's' language.

The Manage Languages menu give access to the language popup, in which you can add or remove languages to that document:

One click on a language in the right column adds it to the document. One click in the left column removes it. You cannot remove the default language.

When a document has several languages defined, a list is displayed in the leftmost column, before the smartphone view. Youcan then quickly select a language and see how many actions are specififed for each language.


Sometimes, if your paper is supposed to be printed in a large size, it makes sense to split one page into several "zones". Each zone to be flashed "naturally" by an end user. "Naturally" means what an end-user would flash without any guidance, like a picture, an ad, or something visually independant on the page.

You can switch a page to "multi-zone mode" using the button with that id. You can then define the zones and enrich each zone separately. You can turn back to single zone anytime or add as many zones as you need.

Remember to keep the end-user experience "natural" :

  • Each zone should have a size ratio close to a picture taken by a smartphone.
  • Each zone should not be too small, or too large.
  • Defining overlaping zones is not a good idea as this could lead to image conflict or ambiguity.
  • Best rule : try it with your smartphone !

Action Types

  • URL : This is the simplest way to connect an image to an online content, from any type. You have to specify that content type in the parameters to allows the smartphone to open the best viewer for that content. Youl'l make sure that theUrl is correct, and that the content is easily and correctly displayed on a smartphone or tablet (no Adobe Flash® content for instance). The option "Browser in the application" (checked by default) will keep the web page inside the application, while when unchecked an dexternal browser application will be reached out to display it. The option "Hidden URL" will force inside browser view and will disallow sharing options, therefore hiding the URl to the user. Here are the 4 content types :

    • Web Page: any wweb page, or even a search engine request
    • Video : The url should point to a valid video, adapted for a smartphone screen (check video host documentation to determine the correct url for this).
    • Audio : the url should point to a valid audio file, hopefully hosted on a streaming server
    • PDF : The url should point to a pdf file that will be opened using a PDF viewer. Make sure the PDF you're pointing to will display correctly on a small screen, and is not heavy to download !
  • Map : You can specify either a (latitude,longitude) couple, or a simple address. Any address or search expression accepted by geographical apps should work. This will open either the default geographical app (Map or Google Maps) on the smartphone and point it to the specified address or search.

  • Email : You can specify an email address, a subject and an email body. Only email addresses are mandatory.
  • Phone call : Specify a valid phone number (international format prefered : "+[0-9]+").
  • SMS : Specify a valid mobile phone number and a default text
  • Share : Specify a text that will be shared either on Facebook on Twitter (user to chose), and an Url (for Facebook))
  • Event : This will add a calendar event to the user’s calendar. Enter a specific Date&Time event with a title, for instance a concert date or any event in the future. The date an time pickers will help you for this.
  • Biz Card : Fill in all the appropriate fields : this will add a new contact in the smartphone contact base. Model is very close to the vCard V2 standard.

Moving, cloning, deleting an action

  • To move an action : drag and drop its "hand" icon to the destination image or zone.

  • To clone an action click on the "2 sheeps" icon. You will probably have to move the new clone to its final image or zone.

  • To delete an action click on the trash icon.


Page titles and actions presentations can be modified. These modifications can be defined globbally for a whole document (all titles, all actions) or defined locally for a specific title or one single action. In that case, local settings have priority over global ones.

The Styles menu, and Titles Styles and Actions Styles sub-menus bring up the customzation dialog.

On the left side the Title Style allows to modify locally one title for the current page or zone.

As well, on each action details section, the Edit Style open the customization popup for actions.

Title's Styles

Page Titles appear on smartphone after image recognition at the top of the page. This is to clarify action's context, and to make sure the correct image has been recognized.

For instance :

We can see here the default style. But the customization dialog allows to change colors, opacity, for background and text. Text can also have bold and italic attributes set.

Action's Styles

By default all action's buttons are presented on the smartphone in a format suitable for most background image, dark or light. But this layout can be customized to suit more precisely some images, or to differentiate actions.

Every action has :

  • a name (mandatory)
  • an icon (mandatory)
  • a background image (optional), defined by its URL. The image has to be hosted somewhere and publicly accessible.

You can modify these fields appearance in the action details :

The button span class="refbouton">Edit Style opens up the customization dialog :

The 3 elements (frame, icon, text) are customizable on several aspects. And first of all, on their visibility (option Display).

On the right side of the dialog is a "wysiwyg" (almost...) view of the resulting action. The final look may vary depending on the width of the actual smartphone used.

By clicking on the colored area you open a color picker which allows you to select a color easily. Use the righmost column in the picker to adjust the opacity level.

A global action can be customized globally only.

The following attributes can be modified :

  • Frame : background color and opacity, height or W×H ratio, corner rounding radius, position and coverage for the background image, if any,
  • Icon : size, position relative to the frame,
  • Text : size, position relative to the frame, color, opacity, weight and italic.

Alltogether these options gives a large number of combinations, allowing very different looks for actions.

IMPORTANT: The 2 buttons Advanced Mode and Simple Mode allows to switch back to the "historical" styles (simple), when needed. For instance when the document will be seen with an old mobile app. Only the ONprint mobile app or other mobile apps based on our SDK V3.0 (or higher) will be able to render these new styles and the background image.

Here are some presentation examples :

And some variants around an e-commerce catalog listing for products :

Title's and action's styles are exported in the XML or JSON file during action export. They are exported in a pseudo-CSS format, making them easy to modify manually when needed. Upon XML or JSON import the styles in the XML file are taken into account and applied to titles and actions accordingly.


In the style bar for an action you can as well associate an icon to that action. By clicking on the icon you open the icon picker below:

You can simply select an icon in the list and click on Select icon to validate your choice (a double-click on the icon will do both at once). But you can as well import new icons and organize them. The Déposez une icône zone is where you can drop your icon files (GIF, PNG or JPEG, 64x64 pixels max in size), they'all appear then in the document section at the top, and will be useable only in the document, by default. But you can change that visibility level and make them available to any folder or organisation level above, by adjusting the Level menu.

By default, every action gets a standard icon depending on its type and sub-type (Url).

Special Option

  • Option "Auto Trigger" (leftmost column) : When an image has only one action associated to it, you can chose to automatically trigger the action, skipping the action display step. You have to check that flag on each image for which you want that behavior.

Activating a Document

0n top of individual page testing (in enrichment page), a document has to be "Activated" when ready for the images to be recognized and the enrichments to work.

This is done using the "INACTIVE > Activate the document" menu (this can as well be done from the main page, in the top-right section of document details).

Document activation might take a minute. You should wait for final "Activated" state before trying to flash doc pages with your smartphone.

Once activated, a document can be deactivated. This happens either automatically at the end of the document lifecycle period of time (one year by default), or manually using the "Deactivate" menu, under the "Active" green button.

In "Inactive" state, a document can be re-activated. Activation/Deactivation can be done as many times as needed.

Only the pages with enrichments are activated, and displayed in the clickstream statistics. Adding global actions will enforce all pages to be activated.

Testing Your Actions

Each time you enrich or modify enrichment on a document, it’s a good idea to validate that they are working properly and to your needs.

For that you need to Activate that document yousing the status menu at the top right.

Click on the eye button at the bottom of the smartphone view to open a wide popup on your screen with your page. Flash it with your smartphone in the onprint application. You should see your buttons.

Be careful : the buttons displayed on your smartphone are the ones defined for your smartphone language, OR for the default language for that doc, if your language is not available.

Silo Mode

When your organization is setup with this "silo" mode enabled, your specific mobile application will "see" only your image subset, therefore avoiding potential conflicts with other customers. Of course this does not avoid internal conflicts, between images belonging to the same organization.

You must have a dedicated mobile application to enable this silo mode.

Please contact onprint to configure your organization with this mode setup.

Document Lifecycle

Here is a typical document lifecycle :

Enrichments can as well be modified anytime during the Active phase.

Activation/deactivation can happen as many times as necessary.

Archiving is not implemented yet.

Commands available on documents

The "cogs" menu associated with each document gives access to several useful commands to manage and modify documents:

  • Import Actions (XML or JSON) : Import actions and zones from an XML or JSON file (format is automatically detected).
  • Export Actions > XML : Export actions in XML format.
  • Export Actions > JSON : Export actions in JSON format.
  • Remplace : Replace document source (PDF, JPG, etc) keeping existing actions on each page.
  • Export Document : Export source file for that document (PDF, JPG, etc).
  • Export Clickstream : Export a zip file with 2 files inside, containing all flashs and clicks details, or a daily summary.

The following sections will describe each command in details.


Often you start creating actions for a big document...and then the customer tells you that PDF file has changed...what you need at that time is a feature to replace the PDF (or image) file with the new one, while keeping all actions in place. If the new file has exactly the same number of pages (usual case for minor modifications on the file) you just need to double check that the pages in the doc have not been swapped or moved around. If yes you’ll have to move the actions accordingly. If the new doc has MORE pages than the previous one: you’ll probably have to add some new actions to the new pages at the end of the doc. If the new doc has LESS pages than before, actions on "lost pages" will simply be dropped.

Export/Import XML

It is possible to export actions associated to a document in an XML file for edition or import in another tool. XML format is quite obvious, if you start from a real exported example. A typical scenario is when you’ve enriched a document with many actions in your language and then need to translate it in many languages, getting help from many translators. Export the actions in xml format, send that file to as many translators as need, asking them to change titles, button ids, and parameters for each new language, then you’ll have to concatenate all the resulting files in one, with appropriate xml tag nesting. And import that big file to the document. Be careful : importing an action file will erase all previous actions on that doc, and replace them with the actions from the xml file.

Export Document

This command allows to retrieve simply the original document source file (PDF, JPG, PNG, etc).

Export Clickstream

This command allows to extract 2 files in CSF format with : the details of all flashes and clicks, and the cumulated number per day.

Image Conflicts

Any activated image can be in conflict with other similar images in the recognition database. In such situation, analyzing the conflicts is necessary.

The CONFLICTS button open up the Conflicts view with all the "activat-able" pages or zones on the left side.

The ANALYZE ALL IMAGES button starts a global evaluation on the whole document, emphasizing on potential conflicts using a color code (green, yellow, orange, red) indicating the risk level for that image.

By clicking on a specific image you can see the detailed analysis on existing conflicts. When a conflict do not mention the document name, that document is outside the customer perimeter and then not accessible.

Dashboards and Reports

At any level (organization, folder and document) the clickstream can be analysed using 2 features :

  • Dashboards : Analytic web view, allowing to go deep, down to the user level, showing the "user journey" using his/her smartphone.

  • Reports : when it's more handy to get the clickstream analysis in an email format, for instance to send that email to your final customer. You can run 3 level of reports : Simple, Detailed, and Full.

ATTENTION : These 2 features are only available when access is granted to your organization. Please contact ONprint for this.

Dashboard Examples for one folder, and one user:

The form to request a report by email :


Administer users in your organization

The ADMIN page is accessible via the ADMIN button in the top menu bar.

Administration features are only accessible by people with appropriate roles (and therefore permissions).

Please ask your account administrator for help if needed.

This Admin page is logically organized from left to right :

  • Leftmost column is where you browse through your organizations and select one.
  • Upon one organization selection, its details and displayed in the center column and its user's list in the righmost column.
  • Selecting a user in the list display his/her details below and allow to change the password or change any parameter.
  • You can create a new user in the current organization as well, or invite him/her. He/she will get an email with a link to activate the account and specify a password.

A user is either Active or Inactive.

An Inactive user cannot log in.

Note : User’s roles are managed by administrators.

User information is kept as basic as possible.

Users are granted roles. Each role enables a set of actions. Today’s roles are :

  • Designer : can create, manage, enrich and activate documents
  • Customer Account Manager : Manage your customers, customer’s users, and customer’s docs.
  • Admin : Manage users in his/her own organization (i.e. peers).

Individual Account vs Enterprise Account

You can create your own individual account, and add your documents. This is done using the "Create Account" welcome page at

You can then invite more users to join you and share documents in what becomes then an entreprise account. There is no difference between an individual and an enterprise account.

However, it is useful, for an enterprise account, to enter a real organization name, and check the billing address. You can as well specify a company logo.

Administrating your customers

Each onprint customer can manage its own customers. A customer is created using a lightweight feature using the New Organization button on the ADMIN page or EDITION page, using the New > Customer button. Customer name is the only mandatory field. The new customer will inherit it’s parent organization default language.

ADMIN mode allows to define more parameter for each organization, including its users.

You can set a logo for each customer. This logo will be displayed in the banner section at the top.

Contracts and Counters

There are 4 different contract types, based on differents metrics :

  • Pages Credit : The customer buys a "pages credit", for instance 1000 pages. Upon first activation for each document, the number of pages of that document is deduced from that counter. The current counter value is always visible in the header at the top right corner of the window. Only the first activation, for a specific document, impacts this counter. After that, you can deactivate or reactivate that same document without impacting that counter any more.

  • Maximum Active Pages : The customer may activate or déactivate as many document as needed. But the total number of simultaneous active pages must stay below a maximum number, defined by contract.

  • Annual Subscription : In that mode, there is no counter. The customer subscribes for an unlimited usage over a one year period of time.

  • In Test : Often for customers who wish to evaluate ONprint solution for a given agreed period of time. That type of contract is supposed to be changed in one of the 3 other types above. When a test period is defined, the number or remaining days is displayed in the header at the top right of the window.

The "Pages Credit" contract (the most frequent) enables you to manage your own sub-customers, and grant them pages credit for them to consumed.

Administrating these sub-customer's counters is done using the "Counters" section of the Admin page :

By selecting a specific organization, you can give (or take) them credits. These credits will then be added (or substracted) to that organization, and as well substracted (or added) to your own, for a correct null-sum transaction.

The "History" button displays the last transactions affecting this organization's counter.

You know everything about onprint !