/
EKW Installation Guide

EKW Installation Guide

I. EPICOR Configuration

This module outlines setup requirements for on premises hosted EPICOR Applications.

1. Finding REST URL

The Epicor Kinetic Warehouse (EKW) application uses a REST API to communicate to the EPICOR Application Server, which in turn communicates with your EPICOR DB.

 

a. The Rest API path uses the following format:

https://[MyAppServerHost]/[MyAppServerInstance]


1) This URL will be entered at login.

2) This can also be found in your IIS services.

b. Browse to check it is all working by opening a browser to the API help page.

c. Append /api/help onto your URL.

Example: https://[MyAppServerHost]/[MyAppServerInstance]/api/help

cd Use EPICOR credentials to access EPICOR API Help.

2. Server-side Configuration

This module outlines the specific steps to configure your Epicor Application Server to be compatible with Epicor Kinetic Warehouse (EKW).

 

 

a. In the Application Server Configuration window, in the Net.Tcp Endpoint Binding field, enter in “UsernameWindowsChannel”.

 

 

 

b. In Application Server Configuration window, enter in “HttpsBinaryUsernameChannel” In the Https Endpoint Binding field.

 

 

 

a. In Kinetic version 2022.1.0 and above, the Endpoint Bindings used for authentication were replaced with the Authentication Modes.

b. In the Classic Client Authentication field, select Basic.

 

 

 

 

a. Additional configuration in Azure AD is required to enable Azure AD authentication for EKW.

1) The following Redirect URI https://emwkineticapp/ needs to be added to Azure AD Registered Client Application to allow EKW to be authenticated with Azure AD.
The redirect address for EKW needs to be entered against the AD Application (client) ID

 

 

2) This also appears in EPICOR Azure Active Directory Configuration Maintenance and was set up in Azure AD for Epicor client access (i.e. http://localhost)

 

 

 

 

 

 

a. The following Replay URI https://emww-biscit.com needs to be added for the specific tenant's ERP JavaScript type client (WebApp) in IdP for successful connection.

 

 

 

 

3. Token Authentication

 

a. Open the Epicor Administration Console.

b. Open Server Management, click on the Server Name and select the EPICOR Instance.

 

 

 

c. Under Actions, click on Configure Token Authentication.

 

 

d. Ensure that Enable Token Authentication checkbox is ticked.

 

 

1) To avoid frequent requests to re-authenticate while using EKW app, default Lifetime (sec) could be extended e.g., to value of 36000, which equivalent to 10 hours.

 

4. Cross-origin resource sharing (CORS)

a. Epicor versions prior to 10.2.300

1) In web.config file, located in the Server sub directory of the Epicor Web Applications physical installation path search for “</appSettings>”.

2) Insert the following code above this line:

<add key="CorsOrigins" value="*" />

 

 

b. Epicor/Kinetic versions 10.2.300 and above

1) The standard product ships with the CorsOrigins modification added. Just verify the web.config has the CorsOrigins key added to the app settings.

5. Detailed Error Messaging

a. Epicor and Kinetic versions prior to Kinetic 2022.1.0

1) In the web.config file, located in the Server sub directory of the Epicor Web Applications physical installation path search for “<system.webServer>”.

2) Insert the following 3 lines of code directly above this line:

<system.web>
<customErrors mode="Off" />
</system.web>

 

 

3) Add the following line inside the <system.webServer> tag.

<httpErrors errorMode="Detailed" />

 

 

 

b. Kinetic versions 2022.1.0 and above

1) To enable detailed error messages, instead of editing the web.config file, add a line of code in host.config file found in the Server sub directory of the Epicor Web Applications physical installation path.

2) Add the lines inside the <appSettings> tag.

<add key="SecureErrors" value="False" />

 2) If the line already exists, SecureErrors value needs to be set to False in that line.

 

 

 

6. BPM Messages

a. For Epicor versions prior to 10.2.600

1) In web.config file, located in the Server sub directory of the Epicor Web Applications physical installation path search for “<system.webServer>”.

2) Insert the following code below the line

<httpProtocol>
<customHeaders>
<add name="Access-Control-Allow-Headers" value="ContextHeader" />
<add name="Access-Control-Expose-Headers" value="ContextHeader" />
<add name="Access-Control-Allow-Methods" value="GET, POST, PUT, DELETE, OPTIONS" />
</customHeaders>
</httpProtocol>

 

 

 

b. For Epicor/Kinetic versions 10.2.600 and above (i.e., 10.2.600, 10.2.700, 2021.1, 2021.2 2022.1)

1) From version 10.2.600 onwards the access to Context Header is given by default in the REST service API.

2) No changes to web.config file are required for those versions.

7. Recycle Application Pool

a. Once modifications are complete, save the web.config file and/or host.config.

b. Open Epicor Administration Console and Recycle IIS Application Pool of the application that was modified.

 

 

8. Epicor Setup

9. Firewall Restrictions

10. EKW and EPICOR Licenses

a. For Epicor versions prior to 10.2.600

1) In the first instance EKW attempts to use Data Collection license when making calls to REST API, if the Data Collection license cannot be found, then Default User license is used.

2) If there are no free Default User licenses available, an error message stating Out of Licenses will show up and the user will not be able to log in.

b. Epicor/Kinetic versions 10.2.600 and above (i.e., 10.2.600, 10.2.700, 2021.1, 2021.2 2022.1)

1) In the first instance, EKW attempts to use Epicor Mobile Warehouse license when making calls to REST API.

 

 

II. EPICOR Kinetic Warehouse Installation

