Child pages
  • eIRB Connector Commons Analysis Template
Skip to end of metadata
Go to start of metadata

The eIRB Integration Analysis Template

 

Application Name:
EIrbConnector

Module Name (if appropriate):
Emory Shared Data, IRB Data, EPEX Data

Phase (if appropriate):
1
Integration Timeframe:
May 2012 - November 2012

Target Template Completion Date:

November 2012

Template Owner Name:

Joshua Spillers

Total Work Estimate:

Resources Named in Template:

Joshua Spillers

Location of Detailed Project Plan:

Detailed is found in the Project Management wiki site.

Template Change Reviewers:

Template Status:

step

status 

date

1 - Existing Integrations 

 

 

2 - Data Involved in Proposed Integrations 

  

3 Flow of Data in the Proposed Integrations 

  

4 - Existing and New Enterprise Data Objects 

  

5 - Name the Messages 

  

6 - Existing and New Messaging Applications 

  

7 - Technical Stories for the Primary Application 

  

8 - Technical Stories for the other Applications 

  

9 - Questions, Issues, and Action Items 

 

 

10 - Work Estimation and Scheduling 

 

 

11 - Functional Approval 

 

 

12 - Initiate Template Change Control 

 

 

13 - Testing Specifications 

 

 

14 - Develop and Test Integrations 

 

 

15 - Implementation and Rollout Plan 

 

 

16 - Implement in Production 

 

 


 

Overview 

The integration analysis and design process consists of the following steps.  Steps 1 and 2 are optional, however, if they are performed they should be completed prior to the integration design meetings with EAI staff.  (Steps 1 and 2 are useful to encourage subject matter experts to gather references and resources prior to starting work with integration analysts.  Sometimes, in large projects, EAI analysts are a potential bottleneck and there is work that subject matter experts can do prior to involving them.  However, in other cases the subject matter area experts are the scarce resource and Step 3 collaboration among integration analysts and subject matter experts should begin immediately, so the integration analysts can help decide what source and target system reference materials are required.)

 

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.  It is recommended that this section be completed prior to integration design meetings 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.  It is recommended that this section be completed prior to integration design meetings 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. This section should be completed during the integration design phase with integration staff.

 

Step 4: List Existing and New Enterprise Data Objects Required for the Integrations - List existing enterprise data objects that will be reused and new enterprise data objects that will be defined to support application interfaces for the application named in this template.  This section should be completed during the integration design phase with integration staff.

 

Step 5: Name the Messages that will be used to Implement the Integrations - Name the messages that use the enterprise data objects to implement the integration flows. This section should be completed during the integration design phase with integration staff.

 

Step 6: Name the Existing and New Messaging Applications Required - Name the existing messaging applications that will be used or define the new messaging applications that must be implemented to produce, consume, transform, and route the messages listed in step 5.  This section should be completed during the integration design phase with integration staff.

 

Step 7: Provide Technical Stories for the Primary Application - For the primary application named in this template, list the messages it must produce and consume and provide detailed stories describing the prescribed production and consumption logic.  The owner of the application, who is also responsible for implementing message production and consumption, should prepare the detailed stories.  This section should be completed during the integration design phase with integration staff.

 

Step 8: Provide Technical Stories for the other Applications Named in the Template - For each remaining application listed in step 7, list the new messages each application must produce and consume and provide brief stories describing the prescribed production and consumption logic. This section should be completed during the integration design phase with integration staff.

 

Step 9: Summarize all Outstanding Questions, Issues, and Action Items - Record all questions, issues and action items during the analysis and design sessions.

 

Step 10: Perform Work Estimation and Scheduling - Identify resources and estimate work for each aspect of the project enumerated in the template and prepare a detailed project plan.

 

Step 11: Functional Approval of Analysis, Scope, and Scheduling - Functional team members must signoff to indicate completion of the analysis, design, and planning.

 

Step 12: Initiate Template Change Control Processes - Identify the integration change reviewers and begin the process of convening them to review every subsequent change to the template.  These reviews should answer the following questions and ensure the appropriate follow-up actions are taken:

 

-         Does the change impact the scope or timeline established for the integration?

-         Does the change impact the overall design of the integration?

-         Has the impact been properly reflected in the project plan and timeline?

-         Do all approvers who initially approve this template also approve of this change?

 

Step 13: Provide Testing Specifications - Develop detailed testing specifications for the integration.  This will usually consist of one or more OpenEAI Test Suites and some functional application use cases that can be used to certify the functionality of the integration.  Typically, test specifications will also include a load testing strategy for the integration, which may again use OpenEAI test suites or involve testing the integration in a production-like environment.  Finally, some production readiness test procedures should be specified.  This testing can be performed in production after the integration is deployed to verify that it is properly deployed. The procedures can be reused whenever changes are made to the production deployment of this integration.  Usually, production readiness testing is implemented with an OpenEAI test suite or application use-case scenarios that can be automated using monitoring or testing tools.

 

Step 14: Develop and Test Integrations - Develop the required message support for the gateways and applications using the technical stories and test specifications provided in the template.  Most development processes are iterative, so changes in stories and requirements should be documented and trigger the template change control process.  In this step, tests are often expanded and improved as a concrete picture of the integration functionality emerges.

 

Step 15: Prepare Implementation and Rollout Plan - Prepare a deployment diagram that visually depicts the deployment and complete an implementation rollout plan enumerating the steps required to implement the new integration in production.

 

