1. Home
  2. Transact
  3. Ephesoft Mobile
  4. Administrator Guide

Administrator Guide


This document provides instructions for Ephesoft Mobile administrators to register their organization and access the necessary credentials needed to onboard their mobile application users. This document also guides administrators on how to connect to their Ephesoft Transact server.

The following table describes the three roles within Ephesoft Mobile:

Role Description
Tenant Administrator This role is defined as the first user registered with your organization’s tenancy. They can manage users, define their roles, and configure connectivity to their Transact environment. Administrators can access both the Ephesoft Mobile Administration portal and the mobile application.
Administrator This role can manage users and define roles. They can access both the Ephesoft Mobile Administration portal and the mobile application.
Mobile User This role can only access the Ephesoft Mobile application.


This section outlines the prerequisites for accessing the Ephesoft Mobile application. The mobile application is available on the following two platforms: Android 5.0 and iOS 10 or greater.

Note: These instructions are applicable for use with Ephesoft Transact 2019.1 or above.

System Requirements

The following is required to access the Ephesoft Mobile application:

Licensing Requirements

The installed Ephesoft Transact instance will need a valid Ephesoft Transact Web Service license.

To check if your Ephesoft Transact instance has a valid Web Services license, navigate to License Details in the System Configuration module as shown below. If the web service is enabled, the value shows as On for the Web Service Switch.

Figure 1. License Details

Mobile Connector Installation

Install the mobile connector if Ephesoft Transact does not use a publicly accessible Transact URL.

This section provides instructions on how to install and configure the mobile connector based on your operating system. This mobile connector acts as middleware and calls the Ephesoft Transact Web Services to ingest documents sent from the mobile device.

Perform the following steps to install the mobile connector:

  1. Download the mobile connector. You can also access this link at the bottom of the Configuration screen.

Figure 2. Download Mobile Connector Link

  1. Open the
  2. Extract the .zip file to any location on your system.
  3. Open the following folder: [extracted-directory]\MobileConnectorTomcat\webapps\dcma\WEB-INF\classes\transact
  4. Open the following file:
  5. Update the mc.transact.hostname property to point to your Ephesoft Transact instance. An example is shown below.

Figure 3. Updating mc.transact.hostname Property Example

Note: To ensure a successful setup, consult your network administrator to enable SSL connectivity according to Tomcat best practices. To modify your SSL connectivity, access the server.xml file in [extracted-directory]\MobileConnectorTomcat\conf.

  1. Open the following bin folder: <extracted-directory>\MobileConnectorTomcat\bin
  2. Enter the following command prompt depending on your operating system to start the mobile connector:
  • Windows:
  • Linux:

User Instructions

The following instructions describe how to set up an administrator account for your organization through the Ephesoft Mobile Administration portal.

Your administrative account is configured to connect to your Ephesoft Transact instance. Once a user has downloaded and installed Ephesoft Mobile, the administrator can use the portal to grant appropriate permissions.

Administrator Account Setup

You will receive an email from with a temporary password after confirming your request for a mobile account with Ephesoft Support.

Note: If the welcome email is lost during the onboarding process, contact for an account reset.

Use the following instructions to complete the account setup.

  1. Navigate to the following URL:

Figure 4. Ephesoft Mobile Administration Login Screen

  1. Enter your email and temporary password displayed in the email you received from Ephesoft Mobile Support.
  2. Click Log In.
  3. Reset your password upon login.

Note: The password must be at least eight characters with at least one uppercase letter, lowercase letter, special character, and number. An example is T3st!1ng.

Figure 5. Change Password Screen

  1. After entering an updated password, click Reset Password.
  2. Click Return to Login Screen.

Figure 6. Password Successfully Changed

  1. Enter your email and updated password.

Important: Your account will be locked after seven failed attempts. Contact for further assistance.

  1. Click Log In. The Transact Dashboard screen displays.

Figure 7: Transact Dashboard Screen

  1. Click Configuration. The Transact Connection Details screen displays.

Figure 8. Transact Connection Details Screen

  1. Enter the Transact URL according to the applicable Platform choice in the following format: http://<hostname or DNS>:<port> without any extra URL naming conventions (i.e. remove /dcma).
    • For public Transact URLs, enter the public Transact URL.
    • For private Transact URLs, enter the public Mobile Connector URL.

Note: If entering the URL returns an error message, contact

  1. Enter the Username and Password of your Transact instance.
  2. Click the Platform dropdown menu and select the appropriate platform for your company’s Ephesoft Transact instance.
    • Select Public (Internet Accessible) if your Ephesoft Transact URL is publicly accessible and does not use the mobile connector.
    • Select Private (Intranet Accessible) if your Ephesoft Transact URL is not publicly accessible and requires the mobile connector.
  3. Click Submit. The following screen displays.

Figure 9. Your Ephesoft Mobile Configuration Screen

Important: We are currently experiencing difficulties reliably receiving automated approval requests. Please contact your systems administrator with a request to review your connection details.

  1. Once you receive the activation email, log into the Ephesoft Mobile Administration portal or refresh the browser with an active session. The Batch Class Details screen displays.

Figure 10. Select the Default Batch Class

  1. Click Select to choose the batch class for mobile application users.
  2. Click Submit. The following access information generates and displays: EID, Client ID, and Client Secret.
    • EID: Electronic identification that allows for online authentication and login.
    • Client ID: A public identifier for applications.
    • Client Secret: A mechanism for authorizing a client. This is known only to the application and the authorization server.

Figure 11. Access Information Successfully Generated

Note: Any updates to your Transact URL will need to be approved by Ephesoft Support. This can take up to 24 hours.

You have successfully set up your administrator account for Ephesoft Mobile. Proceed to Onboard Users.

Onboard Users

The tenant administrator is responsible for onboarding additional administrators and mobile users. The following steps describe how to add and configure users for Ephesoft Mobile.

  1. Navigate to the Transact Dashboard screen.

Figure 12. Transact Dashboard Screen

  1. Click User Management.

Figure 13. User Management Screen

  1. Click Add User. The following dialog box displays.

Figure 14. Add User(s) Dialog Box

  1. Ephesoft Mobile has two methods for onboarding users. The email domain name of the users you are onboarding must match yours. For example, if your domain is then you can only add users with the domain name
  • Manual onboarding: Enter up to 10 user emails in the Email(s) field.
  • .csv onboarding: To add multiple users with a .csv file, click Add Users by CSV.

Figure 15. Adding over 10 Users

  1. Click Choose File. Refer to the sample .csv file to format your list of emails.

Figure 16. File Upload

  1. Select your .csv file and click Open.
  2. Select Admin or User for the Role. This applies to all users listed in the Email(s) field or supplied in the .csv file.
  3. Select the Transact URL and Batch Class. This defaults to the Transact URL and batch class setup during the initial configuration.
  4. Click Add. The onboarded users will receive a welcome email.

You have completed the user onboarding process for Ephesoft Mobile.


You have successfully set up your administrator account and can onboard additional administrators and mobile users. For more information about embedding Ephesoft Mobile, refer to the Ephesoft Mobile SDK Developer Guide.

Was this article helpful to you? Yes No