bil for epicor 10 installation guide€¦ ·...

1

Precise BIL for Epicor 10 Installation Guide


2


Table of Contents

Introduction ............................................................................................................................... 3

About BIL ..................................................................................................................................................... 3

Preparing to Install ...................................................................................................................................... 3

POS and ARM Compatibility with BIL .......................................................................................................... 4

Overview of Installing and Configuring BIL .................................................................................. 6

STAGE 1: Install the BIL Services ................................................................................................................. 7

STAGE 2: Completing the BIL Configuration Utility .................................................................................. 10

STAGE 3: Import Precise BAQs .................................................................................................................. 17

STAGE 4: Import the Precise BPM pack for Epicor 10 .............................................................................. 20

STAGE 5: Make any necessary changes to BIL Configuration files ........................................................... 22

Configuration Notes ................................................................................................................. 23

POS Customer Templates ......................................................................................................................... 23

Filtered Integration flags for POS ............................................................................................................. 23

Configuring Multiple BIL hosts .................................................................................................. 24

Timeout for Processing settings ................................................................................................ 25

3


Introduction

This Installation Guide describes the procedure for installing Precise BIL, the Precise Back Office

Integration Layer.

About BIL

BIL constitutes a software layer that permits data from Precise POS, Precise ARM, and other

management systems to be integrated with Epicor. Precise BIL comprises the following

components and functionality:

• The BIL Tracking Database stores information about data changes or deletions in the

selected ERP System.

• The BIL Services provide the following functionality:

o The Precise BIL Service provides a set of services that other applications can

interact with to receive data from, or create data in, Epicor

o The Precise Data Refresher Service populates the Tracking Database with all data

from Epicor when there is a full synchronisation request.

o The Precise DataSync Service is a real-time service that populates the Tracking

Database with relevant data from both Precise Products and Epicor when there are

changes to existing records.

o The Precise Posting Service has been added for POS 10.0 SP1+ to specifically keep

trying to post items in Epicor as it has been noted that posting is not always

successful on the first attempt in Epicor for various technical reasons.

NOTE The information in this document was accurate at the time of publication, December 2018, but it may change without notice.

Preparing to Install

Prior to installing BIL version 10+ ensure the following:

1. .Net Framework, version 4.5+ has been installed. This can be downloaded and installed via

the internet. Note that .Net Framework v4.5+ is not compatible with SQL Server 2005.

2. Both Epicor and the Precise system (e.g. POS or ARM) to be integrated with have been

configured.

For data integration to take place via BIL, Epicor and the Precise system, e.g. POS or ARM,

that will supply data to it, must be correctly configured.

3. You are logged in as a user with Administrator rights.

You must be logged in with Administrator rights to install Precise BIL.

4. If you are uninstalling a previous version of BIL you must manually delete any remaining

files from the old installation directory, and delete old shortcuts on the Desktop, as these

will no longer work.

4


POS and ARM Compatibility with BIL

Epicor Precise POS and ARM must be installed against the correct BIL version. To ensure that your

version of POS or ARM is compatible with the BIL version installed, please consult the following

tables:

POS Version Epicor System Version BIL Version Date of BIL

Version

10.2 SP5 10.2.300.0 10.2.7 Oct 2018

10.2 SP4 10.2.200.0 10.2.4 Aug 2018

10.2 SP3 10.2.200.0 10.2.3.33 May 2018

10.2 SP2 10.2.200.0 10.2.2.41 Apr 2018

10.2 SP1 10.2.100.2 10.2.1.91 Mar 2018

10.2.0 10.2.100.2 10.2.0.177 Nov 2017

10.1.SP2 10.1.600

10.1.500.0

10.1.400.0,

10.1.300.1,

10.0.700.4

10.0.700.2

10.0.700.1

10.0.600.3

10.1.9 May 2017

10.1.SP1 10.1.500.9,

10.1.400.0

10.1.300.1,

10.0.700.4

10.0.700.2

10.0.700.1

10.0.600.3

10.1.5 Sep 2016

10.1.0 10.1.400.0

10.1.300.1,

10.0.700.4

10.0.700.2

10.0.700.1

10.0.600.3

10.1.0 Feb 2016

10.0 SP6 10.1.300.1,

10.0.700.4

10.0.700.2

10.0.700.1

10.0.600.3

10.0.6 Aug 2015

5


10.0 SP5 10.0.700.4

10.0.700.2

10.0.700.1

10.0.600.3

10.0.5 May 2015

10.0 SP3 10.0.700.2

