Child pages
  • Planning Integration Analysis Template
Skip to end of metadata
Go to start of metadata

Integration Analysis Template

 

This template is used to evaluate data transmissions via Emory Enterprise Service Bus, and consists of 3 steps:

Step 1: Describe Existing Integrations - Describe and define present application interfaces for the application named in this template.  This information will be used to help define enterprise data objects for use in messages when design teams meet with integration staff.

Step 2: Describe Data Involved in Proposed Integrations - Define the data for which the application named in this template is authoritative.  That is, which data in this application will other applications need.  Also describe which data this application will need for which other applications are authoritative.  This information will also be used to help define enterprise data objects for use in message when design teams meet with integration staff.

Step 3: Describe the Flow of Data in the Proposed Integrations - Define (at a high level) the flow of data between the application named in this template and other applications to support the interfaces defined in steps 1 and 2.

 

Project Name:

 

Integration Timeframe:

 

Template Owner Name:

 


Step 1: Describe Existing Integrations

 

Describe and define present application interfaces for the application named in this template.  This information will be used to help define enterprise data objects for use in messages when design teams meet with integration staff.  

What data does this application store and operate on that it does not create itself?  Typically, this data is usually acquired by the application through batch extracts and feeds, remote procedure calls, or data replication.  For example, a payroll history database and an employee change of status application may both maintain and in some cases update employee job data.  This data is kept synchronized with the payroll system by scheduled batch feeds from the payroll system to these applications.  Changes made to this data in these applications are updated in the payroll system through scheduled batch feeds from these applications back to the payroll system.  Another way to ask this question is: What business events occur in other applications that the current application must know about and what business events occur in this application that other applications must know about?

 

1.1. Describe the current business processes that the primary application named in the template supports, how data is presently acquired, the timeline in the case that some of these existing integrations are being phased out, and the current flow of data between applications.  This should be a high-level description in plain English prose not to exceed one page of text.  No charts or diagrams should be provided.

 

  1. Description:
  2. Timeline:
  3. Flow:

 

1.2. List current application interfaces for the primary application named in the template that synchronizes data changes made in other applications to the primary application named in this template.

 

 [For each application, provide the name, description, source data structure, target data structure and how the source data is used to update the target. Use the structure below for the first application and repeat for other applications. If not applicable indicate above by N/A.]

 

List of interfaces:

 

1.2.1. Source application details:

 

Source Application Name:


Source Application Description:

 (Brief description)

Source Data Structure:
(repeat for each table or
filename related to this interface)

Database Name: 
Table Name: 
File Name:   

Source Field Name

Field type

Width

Nullable

Comments

Example TAPPOINTMENT.APPT_REF_NBR

CHAR

1

NO

The appointment reference number in the employee change of status application

 

 

 

 

 

 

 

 

 

 

 

1.2.2. Target application details:

 

Target Application Name:

This is the application named in the template

Target Application Description:

Description already given for the Application named in the template.

Target Data Structure:
(repeat for each table or filename related to this interface)

Database Name:
Table Name:
File Name:   

Target Field Name

Field type

Width

Nullable

Comments

Example APPOINTMENT-REF-NUM-60

VARCHAR

60

NO

The appointment reference number in the payroll system

 

 

 

 

 

 

 

 

 

 

 

1.3. List the interfaces that take data changes from the primary application named in the template to other existing applications.

 [For each application, provide the name, description, source data structure, target data structure and how the source data is used to update the target. Use the structure below for the first application and repeat for other applications. If not applicable indicate above by N/A.]

 

List of interfaces:

 

1.3.1. Source application details:

 

Source Application Name:

This is the application named in the template

Source Application Description:

Description already given for the Application named in the template.

Source Data Structure:
(repeat for each table or filename related to this interface)

Database Name:
Table Name: 
File Name:   

Source Field Name

Field type

Width

Nullable

Comments

Example LAST-NAME-10

CHAR

23

NO

The last name of a person in the payroll system

 

 

 

 

 

 

 

 

 

 

 

1.3.2. Target application details:

 

