Integration Profile Configuration
The following outlines the available settings for the MYOB Client and Jobs integration initialisation file.
Default initialisation filename:
- Int_MYOBAccounts_Default.ini
Settings
Key | Description/Setting |
|---|---|
IntegrationType | Description: Specifies the type of integration to be performed. This is a fixed value that should not be changed. Setting: MYOB Accounts |
UseWizard | Description: Specifies whether integration will be run manually or automatically. Setting: 0: Integration will be run based on the values in the .ini file and can be run automatically without user intervention. 1: Integration will be run using a wizard allowing users to modify the details of the integration. |
Databases
Key | Description/Setting |
|---|---|
ODBCDSN_Framework | Description: ODBC DSN name for the Framework ECM database. Setting: FworkSQLEcm |
ODBCConnect_Framework | Description: ODBC DSN connection string for the Framework ECM database. Setting: None |
ODBCDSN_FrameworkLicense | Description: ODBC DSN name for the Framework licence database. Setting: FworkSQLLic |
ODBCDSN_IntMapping | Description: ODBC DSN name for the Framework Integration mapping database. Setting: FworkSQLIntMap |
ODBCConnect_IntMapping | Description: ODBC DSN connection string for the Framework Integration mapping database. Setting: None |
ODBCDSN_MYOB | Description: ODBC DSN name for the MYOB system database. Setting: MYOB ODBC |
DatabaseName_MYOB | Description: MYOB system database name. Setting: DynaFramInterface |
ODBCConnect_MYOB | Description: ODBC DSN connection string for the MYOB system database. Setting: "uid=enterUserName;pwd=enterPassword" |
Mail Configuration
Key | Description/Setting |
|---|---|
Mail_System | Description: Email delivery method. Setting: 0: No email will be sent. 1: Email will be sent using MAPI. 2 (default): Email will be sent using SMTP. |
Mapi_Profile | Description: Microsoft Outlook user profile name. Setting: (default): Outlook |
Mail_From | Description: Name or email address of who/where the email is being sent from. Setting: FrameworkIntegration |
Mail_Recipient | Description: Mail recipients for the integration logs. Multiple addresses can be added if separated with a semi-colon (;). Spaces are not necessary before or after the semi-colon. Setting: enterRecipientEmail@yourDomain.com.au;integrationsupport@insulagroup.com.au |
Mail_Subject | Description: Email subject heading. Setting: "Framework Integration: MYOB Client and Jobs" |
SMTP_Server | Description: If using Mail_System 2 (SMTP), add the SMTP Server name. Setting: enterSMTPServerName (replace this text with your SMTP Server name) |
SMTP_UseSecurity | Description: Security setting for the SMTP server. Setting: 0 (default): A username or password is not required. 1: A username and password is required. If this setting is used, the SMTP_UserName and SMTP_Pwd fields must have a valid username and password. |
SMTP_UserName | Description: Valid username for the SMTP server. Setting: enterUserName (replace this text with a valid SMTP Server User Name) |
SMTP_PWD | Description: Valid password for the SMTP username. Setting: enterPassword (replace this text with a valid SMTP Server Password) |
Criteria
Key | Description/Setting |
|---|---|
CriteriaMethod | Description: Job selection criteria for retrieving records from Framework ECMto process. Setting: 1: Single region/division. 2: Single job. 3: Single team. 4 (default): All jobs. 5: Accounts entity. |
CriteriaData | Description: Input criteria data for the criteria method. Setting: insert number; for example, if using CriteriaMethod 2, the setting for CriteriaData will be the specific job number to integrate on. |
JobCriteria | Description: Job criteria number. Setting: 1: AllJobs 2: SingleJob(JobNumber) |
JobCriteriaID | Description: Job criteria ID to hold the single job number. Setting: 0 |
Special Values
Key | Description/Setting |
|---|---|
MYOB_TaxCode | Description: Value for the MYOB tax code. Setting: GST (default) |
MYOB_PaymentDueCode | Description: Value for the MYOB payment due code. Setting: 2 (default) |
MYOB_BalanceDueDays | Description: Value for the MYOB balance due days. Setting: 0 (default) |
Integrated Fields
The integration of MYOB Client and Jobs to Framework ECM is fully customisable via the integration mapping database.
Dbo.Import_Jobs
MYOB Database Field Name | Create | Update | Framework Database Field Name |
|---|---|---|---|
JobNumber | Yes |
| Framework: s_job_num |
JobName | Yes | Yes | Special #55: s_job_address or “New Job” |
SubjobOf |
|
|
|
Header | Yes | Yes | Fixed Value: “D” for Detail |
Description | Yes | Yes | Framework: s_description |
Contact | Yes | Yes | Framework: s_clientCont_name |
StartDate | Yes | Yes | Framework: d_site_start_act |
PercentComplete |
|
|
|
FinishDate | Yes | Yes | Framework: d_cst_comp_act |
Manager | Yes | Yes | Framework: s_supervisor_name |
LinkedCustomer | Yes | Yes | Framework: s_client_nameRef |
InactiveJob | Yes | Yes | Framework: s_inactive_job |
TrackReimburseables |
|
|
|
Dbo.Import_Customer_Cards
MYOB Database Field Name | Create | Update | Framework Database Field Name |
|---|---|---|---|
CoLastName | Yes | Yes | Framework: s_client_nameRef |
FirstName |
|
|
|
CardID | Yes |
| Special #56 - Framework: s_client_boq or s_client_num |
CardStatus | Yes | Yes | Framework: s_inactive_client |
CurrencyCode |
|
|
|
Address1AddressLine1 | Yes | Yes | Special #54 - Framework: s_client_stNum + s_client_stName or s_client_address |
Address1AddressLine2 |
|
|
|
Address1AddressLine3 |
|
|
|
Address1AddressLine4 |
|
|
|
Address1City | Yes | Yes | Framework: s_client_suburb |
Address1State | Yes | Yes | Framework: s_client_state |
Address1PostCode | Yes | Yes | Framework: s_client_state |
Address1Country | Yes | Yes | Framework: s_client_country |
Address1Phone1 | Yes | Yes | Framework: s_client_bhPhone |
Address1Phone2 | Yes | Yes | Framework: s_client_ahPhone |
Address1Phone3 | Yes | Yes | Framework: s_client_mobile |
Address1Fax | Yes | Yes | Framework: s_client_fax |
Address1Email | Yes | Yes | Framework: s_client_email |
Address1Website | Yes | Yes | Framework: s_client_website |
Address1ContactName | Yes | Yes | Framework: s_clientCont_name |
Address1Salutation | Yes | Yes | Framework: s_clientCont_salutation |
< Address2/5 sets of fields > |
|
|
|
Notes | Yes | Yes | Framework:s_client_notes |
PaymentIsDue | Yes | Yes | Special #52: Value from ini file for key MYOB_PaymentDueCode |
DiscountDays |
|
|
|
BalanceDueDays | Yes | Yes | Special #53: Value from ini file for key MYOB_BalanceDueDays |
PercentDiscount |
|
|
|
PercentMonthlyCharge |
|
|
|
TaxCode | Yes | Yes | Special #51: Value from ini file for key MYOB_TaxCode |
CreditLimit |
|
|
|
TaxIDNumber |
|
|
|
VolumeDiscount |
|
|
|
SaleLayout | Yes | Yes | Fixed Value: “S” for Service |
ItemPriceLayout | Yes | Yes |
|
PaymentMethod | Yes | Yes | Fixed Value: 0 |
AccountNumber |
|
|
|
AccountName |
|
|
|
ABN |
|
|
|
ABNBranch |
|
|
|
IncomeAccount |
|
|
|
Salesperson | Yes |
| Framework: s_salesPerson_name |
SalespersonCardID | Yes | Yes | Fixed Value: 0 |
SaleComment |
|
|
|
ShippingMethod |
|
|
|
PrintedForm |
|
|
|
FreightTaxCode |
|
|
|
UseCustomersTaxCode |
|
|
|
ReceiptMemo |
|
|
|
InvoiceDelivery |
|
|
|
RecordID |
|
|
|
Database Models
The following database model(s) displays the manner in which data is integrated between the third party application and Framework Integration.
Integration Process
The following information is a low level account of the integration process including criteria, decisions, and outcomes. This information is technical in nature and is provided "as-is" for a detailed analysis of the integration process for system administrators.
- Get eligible Framework jobs using v_sched_myobJobs where
- Client.s_name_ref is not null
- Client.s_name is not null
- Job.s_link_boq <> ‘N/A’
- Job.s_link_accts <> ‘N/A’
- Job.l_wfl_stgMajor_id <> -5 (Maintenance)
- Job. l_job_status_gl_id = -7 (Active) or -10 (On Hold) or l_job_status_gl_id = -946 (Pending Cancellation) or -8 (Cancelled) and d_cont_cancelled >= (today - 14 days)
- and apply Criteria Method criteria where CriteriaMethod is
- 1 – Single Region Division
- job.l_context_id = ‘CriteriaMethodID’
- 2 – Single Job
- job.s_job_num = ‘CriteriaMethodID’
- 3 – Single Team
- job.l_team_id = ‘CriteriaMethodID’
- 4 – All Jobs
- job.l_job_id <> 0
- 5 – Accounts Entity
- job.l_accounts_e_id = ‘CriteriaMethodID’
- For each Framework Job search for the job in MYOB table Jobs where
- If job.s_link_boq is empty then
- Jobs. JobNumber = job.s_job_num else
- Jobs. JobNumber = job.s_link_boq
- If the job is found in MYOB then
- The matching job record is retrieved from Jobs
- The matching client record is retrieved from Customers where Customers. CustomerID = Jobs. CustomerID
- If both records above are retrieved successfully we update the MYOB Jobs, as well as Customers, records.
- If the job is not found in MYOB then
- If the job.s_link_boq field is empty we create the job in MYOB.
- If the Client.s_link_boq field is empty we create the customer in MYOB.
- The way the process actually works is we cannot directly access Jobs, Customers or Address records in MYOB. We write records into Import_Jobs and Import_Customer_Cards tables, from where an internal MYOB process tries to match record keys and decides on adding or updating Jobs, Customers and Address records.
- After record(s) are written to MYOB temporary import tables, we check if the job was written to the permanent Jobs table, otherwise logging a "Job with Card ID XXXX failed to create in MYOB" message.
- At successful completion job.s_link_accts and client.s_link_accts are updated.