Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Integration Profile Configuration

The following outlines the settings for Databuild Client and Jobs integration .ini file profiles.

Default initialisation filename: 

  • Int_DatabuildLand_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: 

Databuild Land

ODBCConnectionType

Description: 

Indicates if the Databuild database is SQL Server or Microsoft Access.

Setting: 

1: SQL Server

2: Microsoft Access

Databases

Key

Description/Setting

ODBCDSN_Framework

Description:

ODBC DSN name for the Framework database.

Setting: 

FworkSQLEcm

ODBCConnect_Framework

Description:

ODBC DSN connection string for the Framework 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_DataBuildSys

Description:

ODBC DSN name for the Databuild system database.

Setting:

FworkDBuildSys

DatabaseName_DataBuildSys

Description:

Databuild system database name.

Setting:

DataBuildSys

ODBCConnect_DataBuildSys

Description:

ODBC DSN connection string for the Databuild System database.

Setting:

"uid=enterUserName;pwd=enterPassword"

ODBCDSN_DataBuildJob

Description:

ODBC DSN name of the Databuild Job database.

Setting:

FworkDBuildJob

DatabaseName_DataBuildJob

Description:

Databuild Job database name.

Setting:

DataBuildJob

ODBCConnect_DataBuildJob

Description:

ODBC DSN connection string for the Databuild Job 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:

The name or email address of who/where the email is being sent from.

Setting:

FrameworkIntegration

Mail_Recipient

Description:

These are the mail recipients of 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 : Databuild Land"

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:

Is security used for the STMP 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:

A valid username for the SMTP server.

Setting:

enterUserName (replace this text with a valid SMTP Server User Name)

SMTP_PWD

Description:

A valid password for the SMTP username.

Setting:

enterPassword (replace this text with a valid SMTP Server Password)

Criteria

Key

Description/Setting

CriteriaMethod

Description:

Land selection criteria for retrieving records from Framework to process.

Setting:

1: Single region/division.

2: Single land.

3: Land team.

4 (default): All land.

5: Land 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 land PKID (prefixed with an 'L') to integrate on.

Integrated Fields

The integration of Databuild Land to Framework ECM is fully customisable via the integration mapping database.

 Dbo.Jobs

Databuild Database Field Name

Databuild Field Label

Create

Update

Framework Database Field Name

Framework Field Label

AnyQuantities

 

Yes

 

Fixed Value: 0

 

GST

 

Yes

 

Fixed Value: 0

 

Job_No

 

Yes

 

Special #6: Framework Land (prefixed with an 'L')

 

JobPostCode

 

Yes

Yes

Special #15: fwork s_job_postcode

 

LiveOrders

 

Yes

 

Fixed Value: 0

 

LockBudgets

 

Yes

 

Fixed Value: 0

 

PreventBill

 

Yes

 

Fixed Value: 0

 

PreventPosting

 

Yes

 

Fixed Value: 0

 

Site_Address

 

Yes

Yes

Special #5: lot num, street num, street name suburbName, stateName

 

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.

  1. Get eligible Framework jobs using v_FWINT_Land where
    1. land.s_link_accts <> ‘N/A’
    2. and apply Criteria Method criteria where CriteriaMethod is
    3. 1 – Single Region Division
    4. land.l_context_id = ‘CriteriaMethodID’
    5. 2 – Single Land
    6. land.l_land_id = ‘CriteriaMethodID’
    7. 3 – Single Team
    8. land.l_team_id = ‘CriteriaMethodID’
    9. 4 – All Land
    10. land.l_land_id <> 0
    11. 5 – Accounts Entity
    12. land.l_accounts_e_id = ‘CriteriaMethodID’
  2. For each Framework Job search for the job in Databuild table jobs where
    1. 'L' land.l_land_id = Jobs.job_no else
    2. Jobs.job_no = land.s_link_accts
  3. If the land is found in databuild then
    1. The matching land record is retrieved from land
    2. If the records above are retrieved successfully we update the databuild job.
  4. If the job is not found in databuild then
    1. If the land.s_link_accts field is empty we create the job in databuild.
    2. The framework land.l_land_id value is checked. It must be <= 6 characters for us to be able to create the record. This is because we add an L to the front of Land PKID.
    3. We retrieve a link to the jobs table so we can add the new job
    4. If the table is accessed successfully then we create the databuild job.
  • No labels