simPRO2EXO - Acacia Consulting...

Acacia Consulting Services Pty Ltd simPRO2EXO Manual

ACN 056 133 745 Issue 2.0, 1 July, 2013

simPRO2EXO

Manual

Acacia Consulting Services Pty Ltd

Level 1, 670 Canterbury Road

SURREY HILLS 3127

www.acaciaconsulting.com.au

http://www.acaciaconsulting.com.au/


ACN 056 133 745 Issue 2.0, 1 July, 2013

Table of Contents

1. What is simPRO2EXO? ....................................................................................... 1

2. User Guide ........................................................................................................... 2

2.1 Main Page ......................................................................................................... 2

2.2 View Data Page ................................................................................................ 3

2.3 Search Button ................................................................................................... 4

2.4 Exception Log Page .......................................................................................... 5

3. Installation Guide ................................................................................................. 7

3.1 System Requirements ....................................................................................... 7

3.2 Installation Notes .............................................................................................. 7

3.3 Installation ........................................................................................................ 7

3.4 Connecting to the simPRO Server .................................................................... 8

3.4.1 Setting up an OAuth Key in simPRO ........................................................ 8

3.4.2 Setting up simPRO Connection ................................................................. 8

3.5 Setting up EXO Connections .......................................................................... 10

3.6 Loading simPRO2EXO Database Additions .................................................. 10

3.7 Selecting simPRO Items for Export ............................................................... 10

3.8 Current Period Only ........................................................................................ 11

3.9 GL Coding Settings ........................................................................................ 11

3.9.1 Get Branch from simPRO ........................................................................ 11

3.9.2 Ignore Account Hyphens .......................................................................... 11

3.9.3 Use simPRO Department Codes .............................................................. 12

3.9.4 Add Company ID to Department ............................................................. 12

4. Initial Synchronisation of Data .......................................................................... 13

4.1 Populating an EXO Database from an Established simPRO System ............. 13

4.2 Populating a simPRO Database from an Established EXO System ............... 14

5. Command Line Parameters ................................................................................ 16

6. Synchronisation Details ..................................................................................... 17

6.1 Clients ............................................................................................................. 17

6.2 Suppliers and Contractors ............................................................................... 17

6.3 Client Invoices ................................................................................................ 18

6.4 Client Payments .............................................................................................. 18

6.5 Supplier and Contractor Invoices ................................................................... 18

6.6 Departments .................................................................................................... 19


ACN 056 133 745 Issue 2.0, 1 July, 2013

7. EXO Database Additions ................................................................................... 20

7.1 Extra Fields in standard EXO Tables ............................................................. 20

7.2 SQL Stored Procedures ................................................................................... 20

7.3 SQL Functions ................................................................................................ 20

7.4 SQL Tables ..................................................................................................... 20

8. Configuration File .............................................................................................. 22

8.1 Additional Configuration Setting - NoFlagMode ........................................... 22


ACN 056 133 745 Issue 2.0, 1 July, 2013

Document Change History

Issue Date Comment

0.0 Dec 2010 Preliminary Draft Release

0.1 Jan 20 2011 Draft Release

1.0 Feb 1 2011 Initial Product Release

2.0 July 1 2013 Updated for version 2.0 of simPRO2EXO, compatible with

simPRO V11


ACN 056 133 745 Issue 2.0, 1 July, 2013

1

1. What is simPRO2EXO?

The simPRO2EXO interface performs a synchronisation from simPRO to MYOB

EXO.

It downloads the following items from simPRO into EXO:

• Clients

• Client Invoices

• Client Payments

• Suppliers and Contractors

• Supplier and Contractor Invoices

• Departments

Clients in simPRO correspond to Debtors in MYOB EXO.

Suppliers and Contractors in simPRO correspond to Creditors in MYOB EXO.

The simPRO system will export items that have not been previously marked as

exported.

This means that when new transactions are available for exporting to MYOB EXO,

they will be imported to EXO and marked as exported in simPRO to prevent them

from being exported again.

New and amended Clients, Suppliers and Contractors in simPRO will be available for