1. Device Management

a. Managing your devices and the applications installed on them is your responsibility. We recommend implementing an EMM (Enterprise Mobility Management) solution, particularly as your number of devices increase.

1) Benefits of an EMM:

a) Allows a central administrator to manage all company devices and push out software to all devices

b) Lock down devices

c) Manage software versions

d) Replace the need to physically handle each device and do updates or changes

b. The following configuration variables which are also referred to as app restrictions are exposed in EKW application.

1) epicor_server_url

2) epicor_username

3) license_key

2. Installing EKW from Google Play Store

a. Search Epicor Kinetic Warehouse in the Google Play Store.

b. Select the Epicor Kinetic Warehouse application in the result list.

c. Tap on the INSTALL button.

d. Once the application is finished downloading and the OPEN button is available, the application installation has completed.

e. Tap on the OPEN button to start EKW application.

3. Enabling Automatic Updates

a. To check if this is enabled, go to the Google Play Store and search for the Epicor Kinetic Warehouse application.

 

 

4. Disabling Automatic Updates

a. To check if the Enable auto-update is disabled, go to the Google Play Store and search for the Epicor Kinetic Warehouse application.

 

 

b. Tap on the three dots and ensure that the Enable auto-updates checkbox is un-ticked. 

5. Joining Beta testing

a. Search Epicor Kinetic Warehouse in the Google Play Store.

b. Select the Epicor Kinetic Warehouse application in the result list.

c. Tap on the Join link in Join the beta section.

 

 

c. Tap on the Leave link in You’re a beta tester section to leave Beta testing.

6. Downloads Platform

 

a. Downloading EKW from Downloads Platform

1) Open Google Chrome and navigate to https://downloads.biscit.com.

2) Enter EKW License Key and tap on Login.

 

 

3) Tap the EMW directory.

4) Tap on the folder for the specific release  to be downloaded.

 

 

5) Within the release folder, you will see an installation file: xxxxxx.apk.

6) To install the application, tap on the xxxxxx.apk file.

7) Choose the download location and select and tap on the Download button.

 

 


8) Disregard the warning message and tap on Download anyway.

 

 

9) Tap on Open after the file has been downloaded.

10) Once prompted to install the application, tap on INSTALL (whether installing for the first time or updating the version).

11) A message will confirm if the installation has been successful.

12) Tap on OPEN to open the application or tap on DONE to open the application later.

 

 

 

 

b. Choosing a version of EKW via Release Notes

1) Open Google Chrome and navigate to https://downloads.biscit.com.

2) Tap on the Menu icon and select Release Notes.

 

 

 

2) Tap on the Licence key field and enter EKW License Key.

3) Tap on Login.

4) Read through and choose a version of EKW from the list.

5) Go back to the previous section to download accordingly.

7. EPICOR Login

a. Review and accept the Terms of Service.

b. Tap on CONTINUE.

c. The application will send a request to the Epicor Application Server URL and attempt to obtain a token.

 

 

d. Enter the URL path to your REST API’s in the following format:

“yourservername\yourenvironmentname”

For example: ERPAppServer\ERP10Live

e. Tap on CONTINUE.

 

 

f. Enter EPICOR username and password

 

 

g. Tap on LOG IN.

 

8. Applying License Key


a. Enter a license key or run the application in Demo Mode.

 

 

 

1) Entering the License Key on the device will register it as an active device against the license. Once all of devices allowed by the license have been registered, it will no longer be possible to register any additional device.

a) It is advised to keep an internal log of which devices have been registered.

2) When DEVICE button is tapped, the ID of the device used to register it is displayed. Depending on the Android and EKW versions it could be a SERIAL, IEMI or UUID.

 

 

b. Depending on the Android and EPICOR Kinetic Warehouse application versions, access permission pop-ups may be presented.

 

c. Tap on the ALLOW button. Selecting DENY will not allow the application to function.

 

 

d. The collected information is non-personal, non-identifiable, and complies with EPICOR Privacy Policy, as well as international laws and regulations.

 

e. In the Employee Config window, select the Company, Plant, and Employee ID.

 

 

 

f. Tap on LOGIN.

g. An info message prompt will indicate that Roaming settings are not configured.

 

 

h. Tap on OK.

9. Deregistering Device License

a. Log into the application.
b. On the Home screen, tap on the employee image and select Licensing.

 

 

c. Tap on Remove Licence.

 

 

d. On the Log in screen, tap on the employee image and tap on Remove Licence.

 

 

a. Access the Product Portal

b. Select device/devices to be deregistered

c. Press DEREGISTER SELECTED DEVICES button

 

 

d. Enter reason for deregistering the device/devices (optional) and press SUBMIT button

10. Downgrading installed version

a. Deregister Device License as described in point 8 of this guide (above).

b. Uninstall the current version (drag the app icon to the top of the screen and drop on Uninstall icon or long press the app icon and press app info icon and press UNINSTALL icon)

c. Download the required EKW version from https://downloads.biscit.com (access with valid license key)
d. Install the application following instructions in points 5, 6 and 7 of this guide.

III. Recommended Devices

1. Keyence Device Configuration

 

2 Honeywell Device Configuration

 

 

 

3. Zebra Device Configuration

 

 

a. To create the EMW profile, verify that EMW profile does not exist in the DataWedge.

 

 

1) Tap on the DataWedge app icon to view configured profiles.

 

 

b. In EKW, navigate to Settings and tap on Scanner.

 

 

c. Tap IMPORT PROFILE button.

 

 

d. Re-check DataWedge to check if the profile is now visible in the list.