10.0.700.1

10.0.600.3

10.0.3 Nov 2014

10.0 SP2 10.0.700.1

10.0.600.3

10.0.2 Oct 2014

10.0 SP1 10.0.700.1

10.0.600.3

10.0.1 Jul 2014

10.0.0 10.0.500.1 10.0.0 Mar 2014

ARM Version Epicor Version BIL Version Date of BIL

Version

10.3.0 10.2.300.0 10.2.9.4 Dec 2018

10.2.4 10.2.300.0 10.2.6.13 Oct 2018

10.2.3 10.2.200.0 10.2.5.20 Aug 2018

10.2.2 10.2.200.0 10.2.1.13 May 2018

10.2.1 10.2.200.0 10.2.1.91 Mar 2018

10.2.0 10.2.100.2 10.2.1.13 Dec 2017

10.1 SP9 10.1.600 10.1.11.57 Jun 2017

10.1 SP8 10.1.600 10.1.10 May 2017

10.1 SP7 10.1.600 10.1.8 Apr 2017

10.1.SP6 10.1.500.9 10.1.7 Feb 2017

10.1 SP5 10.1.500.7 10.1.6.91 Jan 2017

10.1 SP4 10.1.500.1 (.Net 4.6.1 +)

10.1.500.0

10.1.4 Sep 2016

10.1 SP3 10.1.400.7 10.1.3.74 Jun 2016

10.1 SP2 10.1.400.0 10.1.2.29 May 2016

10.1 SP1 10.1.400.0 10.1.1.1 Mar 2016

10.1.0 10.1.400.0 10.0.6.77 Dec 2015

10.0 SP5 10.1.300.1 10.1.0.9 Oct 2015

10.0 SP5 10.1.300.1 10.0.6.62 Aug 2015

10.0 SP4 10.0.700.4 10.0.6.16 Jun 2015

10.0 SP3 10.0.700.2 10.0.4.89 Feb 2015

10.0 SP2 10.0.700.1 10.0.2.43 Sep 2014

10.0 SP1 10.0.500.1 and 10.0.600.3 10.0.1.89 Jun 2014

10.0.0 10.0.500.1 10.0.1.55 May 2014

6


IMPORTANT The BIL install file for Epicor 9/10 is titled similar to

‘BILServices.Setup.(10.0.x.x).x86.E9.msi’. The BIL install file for Epicor 7 is titled

similar to ‘BILDatabaseWizard.msi’. Please ensure that you are running the correct

version of BIL for your backoffice software, i.e. Epicor 9, Epicor 10, or Epicor 7(POS).

Also, note that when using ARM on Epicor 7 no BIL is required.

Overview of Installing and Configuring BIL Installing BIL entails the following stages:

STAGE 1: Install the BIL ServicesThe Setup Wizard installs the BIL/Data Refresher/DataSync Services, the Database Wizard, and the BIL Configuration Utility.

STAGE 2: Run BIL ConfigurationThe Configuration Utility installs the DataTracker database, saves database connection settings, and values such as username / password / company ID / and app server name.

STAGE 3: Import Precise Business Activity Queries.The BAQs import supplemental data for POS/ARM.

STAGE 4: Import the Precise BPM pack

STAGE 5: Make any extra BIL Configuration changes.

7


STAGE 1: Install the BIL Services

1. Run the Windows Installer Package: BILServices.Setup.10.x.x.x.msi

NOTE The default installation location is C:\Program Files(x86)\Precise\BIL

2. When the BIL Setup Wizard starts, click the Next button.

3. Tick the checkbox to accept the License Agreement and click the Next button.

8


4. Choose the Setup Type and then click Next. This guide assumes the user has selected

Complete. If you select any of the other buttons follow the appropriate prompts.

5. Click the Install button to start the installation.

6. When the Installation Complete message is displayed leave the Launch Precise BIL

Configuration Utility checkbox selected, and click Finish.

9


NOTE The BIL Configuration Utility should always be run after installing BIL.

If the BIL Configuration Utility does not start automatically it could be that

.NETFramework, version 4.5+ has not been downloaded and installed. Please

download and install this software then start the BIL Configuration Utility manually

from the installation folder, by default this will be C:\Program Files

(x86)\Precise\BIL. The application is titled PBS.BIL.ConfigurationUtility.exe. Double

click this application to start the Precise BIL Configuration Utility.

10


STAGE 2: Completing the BIL Configuration Utility

When the Precise BIL Configuration Utility launches, click Add

Select the BackOffice product.