Step 16: Implement in Production - Execute the rollout plan and production readiness testing.

 

The next sections of the document describe the details required for the steps listed above.


Step 1: Describe Existing Integrations.5

Step 2: Describe Data Involved in Proposed Integrations.8

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

Step 4: List Existing and New Enterprise Data Objects Required for the Integrations.11

Step 5: Name the Messages that Will Be Used to Implement the Integrations.12

Step 6: Name the Existing and New Messaging Applications Required.13

Step 7: Provide Technical Stories for the Primary Application.14

Step 8: Provide Technical Stories for the other Applications Named in the Template.17

Step 9: Summarize all Outstanding Questions, Issues, and Action Items.18

Step 10: Perform Work Estimation and Scheduling.19

Step 11: Functional Approval of Analysis, Scope, and Scheduling.20

Step 12: Initiate Template Change Control Processes.21

Step 13: Provide Testing Specifications.23

Step 14: Develop and Test Integrations.24

Step 15: Prepare Implementation and Rollout Plan.24

Step 16: Implement in Production.24

The GNU Free Documentation License.25


 

 

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.  This section should be completed prior to integration design meetings 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.

 

Description: The eIRB application is a purchased solution that is used to track proposal data and is considered the 'source of truth' with regards to research data involving human subjects.

Timeline: XXXXXXXX

Flow: XXXXXXXXX


 

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.

List of interfaces: N/A

1.2.1 Source application

1.2.1.1 Source application details: N/A

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)

 

Target Field Name

Field type

Width

Nullable

Comments

N/A

 

   

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

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: XXXXXXXX Table Name: XXXXXXXX File Name:XXXXXXXX

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

 

 

 

 

 

 

 

 

 

 

Step 2: Describe Data Involved in Proposed Integrations

2.1. Describe the proposed business processes that the application named in the template will supports, 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.

 

Description: .

 

 

Timeline: XXXXXXXX

 

 

Flow: XXXXXXXXX

 

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

  • None

2.2.2. Target application details:

Give a brief description of what we are looking to do with the new functionality.

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)

 

Target Field Name

Field type

Width

Nullable

Comments


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

NA

2.3.1. Source application details:

2.3.2. Target module details: |

 

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

Esb Diagram:

EcoiDbConnector Dataflow Diagram:  

ESB diagram highlighting Ecoi Connector functions:

3.1. Application 1: ESD

  1. As person information changes in the ESD, the ESDConnector will publish Person sync (create, update, delete) messages.
  2. The RoutingService will route, and the EcoiDbConnector will apply the sync (create, update, delete) messages to the staging tables in Ecoi.

3.2. Application 2: Eirb

  1. As IrbProposal information changes in Eirb, the EirbConnector will publish IrbProposal sync (create, update, delete) messages.
  2. The RoutingService will route, and the EcoiDbConnector will apply the sync (create, update, delete) messages to the staging tables in Ecoi.

3.3. Application 3: EPEX

  1. As GM Award and Customer information changes in the EPEX (in COMPASS), the RdbmsConnector-Psfs will publish GM_AWARD and CUSTOMER sync (create, update, delete) messages.
  2. The RoutingService will route, and the EcoiDbConnector will apply the sync (create, update, delete) messages to the staging tables in Ecoi.

3.4 Application 4: EmoryCommons

  1. Will consume EmoryCommons request messages for Proposals and Annual Certifications.
  2. Will recieve the replys for requests.

3.5 Application 5: Ecoi Connector

  1. Consume ESD Person v1 create, update and delete sync messages.
  2. Consume Eirb IrbProposal create, update and delete sync messages.
  3. Consume EPEX GM_AWARD and CUSTOMER create, update and delete sync messages.
  4. Consume Ecoi handle requests and publish sync messages for the data it is authoritative for.

 

Step 4: List Existing and NewEnterprise Data Objects Required for the Integrations

 

 

4.1 Existing enterprise data objects that will be reused or modified.  This section should include the current definition of the enterprise objects as they appear in the enterprise message repository at the time the analysis was performed and any proposed changes. 

 

4.2 New enterprise data objects proposed.  This section should include the proposed name and structure of the new data objects.

Ecoi objects (definition)

File

Name

Proposed Definition

Research

IrbProposal 

<!ELEMENT IrbProposal (StudyId, ShortTitle, Description, StudyStaff+, Status, DataSubmitted, DateModified, DateExpiration, Sponsor*, AssignedOwner?, TotalEnrollment?, StudySite*, ConsentForm*)>
<!ELEMENT Sponsor (SponsorName)>
<!ELEMENT AssignedOwner (FirstName?, LastName, UserId?)>
<!ELEMENT StudySite (SiteName, SiteType?)>
<!ELEMENT ConsentForm (FormName, FormUrl, FormType?)>
<!ELEMENT StudyStaff (Identifier, LastName?, FirstName?, MiddleName?, EmailAddress?, Role, AssignmentDatetime?, UserId?, PersonelType?)>
<!ELEMENT IrbProposalQuerySpecification (StartRow, NumResultsToReturn, StudyId)>

Generic

GenericQuery 


<!ELEMENT IrbGenericResults (ResultSets*)>
<!ELEMENT IrbGenericQuerySpecification (WebServiceName, StartRow, NumResultsToReturn, QueryParameters)>
<!ELEMENT QueryParameters (QueryParameter+)>
<!ELEMENT QueryParameter(ParameterName, ParameterValue)>
<!ELEMENT ResultSets(Set+)>
<!ELEMENT Set(SetGroup+)>
<!ELEMENT SetGroup(Result+)>
<!ELEMENT Result(ResultName, ResultValue)>

 

 


 

 