export, and imported into EXO. They will not normally be exported again unless their

details change in simPRO.

Departments correspond to Lookup Stock Items in MYOB EXO. They are used on the

detail lines of debtor invoices in EXO.

This allows for standard Sales Analysis reports to be used in EXO with simPRO

Departments.


ACN 056 133 745 Issue 2.0, 1 July, 2013

2

2. User Guide

2.1 Main Page

Once simPRO2EXO has been setup, Normal operation consists of:

• Choosing the simPRO company (only in a multi-company simPRO

installation)

• Click “Load New Data from simPRO”

This downloads any new or updated items that have not been downloaded

before.

• Click “Post Data to MYOB EXO”.

This sends the downloaded data to EXO.

The item counters show the number of each type on item that has been downloaded

from simPRO, prior to posting through to EXO.

Once the items are posted through to EXO, these item counters would normally be

returned to zero, unless there are exceptions that have prevented transactions from

being loaded into EXO.

The reasons for exceptions are covered in a later section.


ACN 056 133 745 Issue 2.0, 1 July, 2013

3

2.2 View Data Page

Once data has been loaded from simPRO, and before it is posted through to EXO, it

can viewed on the view data page.

It is not normally necessary to use this page to view the data prior to loading into

MYOB EXO.

The View Data Page can be used:

To prevent selected transactions from being imported into EXO, by electing to

“SKIP” exporting specific transactions. This might be done to address a

problem where a transaction has already been manually entered into EXO

inadvertently by an operator, and hence it can be skipped to prevent a double

up.

As an aid to understanding and troubleshooting synchronising with EXO by

allowing the data to be viewed.

Search for specific items in simPRO using the Search function; and choose to

load them into MYOB EXO.


ACN 056 133 745 Issue 2.0, 1 July, 2013

4

2.3 Search Button

The Search Button allows for searching for items in simPRO that have already been

marked as being exported, and hence would not normally be available for download.

It used by choosing the Search parameters and clicking Search. The application will

then download any items that match the search criteria, and display them on the View

Data Page.

The items can then be chosen individually for posting through to MYOB EXO if

required.


ACN 056 133 745 Issue 2.0, 1 July, 2013

5

2.4 Exception Log Page

This page is used to display the exceptions that have prevented transaction from being

loaded into EXO.

The following table lists the common exceptions and the reasons for them occuring.

Exception Message Explanation

Debtor not found in EXO. A Client Invoice or Payment has been

downloaded from simPRO, but there is no

debtor in EXO with a corresponding ID.

This can be solved by manually amending the

details of the Client in simPRO to cause them

to be exported from simPRO into EXO.

Creditor not found in EXO. A Supplier Invoice or Contractor Invoice has

been downloaded from simPRO, but there is

no creditor in EXO with a corresponding ID.

This can be solved by manually amending the

details of the Supplier or Contractor in

simPRO to cause them to be exported from


ACN 056 133 745 Issue 2.0, 1 July, 2013

6

simPRO into EXO.

Transaction is future dated relative

to EXO. The date of the transaction coming from

simPRO corresponds to a future period in

EXO.

Debtor transactions are checked against the

current period in the debtor’s ledger and

creditor transactions are checked against the

creditor’s ledger.

Transaction period is locked in EXO. The date of the transaction coming from

simPRO corresponds to a period in EXO that is

locked.

Debtor transactions are checked against the

debtor’s periods and creditor transactions are

checked against the creditor’s periods.

Transaction period is not current,

and 'Current Period Only' is

required.

On the Setup Page of the simPRO2EXO page

there is an option to enforce current period

only.

This exception is due to the date on transaction

not being in the current period in EXO, while

that option is enabled on the Setup Page.

Debtor Transaction is already present

in MYOB EXO with SeqNo: ??? This means that a Client transaction with a

matching simPRO ID was found in EXO, and

this transaction will not be loaded. This can

occur when using the Search function to down

load transactions from simPRO that have

previously been Exported to EXO.

Creditor Transaction is already

present in MYOB EXO with SeqNo: ??? This means that a Supplier or Contractor

transaction with a matching simPRO ID was