Enter the required Epicor Company Information and then click the Next button.

11


If you are installing BIL for ARM and ARM is to be multi-company enter the Company ID of the

additional companies in the Additional Companies section of the screen above. For each

additional company, please enter the Code of the Chart of Account, and the Code of the main

site/Plant for that company. (See below for information on where to find these details in Epicor).

The column is entitled Plant because this wizard covers both Epicor 9 and Epicor 10. Epicor 9 Plants

are called Sites in Epicor 10.

If you are installing BIL for POS do not enter any data in the Additional Companies section as POS

does not support Multi Company setup.

a. Company ID is found in Epicor > System Setup > Company/Site Maintenance >

Company Configuration screen:

b. Site ID for the Plant field in the wizard is found in the Epicor database in the Site

column of the Site table.

c. Chart of Account (ID) is found in Epicor > Financial Management > Accounts

Receivable > Setup > Chart of Account Structure Maintenance screen:

d. Customer Template Group Code, select an appropriate code from Epicor > Sales

Management > Customer Relationship Management > Setup > Customer Group

IMPORTANT The Customer Template Group Code entered into BIL must pre-exist

in Epicor.

12


On the Epicor Connection Information page enter the required data:

a. EPICOR App Server Url – This is copied directly from the EpicorERP10.sysconfig file

which is usually in the location:

C:\Epicor\ERP10\ERP10.2.300.0\ClientDeployment\Client\Config and will be of the

format net.tcp://localhost/Epicor10

b. EPICOR User Name – The login for the installed version of Epicor

c. EPICOR Password– The password for the installed version of Epicor

d. Confirm EPICOR Password – Type in the password again

e. Epicor Version – Select the installed version from the list

f. Epicor Client Binaries Folder – Browse to the appropriate folder. The default is usually

C:\Epicor\ERP10\LocalClients\E10Demo** (for example). Click Next to display the E10

App Server Connection Method page.

Click the Next button.

The E10 App Server Location page specifies the method of connecting to the E10 Application

Server. Make the appropriate selections and click the Next button.

• The default setting On local network assumes that the Epicor App server is installed locally.

If Windows single sign on is used tick the checkbox and add the Windows user name and

password.

• If you are using Epicor SaaS select the In the cloud radio button and enter the Dns identity

which can be found in the start-up Config file of the Epicor Client.

13


The User defined codes page is displayed.

This page is used in conjunction with User Codes in Epicor > System Setup > System Maintenance >

User Codes. The User Codes in Epicor must be pre-configured for BIL to be able to use them. The

data on this screen is not mandatory, if your installation is not using User Codes from Epicor leave

the fields blank and click Next. For more information on how to configure Epicor User Codes please

see the Precise POS for E10 Installation Guide.

➢ Create missing UD fields

This check box provides the option to skip the UD field creation process the BIL

Configuration Utility performs. For example, this should be un-checked when

implementing a connection to an Epicor SaaS environment.

14


On the Precise BIL Tracker Database page, in the SQL Server field enter the name of the server that

the BIL tracker database is to be installed on. After entering the Login Name and Password click on

the Validate Server button to confirm the connection. When the cursor flashes in the Database

field enter a name for the database to be used e.g. E10DataTracker. If the database does not

already exist it will be created. Click the Next button.

The Precise BIL Service Instance Information is entered next. Select the Binding type from the

drop down list, enter the Port number and click OK.

* As of BIL 10.2.4 POS requires that you use WsHttp binding (because the BIL services for POS use

the metadata exchange endpoints that are the default in WsHttp binding).

15


On the summary page you can now click either the Finish button or the Add button (to add

additional instances of BIL for speedier processing).

Once you click Finish, a dialog box is shown that performs a check of the steps the BIL installation

does. The process also confirms the UD fields that are required by Precise POS or ARM are present

in Epicor and if they are not or some are missing, creates these automatically.

Note: this process only creates the UD fields. The Regenerate Data Model process should then be

executed manually within the Epicor Administration Console.

Lastly, a confirmation message is displayed if BIL has been correctly configured.

16


To Edit the BIL Configuration at any time run the Utility again via the executable,

PBS.BIL.ConfigurationUtility.exe, which is installed to C:\Program Files (x86)\Precise\BIL by default.

17


STAGE 3: Import Precise BAQs

IMPORTANT This step needs to be completed whether BIL is to be used with

Epicor Precise POS or Epicor Precise ARM

1. Start Epicor

2. Navigate to: System Management > Business Activity Queries > Business Activity Query to

