User Tools

Site Tools


docbrowser:introduction

DocBrowser Digital Document Distribution System

General

Introduction

DocBrowser Digital Document Distribution system provides a server platform for document hosting and multi-platform client software (Mac OS X, MS Windows, Linux, iOS) that synchronizes with the server to provide offline access to company manuals and documents. The server platform also presents manuals and documents and provides an administrative interface via any compatible web-browser. Additionally the system supports optional modules and associated iOS clients for offline Reports and Forms and interactive Destination Information.

Hardware and Software Requirements

The server platform is managed by the system provider and hosted in a redundant environment. The web-based interface is designed for compatibility with all major modern browsers such as Google Chrome, Mozilla Firefox, Apple Safari and Microsoft Edge.

iDocBrowser client software requires a device capable of running iOS 9.0 or later.

iFlyThere client software requires a device capable of running iOS 9.0 or later.

iReForm client software requires an iPad capable of running iOS 9.0 or later.

Concept

Introduction

The server platform hosts all documents in a structure defined by the system administrator. In addition the server platform contains a user database where users and approved software clients are registered.

The required document structure is maintained by the system administrator using a web-based graphical user interface. Documents are uploaded to the server directly from the administrative user interface.

Document access rights are defined by user roles. Each registered user is associated with any number of roles.

Each user may also be subject to usage tracking where every document’s download, read and confirmed status is tracked across the users client and registered on the server.

The Digital Document Distribution Server replies to synchronization requests sent from DocBrowser clients via a secure https/SSL connection. If the provided user and client information is registered on the server a response will be sent to the client with data of the current document structure. The client will modify the document structure as required, verify all local files and request missing documents from the server and/or delete obsolete local documents.

All document transfers are verified against the user/client data and performed using secure https/SSL. As all document transfers are logged the civil aviation authority’s requirement of sign-that-received is fulfilled. Each user account may have three different clients registered. Each client will be identified using hardware or software based unique ID’s. These ID’s must be registered on the server and associated with the respective user in order to allow synchronization.

An MDM system supporting Managed Application Configurations may be used to preconfigure iDocBrowser client settings and automate the device authentication.