Step 5: Name the Messages that Will Be Used to Implement the Integrations

 

            5.1. Existing Messages

  1. com.clickcommerce.Research.IrbProposal.Create-Sync (Sample Message)
  2. com.clickcommerce.Research.IrbProposal.Update-Sync (Sample Message)
  3. com.clickcommerce.Research.IrbProposal.Delete-Sync (Sample Message)

            5.2. Proposed Messages

  1. com.clickcommerce.Research.IrbProposal.Query-Request (Sample Message)
  2. com.clickcommerce.Research.IrbProposal.Provide-Reply (Sample Message)
  3. com.clickcommerce.Generic.GenericQuery.Query-Request (Sample Message)
  4. com.clickcommerce.Generic.GenericQuery.Provide-Reply (Sample Message)

           

 

Step 6: Name the Existing and New Messaging Applications Required

            6.1. Existing Messaging Components

Name

Type

Status

Responsible Unit

EcoiDbConnector

Connector

Implemented

Integration Team

IdentityService

Service

Implemented

Integration Team

EirbConnector

Connector

Implemented

Integration Team

RdbmsConnector-Psfs (EPEX)

Connector

Implemented

Integration Team

 

            6.2. New Messaging Components

           

Name

Type

Status

Responsible Unit

eIRB Connector- Request-Reply 

Connector 

in development (POC) 

R-WIT development Team 

 

 

6.3. Other interface Components

   N/A      

Name

Type

Status

Responsible Unit

None

None

None

None 

 


 

 

Step 7: Provide Technical Stories for the Primary Application

For the messaging component(s) of the application named in this template, list the messages that component must produce and consume and provide detailed stories describing the prescribed production and consumption logic.  The owner of the application who is also responsible for implementing message production and consumption should prepare the detailed stories.  This section should be completed during the integration design phase with integration staff.

EIrbConnector 

7.1. Messages

     Messages to produce

  1. com.clickcommerce.Research.IrbProposal.Provide-Reply
  2. com.clickcommerce.Generic.GenericQuery.Provide-Reply

     Messages to consume

  1. com.clickcommerce.Research.IrbProposal.Query-Request
  2. com.clickcommerce.Generic.GenericQuery.Query-Request

 

7.2. Message Consumption Logic

The eIRB connector will consume Query-Request and respond with a Provide-Reply.

 

7.2.1. Messages
com.clickcommerce.Research.IrbProposal.Query-Request.  (DTD | sample message)

com.clickcommerce.Generic.GenericQuery.Query-Request.  (DTD | sample message)

 

Data Area Element values:

The Query-Request will  contain a query specification object.

 

Implementation resources:

 

Work estimate in hours:

 

7.3. Message Production Logic

The eIRB connector will produce Provide-Reply messages in response to IrbProposal and GenericQuery Query-Requests.

The messages the Ecoi connector must Produce are:

 

7.3.1. Messages

com.clickcommerce.Research.IrbProposal.Provide-Reply.  (DTD | sample message)

The eIRB connector will produce Provide-Reply for the EmoryCommons application from the eIRB Web Service.

 

Data Area Element values:

The following table shows the mapping from the eIRB Web Service call using eIRB's WSDL definitions to the eIRB IrbProposal enterprise Object. This mapping is done in the EIrbConnector. The EIrbConnector will use the com.clickcommerce.Research.IrbProposal enterprise object to construct the Provide-Reply. 

Source Table / Field

Target Enterprise Object Element / Attribute

Notes

(IRB Study) ID

com.clickcommerce.Research.IrbProposal.StudyId

 
(IRB Study) Namecom.clickcommerce.Research.IrbProposal.ShortTitle 

(IRB Study) Description

com.clickcommerce.Research.IrbProposal.Description

 

N/A - Existing field, not used for this implementation

com.clickcommerce.Research.IrbProposal.StudyStaff.Identifier

 

(IRB Study)

  • Study Staff - Principal Investigator.Last Name
  • Study Staff - Co-Investigators.Last Name
  • Study Staff - Coordinator.Last Name
  • Study Staff - Emory Other.Personnel.Last Name
  • Study Staff - Non-Emory Other.First Name, Last Name, Title

com.clickcommerce.Research.IrbProposal.StudyStaff.LastName

 

(IRB Study)

  • Study Staff - Principal Investigator.First Name
  • Study Staff - Co-Investigators.First Name
  • Study Staff - Coordinator.First Name
  • Study Staff - Emory Other.Personnel.First Name
  • Study Staff - Non-Emory Other.First Name, Last Name, Title

com.clickcommerce.Research.IrbProposal.StudyStaff.FirstName

 

(IRB Study)

  • Study Staff - Principal Investigator.Middle Name
  • Study Staff - Co-Investigators.Middle Name
  • Study Staff - Coordinator.Middle Name
  • Study Staff - Emory Other.Personnel.Middle Name

com.clickcommerce.Research.IrbProposal.StudyStaff.MiddleName

 

N/A - Existing field, not used for this implementation

com.clickcommerce.Research.IrbProposal.StudyStaff.EmailAddress

 

(IRB Study)

  • Study Staff - Principal Investigator
  • Study Staff - Co-Investigators
  • Study Staff - Coordinator
  • Study Staff - Emory Other.Personnel