open the Business Activity Query Designer screen.

3. Select Actions > Import BAQ

4. On the Import Business Activity Query dialog click the Select File button

5. System defaults to the BIL install folder, if not the default install path is C:\Program Files

(x86)\Precise\BIL\BPMs

6. Select each file in turn applicable to your Epicor version. There is currently a total of 6

BAQs to import for Epicor 10.

Epicor 9 Epicor

10.0.x

Epicor

10.1.x

up to

10.1.500

Epicor

10.1.600

10.2.100

10.2.200

10.2.300

APInvoiceByLineItemSearch-E10.0.x

APInvoiceByLineItemSearch-E10.1.x

GetEntityGLC

GetOrderRelSysRevID

GetPartDefaultBin

GetTFShipDtlRows

GetTFShipDtlRows-E10.0.x

GetTFShipDtlRows-E10.1.600

GetTFShipDtlRows-E10.1.x

GetUnprocessedShipments

GetUnprocessedShipments-E10.1.600

GetUnprocessedShipments-E10

18


7. Copy the name of the file only into the New QueryID field. Eg. GetEntityGLC. Epicor 10

users should follow the naming convention GetUnprocessedShipments-E10 for that

particular BAQ.

8. Tick the Show in Designer checkbox.

9. Click the Import button.

10. Answer Yes when asked if you want to overwrite the existing file.

11. Close the Import Business Activity Query dialog, the Detail screen is displayed.

12. Tick the Shared and All Companies checkboxes and Save. Repeat steps 3 to 11 for each Baq

file.

19


If you are installing Epicor Precise POS, amend the value in following setting into the POS

Integration Manager Configuration file to be the same name as the BAQ that you have just

imported, e.g. usually this just means add the ‘-E10’ to the end of the value. The Integration

Manager Configuration file is called IntegrationManager.exe.config

IMPORTANT For POS the name of the GetUnprocessedShipment.baq file can be

changed prior to import if necessary, however there is a limit of 30 characters for

the name of the file and some extra configuration needs to be added to the IM

Configuration file, IntegrationManager.exe.config. Complete the following

procedure if a name change is required

1. Export and Re-Import the GetUnprocessedShipments baq with the new name.

2. Add the following setting into the Integration Manager configuration file

Note: the value of this setting must match the name of the new BAQ at step 1. (By default

BIL uses the value UnprocessedShipments, so, if there is a different name for the query a

new key is required.)

3. Start or restart Precise POS Integration Manager Service.

20


STAGE 4: Import the Precise BPM pack for Epicor 10

IMPORTANT The BPM pack/s needs to be imported for each Company that ARM

will use.

1. Start Epicor

2. Navigate to System Management > Business Process Management > Directive Import

3. Click on the File Name button to select the File for import

4. System defaults to the BIL BPMs folder, if not the default install folder path is C:\Program

Files (x86)\Precise\BIL\BPMs

5. Select the BPM file that is appropriate for Epicor 10: Precise.BIL.E10.Common.bpm

6. Click Open

7. Back on the Directive Import screen, select the appropriate Group from the drop list

(Precise) and ensure the Replace Existing Group checkbox is ticked. *Note: For a first time

installation, no existing group will be present. Leave the Destination Group as

and the Precise group will be created.

8. Click the Import button

9. An Information message is displayed when the import has completed

10. ARM 10.2 SP4+ now requires a separate BPM (Precise.BIL.E10.ARM.bpm) which will import

for the first time to a group called PBS-ARM.

21


11. If you are installing BIL for ARM and ARM is multi-company then the BPM packs needs to

be imported to each Additional Company as well.

22


STAGE 5: Make any necessary changes to BIL Configuration files

If BIL is being installed on Epicor 10 the following changes to the BIL configuration files are

required:

1. Open the BIL configuration file. The name of this file(s) will depend on the port number

used during the installation of BIL. Look at the Precise BIL Configuration Utility and find the

BIL Port number, the name of the BIL Configuration file will be BIL underscore port number,

so in the following instance the file will be called BIL_17000. The default installation path

for this file is C:\Program Files (x86)\Precise\BIL

2. Change the value of the following line from ‘true’ to ‘false’.

3. Save the changes.

4. Restart the Precise BIL services.

If you are running backend version Epicor 10.0.500 + for either ARM or POS, add the following

setting

(This setting is required for Epicor 10.0.500 + This setting should not be added if you are running

backend version Epicor10.0.400)

1. Add this setting to the BIL_17000 config file:

2. Save the changes.

