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 Accounts Receivable integration .ini file profiles.

Default initialisation filename: 

  • Int_DatabuildClaims_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 Claims

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

MultipleForeignDatabase

Description:

Allow multiple Databuild databases.

Setting:

0 (default): No

1: Yes

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 Claims"

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:

Job selection criteria for retrieving records from Framework to 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:

0

DepositRunStartDate

Description:

Date used to select receipts that were entered into Databuild after or on this date.

Setting:

01/01/2006

DepositRunEndDate

Description:

Date used to select receipts that were entered into Databuild before or on this date.

Setting:

01/01/2006

ConsistencyCheckout

Determines whether the consistency check process. Calculates the totals for each claim or all claims for the job.

1 (Default): Claim

2: Job

Consistency

Key

Description/Setting

PreAdmin

Description:

n/a

Setting:

False

Admin

Description:

n/a

Setting:

True

Construction

Description:

n/a

Setting:

True

Maintenance

Description:

n/a

Setting:

False

Actions

Key

Description/Setting

ActionCreateInvoices

Description:

Creates a file of Framework Claims Invoices in a format that can be inserted into Databuild.

Setting:

0: Framework Integration will not create invoices.

1 (default): Framework Integration will create invoices.

ActionProcessReceipts

Description:

Retrieves Databuild Receipts and inserts them into Framework, updating invoices in the process.

Setting:

0 (default): Framework Integration will not process receipts.

1: Framework Integration will process receipts.

ActionCheckingConsistency

Description:

Checks that Framework and Databuild have matching invoices and receipts.

Setting:

0 (default): Framework Integration will not check consistency. 

1: Framework Integration will check consistency.

Databuild Settings

Key

Description/Setting

GLac

Description:

Databuild General Ledger Account code.

Setting:

0

CCBank

Description:

Cost Centre Bank value.

Setting:

1 (default)

Integrated Fields

