Book a Demo

Author Topic: Diagramming Artifacts  (Read 6746 times)

Bill Egge

  • EA User
  • **
  • Posts: 93
  • Karma: +0/-0
    • View Profile
Diagramming Artifacts
« on: August 30, 2005, 10:22:38 am »
Can somone tell me if this diagram is correct?

Here is what it is:

The purpose of the system is to create 2 word documents from a mail merge.  One will be stored into our indexing system and the other will be printed and mailed out.  The document for indexing is the same as the one that is being mailed out except that it includes extra fields for indexing and retreival.  The 2 word documents are at the bottom of the diagram.

In house this work is divided between 2 people.  First, documents are printed and mailed and then they are indexed.

The "mailer" runs the Mail_ClientTermEE program to gather specific data for the mail merge and stores this data into the ClientTermMail table (The table is emptied out before filling).  This table is used for the data source for the mail merge for mailing and printng.  Then the person clicks a button and transfers this data to the IndexXXX tables and then notifies person #2 that she should do indexing.  Person #2 runs the program Index_ClientTermEE and selects data from the IndexXXX tables and populates the ClientTermSC table (ClientTermSC is emptied first).  Person #2 runs a special macro in document ForIndexing... which pulls data from ClientTermSC.

I wanted to know if I have diagramed the physical layout properly.



jeshaw2

  • EA User
  • **
  • Posts: 701
  • Karma: +0/-0
  • I'm a Singleton, what pattern are you?
    • View Profile
Re: Diagramming Artifacts
« Reply #1 on: August 31, 2005, 08:03:32 am »
Quote
Can somone tell me if this diagram is correct?
 Correct is the operative word here...

What are you trying to document|diagram?  You are using a Deployment diagram (how artifacts are allocated to physical nodes) to document a database structure and document associations!  And then, your textual comments document a work flow process.  ???

I'm confused...You need to clarify your thoughts I think.  At least, make your question more specific.
Verbal Use Cases aren't worth the paper they are written upon.

Bill Egge

  • EA User
  • **
  • Posts: 93
  • Karma: +0/-0
    • View Profile
Re: Diagramming Artifacts
« Reply #2 on: August 31, 2005, 08:47:57 am »
The workflow description was just information to help understand the diagram but the diagram is not suppose to show a workflow - its only suppose to show dependencies between files.

What I am trying to do is to document the physical files involved in the process so that later when I need to change something, I know what files need to be changed.

But, if I only put in the files and exclude the database tables that are within the database file then I will not have enough information in the diagram to understand that table "ClientTermSC" needs to be referenced by the word document "ForIndexing - Term Letter...."

That is why I showed the tables in the diagram even though they are not actual files.

Paolo F Cantoni

  • EA Guru
  • *****
  • Posts: 8626
  • Karma: +259/-129
  • Inconsistently correct systems DON'T EXIST!
    • View Profile
Re: Diagramming Artifacts
« Reply #3 on: August 31, 2005, 03:38:55 pm »
Quote
The workflow description was just information to help understand the diagram but the diagram is not suppose to show a workflow - its only suppose to show dependencies between files.

What I am trying to do is to document the physical files involved in the process so that later when I need to change something, I know what files need to be changed.

But, if I only put in the files and exclude the database tables that are within the database file then I will not have enough information in the diagram to understand that table "ClientTermSC" needs to be referenced by the word document "ForIndexing - Term Letter...."

That is why I showed the tables in the diagram even though they are not actual files.
Bill,
As it happens, this last week I've been playing with artifacts and components and model elements.  In order to generate (in this case source) Components, I need to know which Classes are in which Artifacts for which Components.   For a Source Component (Folder), there are typically many Artifacts (files) composed of many Classes.
UML provides a Manifest relationship to say that a Classifier is manifest in a specific Artifact.  However, conceptual analysis suggests this is a ternary and not a binary relation.  Thus I use an (N-ary) Association lozenge to relate a specific Class, to a specific Artifact for a specific Component, using 3 AssociationEnds (I simulate AssociationEnds by creating an Association from the Association(Class) to the Class (or Component or Artifact) but placing the filled in compositional filled-in diamond on the end opposite the Association(Class).  The AssociationEnds are (currently) stereotyped end, and the Association(Class) stereotyped manifestation.

This would seem to be analogous to your requirement where you want to document which Tables are in which Databases for which Process.  You could stereotype your Association(Class) involvement.

HTH,
Paolo
Inconsistently correct systems DON'T EXIST!
... Therefore, aim for consistency; in the expectation of achieving correctness....
-Semantica-
Helsinki Principle Rules!