com.clickcommerce.Research.IrbProposal.StudyStaff.Role

This element will be inferred based on the type of study staff returned. Possible values include Principal Investigator, Co-Investigator, Coordinator, Emory Other, and Non-Emory Other.

(IRB Study)

  • Study Staff - Principal Investigator.User ID
  • Study Staff - Co-Investigators.User ID
  • Study Staff - Coordinator.User ID
  • Study Staff - Emory Other.Personnel.User ID

com.clickcommerce.Research.IrbProposal.StudyStaff.UserId

 

(IRB Study)

  • Study Staff - Emory Other.Personnel type.Study Personnel type
  • Study Staff - Non-Emory Other.Personnel type.Study Personnel type
com.clickcommerce.Research.IrbProposal.StudyStaff.PersonnelTypeWe are only interested in this element for Study Staff - Emory Other and Study Staff - Non-Emory Other
(IRB Study) Project State.IDcom.clickcommerce.Research.IrbProposal.Status 
(IRB Study) Date Submittedcom.clickcommerce.Research.IrbProposal.DataSubmitted 
(IRB Study) Modified Datecom.clickcommerce.Research.IrbProposal.DateModified 
(IRB Study) Date Expirationcom.clickcommerce.Research.IrbProposal.DateExpiration 
N/A - Existing field, not used for this implementationcom.clickcommerce.Research.IrbProposal.Sponsor.SponsorName 
(IRB Study) Owner.First Namecom.clickcommerce.Research.IrbProposal.AssignedOwner.FirstName 
(IRB Study) Owner.Last Namecom.clickcommerce.Research.IrbProposal.AssignedOwner.LastName 
(IRB Study) Owner.User IDcom.clickcommerce.Research.IrbProposal.AssignedOwner.UserId 
(IRB Study) SF - Population.Population Main.Number of total enrollmentcom.clickcommerce.Research.IrbProposal.TotalEnrollment 

(IRB Study)

  • SF - Study Sites.Emory Sites.Emory Sites
  • SF - Study Sites.Non-Emory Sites.Name of the Site
com.clickcommerce.Research.IrbProposal.StudySite.SiteName 

(IRB Study)

  • SF - Study Sites.Emory Sites
  • SF - Study Sites.Non-Emory Sites
com.clickcommerce.Research.IrbProposal.StudySite.SiteTypeThis element will be inferred based on the type of site returned. Possible values include Emory and Non-Emory.

(IRB Study)

  • SF - Consent Forms - Approved.Name
  • SF - Consent Forms - Draft.Name
com.clickcommerce.Research.IrbProposal.ConsentForm.FormName 

(IRB Study)

  • SF - Consent Forms - Approved.Content URL
  • SF - Consent Forms - Draft.Content URL
com.clickcommerce.Research.IrbProposal.ConsentForm.FormUrl 

(IRB Study)

  • SF - Consent Forms - Approved.Name
  • SF - Consent Forms - Draft.Name
com.clickcommerce.Research.IrbProposal.ConsentForm.FormTypeThis element will be inferred based on the state of the document returned. Possible values include Approved and Draft.

 

Implementation resources:

 

Work estimate in hours:

 

7.3.2. Messages

com.clickcommerce.Generic.GenericQuery.Provide-Reply.  (DTD | sample message)

The eIRB connector will produce GenericQuery Provide-Reply for the EmoryCommons application from the eIRB Web Service.

Data Area Element values:

This eIRB message specification is used to allow data to be dynamically queried for. The eIRB web application allows for dynamically calling and executing searches via a Web Service interface.

Source Table / Field

Target Enterprise Object Element / Attribute

Notes

<Defined via the eIRB search utility>

com.clickcommerce.Generic.GenericQuery.ResultSets

Encapsulates all 'rows' returned by a generic query.

<Defined via the eIRB search utility>

com.clickcommerce.Generic.GenericQuery.Set

Encapsulates a single 'row' returned by a generic query

<Defined via the eIRB search utility>

com.clickcommerce.Generic.GenericQuery.SetGroup

Encapsulates a group of 'columns' in a 'row' returned that are related. For example First Name, Middle Name, and Last Name for a member of the Study Staff.

<Defined via the eIRB search utility>

com.clickcommerce.Generic.GenericQuery.Result.ResultName

The name of the 'column' returned in a 'row'.

<Defined via the eIRB search utility>

com.clickcommerce.Generic.GenericQuery.Result.ResultValue

The value of the 'column' returned in a 'row'.

 

Implementation resources:

 

Work estimate in hours:

Step 8: Provide Technical Stories for the other Applications Named in the Template

 

For each remaining messaging component listed in step 6, list the new messages that component must produce and consume and provide brief stories describing the prescribed production and consumption logic. This section should be completed during the integration design phase with integration staff.

8.1. Messaging Component 1: LMSXCP Connector (example)

 

  1. com.peoplesoft.Student.CLASS.Create-Sync
  2. com.peoplesoft.Student.CLASS.Update-Sync
  3. com.peoplesoft.Student.CLASS.Delete-Sync
  4. com.peoplesoft.Student.STDNT_ENRL.Create-Sync
  5. com.peoplesoft.Student.STDNT_ENRL.Delete-Sync
  6. com.peoplesoft.Student.STDNT_ENRL.Update-Sync
  7. com.peoplesoft.Student.STDNT_ENRL.Query-Request
  8. com.peoplesoft.Student.STDNT_ENRL.Provide-Reply
  9. com.peoplesoft.Student.CLASS_INSTR.Update-Sync

 