The integration of Databuild Accounts Receivable to Framework is fixed in the content that is exchanged between the systems. There are no user-configurable integrated fields available to this type of integration.


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. Read profile keys to determine which actions to process.

  2. ActionCreateInvoices
    1. Get eligible Framework jobs using v_sched_tlClaims where
      1. csg_claim.d_invoice is not null
      2. Cst_claim.s_link_accts <> ‘N/A’
      3. Cst_claim.f_link_exported = 0
      4. Job.s_link_accts <> ‘N/A’
      5. Job. l_job_status_gl_id = -7(Active) or -10(On Hold) or l_job_status_gl_id = -946 (Pending Cancellation)
      6. and apply Criteria Method criteria where CriteriaMethod is
      7. Single Region Division • job.l_context_id = ‘CriteriaMethodID’
      8. Single Job • job.s_job_num = ‘CriteriaMethodID’
      9. Single Team • job.l_team_id = ‘CriteriaMethodID’
      10. All Jobs • job.l_job_id <> 0
      11. Accounts Entity • job.l_accounts_e_id = ‘CriteriaMethodID’ b.
      12. If an eligible job claim has an empty invoice Number, it is not included in the output file.
    2. The Databuild table jobs is checked for a matching Job Number where jobs.job_no = ‘job.s_link_boq’, or if the s_link_boq field is empty then the match is done on jobs.job_no = ‘job.s_job_num’,
    3. If the job is found then a new record is added to the transactions table holding details of the framework claim.
    4. The Framework cst_claim is updated so that…
      1. cstClaim.f_link_exported is set to true
      2. cstClaim.s_link_accts is set to transactions.tranNo
  3. ActionProcessReceipts
    1. First, we get unlinked payment records from Framework and see if they’re now linked in Databuild to a claim. We get all records from cont_pay where
      1. Cont_pay.l_cst_claim_id = 0
      2. Cont_pay.s_link_accts is not empty
    2. For each payment that is unlinked we look for a matching record from the databuild transactions table where
      1. transactions.tranNo = cont_pay.s_link_accts
      2. transactions.closingTran > 0
    3. Next we find the Framework Claim where
      1. cst_claim.s_link_accts = transactions.closingTran
    4. If the claim is found the cont_pay record is linked to the claim and the claim has it’s paid amount field updated.
    5. Now we process Databuild Receipts. Eligible receipts are read from Databuild table Transactions where
      1. transactions.tType = 2 if profile key DepositRunEndDate is empty then
      2. transactions.date > = ‘DepositRunStartDate’ and <= now else if DepositRunEndDate has a date entered then
      3. transactions.date > = ‘DepositRunStartDate’ and <= ‘DepositRunEndDate’
    6. If the transactions.closingTran is > 0 we
      1. Make sure the receipt does not exist in the cont_pay table where cont_pay.s_link_accts = the transactions.tranNo
      2. if the payment does not exist then we can create it. First get the Framework job where job.s_job_num = transactions.jobNo
      3. Then Insert the new cont_pay receipt record and update the cont payments.
      4. Else if the transactions.closingTran = 0 then
      5. Make sure the receipt does not exist in the cont_pay table where cont_pay.s_link_accts = the transactions.tranNo
      6. If the payment does not exist, get the framework claim where cst_claim.s_link_accts = transactions.closingTran
      7. Then insert the new cont_pay receipt record and update the cont payments.
      8. After processing receipts the profile key depositRunStartDate is updated.
  4. ActionCheckingConsistency
    1. Eligible Framework jobs for checking are retrieved from v_sched_tlCstClaim where
      1. Check Consistency Level claim by claim
        1. Job.l_wfl_stgMajor_id = -3(Administration) or -4 (Construction)
        2. Job. l_job_status_gl_id = -7(Active) or -10(On Hold)
        3. Cst_claim.s_invoice_num is not empty
        4. Cst_claim.s_link_accts <> ‘N/A’
        5. job.s_link_accts <> ‘N/A’
      2. Check Consistency Level is job by Job
        1. Job.l_wfl_stgMajor_id = -3(Administration) or -4 (Construction)
        2. Job. l_job_status_gl_id = -7(Active) or -10(On Hold)
        3. job.s_link_accts <> ‘N/A’
      3. 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’
    2. Invoice Totals are compared between Databuild and Framework
      1. Check Consistency Level is Claim by Claim
        1. Cst_claims with the same invoice numbers have their cst_claim.c_total field values summed together
        2. The matching invoice is retrieved from transactions where transactions.tranNo = cst_claim.s_link_accts and transactions.tType = 1
        3. If the invoice record is found the transactions.amount is compared with the total of the cst_claim.c_total fields, we calculated previously, to determine if the invoice totals match.
      1. Check Consistency Level is Job by Job
        1. All eligible claims for the job are read and the sum of cst_claim.c_total is determined where
          • - cst_claim.s_invoice_num is not empty
          • - cst_claim.s_link_accts <> ‘N/A’
          • - f_link_exported = -1
          • -d_invoice is not empty
        2. The sum is compared to Databuild where the Amount is read from the transactions table where JobNo = (job.s_link_boq or if empty job.s_job_num) and ttype = 1
    1. Receipt Totals for each invoice are compared between Databuild and Framework
      1. Check Consistency Level is Claim by Claim
        1. Cst_claims with the same invoice numbers have their cst_claim.c_paid_amt field values summed together
        2. The matching receipts are retrieved from transactions where transactions.closingTran = cst_claim.s_link_accts and transactions.tType = 2
        3. If there are receipts then the sum of transactions.amount is calculated and compared with the total of the cst_claim.c_paid_amt fields, we calculated previously, to determine if the receipts match.
      2. Check Consistency Level is Job by Job
        1. The Framework Payments are summed together, the sum of c_pay from cont_pay is added up.Then because some cst_claims can indicate a refund we have to sum any cst_claims for the job where the c_paid_amt < 0 and remove this amount from the total payments.
        2. The matching receipts are retrieved from transactions where transactions.jobNo = (job.s_link_boq or if empty job.s_job_num)and transactions.tType = 2
        3. If there are receipts then the sum of transactions.amount is calculated and compared with the total of the Framework payments, to determine if the receipts match.


  • No labels