Restart the BIL services.

Installation of BIL is now complete.

23


Configuration Notes

This section describes optional settings that may be configured.

POS Customer Templates

In the Precise BIL configuration files, BIL_17000, BIL_17001 etc., (if more than one BIL instance

configured,) the setting customerTemplateGroupCode specifies the Code for the CustomerGroup

that will be used for the POS Customer Templates.

IMPORTANT This Code should be set up in Epicor before installing Precise BIL;

otherwise installation will not be able to proceed.

Every Customer that is part of the configured Customer Group in Epicor will be treated as a

Customer Template in POS.

To synchronise Customer Templates from Epicor to POS (to the AR Settings tab on the Customer

Type Maintenance screen), you need to add Customers in Epicor to this particular Customer Group

and wait for them to be synchronised to POS.

Filtered Integration flags for POS

In the BIL_17000+ config files are three flags that allow POS Clients to filter some data that is

integrated into POS. The flags are ‘customerIntegrationFlag’, ‘partIntegrationFlag’, and

shipViaIntegrationFlag.

These enable BIL to look at a specific User-defined field in the Epicor database in the Customer,

Part and ShipVia tables and based on the value of that flag BIL will know whether to integrate this

Customer, Inventory Item (Part) or ShipVia code into POS. If the value of the flag is ‘1’ then the

Customer, Inventory Item (Part), or ShipVia code will be integrated.

It is the POS Client’s responsibility to maintain the settings in the BIL config file and also the

referenced database fields.

After any change to these settings it will be necessary to restart the Precise services in Start >

Administrative Tools > Services and re-synchronise the appropriate Integration Manager job within

POS SMS, i.e. the Customer job, the InventoryItem job, or the ShipVia job or perhaps all three.

Navigate to SQL Server Management Studio and execute an sql statement / query to update the

value of the new field to ‘1’ for those records that are to be integrated.

In the BIL config file (BIL_17000.config), (or files if you are running multiple BIL hosts), enter the

name of the relevant field into the parentheses belonging to customerIntegrationFlag,

partIntegrationFlag or shipViaIntegrationFlag. Save the changes.

Restart the BIL services via Administrative Tools > Services.

In Precise POS SMS synchronise the appropriate job, Customer, InventoryItem or ShipVia. The

relevant records only will be integrated into POS.

24


Configuring Multiple BIL hosts

The BIL Service is installed by default with one instance (host) only. However, the BIL Service can be

configured to have multiple instances running on different ports and have all those instances used

globally by the Integration jobs. Doing this will speed up processing as it means the Integration jobs

can run multi-threaded.

As of BIL 9.0.6 additional BIL instances can be configured automatically via the BIL Configuration

Utility.

To configure multiple instances of the BIL Service automatically:

1. Stop the Integration Manager Service and all BIL services.

2. Use the Precise BIL Configuration Utility which is installed by default to '"C:\Program Files

(x86)\Precise\BIL\"

3. Click the Add button on the utility to begin creating the new instance of BIL. Settings can

be copied from previous instances unless this instance is being hosted on a different

Application Server (Host). If the new instance is to run on the same server then only the BIL

Port setting must be changed.

4. During the Configuration these screens will be displayed in order, EPICOR Company

Information, EPICOR Connection Information, BIL Tracker Database connection details, and

finally BIL Service Instance Information.

5. You can ignore the final message about importing the BPMs and BAQs as this will already

have been done during the configuration of the original BIL service and does not need to be

repeated.

6. The BIL Configuration Utility will automatically start the BIL services after the configuration

of this new instance.

IMPORTANT To use the additional BIL instances globally with Precise POS SMS go

to Central > Site Tools > Integration Manager, right click and select Properties then

Global WCF Service Hosts tab and add the new instance similar to below:

See the Precise ARM Installation Guide for the additional configuration required

there.

25


Timeout for Processing settings

If you are experiencing problems with timeout errors the Timeout for processing can be configured

in the BIL configuration file. Search for the following snippet and amend the timeouts as required.

26


Precise Business Solutions 1/116 Hobart Street Mt Hawthorn WA 6016 Phone: +61 8 9242 5933 Fax: +61 8 9242 5934 www.precisebusiness.com.au

Corporate Office 804 Las Cimas Parkway Austin, TX 78746 USA Toll Free: +1.888.448.2636 Phone: +1.512.328.2300 Fax: +1.512.278.5590 www.epicor.com

Document Title:


Release Date:

Dec 2018

bil for epicor 10 installation guide€¦ ·...

Documents