8.1.2. Brief Story (example)

 

The LMSXCP connector will receive CLASS, STDNT_ENRL sync messages from the Peoplesoft Connector. In response to each of these messages the LMSXCP connector will create a Blackboard update/create/delete request message as appropriate. To construct the  request message, the LMSXCP connector will query  emory.lmsxcp.CourseSite, and identity.Person to marshall the data for the update request.

 

Step 9: Summarize all Outstanding Questions, Issues, and Action Items

 

Record all questions, issues and action items during the analysis and design sessions. Status will be indicated only when it is "closed".

 

#

Question / Issues /Actions

Who?

Resolution

Date Resolved

Status

 

 

 

 

 

 

 

 

 

 

 

 


 

           

 

Step 10: Perform Work Estimation and Scheduling

 

Review work estimates provided with each story and messaging application.  Sequence implementation work into a detailed project plan using your preferred project management tools.

 

10.1 List New Messaging Applications to Develop and Summary Work Estimates

 

Task #

Task Description

Task Hours

Total Hours

1.

Define Segments and Fields

 

 

2.

Define Messages

 

 

3. 

Set up MOA build environment

 

 

4. 

Build MOA

 

 

5. 

Deploy jar to Development environment

 

 

6. 

Deploy sample messages to Dev environment

 

 

7. 

Deploy EO's to Dev environment

 

 

8.

Build out database items:

 

 

8.1 

     Get ID and access to application DB

 

 

8.2 

     Get ID and build tables for ESB DB

 

 

Setup Sonic MQ items:

 

 

9.1 

     Add ID

 

 

9.2 

     Build Queues and Topics

 

 

9.3 

     Build Connection Factories

 

 

9.4 

     Add ACLs

 

 

10. 

Build Application Configuration in the console

 

 

11. 

Create build environment

 

 

12. 

Design Request command

 

 

13. 

Code Request command

 

 

14. 

Test Request command

 

 

15. 

Build Test Suite if needed

 

 

 

 

 

 

 

 

10.2 List New Message Support to Add to Existing Messaging Applications and Summary Work Estimates

 

Messaging Application

Resources

Total Hours

(Example) Identity Service

  1. Chris Analyst, analysis and test suite development (36 hours)
  2. Suzy Developer, InstitutionalIdentity synchronization message support (20 hours)
  3. Q.A. Masters, Test Suite Review and Certification (24 hours)

80

 

 

 

 

 

10.3 Detailed Work Plan

 

Location of detailed implementation project plan: [provide link to location here]

 

NOTE: need one time conversion of existing Blackboard batchUid from prsn_i to PRSN_I_PBLC


 

 

Step 11: Functional Approval of Analysis, Scope, and Scheduling

 

Functional team members must give approval to indicate completion of the analysis and design. An e-mail stating approval may be copied and pasted here instead of a signature on paper.

 

While many may consider this a pedantic step, experience teaches that this level of explicit approval is often required to support a strict scope management and change control process.

 

Project Role

Team member  name

Signature

Approval Date

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Step 12: Initiate Template Change Control Processes

 

Application name:

Payroll System Gateway (example) 

Requestor name(s):

xxxx xxxxxxx 

Priority:

XXXX   (Low, Medium, High. Please give details in later section for priority)  

Change Request Number:

1 

(starts at 1 and increments by 1 for each application change request)

Brief change request description: xxxxxxxxx

 

 

Process for change requests: The EAI template should be completed during the period allocated to do the analysis and design work.  Any changes subsequent to approval and acceptance of the template should follow the change request process.  The change requests will be submitted by the requesting team to the EAI project manager who will forward the request to management for approval.

 

All items in this template must be filled out completely otherwise it may delay processing.  For items that are not relevant to the change being requested please indicate that by typing in "Not Applicable".

 

The change requests must be packaged each week and delivered to the EAI project manager by Thursday noon. The review will be generally completed by the following Tuesday. {*}

12.1 New requirements information:* Please fill out the story and the details for the new functionality or services the gateway or application must support. This section must also be completed if there are new tables or fields in the requirements with or without any new functionality or services being requested.

 

Provide story here

 

12.2 Reference section in the existing EAI template which is impacted by the new request:

 

[Provide template section numbers or messages that are impacted by the new requirements]

 

12.3 Impact on other known integrations:

 

[example: Same change required in IdentityService template]

 

12.4 Describe priority (LOW, MEDIUM, HIGH): 

 

[Describe the reasons behind the priority assessment in story format. If this requires a faster turnaround describe why and what dependencies it may share with other tasks]

 

12.5 New source system table and fields, if applicable:

 

[List the table and fields]

 

 

 12.6 New target system table and fields, if applicable:

 

 [List the table and fields]

 

12.7 New transformation requirements, if applicable:

 

 

{*}Source table or file:\* (file:*)

XXXXXX

{*}Target table or file:\* (file:*)

XXXXXX

Source field

Target field

Transformation and reformatting rules

Message object

Example Last-Name-10

Last_Name

None

BasicPerson/Name/LastName

 

 

 

 

 

 

12.8 Message Object changes: [Enumerate message object definition changes.]

 

12.9 Work impact:

 

[Describe the anticipated impact on the project plan and timeline.]

 

12.10 Approval:

 