found in EXO, and this transaction will not be

loaded. This can occur when using the Search

function to down load transactions from

simPRO that have previously been Exported to

EXO.


ACN 056 133 745 Issue 2.0, 1 July, 2013

7

3. Installation Guide

3.1 System Requirements

Windows XP SP3 or Windows Server 2003 or better.

Dot Net Framework 3.5 or better.

EXO Version 7.400 or better.

Read/Write privileges over the folder where simPRO2EXO is installed.

Internet connectivity for normal HTTP traffic.

3.2 Installation Notes

The simPRO2EXO application is installed by placing the executable file into any

convenient location where the user has read/write privileges.

All program settings are saved into an INI file located in the same folder as the

executable file.

No program settings are saved in the Windows Registry.

You will need connection details for the simPRO server, consisting of server address,

username and password. You will also need connection details for the EXO database,

consisting of SQL Server name, database name, SQL username and password.

3.3 Installation

Run the simPRO2EXO application to commence setup.

The first time it is run, messages will be displayed requesting that setup details are

established.

Proceed to the SETUP tab to set up the program details.


ACN 056 133 745 Issue 2.0, 1 July, 2013

8

3.4 Connecting to the simPRO Server

The simPRO2EXO interface must be given permission to access the simPRO system

before any data can be accessed. This is done within simPRO.

3.4.1 Setting up an OAuth Key in simPRO

Log into the simPRO system.

Go to System – Setup – API –Application.

Choose Add Application - and setup the details within simPRO.

Once the applicaton is setup within simPRO, you can obtain an OAuth secret key to

be used within the simPRO2EXO interface.

A typical OAuth secret key might look like this:

VKVyzrtyTwFBVqVVBtE-xjbG8sdfgprcOjBgdhj1dug6PBnjYiOPF0CE8M25zJOvm4EfjArwty

3.4.2 Setting up simPRO Connection

Enter the simPRO Connection details into the Setup Tab of simPRO2EXO:

Enter the address of the simPRO server


ACN 056 133 745 Issue 2.0, 1 July, 2013

9

Enter the OAuth Key used in simPRO

Enter the OAuth Secret Key obtained from the simPRO system.

This must be copied-and-pasted into simPRO2EXO because at around 85

characters in length, it is too long to be keyed in accurately.

Click “Test Connection” to verify that the details are correct and that a connection can

be established with the simPRO server.

Remember to save the settings if they are correct.


ACN 056 133 745 Issue 2.0, 1 July, 2013

10

3.5 Setting up EXO Connections

Click “Load simPRO Companies” to retrieve a list of simPRO companies.

There may be only one in a single company installation; or more than one in multi-

company installation.

A different EXO database can be associated with each simPRO company, or a single

EXO database could be used with a different EXO GL Branch for each simPRO

company (or a combination of multiple EXO databases and EXO branches, as

required.)

Enter the EXO Database details for each simPRO company as required:

SQL Server name

Database name

SQL username and password

EXO Branch number (user zero if GL Branches are not being used)

Click “Test Connection” to verify the details and then Save Settings.

3.6 Loading simPRO2EXO Database Additions

When the “Test Connection” button is clicked, the version of the EXO database is

displayed and also the version of the simPRO interface database additions.

A Database Additions version of zero means that the database additions have not been

loaded.

The simPRO interface database additions can be loaded by clicking the “Update

Interface DB…” button. This will load the database additions or perform an update of

the additions if they are already present.

When the simPRO2EXO application starts up, it will check the EXO database for the

version of the addtions. If the version is below the minimum requirement (2023) at the

time of writing) then it will prompt to apply an update for the database additions.

3.7 Selecting simPRO Items for Export

Choose the items to be exported from simPRO to EXO.

It would be normal to tick all items.


ACN 056 133 745 Issue 2.0, 1 July, 2013

11

3.8 Current Period Only

This tick box is used to enforce that transactions can only be loaded into MYOB EXO

if their dates correspond to the current period in EXO.

3.9 GL Coding Settings

3.9.1 Get Branch from simPRO

When this option is ticked, the GL Branch Code for a transaction is will obtained from

