Architecture diagram/Logical Data Model and Interface Control Document progress
8 views
Skip to first unread message
Sumana Harihareswara
Nov 16, 2017, 4:32:35 PM11/16/17
to psm...@googlegroups.com
The team is committed to producing an Interface Control Document (ICD) and a Logical Data Model (LDM) for the PSM, and is committed to producing an architecture diagram depicting how the PSM is technically structured.
An LDM would represent the specific entities, attributes, and relationships involved in a business function’s view of information, per the guidance at https://www.cms.gov/Research-Statistics-Data-and-Systems/CMS-Information-Technology/DataAdmin/LogicalDataDesign.html . As I understand it, the LDM is meant to illustrate the flow of data through the PSM, from user input through the application to the database, from APIs like our LEIE interface, and to users via the front end or via APIs/export. Thus, I believe another way to talk about an LDM is to call it an architecture diagram, and am working on the assumption that it will be a boxes-and-arrows diagram plus necessary prose annotations.
An LDM would represent the specific entities, attributes, and relationships involved in a business function’s view of information, per the guidance at https://www.cms.gov/Research-Statistics-Data-and-Systems/CMS-Information-Technology/DataAdmin/LogicalDataDesign.html . As I understand it, the LDM is meant to illustrate the flow of data through the PSM, from user input through the application to the database, from APIs like our LEIE interface, and to users via the front end or via APIs/export. Thus, I believe another way to talk about an LDM is to call it an architecture diagram, and am working on the assumption that it will be a boxes-and-arrows diagram plus necessary prose annotations.
A first step to this LDM is automatically generating a map from our database schema. I've used the "pgmodeler" tool to do so. I'll avoid attaching the images directly to this mail and instead suggest you view a few sample visualizations in this GitHub comment (click on them to magnify). I'd welcome feedback on that output.
I have not yet started on the ICD. As I understand it, an ICD would be meant to document and track possible inputs and
outputs for the PSM. It would describe data interchange between the
application and the database, and between the application and other
applications (via application programming interfaces). It would NOT
describe data interchange within the PSM (between and among different
components of the application), as I understand it. https://www.cms.gov/Research-Statistics-Data-and-Systems/CMS-Information-Technology/XLC/Downloads/InterfaceControlDocument.docx is the template I anticipate using for an ICD.
I welcome feedback on this progress and on my working assumptions, either here or in the GitHub issue.
Thanks,
Sumana Harihareswara
Open Tech Strategies
Reply all
Reply to author
Forward
0 new messages