Optional components consists of dynamic platforms for an interactive Destination Brief, electronic reports and forms and tracking and displaying of Key Performance Indicators (KPI's).

The destination brief functionality presents dynamically generated destination information in the web-interface or an iOS client based on locally stored database content.

The reports and forms functionality can be used to define custom reports and forms for offline use on any iPad device.

The Digital Document Distribution Server can also be accessed via a secure web-interface where all documents as well as DocBrowser clients are available for download. There is a possibility to either access the server via an embedded link from an Intranet or via a dedicated login web-page. Any user logging on the web-interface with administrative privileges will have access to different levels of administrative functions on the server. These functions include statistics retrieval, document administration, user and client management as well as optional EFB administrative functionality for document synchronization with any EFB administration server.

Graphical Overview

Typical Usage Scenarios

Common Web-login – Individual client usage tracking

In this scenario a user typically named “webuser” is created and associated with a role associated with all document categories that shall be accessible via the webDocBrowser interface.

A hyperlink is created in the company intranet with embedded login-information for the “webuser”. By clicking this link the user will be directed to the webDocBrowser and have access to all available documents.

Optionally the webDocBrowser can be customized and fully embedded in an existing intranet setup.

All users that desire offline access to documents via client software are registered on the server with a maximum of three individual clients. Users will be assigned to any role giving access to the documents that is applicable to the individual user. Each client will feed back document read status to the server for follow up and statistics. Document read status will be shared between all clients used by a user.

Individual Web-login and client usage tracking

In this scenario individual user accounts are created for all applicable staff. Each account is assigned to the role giving access to the applicable documents. Document access for each individual user will be logged by the system for follow up and statistics.

A hyperlink is dynamically created in the company intranet with embedded login-information for each individual user. By clicking this link the user will be directed to the webDocBrowser and have access to the documents applicable to his/her role. Optionally the user can be presented with a list of all unread documents. It is also possible to present this unread list or the number of unread documents in the company intranet environment by creating a custom request.

Optionally the webDocBrowser can be customized and fully embedded in an existing intranet setup. (Alternatively a hyperlink is created leading to the webDocBrowser login page.)

All users that desire offline access to documents via client software can be associated with a maximum of three individual clients. Each client will feed back document read status to the server for follow up and statistics. Document read status will be shared between all clients used by a user.

Optionally a common Web-Login to be used by generic users or to access documents not available in an individual user profile can be created also in this scenario.

No usage tracking

A setup as described in the Common Web-login scenario except that no usage tracking is enabled on the individual user accounts. Each individual client software will track read/unread status locally without feeding back any information to the DocBrowser server.

Client only access

The webDocBrowser is only used for server administration and all users access the available documents using the client software.

Data Feeds

Various data can be retrieved from the DocBrowser server.

Data feeds will only be available if requested from domains specified in the Administration Settings page.

Number of Unread Documents

The number of unread required documents for users subject to document access tracking can be retrieved via the below link. This may be used to present the presence of new documents while logging on to an intranet.

https://SERVER/api/unreadstatus/USERNAME

The response is returned in JSON format containing the variable [unread] with an integer representing the number of unread required documents for the given user. 0 will be returned if any error occurs.

Web-based User Interface

The web-based user interface is accessed via the url of your assigned server.

A link with embedded login information can also be created for integration in for example an intranet platform:
https://SERVER/login/GROUP/USERNAME/PASSWORD(/TAB)

  • Replace SERVER with applicable document server.
  • Replace GROUP with applicable three-letter company group code.
  • Replace USERNAME with username for the desired user.
  • Replace PASSWORD with password for the desired user.
  • Optionally append a desired TAB. This tab will be displayed when the webDocBrowser is loaded (e.g. any category, Software, Destinations, Administration etc).

Direct links will only be allowed from domains specified in the Administration Settings page. All parameters such as username and password contained in direct-links are encrypted using SSL.

Document Structure

All manuals and documents are presented in an easy an intuitive way similar to the structure found in the DocBrowser clients and Electronic Flight Bag (Optional DocBrowser EFB software).

A tab presenting all unread required documents for the current user will be shown if the system administrator selects this option.

A tab presenting all recently published documents for the current user will be shown if the system administrator selects this option.

Client Download

Under the “Software” tab in the web-based user interface instructions and links are provided for downloading and installing the DocBrowser client software.

Administrative functions

In order to access the administrative functions the current user must have some level of administrative privileges. If the current user has administrative privileges the “Administration” tab will be shown. Under this tab functions for document administration, user administration, statistics, EFB synchronization (optional), reports and forms administration (optional), KPI administration (optional).

Any user session will expire after 60 minutes of inactivity.

Documents

Add and delete documents or edit document data.

The iDocBrowser iOS client fully supports PDF, Boeing FTID XML documents and various X/HTML formats. Additionally video playback is supported (MP4/MOV/MPV/3GP). MS Word, Excel and PowerPoint documents has limited support and Apple iBooks can be distributed via iDocBrowser and viewed in the Apple iBooks app.

Current documents are listed and can be filtered by name, categories and subcategories. The document list may be sorted by any column by clicking on the column header. Documents that have expired will show EXPIRED in red as valid to date.

Neither expired nor not yet valid documents will be visible in the webDocBrowser or any client software.

Documents can be uploaded and deleted as required and the document Meta data such as name and category can be edited when necessary.

Add a document by pressing the “Add Document” button.

View or Edit document data by marking a document and press the “Edit Document” button or double clicking a document in the list.

Delete documents by marking one or more documents in the document list and press the “Delete Document” button. Documents can also be deleted by pressing the “Delete” button while viewing the document data dialog.

Pressing the “Role Availability” button shows all roles and users that have access to the selected document.

The following fields are available in the Document Data dialog:

Document NameEnter the document name that will be shown to system users. If empty when uploading the document file, this field will be populated by the uploaded files name without extension.
Document CategoryChoose a document category.
Document SubcategoryChoose a document subcategory. This field is updated with valid subcategories when selecting a category.
Document TagsSelect any applicable tags. If tags are available in this document category at least one tag must be selected.
Document WeightEnter a document weight if this is required to sort the document within this category, otherwise leave blank. Document weight have sorting priority above the sorting criteria defined for the current category. A higher weight will put a document below a document with lower weights. Negative weights are allowed.
Valid FromSelect the date and optionally the time when this document should be published. If blank the current date will be used. If no specific time is set the document will be published at midnight.
Document ExpiryAdd an expiry date and time if the document should be automatically unpublished at this moment, otherwise leave blank. If no specific time is set the document will be unpublished at midnight
Require ReceiptCheck this box if users should be prompted to confirm that they have received and will read the information contained in this document.
Receipt Due DateSelect the date when all intended recipients should have read this document. An alert will be show in the client software if any document has not been read by its assigned due date. Leave blank if no due date is desired.
File Information (Only available when editing document information)Displays information about the file name and who and when that last updated this document information. An URL to open this document in iDocBrowser is also displayed. This URL can be used to open iDocBrowser documents directly from e-mail or for linking between documents.
Upload a FileClick button and choose or drag and drop any valid file to upload a document to the server. Only files of types allowed by the system (PDF, MS Word/PPT, iBooks, Video (MP4/MOV/MPV/3GP), Boeing FTID XML (ZIP)) with a maximum size of 256Mb is accepted. When uploading a file a time stamp will be prefixed the file name to ensure the file is unique on the server.
Mail Upload

Optionally the server can be configured to accept upload of new documents via mail. A mail address for document upload will be assigned and the server will accept mails from any of the e-mail addresses predefined on the system settings page.

When uploading documents to the server the document can either be an attached file or a PDF-document can be generated based on the content of the mail. The uploaded mail shall contain XML-data describing the document properties as follows:

<?xml version='1.0' standalone='yes'?>
<DOCUMENT>
<NAME>Document Name</NAME>
<CATEGORY>Category</CATEGORY>
<SUBCATEGORY>SubCategory</SUBCATEGORY>
<TAGS>Tags (comma-separated, optional)</TAGS>
<WEIGHT>Weight (optional - defaults to 0)</WEIGHT>
<VALIDFROM>YYYY-MM-DD (optional - defaults to today)</VALIDFROM>
<VALIDTO>YYYY-MM-DD (optional - defaults to no expiry)</VALIDTO>
<RECEIPT>YES/NO (optional - defaults to no)</RECEIPT>
<RECEIPTDUE>YYYY-MM-DD (optional - defaults to no due date)</RECEIPTDUE>
<CONTENT><![CDATA[ Content of PDF to be generated ]]></CONTENT>
</DOCUMENT>

The CONTENT tag may include plain text or HTML. Any HTML code must be surrounded by tags. If no CONTENT tag is included the server will look for an attached document that will be uploaded to the server.

Alternatively basic document properties may be described in the mail subject and the complete mail body will be converted to a PDF-document and uploaded to the server. The mail subject should contain the following information separated by “|”:

Category|SubCategory|Document Title|Page Orientation (P/L)

Page orientation defaults to portrait but may be set to landscape by L. All other document properties will use the default values stated in the XML-syntax above.

The server will send a notification to the system-administrator following a successful or failed mail-upload.

There is also possibilities to use customised import scripts to fit specific mail formats.

Web Upload API

Documents can be uploaded from external systems by submitting an HTTPS POST request to the following address: https://SERVER/api/upload

This request will accept the the following parameters of required and optional metadata:

KEY[Required] An API key that can be found in the server user interface under Administration - Settings.
FILE[Required] File to be uploaded.
NAME[Required] The name of the document as published in DocBrowser.
CATEGORY[Required] The category where this document should be published.
SUBCATEGORY[Required] The subcategory where this document should be published.
TAGS[Optional - defaults to none] Comma separated list of tags as applicable.
VALIDFROM[Optional - defaults to now] YYYY-MM-DD HH:MM when document will be available to DocBrowser clients (HH:MM defaults to 00:00 if omitted).
VALIDTO[Optional - defaults to no expiry] YYYY-MM-DD HH:MM when document will be withdrawn from DocBrowser clients (HH:MM defaults to 00:00 if omitted).
RECEIPT[OPTIONAL - defaults to NO] YES if users actively must confirm receipt of this document.
RECEIPTDUE[Optional - defaults to none] YYYY-MM-DD when document must have been confirmed by the recipient.
ID[OPTIONAL] Unique Ovidius Document ID for the uploaded document - if document with ID already exists that document will be updated.
RESET[Optional - defaults to NO] YES - If RESET is set the download logs for a replaced document will be erased and the uploaded document will appear as new.

The server will respond with an appropriate JSON formatted status message.

Automated Fetch

Optionally the server can be configured to automatically fetch and publish documents from external sources. A common usage scenario is when an external provider regularly publishes documents that shall be available to the DocBrowser users, a task that can be completely automated by the system.

Structure

The foundation of the document data is the structure. All documents are associated with Categories, Subcategories and Tags defined in the structure. The user access control also controls document access by associating roles with Structure elements.

Add a category by pressing the “Add” link in the “Add, remove or edit document categories, subcategories and tags”. Edit or delete a category by pressing respective button in the Edit Category Information dialog by clicking on a category in the category list.

Categories, Subcategories and Tags will be listed in the order defined by the given weight (any number between 0 and 32768).

Each category can accept PDF, MS Word (doc/docx/dot/dotx), MS Excel (xls,xlsx) ,MS Powerpoint (ppt/pptx/pps/ppsx), Videos (MP4/MOV/MPV/3GP), Boeing FTID XML or X/HTML packages (ZIP) and iBOOKS files as set in the Allowed FileType selection. Currently the Windows / OS X client software will only handle PDF files. MS Word files may be downloaded via the webDocBrowser interface but is not ideal for distribution of digital content. It may however be useful to store word document templates in restricted administrative categories for use by editors of digital content. iDocBrowser fully supports PDF and Boeing FTID XML and various X/HTML documents, playback Videos and implements basic functionality for displaying of Word and Powerpoint documents as well as possibility to distribute and open iBooks in Apple iBook.

Documents in each subcategory can be sorted in ascending or descending order according to document name or valid from date. Individual document weighs will always have sorting priority.

Every category must have at least one Subcategory. You may assign a color to subcategories that will be reflected in the client software user interface, a feature useful for color coding of operational notices.

When the “Automatically show All subcategories button” box is checked a Subcategory named “All” will be automatically shown in the client user interface. This Subcategory will list all documents within this Category. When the “Show document count in subcategory buttons” box is checked the total number of documents in each Subcategory will be shown in the client user interface.

When the “Default Require Receipt selection when adding documents” box is checked the Require Receipt box will be checked by default when adding documents to this category.

When the “Automatically permanently delete Expired Documents” box is checked expired documents in this category will be automatically deleted from the server.

When the “MDM Required” box is checked this category will only be visible to devices that are authenticated using a pushed managed application configuration controlled by an Mobile Device Management system. This can be useful to assure that certain categories of sensitive documents only are available on company controlled devices and not on personal devices.

Tags are used by administrators to control document and/or for users to filter documents based on relevance. When the “Show Tag Filtering in DocBrowser user interface” box is checked the user will have the possibility to filter documents based on tags in the client software.

Groups

Groups can be defined in the administrative user interface. Categories can be tied to groups and will be presented in the iDocBrowser user interface under a group menu based on their assigned group. Categories not belonging to any group will be displayed under General. If only one group is available to a user the group menu will not be visible.

Users

Users of the system and their clients must be registered on the server.

The user list can be filtered by name and role. Clicking on respective column header will sort the list based on that column.

New users can be added by clicking on “Add User”. Existing users can be edited or deleted by marking respective user and click on the “Add User” or “Delete User”. Multiple users may be edited or deleted simultaneously. When editing multiple users editing is limited to non user unique options. The edit user dialog may be displayed by double-clicking any user in the list.

Different levels of administrative privileges may be given to any user.

Administrative PrivilegeAdministrative Access
SystemSystem Settings, User Control, Roles, Document Structure, EFB Support
DocumentsDocument Control, Destinations / Hotel Control [Optional],iReForm [Optional]
StatisticsUsage Tracking, Statistics
UserUser Control
KPI [Optional]KPI administration
iReForm [Optional]iReForm administration

The following fields are available in the User Edit dialog:

First NameUsers First Name.
Last NameUsers Last Name.
User IDThe unique individual id used to log on to the webDocBrowser or to synch any DocBrowser client software. The user id is not case sensitive.
PasswordThe user specific password. Passwords are case sensitive.
RoleAt least one role must be assigned to each user. The role defines which documents each user will be able to access.
Allow Self AdministrationChoose if the user has privileges to edit his/her own basic information and/or add/update client information.
AdministratorAssign any administrative privileges.
Publishing RightsOnly visible to users with DOCUMENTS administrative privileges. Assign the categories where this user should be able to publish documents.
Track Document AccessChoose if the user document read status should be tracked on the server. This box must be checked in order to follow up this users activity. For general user accounts this box usually remains unchecked and for individual user accounts this box should be checked.
Initially Mark All as ReadChoose if all documents should be registered as read when the user initially logs on to the system. This option is only available when adding a new user.
User Account ExpirySelect a date when this user account will expire. Leave blank to keep this account available indefinitely.
E-mailEnter the users e-mail address. This address will be used when sending notifications to this user. By clicking the “arrow” button next to this field the system will generate an e-mail address based on first name, last name and the group domain as set in system settings.
E-mail NotificationsDepending on selection a mail notification will be sent to the users e-mail address any time a new document available to this user is published.
CommentIf desired, add a comment regarding this user. Comments are shown in the users list.
ClientsAssociate up to three clients to each user. Each client must be registered using its unique device identifier. The device identifier is generated by the clients and displayed in the client connection settings.The date and time for last client synchronisation is also shown.
User Information (Only shown when editing a user)Shows who and when that last edited this user. Also shows some basic usage statistics.

Note that when editing multiple users at the same time checkboxes in the user edit dialog will have three states: Checked, Unchecked and Mixed. Mixed mode will leave the present value unchanged and will be displayed when editing multiple users with different settings for the particular checkbox.

Roles

The administrator can create, edit or delete different roles. A minimum of one role is required.

Each role is assigned to the applicable categories, subcategories and tags. Typically one role is created for each group of staff (ie Flight Deck B737, Flight Deck B767, Cabin Crew, Technical, Admin Staff etc).

A role can have several levels of access to documents: No Access, Required, Reference, Decluttered, Wifi Download Only or Manual Download. Required documents are documents that is subject to highlighting, read compliance statistics and tracking for users in the specified role. Reference documents are available but not subject to highlighting or read compliance statistics. Decluttered documents are similar to reference documents but will be completely hidden in iDocBrowser decluttered mode. Wifi Download only documents are similar to decluttered documents but will not be automatically downloaded to the device unless a Wifi connection is available. Manual download documents will only be downloaded to iDocBrowser if so requested by the user. (Decluttered, Wifi Download Only and Manual Download feature require iDocBrowser 5.2 or later. On earlier versions these documents will be given reference access)

A user may be assigned to multiple roles and the role access will be merged where required categories has priority over reference categories.

The number of users associated with each role are shown in the roles list. By clicking on the number the users will be displayed.

Settings

Various system settings may be controlled by the assigned system administrator:

Group NameThe name for this user group - cannot changed by the system administrator
MDM passKEYA unique key to be used when authorizing clients automatically using a Mobile Device Management systems application configuration settings.
API KEYA unique key to be used when calling various api functions from external systems.
Contact DepartmentName of the responsible support function for this user group
Contact MailMail address for the responsible support function
Default Mail DomainThe default mail-domain that will be appended when pre-populating mail-address fields
Show Unread Tab for Tracked UsersCheck this box to show an Unread Documents Tab for tracked users in the webDocBrowser user interface
Show Recent Documents TabCheck this box to show a recently published documents tab in the webDocBrowser user interface
Mail weekly status reports (01:00 Monday)Check this box for the system to mail weekly status reports to tracked users that have unread required documents. A summary will also be mailed to the system administrator.
Allow API access and direct link login from following domains (comma-separated)Only allow RSS-feeds and direct link logins from the assigned domains. “*” will allow access from any domain.
Allow document upload via mail from following addresses (comma-separated)Document upload via mail is restricted to mails originating from any of the e-mail addresses assigned here
Allow iOS Client Self RegistrationCheck this box to allow iOS client software to self-register iOS devices on the server
Allow iOS Client Sharing CapabilitiesEnable or disable document sharing capabilities (Mail, Print, Open In) in iDocBrowser
Send Report every monday morning containing upcoming document expiresA report containing documents due for expiry the next seven days is mailed to the system administrator every Monday morning at 5:00
Exclude categories from expiry report (comma separated)A comma separated list of Categories that should be excluded from the document expiry report

Track Usage

The Track Usage functionality is used to display reports over document read status, user read status and user activity. Automated reports can be created that are sent to specified e-mail recipients on a daily (01:30), weekly (Monday 01:30) or monthly (first day of month 01:30) schedule.

Statistics

Comprehensive statistics and access history can be viewed on the Statistics page.

Diagram shows which type of web browsers that are used to access the webDocBrowser and the split between use of iOS or Windows/OS X client software. Additionally a graph representing daily access statistics for the last year is shown.

EFB Support [Optional]

The DocBrowser server may be custom configured to remotely update other servers such as EFB data distribution systems.

The EFB Document Server will be synchronized according to the user role/document access rights of the user named EFBUSER. If this user is not present in the system a warning will be displayed.

The Windows and OS X versions of the DocBrowser and DestBrowser client software can be launched in an EFB mode with a touch friendly interface featuring full text document indexing and search and an integrated PDF-viewer.

Destinations [Optional]

Destination and hotel information can be stored in a database and presented in to users in the interactive iFlyThere iOS app, in the web interface or on the Windows EFB DestBrowser application. Destination and hotel information templates can be defined in the administrative interface. The templates define what information can be stored for a destination or a hotel and how this information is presented to the user. Information is structured in Categories that has a title. This title is presented as a section header to the user. Each Category may have any number of fields. A field can be a short unformatted text field typically used to store names, contact numbers etc or a large capacity rich text field that can store complex formatted text as well as inline images. Only fields containing information will be reflected to the system users.

Visibility of Destination and Hotel information can be controlled using roles. In Destination Settings the overall access to the Destinations functionality can be restricted to certain roles. Each destination and/or hotel can be restricted to certain roles. Each category of data within a destination and/or hotel template can be restricted to certain role.

If location information is provided the destination location will be visually plotted on maps. For destinations the location must be presented as latitude and longitude and for hotels the postal address is required. By pressing the LOOKUP button following entry of an airport IATA code general destination information will be retrieved from a database containing almost ten thousand airports around the world.

All changes will become immediately reflected to the applicable users in the Destinations tab, the iFlyThere iOS client and optionally the DestBrowser EFB application. All destination and hotel data updates require that a revision/change note is entered in order to maintain a revision history.

iReForm [Optional]

The iReForm administrative interface is used to manage available reports and forms, show usage activity and display, review and export forms data submitted to the server from the iReForm iOS application.

Add a form by pressing the “Add Form” button.

View or Edit a form by marking a form and press the “Edit Form” button or double clicking a form in the list.

Delete forms by marking one or more forms in the list and press the “Delete Form” button. Forms can also be deleted by pressing the “Delete” button while editing a form.

The following fields are available when editing a form:

NameEnter the form name that will be shown to iReForm users.
DescriptionEnter a form description. Currently the form description is only shown in the administrative interface.
CategoryEnter a new or select an already existing form category from the list. All forms will be grouped in the iReForm application according to their category. If no category is entered, the form will be grouped under a “General” category.
Available to RolesEnter the Roles for which the form should be available.
Valid FromSelect the date and optionally the time when this form should be published. If blank the current date will be used. If no specific time is set the form will be published at midnight.
Valid ToAdd an expiry date and time if the form should be automatically unpublished at this moment, otherwise leave blank. If no specific time is set the form will be unpublished at midnight
AnonymousCheck this box to prevent storing any user information when receiving a form to the server.
Delivery MethodSelect either “Deliver to Server” or “Send to Mail”. If selecting “Deliver to Server” the iReForm app will deliver any submitted form to the DocBrowser system server where it will be stored in a local database. If selecting “Send to Mail” the iReForm app will use the iOS mail client to submit the form as a mail to a predefined mail address.
Send Mail Notification ToIf the “Deliver to Server” option is selected a notification can be sent to the e-mail addressees (comma-separated) that are entered here. Additionally the recipient can be populated by a form field by using the desired form-id in brackets: [FORMID].
Notification Reply-To addressThe server can add the submitting users e-mail address as the mail notifications reply-to address. The notification receiver can then reply directly to the submitting user from their e-mail client. Beware that some spam-filters may regard a reply-to address not belonging to the sending servers domain as suspicious behaviour.
Notification ContentA mail notification can consists of either “Plain Mail Notification” that only notifies the recipient that a new form has been received by the server or a HTML or XML version of the submitted report. This can be a useful way to export report data to another system.
Deliver Form as Mail toIf the “Send to Mail” delivery method has been submitted this field should contain a comma separated list of e-mail addresses of the intended recipients of this form. The recipient can be populated by a form field by using the desired field-id in brackets: [FIELDID]
Mail SubjectThe desired subject of the mail containing the submitted form. The subject can be populated by a form field by using the desired field-id in brackets: [FIELDID]
Mail ContentSelect the format of the form submitted by mail. Either an attached file in PDF, CSV or XML-format or XML-data within the mail-body.
FTP UploadCheck this box to automatically transfer received reports to an external FTP-account. The transfer will occur four times daily but can also be initiated manually from the iReForm Reports Administration page.
FTP Server CredentialsEnter server address, username and password to be used. Prefix server address with sftp:⁄⁄ if connecting to a secure FTP server. Additionally a destination path can be appended to the server address to specify a directory on the server where the reports should be saved (i e sftp:⁄⁄sftp.test.com⁄myreports).
FTP Report File Type(s)Select which report formats (PDF,CSV,XML) to include in the ftp-transfer.
Receipt ConfirmationCheck this box to send the submitting user an automated confirmation that to the report has been received. This confirmation will only be sent if the user has an e-mail address registered in the user settings.
Receipt confirmation messageAn optional message that will be included in a receipt confirmation mail.
Form EditorThe form editor consists of an online XML editor where the forms template can be edited. Further information about forms creation and editing can be found here.
E-mail recipient from form field

When submitting a form directly from the app as an e-mail or if sending notifications when a form has been received by the server the e-mail addressee can depend on the content of a given form field. If only the field-id is given within brackets [FIELDID] the field is expected to contain one or several comma-separated e-mail addresses. Alternatively address-options may be contained within the brackets in the following format:

[FIELDID|OPTION;ADDRESS|OPTION1;OPTION2;OPTION3;ADDRESS]

FIELDID is the id of the form field where the OPTION should be retrieved. If the form field data matches the option the corresponding address or list of comma separated addresses will be used for sending the mail notification or when submitting the form, as applicable. (The support for submitting a form via mail using the [FORMID|OPTION;ADDRESS] format is supported in iReForm v3.6 and later versions)

Manage received reports

By pressing the Review and Export received reports all forms submitted to the local DocBrowser server database can be reviewed, administered and exported either as individual PDF's, CSV or Excel lists.

Reports and Forms that has been posted to the server may be reviewed and exported by selecting the respective form in the list. A server database table will be created automatically the first time a new report is posted to the server. If an updated form with an existing form ID is posted to the server any new form fields will be merged into the existing database table.

By selecting a form table in the list box and press the List Reports button a dialog will be shown where selection criteria and data filtering can be applied. By default a list with all received reports for the selected form will be displayed. Columns can be rearranged as desired and reports can be filtered according to given criteria. The resulting reports list may be sorted by any column by clicking on the column header. Field data in the displayed report list will be truncated to maximum 20 characters and any images will not be displayed. By double-clicking on a report the report will be shown with all available data including images and the options to save the report as a PDF or delete the report will be available.

By pressing Delete Reports either all or the currently listed reports from the selected form can be deleted.

By pressing Export CSV the currently listed reports with the selected columns will be exported to a comma separated text-file (CSV).

By pressing Export XLS the currently listed reports with the selected columns will be exported to an Excel 2007+-file (XLSX).

By pressing the Activity Report button basic usage statistics is displayed.

By pressing the Force FTP Upload button FTP transfer of reports configured for FTP UPLOAD will be initiated manually.

KPI [Optional]

The KPI administrative interface is used to manage Key Performance or Safety Performance Indicators. Indicators and their properties and accessibility can be defined using the administrative interface. The administrator updates and maintains the indicator data as required. The indicators are presented in a “KPI”-tab to users with roles that has access to Key Performance Indicators. If desired a user named KPIKIOSK may be registered on the server. When logging in with this user the available KPI's will be presented in a KPI-only view that never will timeout and automatically refresh the KPI data every eight hours. This mode can for example be used to present KPI/SPI's on large screen displays in a public office environment. Additionally a pocketKPI compatible JSON feed can be generated by the DocBrowser server using this format: https://SERVER/getPocketKPI.php?un=USERNAME&pw=PASSWORD

The username in the above URL must be prefixed with the applicable group-code, e.g. xxx.username

Client Software

To provide offline access to company manuals and documents the (i)DocBrowser client software can be used.

Client software are available for the MS Windows, Mac OS X, Linux and iOS (iPod, iPhone, iPad) platforms.

Each DocBrowser client’s individual id-number must normally be registered on the server and associated to the current user in order to have access to any document. The system administrator can terminate access rights for any client as desired.

iOS client applications can be remotely configured with relevant server address and user credentials when the target device is enrolled in an Mobile Device Management solution that supports Managed App Configurations.

The following key and value pairs should be included in the Managed Application Configuration to enable remote configuration of the iDocBrowser application:

serverURLThe URL for the DocBrowser server
userIDThe user ID or e-mail address of the user as registered on the DocBrowser server
passKEYThe MDM API passKey that can be generated on the DocBrowser Server Administrative Settings page
docbrowser/introduction.txt · Last modified: 2020/06/21 20:26 (external edit)