simPRO. The Branch code will be taken from the digits to left of a hyphen within the

GL code recorded within simPRO.

For example:

01-51000. The Branch Code is 01. The GL code is 51000.

01-51000-01. The Branch Code is 01. The GL code is 51000, with a sub code of 01.

3.9.2 Ignore Account Hyphens

A hyphen might be used to separate the segments of GL Codes. Hence, this setting

allows hyphens embedded in GL codes in simPRO to be ignored.

This is used in the circumstance where a simPRO installation has been used

previously with MYOB Premier or MYOB AccountRight. In this circumstance the GL

Codes recorded within simPRO would have an embedded hyphen to separate the

single digit GL Account Group from the four digit GL code. For example 5-1000.

The MYOB AccountRight GL code of 5-1000 would become GL account 51000 in

MYOB EXO. Hence in this case, it is important to ignore the hyphens from GL codes

in simPRO or edit all of the GL codes recorded in simPRO to remove the hyphens so

that the correct GL code is passed to EXO.

This option is only active if “Get Branch from simPRO” is not ticked.


ACN 056 133 745 Issue 2.0, 1 July, 2013

12

3.9.3 Use simPRO Department Codes

When this option is ticked the GL Codes within simPRO are ignored, and instead the

simPRO Department Codes are used instead.

The simPRO2EXO interface automatically creates Lookup Stock Items within MYOB

EXO for each simPRO Department. The simPRO Department code in each

transaction is used to select the MYOB EXO Lookup Stock Item. The GL coding for

the transaction is derived from the GL Coding of the Lookup Stock Item.

Example department codes might be: “ELEC”, “DRAWING” etc.

3.9.4 Add Company ID to Department

In the case of a simPRO installation with multiple companies, this option allows for

the Lookup Stock Items created and referenced within MYOB EXO to be preceded by

a company number.

This allows for the case where multiple simPRO Companies are linked to a single

MYOB EXO company, but different GL coding is required per department per

company.

Example Lookup Stock Items created in MYOB EXO might be: “2-ELEC” or

“3-ELEC”.


ACN 056 133 745 Issue 2.0, 1 July, 2013

13

4. Initial Synchronisation of Data

4.1 Populating an EXO Database from an Established simPRO System

An intial download of all Clients, Suppliers and Contractors into EXO from a pre-

existing simPRO installation can be performed with the simPRO2EXO application.

This process will download all Clients, Suppliers and Contractors into EXO provided

they are ticked in the Export section of the Setup Tab.

Transactions are not downloaded into EXO using this process.

It is accessed from the Setup Tab using the Data Initialisation Button.


ACN 056 133 745 Issue 2.0, 1 July, 2013

14

4.2 Populating a simPRO Database from an Established EXO System

An initial upload of EXO Customers and Suppliers can be performed using the

simPRO2EXO interface.

It is accessed from the Setup Tab using the Data Initialisation Button.

Selected Customers and Suppliers can be upload from EXO to simPRO. The

Customers and Suppliers to be uploaded can be previewed prior to uploading them.

The selection of customers and suppliers to be uploaded is performed using a patial

“where” clause for an SQL statement. Hence it could be used to upload Customers or

Suppliers within specific Account Groups or other criteria, as required.

Only Customers or Suppliers with a null value for the X_SIMPRO_ID will be

uploaded.


ACN 056 133 745 Issue 2.0, 1 July, 2013

15

When a Customer or Supplier is uploaded to simPRO, they will be assigned a

simPRO ID. This value is automatically updated within EXO as part of the upload

process.


ACN 056 133 745 Issue 2.0, 1 July, 2013

16

5. Command Line Parameters

The simPRO2EXO application can be automated by running from the command line.

Hence a shortcut can be established with the appropriate command lines parameters,

or it could be run from the Windows Scheduler.

The command line parameters options are as follows:

simPRO2EXO <company number> [auto]

Where:

The company number is the simPRO company number.

“auto” is an option parameter to automatically perform the following

functions:

o Download data from the selected simPRO company.

o Post the data through to MYOB EXO.

o Close the program.

