1 eccf training 2.0 guidance for the platform independent model (pim) eccf training working group...
TRANSCRIPT
![Page 1: 1 ECCF Training 2.0 Guidance for the Platform Independent Model (PIM) ECCF Training Working Group January 2011](https://reader036.vdocuments.us/reader036/viewer/2022062500/5697bfbc1a28abf838ca124f/html5/thumbnails/1.jpg)
1
ECCF Training 2.0
Guidance for the Platform Independent
Model (PIM)
ECCF Training Working Group
January 2011
![Page 2: 1 ECCF Training 2.0 Guidance for the Platform Independent Model (PIM) ECCF Training Working Group January 2011](https://reader036.vdocuments.us/reader036/viewer/2022062500/5697bfbc1a28abf838ca124f/html5/thumbnails/2.jpg)
2
Outline
• What is the PIM?• Looking through the viewpoints• Detailed look at artifacts by viewpoint
• Explanation• Example• Exercise
• Other Artifacts
![Page 3: 1 ECCF Training 2.0 Guidance for the Platform Independent Model (PIM) ECCF Training Working Group January 2011](https://reader036.vdocuments.us/reader036/viewer/2022062500/5697bfbc1a28abf838ca124f/html5/thumbnails/3.jpg)
What is the PIM?
• From analysis in CIM to logical model in PIM• Independent of technology stack• Typically one PIM for one CIM
3
![Page 4: 1 ECCF Training 2.0 Guidance for the Platform Independent Model (PIM) ECCF Training Working Group January 2011](https://reader036.vdocuments.us/reader036/viewer/2022062500/5697bfbc1a28abf838ca124f/html5/thumbnails/4.jpg)
Looking through the viewpoints
• Enterprise Viewpoint• Minimal focus for the PIM (optional artifacts)• Mostly traceability to CIM
• Information Viewpoint• Constrained Local Information Model
• Computational / Behavioral• Service Contract
• Engineering / Implementation• Deployment Considerations
4
![Page 5: 1 ECCF Training 2.0 Guidance for the Platform Independent Model (PIM) ECCF Training Working Group January 2011](https://reader036.vdocuments.us/reader036/viewer/2022062500/5697bfbc1a28abf838ca124f/html5/thumbnails/5.jpg)
Artifacts by Viewpoint
Information Viewpoint
5
![Page 6: 1 ECCF Training 2.0 Guidance for the Platform Independent Model (PIM) ECCF Training Working Group January 2011](https://reader036.vdocuments.us/reader036/viewer/2022062500/5697bfbc1a28abf838ca124f/html5/thumbnails/6.jpg)
Information Model
• Add constraints and localizations to information model work begun in the CIM
• Artifacts:• Primary Information Object Types
• State Model
• Error Information Model
• Control Data Types
• Value Set Definitions
6
![Page 7: 1 ECCF Training 2.0 Guidance for the Platform Independent Model (PIM) ECCF Training Working Group January 2011](https://reader036.vdocuments.us/reader036/viewer/2022062500/5697bfbc1a28abf838ca124f/html5/thumbnails/7.jpg)
Primary Information Object Types
• What are the Primary Information Objects?• Represent the main functionality• Other objects are associated with primary objects• Generally form the input and output• State is controlled by functionality of the service• There can be more than one primary object type
• How do we define them?• Object Model• State Transition Model• Traceability to referenced models
7
![Page 8: 1 ECCF Training 2.0 Guidance for the Platform Independent Model (PIM) ECCF Training Working Group January 2011](https://reader036.vdocuments.us/reader036/viewer/2022062500/5697bfbc1a28abf838ca124f/html5/thumbnails/8.jpg)
MA Gene Object Model
8
![Page 9: 1 ECCF Training 2.0 Guidance for the Platform Independent Model (PIM) ECCF Training Working Group January 2011](https://reader036.vdocuments.us/reader036/viewer/2022062500/5697bfbc1a28abf838ca124f/html5/thumbnails/9.jpg)
MA Gene State Model
9
![Page 10: 1 ECCF Training 2.0 Guidance for the Platform Independent Model (PIM) ECCF Training Working Group January 2011](https://reader036.vdocuments.us/reader036/viewer/2022062500/5697bfbc1a28abf838ca124f/html5/thumbnails/10.jpg)
MA Gene Model Reference UML
10
![Page 11: 1 ECCF Training 2.0 Guidance for the Platform Independent Model (PIM) ECCF Training Working Group January 2011](https://reader036.vdocuments.us/reader036/viewer/2022062500/5697bfbc1a28abf838ca124f/html5/thumbnails/11.jpg)
MA Gene Model Traceability
Trace Attribute Name Type Description
LSPIM Symbol ST The official symbol for the gene based on an organism-specific database of gene symbols, such as HUGO, MGI or RGD
New fullName ST The title of the gene.
11
Gene
![Page 12: 1 ECCF Training 2.0 Guidance for the Platform Independent Model (PIM) ECCF Training Working Group January 2011](https://reader036.vdocuments.us/reader036/viewer/2022062500/5697bfbc1a28abf838ca124f/html5/thumbnails/12.jpg)
Error Information Model
• Defines the types for all the errors that the service may throw
12
![Page 13: 1 ECCF Training 2.0 Guidance for the Platform Independent Model (PIM) ECCF Training Working Group January 2011](https://reader036.vdocuments.us/reader036/viewer/2022062500/5697bfbc1a28abf838ca124f/html5/thumbnails/13.jpg)
MA Exception Model
13
![Page 14: 1 ECCF Training 2.0 Guidance for the Platform Independent Model (PIM) ECCF Training Working Group January 2011](https://reader036.vdocuments.us/reader036/viewer/2022062500/5697bfbc1a28abf838ca124f/html5/thumbnails/14.jpg)
Control Data Type Definitions
• What are control data types?• Search Criteria• Exception Conditions• Input Criteria• Result Sets
14
![Page 15: 1 ECCF Training 2.0 Guidance for the Platform Independent Model (PIM) ECCF Training Working Group January 2011](https://reader036.vdocuments.us/reader036/viewer/2022062500/5697bfbc1a28abf838ca124f/html5/thumbnails/15.jpg)
MA – Search Criteria Types
15
![Page 16: 1 ECCF Training 2.0 Guidance for the Platform Independent Model (PIM) ECCF Training Working Group January 2011](https://reader036.vdocuments.us/reader036/viewer/2022062500/5697bfbc1a28abf838ca124f/html5/thumbnails/16.jpg)
Value Set Definitions
• Attributes whose values are controlled by a list of valid values• Error Codes• Status Codes
16
![Page 17: 1 ECCF Training 2.0 Guidance for the Platform Independent Model (PIM) ECCF Training Working Group January 2011](https://reader036.vdocuments.us/reader036/viewer/2022062500/5697bfbc1a28abf838ca124f/html5/thumbnails/17.jpg)
MA – Error Codes
Error Code Error Condition Description
MAE00000 Fatal Remote system error
MAE10001 Error Gene does not exist
MAE10002 Error Specified microarray is not supported
MAE10003 Error Reporter not found
17
![Page 18: 1 ECCF Training 2.0 Guidance for the Platform Independent Model (PIM) ECCF Training Working Group January 2011](https://reader036.vdocuments.us/reader036/viewer/2022062500/5697bfbc1a28abf838ca124f/html5/thumbnails/18.jpg)
Artifacts by Viewpoint
Computational / Behavioral Viewpoint
18
![Page 19: 1 ECCF Training 2.0 Guidance for the Platform Independent Model (PIM) ECCF Training Working Group January 2011](https://reader036.vdocuments.us/reader036/viewer/2022062500/5697bfbc1a28abf838ca124f/html5/thumbnails/19.jpg)
Interface Model
• Provides a logical grouping for service implementers
• Artifacts:• UML model of interfaces• List of operations• Detailed operation behavior descriptions
19
![Page 20: 1 ECCF Training 2.0 Guidance for the Platform Independent Model (PIM) ECCF Training Working Group January 2011](https://reader036.vdocuments.us/reader036/viewer/2022062500/5697bfbc1a28abf838ca124f/html5/thumbnails/20.jpg)
MA – Interface Model
Interface No Interface Name Interface Description
MA-INF1 MAGeneAnnotationQuery Includes all of the operations for retrieving gene annotations
MA-INF2 MAFreestyleSearch Includes all of the operations for Freestyle Search
20
![Page 21: 1 ECCF Training 2.0 Guidance for the Platform Independent Model (PIM) ECCF Training Working Group January 2011](https://reader036.vdocuments.us/reader036/viewer/2022062500/5697bfbc1a28abf838ca124f/html5/thumbnails/21.jpg)
MA – Interface Model UML
21
![Page 22: 1 ECCF Training 2.0 Guidance for the Platform Independent Model (PIM) ECCF Training Working Group January 2011](https://reader036.vdocuments.us/reader036/viewer/2022062500/5697bfbc1a28abf838ca124f/html5/thumbnails/22.jpg)
MA – List of Operations (Truncated)
Operation No.
Operation Name Interface Name Operation Description
MA-INF1-OP1 getGenesBySymbol MAGeneAnnotationQuery Returns the genes named by the specified gene symbols and/or gene aliases
MA-INF1-OP2 getCellularLocations MAGeneAnnotationQuery Returns annotations describing a gene’s location within a cell
MA-INF2-OP1 freestyleSummarySearch MAFreestyleSearchProfile Returns a summary result for a given keyword or keywords
MA-INF2-OP2 freestyleSearch MAFreestyleSearchProfile Returns a list of results matching the given keyword or keywords
22
![Page 23: 1 ECCF Training 2.0 Guidance for the Platform Independent Model (PIM) ECCF Training Working Group January 2011](https://reader036.vdocuments.us/reader036/viewer/2022062500/5697bfbc1a28abf838ca124f/html5/thumbnails/23.jpg)
Operation Behavior Description
• Detailed description of the behavior of each interface operation
• Grouped by interface
• Includes:
• Description
• Pre-Conditions
• Security Conditions
• Inputs
• Outputs
• Post-Conditions
• Exception Conditions
• Additional Implementation Details
• Notes
23
![Page 24: 1 ECCF Training 2.0 Guidance for the Platform Independent Model (PIM) ECCF Training Working Group January 2011](https://reader036.vdocuments.us/reader036/viewer/2022062500/5697bfbc1a28abf838ca124f/html5/thumbnails/24.jpg)
MA - getGenesByMicroArrayReporter
Behavior Description • Client supplies a ReporterSearchCriteria instance with a reporter name and a microarray design to search within
• The case of the reporter name is ignored• If the Microarray is null then all Microarrays are
searched• The system returns the matching Gene object(s), if any
Pre-Conditions None
Security Pre-Conditions
None
Inputs ReporterSearchCriteria
Outputs Fully-populated instance(s) of Gene
24
![Page 25: 1 ECCF Training 2.0 Guidance for the Platform Independent Model (PIM) ECCF Training Working Group January 2011](https://reader036.vdocuments.us/reader036/viewer/2022062500/5697bfbc1a28abf838ca124f/html5/thumbnails/25.jpg)
MA - getGenesByMicroArrayReporter (cont.)
Post-Conditions None
Alternate Conditions No matching genes found
Exception Conditions • Specified microarray is not supported• Reporter not found
Additional Details None
Notes None
25
![Page 26: 1 ECCF Training 2.0 Guidance for the Platform Independent Model (PIM) ECCF Training Working Group January 2011](https://reader036.vdocuments.us/reader036/viewer/2022062500/5697bfbc1a28abf838ca124f/html5/thumbnails/26.jpg)
Dynamic Model
• Describe the interactions of the service with sequence diagrams or collaboration diagrams
• Includes relationships with other services
26
![Page 27: 1 ECCF Training 2.0 Guidance for the Platform Independent Model (PIM) ECCF Training Working Group January 2011](https://reader036.vdocuments.us/reader036/viewer/2022062500/5697bfbc1a28abf838ca124f/html5/thumbnails/27.jpg)
MA – External Service Relationships
Service / System / Actor’s Name
Relationship Data Description
Integrative Translational Research System
Depends Molecular Annotations
Integrative Translational Research Systems such as caIntegrator depend on Molecular Annotations for looking up annotations for microarray reporters used in experiments being analyzed.
Gene Expression Analysis Tool
Depends Molecular Annotations
Gene Expression Analysis Tools such as GEWorkbench depend on a Molecular Annotations for putting expression data in context of a genome.
27