Management will sign and send documents back to the EAI team and the requestor. Approval implies acceptance of the change in timeline.

Approval Request date:

mm-dd-yyyy

 

 

 

Project Role

Name

Signature

Signature date

Status 
(Approved or Denied)

Project director

 

 

 

 

Project manager

 

 

 

 

Project manager

 

 

 

 

Project manager

 

 

 

 

 

 

 

 

Step 13: Provide Testing Specifications

 

 

13.1 Test Stories

 

For every messaging application and gateway listed in this template, provide a brief description of how it will be tested for functional, performance, and production readiness certification.

 

(Example)  Payroll System Gateway

 

Functional testing of the payroll system gateway will be accomplished by preparing an OpenEAI test suite to test the gateway's ability to handle BasicPerson and BasicEmployee query, create, update, and delete request messages as well as its ability to publish the corresponding synchronization messages.  The goal of this test suite is to cover all actions on both BasicPerson and BasicEmployee objects using an appropriately diverse set of data.

 

Performance testing of the payroll system gateway will be accomplished by preparing an OpenEAI test suite with multiple series that can be run concurrently from one or more deployments of the test suite application to simulate the peak anticipated production load of concurrent requests.  This suite will be used to test a deployment of the payroll system gateway to determine if the performance of deployment will handle the anticipated peak load.  Additionally performance tests of web applications that send request messages to this gateway will be conducted independently of the gateway testing.

 

A self-contained production readiness OpenEAI test suite will be prepared that creates, queries for, updates, and deletes several bogus users and employees using realistic data.  This test suite will be executed to certify the deployment in both non-production and production environments.

 

13.2 Links to Testing Artifacts Listed in the Test Stories and Preparation Status

 

Testing Artifact Description

Location

Preparation Status

(Example)  Payroll System Gateway Functional Test Suite

CVS Repository Project/TestSuites
PayrollSystemGateway.TestSuite1.xml

100%

(Example)  Payroll System Gateway Performance Test Suite

CVS Repository Project/TestSuites
PayrollSystemGateway.TestSuite2.xml

70%

 

 

 

 

 

 

 


 

 

 

Step 14: Develop and Test Integrations

 

At this point, development tasks for each messaging application and service should be enumerated in the integration project plan or master project plan.  Developers and quality assurance staff should be developing and testing applications and gateways and reporting status on their assigned tasks.

 

A summary of tasks and their status could be maintained here in the integration template, but it is strongly encouraged to maintain this information and refer to it in a master project plan.

 

 

Step 15: Prepare Implementation and Rollout Plan

           

A rollout plan differs from the overall project plan in that it provides clear, step by step instructions for deployment and production readiness testing activities.  This plan should be completed prior to production implementation and executed in a non-production environment as a practice or "dress rehearsal" run.

 

 

Step 16: Implement in Production

 

At this stage, production implementation should be anti-climactic.  Execute the rollout plan, which should include production readiness testing, and celebrate.

 

 


 

 

The GNU Free Documentation License     |     GNU Free Documentation License

 

        Version 1.1, March 2000 

 Copyright (C) 2000  Free Software Foundation, Inc. 
     59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 
 Everyone is permitted to copy and distribute verbatim copies 
 of this license document, but changing it is not allowed. 


0. PREAMBLE 

The purpose of this License is to make a manual, textbook, or other 
written document "free" in the sense of freedom: to assure everyone 
the effective freedom to copy and redistribute it, with or without 
modifying it, either commercially or noncommercially.  Secondarily, 
this License preserves for the author and publisher a way to get 
credit for their work, while not being considered responsible for 
modifications made by others. 

This License is a kind of "copyleft", which means that derivative 
works of the document must themselves be free in the same sense.  It 
complements the GNU General Public License, which is a copyleft 
license designed for free software. 

We have designed this License in order to use it for manuals for free 
software, because free software needs free documentation: a free 
program should come with manuals providing the same freedoms that the 
software does.  But this License is not limited to software manuals; 
it can be used for any textual work, regardless of subject matter or 
whether it is published as a printed book.  We recommend this License 
principally for works whose purpose is instruction or reference. 


1. APPLICABILITY AND DEFINITIONS 

This License applies to any manual or other work that contains a 
notice placed by the copyright holder saying it can be distributed 
under the terms of this License.  The "Document", below, refers to any 
such manual or work.  Any member of the public is a licensee, and is 
addressed as "you". 

A "Modified Version" of the Document means any work containing the 
Document or a portion of it, either copied verbatim, or with 
modifications and/or translated into another language. 

A "Secondary Section" is a named appendix or a front-matter section of 
the Document that deals exclusively with the relationship of the 
publishers or authors of the Document to the Document's overall subject 
(or to related matters) and contains nothing that could fall directly 
within that overall subject.  (For example, if the Document is in part a 
textbook of mathematics, a Secondary Section may not explain any 
mathematics.)  The relationship could be a matter of historical 
connection with the subject or with related matters, or of legal, 
commercial, philosophical, ethical or political position regarding 
them. 

The "Invariant Sections" are certain Secondary Sections whose titles 
are designated, as being those of Invariant Sections, in the notice 
that says that the Document is released under this License. 

The "Cover Texts" are certain short passages of text that are listed, 
as Front-Cover Texts or Back-Cover Texts, in the notice that says that 
the Document is released under this License. 