Example 1:

simPRO2EXO 3

This will run the application in interactive mode, and will choose simPRO company

number 3.

Example 2:

simPRO2EXO 4 auto

This will run the application in auto mode, and will choose simPRO company number

4 and perform a synchronisation with EXO. The application will then close.


ACN 056 133 745 Issue 2.0, 1 July, 2013

17

6. Synchronisation Details

This section provides details about the methods used to synchronise data from

simPRO to EXO.

All items being exported from simPRO and imported into EXO have a unique ID.

This is stored in EXO in an extra fields named X_SIMPRO_ID which is usually a

varchar(10) data type.

6.1 Clients

Clients in simPRO correspond to Debtors in EXO.

Clients in simPRO have a unique ID in form of CLI followed by a number. For

example: CLI123.

The ID for the client is stored in an extra field X_SIMPRO_ID on the DR_ACCS

table. It is also stored in the AlphaCode field, but this is for readability only, and is not

used for synchronisation.

If it is necessary to manually set up debtors in simPRO against Clients in EXO, then

both the X_SIMPRO_ID field and AlphaCode fields should be populated with the ID

so that synchronisation will work.

When a Client that is ready for export from simPRO is being loaded into EXO, the

application will look for a client with a matching ID (in the X_SIMPRO_ID field). If

it is not found then a new debtor in EXO will be created. If a matching debtor is

found, then it will be updated with the new details.

6.2 Suppliers and Contractors

Suppliers and Contractor in simPRO both correspond to Creditors in EXO.

Suppliers in simPRO have a unique ID in form of SUP followed by a number. For

example: SUP123.

Contractors in simPRO have a unique ID in form of CON followed by a number. For

example: CON123.

The ID for the supplier or contractor is stored in an extra field X_SIMPRO_ID on the

CR_ACCS table. It is also stored in the AlphaCode field, but this is for readability

only, and is not used for synchronisation.

If it is necessary to manually set up creditors in simPRO against Suppliers or

Contractors in EXO, then both the X_SIMPRO_ID field and AlphaCode fields should

be populated with the ID so that synchronisation will work.


ACN 056 133 745 Issue 2.0, 1 July, 2013

18

6.3 Client Invoices

New client invoices will be downloaded into EXO provided there are no exceptions

preventing their import into EXO.

Client invoices have an ID in simPRO which is loaded into the extra field,

X_SIMPRO_ID, on the DR_TRANS table.

The line details of the sales invoice in EXO use Lookup Stock Items that correspond

to simPRO Departments. The GL code on the invoice lines are contained in the

invoice details from simPRO.

If a matching GL code is found in EXO, then it is used on the invoice line.

If a matching GL code is not found in EXO, then the default Sales GL code in the

EXO GL control accounts is used.

If the option to “Ignore Account Hyphens” is enabled then the GL Code provided in

the Client Invoice details is provided with hyphens removed. The GL code is then

validated in EXO, and will not be interpreted as including a sub-code.

If the “Ignore Account Hyphens” option is not enabled, then any hyphen present will

be interpreted as being a separator between the GL code and Sub-code, prior to being

validate in EXO.

Invoices will only be downloaded once from simPRO.

6.4 Client Payments

Client payments will be downloaded into EXO provided there are no exceptions

preventing their import in to EXO.

Client payments have an ID in simPRO which is loaded into the extra field,

X_SIMPRO_ID, on the DR_TRANS table.

Client payments in simPRO may be allocated to multiple invoices. The same

allocations will be performed in EXO provided the matching invoices are present in

EXO (which they should normally be).

If an invoice identified in a payment allocation detail is not present in EXO, then that

amount will be left unallocated in EXO.

6.5 Supplier and Contractor Invoices

New supplier and contractor invoices will be downloaded into EXO provided there

are no exceptions preventing their import into EXO.

Supplier and Contactor invoices have an ID in simPRO which is loaded into the extra

field, X_SIMPRO_ID, on the CR_TRANS table.

These account codes provided by simPRO are validated against GL Account Codes in

MYOB EXO. If a match is found, then it is used on the Creditors Invoice line. If a


