Framework Integration User Guide

Framework Integration provides a safe and structured process for transferring data between Framework and third party systems. Framework Integration is available for many different products and many different types of data including client, accounting, claims, documents, estimates, orders, sales pricing, etc.

This guide is a comprehensive resource of all information on integrating Framework with other products including details on determining requirements, configuration, and all technical details important to the integration process.

Integration can be initiated automatically using Microsoft Windows Task Scheduler feature.

Important: Only install and configure Framework Integration once all requirements, analysis, and preparation has been completed, as per this guide.

Table of Contents

Integration Results

When Framework Integration is performed with third party applications, the results of the integration process can be emailed to an appropriate member of staff.

The best method for managing the results of integration tasks is to setup one or more email distribution groups within the organisation. All members of a distribution group will receive email notifications when an integration task is completed. Different groups can be established for accounts, orders, document estimation, etc., as required.

To simplify this process a member of the distribution group should be a public email folder that any number of users should be given permission to access. This allows a complete historical record of integration to be kept without relying on individual user's monitoring integration emails.

Insula Software also recommend including the Insula Software Integration Support email address so that prompt support can be provided for integration questions. Insula Software also offers an integration monitoring service to check daily that integration is running as expected. The email address is: integrationsupport@insulagroup.com.au.

Requirements

Framework Integration is a powerful solution to replicate and synchronise data between database systems. To ensure a smooth implementation of Framework Integration, there are some key requirements that must be met.

  • A detailed discussion of desired outcomes from Framework Integration to ensure the process, procedures, and results meet business expectations.
  • Analysis questions and activities must be completed to ensure a full understanding of the target environment.
  • Preparation of Framework ECM data must be completed to address any specific requirements of both existing data in the system and new data moving forward.
  • Installation and configuration of all integration software and the required connectivity to the various systems and databases.
  • A comprehensive process of testing Framework Integration and full acceptance and sign-off of the integration project by required management and staff.

Insula Software Consultation

It is highly recommended that the implementation of Framework Integration be discussed and coordinated with Insula Software. This will ensure that all issues raised in this documentation are reviewed and considered in the context of a client's specific environment.

Test/Production Environment Implementation

Due to the technical nature of integration and a high level of understanding required to configure systems and databases, it is HIGHLY RECOMMENDED that Framework Integration first be installed and configured in a test environment. Once the implementation has been deemed successful and affected users have performed (and signed off on) User Acceptance Testing (UAT), the installation and configuration can be migrated easily to the live production environment.

Where a test environment is not available, consideration as to when integration is activated and tested should be made. Where integration is being installed directly into a live production environment, it should be done after hours with no users connected to any of the systems involved. Complete backups of all systems should be taken prior to starting integration so that a clear roll-back point is established and can be used if the results of integration are incorrect or unsatisfactory.