A "Transparent" copy of the Document means a machine-readable copy, 
represented in a format whose specification is available to the 
general public, whose contents can be viewed and edited directly and 
straightforwardly with generic text editors or (for images composed of 
pixels) generic paint programs or (for drawings) some widely available 
drawing editor, and that is suitable for input to text formatters or 
for automatic translation to a variety of formats suitable for input 
to text formatters.  A copy made in an otherwise Transparent file 
format whose markup has been designed to thwart or discourage 
subsequent modification by readers is not Transparent.  A copy that is 
not "Transparent" is called "Opaque". 

Examples of suitable formats for Transparent copies include plain 
ASCII without markup, Texinfo input format, LaTeX input format, SGML 
or XML using a publicly available DTD, and standard-conforming simple 
HTML designed for human modification.  Opaque formats include 
PostScript, PDF, proprietary formats that can be read and edited only 
by proprietary word processors, SGML or XML for which the DTD and/or 
processing tools are not generally available, and the 
machine-generated HTML produced by some word processors for output 
purposes only. 

The "Title Page" means, for a printed book, the title page itself, 
plus such following pages as are needed to hold, legibly, the material 
this License requires to appear in the title page.  For works in 
formats which do not have any title page as such, "Title Page" means 
the text near the most prominent appearance of the work's title, 
preceding the beginning of the body of the text. 


2. VERBATIM COPYING 

You may copy and distribute the Document in any medium, either 
commercially or noncommercially, provided that this License, the 
copyright notices, and the license notice saying this License applies 
to the Document are reproduced in all copies, and that you add no other 
conditions whatsoever to those of this License.  You may not use 
technical measures to obstruct or control the reading or further 
copying of the copies you make or distribute.  However, you may accept 
compensation in exchange for copies.  If you distribute a large enough 
number of copies you must also follow the conditions in section 3. 

You may also lend copies, under the same conditions stated above, and 
you may publicly display copies. 


3. COPYING IN QUANTITY 

If you publish printed copies of the Document numbering more than 100, 
and the Document's license notice requires Cover Texts, you must enclose 
the copies in covers that carry, clearly and legibly, all these Cover 
Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on 
the back cover.  Both covers must also clearly and legibly identify 
you as the publisher of these copies.  The front cover must present 
the full title with all words of the title equally prominent and 
visible.  You may add other material on the covers in addition. 
Copying with changes limited to the covers, as long as they preserve 
the title of the Document and satisfy these conditions, can be treated 
as verbatim copying in other respects. 

If the required texts for either cover are too voluminous to fit 
legibly, you should put the first ones listed (as many as fit 
reasonably) on the actual cover, and continue the rest onto adjacent 
pages. 

If you publish or distribute Opaque copies of the Document numbering 
more than 100, you must either include a machine-readable Transparent 
copy along with each Opaque copy, or state in or with each Opaque copy 
a publicly-accessible computer-network location containing a complete 
Transparent copy of the Document, free of added material, which the 
general network-using public has access to download anonymously at no 
charge using public-standard network protocols.  If you use the latter 
option, you must take reasonably prudent steps, when you begin 
distribution of Opaque copies in quantity, to ensure that this 
Transparent copy will remain thus accessible at the stated location 
until at least one year after the last time you distribute an Opaque 
copy (directly or through your agents or retailers) of that edition to 
the public. 

It is requested, but not required, that you contact the authors of the 
Document well before redistributing any large number of copies, to give 
them a chance to provide you with an updated version of the Document. 


4. MODIFICATIONS 

You may copy and distribute a Modified Version of the Document under 
the conditions of sections 2 and 3 above, provided that you release 
the Modified Version under precisely this License, with the Modified 
Version filling the role of the Document, thus licensing distribution 
and modification of the Modified Version to whoever possesses a copy 
of it.  In addition, you must do these things in the Modified Version: 

A. Use in the Title Page (and on the covers, if any) a title distinct 
   from that of the Document, and from those of previous versions 
   (which should, if there were any, be listed in the History section 
   of the Document).  You may use the same title as a previous version 
   if the original publisher of that version gives permission. 
B. List on the Title Page, as authors, one or more persons or entities 
   responsible for authorship of the modifications in the Modified 
   Version, together with at least five of the principal authors of the 
   Document (all of its principal authors, if it has less than five). 
C. State on the Title page the name of the publisher of the 
   Modified Version, as the publisher. 
D. Preserve all the copyright notices of the Document. 
E. Add an appropriate copyright notice for your modifications 
   adjacent to the other copyright notices. 
F. Include, immediately after the copyright notices, a license notice 
   giving the public permission to use the Modified Version under the 
   terms of this License, in the form shown in the Addendum below. 
G. Preserve in that license notice the full lists of Invariant Sections 
   and required Cover Texts given in the Document's license notice. 
H. Include an unaltered copy of this License. 
I. Preserve the section entitled "History", and its title, and add to 
   it an item stating at least the title, year, new authors, and 
   publisher of the Modified Version as given on the Title Page.  If 
   there is no section entitled "History" in the Document, create one 
   stating the title, year, authors, and publisher of the Document as 
   given on its Title Page, then add an item describing the Modified 
   Version as stated in the previous sentence. 
J. Preserve the network location, if any, given in the Document for 
   public access to a Transparent copy of the Document, and likewise 
   the network locations given in the Document for previous versions 
   it was based on.  These may be placed in the "History" section. 
   You may omit a network location for a work that was published at 
   least four years before the Document itself, or if the original 
   publisher of the version it refers to gives permission. 