ACN 056 133 745 Issue 2.0, 1 July, 2013

19

matching GL Account is not found, then the Default Purchase Account as defined in

the EXO GL Control Accounts will be used.

If the option to “Ignore Account Hyphens” is enabled then the GL Code provided in

the Client Invoice details is provided with hyphens removed. The GL code is then

validated in EXO, and will not be interpreted as including a sub-code.

If the “Ignore Account Hyphens” option is not enabled, then any hyphen present will

be interpreted as being a separator between the GL code and Sub-code, prior to being

validate in EXO.

Invoices will only be downloaded once from simPRO.

6.6 Departments

Departments in simPRO correspond to Lookup Stock Items in MYOB EXO.

The GL coding on these Department Lookup Stock items is ignored.

The GL Coding on the Supplier, Contractor and Client invoice lines is derived directly

from GL codes contained within those documents from simPRO.

The use of Department Lookup Stock items in sales invoices in EXO allows for the

use of standard Sales Analysis reports.


ACN 056 133 745 Issue 2.0, 1 July, 2013

20

7. EXO Database Additions

This section provides a list of the additions to the EXO database. These additions

consist of extra fields, tables, stored procedures and functions.

7.1 Extra Fields in standard EXO Tables

DR_ACCS add X_SIMPRO_ID varchar(10)

CR_ACCS add X_SIMPRO_ID varchar(10)

STOCK_GROUPS add X_SIMPRO_ID varchar(10)

DR_TRANS add X_SIMPRO_ID varchar(20)

DR_TRANS add X_SIMPRO_COMPANY int

CR_TRANS add X_SIMPRO_ID varchar(20)

CR_TRANS add X_SIMPRO_COMPANY int

STOCK_ITEMS add X_SIMPRO_ID varchar(100)

STOCK_ITEMS add X_DEPT_BATCH_NO INT

STOCK_ITEMS add X_DEPT_ID INT

7.2 SQL Stored Procedures

ACS_Create_CrInv_GLLine_Record

ACS_Create_CrInv_Hdr_Record

ACS_Create_CrInv_StockLine_Record

ACS_Create_Dr_Adjustment

ACS_Create_Dr_Allocation

ACS_Create_Dr_Payment

ACS_Create_DrInv_Hdr_Record

ACS_Create_DrInv_StockLine_Record

ACS_CREATE_STOCK_ITEM_DEPTARTMENT

ACS_Create_StockTransaction

ACS_Get_GLCode

ACS_GetPurchaseTaxNo

ACS_GetSalesTaxNo

ACS_Merge_Creditor

ACS_Merge_Debtor

7.3 SQL Functions

ACS_CLEAN_INTEGER_STRING

ACS_GetDatePeriodSeqno

7.4 SQL Tables

X_SIMPRO2EXO_CONTROL


ACN 056 133 745 Issue 2.0, 1 July, 2013

21


ACN 056 133 745 Issue 2.0, 1 July, 2013

22

8. Configuration File

The simPRO2EXO application saves all settings in a configuration file named

simPRO2EXO.ini, located in the same folder as the executable file,

simPRO2EXO.exe.

The configuration file contains all settings from the SETUP page that have been

saved.

The contents of the configuration file can be viewed in Windows Notepad by double-

clicking on the connection details message at the lower right side of the main form as

shown below. (This is provided INI files have an association with Windows Notepad.)

8.1 Additional Configuration Setting - NoFlagMode

There is an additional configuration setting for testing purposes that can only be

established by directly editing the INI configuration file.

Add the line, NoFlagMode =-1, to the simPROConnection group in the configuration

file to set the application into the test mode: NoFlagMode.

This mode prevents the application form sending any flag instructions back to

simPRO. It can be used to allow for testing with live simPRO system without altering

the simPRO data, by flagging it as exported.

The operator is alerted that the application is in the NoFlag mode by a red alert

message in the lower right corner of the main form as shown below.

Date post:	26-Jul-2018
Category:	Documents
Upload:	hadiep
View:	217 times
Download:	0 times

simPRO2EXO - Acacia Consulting...

Documents