Target Application Name:

 

Target Application Description:

 (Brief description)

Target Data Structure:
(repeat for each table or filename related to this interface)

Database Name: 
Table Name: 
File Name:   

Target Field Name

Field type

Width

Nullable

Comments

Example TPERSON.LAST_NAME

VARCHAR

30

NO

The last name of a person in the employee change of status system

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Step 2: Describe Data Involved in Proposed Integrations

Describe and define the data that may be involved in interfaces with the application named in this template.  This information will also be used to help define enterprise data objects for use in message when design teams meet with integration staff.

2.1. Describe the proposed business processes that the application named in the template will support, how data will be acquired, the timeline and the proposed flow of data between applications.  This should be a high-level description in plain English prose not to exceed one page of text.  No charts or diagrams should be provided.

 

  1. Description:  
  2. Timeline:  
  3. Flow: 

 

2.2. What data will this application require from other authoritative sources? 

 

[Provide the name, description, authoritative source data structure, target data structure, and how the data will be used to update the application named in the template. Use the structure below for each authoritative source table and Target table and repeat as needed. If not applicable indicate above by N/A.]

           

2.2.1. Module details:

 

Source Application Name:

(name of the other authoritative system)

Source Application Description:

(Briefly describe the authoritative source module or business function involved in this interface.)

Source Data Structure:
(repeat for each table or filename related to this interface)

Database Name:
Table Name:
 

Source Field Name

Field type

Width

Nullable

Comments

Example GENDER

VARCHAR

1

YES

The gender code stored by the authoritative source related to a person's gender

 

 

 

 

 

 

 

 

 

 

 

2.2.2. Target application details:

 

Target Application Name:

This is the application named in the template

Target Application Description:

Description already given for the application named in the template

Target Data Structure:
(repeat for each table or filename related to this interface)

Database Name:  
Table Name:
File Name:     

Target Field Name

Field type

Width

Nullable

Comments

Example LEGACY_GENDER

CHAR

1

NO

Gender code stored by the legacy system

 

 

 

 

 

 

 

 

 

 

 

2.3. For what data will this application be the authoritative source? 

 

[Provide the name, description, and how the inputs will used to update the application named in the template. Use the structure below for each source data structure. If not applicable indicate above by N/A.]

                         

2.3.1. Source application details:

 

Source Application Name:

(This is the application named in the template)

Source Application Description:

(Description already given for the Application named in the template.)

Source Data Structure:
(repeat for each table or filename related to this interface)

Database Name:  
Table Name:
File Name:

Source Field Name

Field type

Width

Nullable

Comments

Example LAST-NAME-10

CHAR

23

NO

The last name of a person in the legacy system

 

 

 

 

 

 

 

 

 

 

 

2.3.2. Target module details:

 

Target Application Name:

Other system that requires data from our legacy system

Target Application Description:

(Briefly describe the module involved in this interface.)

Target Data Structure:
(repeat for each table or filename related to this interface)

Database Name:
Table Name:
 

Target Field Name

Field type

Width

Nullable

Comments

Example LAST_NAME

VARCHAR

60

NO

The last name of a person in the target system

 

 

 

   

 

 

 

 

 

 

 

Step 3: Describe the Flow of Data in the Proposed Integrations

 

Define (at a high level) the flow of messages between the application named in this template and other applications to support the interfaces defined in steps 1 and 2. 

 

3.1. Application 1: Payroll System (Example)

 

1.      As basic person and basic employee information changes the Payroll System, the Payroll System publishes synchronization messages to keep the ERP and Identity Service up-to-date.

2.      ...

 

 

3.2. Application 2: Identity Service (Example)

 

1.      The Identity Service must handle incoming ID number query and generate requests and send the appropriate replies.

2.      The Identity Service must handle incoming basic person and basic employee synchronization messages and apply any changes to the Identity Service database to keep its data current.

3.      ...

 

3.3. Application 3: ERP (Example)

 

1.      The ERP must consume basic person and basic employee synchronization messages from the legacy Payroll system to keep its data current.

2.      ...

 

  • No labels