K. In any section entitled "Acknowledgements" or "Dedications", 
   preserve the section's title, and preserve in the section all the 
   substance and tone of each of the contributor acknowledgements 
   and/or dedications given therein. 
L. Preserve all the Invariant Sections of the Document, 
   unaltered in their text and in their titles.  Section numbers 
   or the equivalent are not considered part of the section titles. 
M. Delete any section entitled "Endorsements".  Such a section 
   may not be included in the Modified Version. 
N. Do not retitle any existing section as "Endorsements" 
   or to conflict in title with any Invariant Section. 

If the Modified Version includes new front-matter sections or 
appendices that qualify as Secondary Sections and contain no material 
copied from the Document, you may at your option designate some or all 
of these sections as invariant.  To do this, add their titles to the 
list of Invariant Sections in the Modified Version's license notice. 
These titles must be distinct from any other section titles. 

You may add a section entitled "Endorsements", provided it contains 
nothing but endorsements of your Modified Version by various 
parties--for example, statements of peer review or that the text has 
been approved by an organization as the authoritative definition of a 
standard. 

You may add a passage of up to five words as a Front-Cover Text, and a 
passage of up to 25 words as a Back-Cover Text, to the end of the list 
of Cover Texts in the Modified Version.  Only one passage of 
Front-Cover Text and one of Back-Cover Text may be added by (or 
through arrangements made by) any one entity.  If the Document already 
includes a cover text for the same cover, previously added by you or 
by arrangement made by the same entity you are acting on behalf of, 
you may not add another; but you may replace the old one, on explicit 
permission from the previous publisher that added the old one. 

The author(s) and publisher(s) of the Document do not by this License 
give permission to use their names for publicity for or to assert or 
imply endorsement of any Modified Version. 


5. COMBINING DOCUMENTS 

You may combine the Document with other documents released under this 
License, under the terms defined in section 4 above for modified 
versions, provided that you include in the combination all of the 
Invariant Sections of all of the original documents, unmodified, and 
list them all as Invariant Sections of your combined work in its 
license notice. 

The combined work need only contain one copy of this License, and 
multiple identical Invariant Sections may be replaced with a single 
copy.  If there are multiple Invariant Sections with the same name but 
different contents, make the title of each such section unique by 
adding at the end of it, in parentheses, the name of the original 
author or publisher of that section if known, or else a unique number. 
Make the same adjustment to the section titles in the list of 
Invariant Sections in the license notice of the combined work. 

In the combination, you must combine any sections entitled "History" 
in the various original documents, forming one section entitled 
"History"; likewise combine any sections entitled "Acknowledgements", 
and any sections entitled "Dedications".  You must delete all sections 
entitled "Endorsements." 


6. COLLECTIONS OF DOCUMENTS 

You may make a collection consisting of the Document and other documents 
released under this License, and replace the individual copies of this 
License in the various documents with a single copy that is included in 
the collection, provided that you follow the rules of this License for 
verbatim copying of each of the documents in all other respects. 

You may extract a single document from such a collection, and distribute 
it individually under this License, provided you insert a copy of this 
License into the extracted document, and follow this License in all 
other respects regarding verbatim copying of that document. 


7. AGGREGATION WITH INDEPENDENT WORKS 

A compilation of the Document or its derivatives with other separate 
and independent documents or works, in or on a volume of a storage or 
distribution medium, does not as a whole count as a Modified Version 
of the Document, provided no compilation copyright is claimed for the 
compilation.  Such a compilation is called an "aggregate", and this 
License does not apply to the other self-contained works thus compiled 
with the Document, on account of their being thus compiled, if they 
are not themselves derivative works of the Document. 

If the Cover Text requirement of section 3 is applicable to these 
copies of the Document, then if the Document is less than one quarter 
of the entire aggregate, the Document's Cover Texts may be placed on 
covers that surround only the Document within the aggregate. 
Otherwise they must appear on covers around the whole aggregate. 


8. TRANSLATION 

Translation is considered a kind of modification, so you may 
distribute translations of the Document under the terms of section 4. 
Replacing Invariant Sections with translations requires special 
permission from their copyright holders, but you may include 
translations of some or all Invariant Sections in addition to the 
original versions of these Invariant Sections.  You may include a 
translation of this License provided that you also include the 
original English version of this License.  In case of a disagreement 
between the translation and the original English version of this 
License, the original English version will prevail. 


9. TERMINATION 

You may not copy, modify, sublicense, or distribute the Document except 
as expressly provided for under this License.  Any other attempt to 
copy, modify, sublicense or distribute the Document is void, and will 
automatically terminate your rights under this License.  However, 
parties who have received copies, or rights, from you under this 
License will not have their licenses terminated so long as such 
parties remain in full compliance. 


10. FUTURE REVISIONS OF THIS LICENSE 

The Free Software Foundation may publish new, revised versions 
of the GNU Free Documentation License from time to time.  Such new 
versions will be similar in spirit to the present version, but may 
differ in detail to address new problems or concerns.  See 
[http://www.gnu.org/copyleft/

Each version of the License is given a distinguishing version number. 
If the Document specifies that a particular numbered version of this 
License "or any later version" applies to it, you have the option of 
following the terms and conditions either of that specified version or 
of any later version that has been published (not as a draft) by the 
Free Software Foundation.  If the Document does not specify a version 
number of this License, you may choose any version ever published (not 
as a draft) by the Free Software Foundation. | 

  • No labels