Book a Demo

Author Topic: Enlighten us about Document artifacts  (Read 7183 times)

marcelloh

  • EA User
  • **
  • Posts: 192
  • Karma: +0/-0
    • View Profile
Enlighten us about Document artifacts
« on: December 30, 2009, 10:16:06 pm »
I can have a linked document on an Document Artifact.
That should give me a lot of possibilities.

But if I use this, there is no way how to get this into a document.

The manual should give me some info, I suppose.

fwoolz

  • EA User
  • **
  • Posts: 435
  • Karma: +0/-0
  • We have met the enemy, and he is us.<Pogo, 1970>
    • View Profile
Re: Enlighten us about Document artifacts
« Reply #1 on: December 31, 2009, 08:01:48 am »
Hi Marcelloh,

I'm not sure I understand what you're getting at. I just tried the following and it worked properly:
1. Add a plain "Artifact" to a diagram.
2. Create and then edit a linked document for that "Artifact".
3. Add a "Document Artifact" to a diagram.
4. Create and then edit a linked document for that "Document Artifact".
5. Generate RTF documentation for the package containing the diagram with "Linked Document" checked under "Element" in the RTF Template Editor.
6. View the generated document and verify that the contents of the linked documents are in fact in the generated document.
Fred Woolsey
Interfleet Technology Inc.

Always be ready to laugh at yourself; that way, you beat everyone else to the punch.


marcelloh

  • EA User
  • **
  • Posts: 192
  • Karma: +0/-0
    • View Profile
Re: Enlighten us about Document artifacts
« Reply #2 on: January 04, 2010, 11:37:35 pm »
1. I added a Document Artifact to a package
2. moved it to the use case within that package
    just because I can't create it there in the first place
3. added a Linked Document to the Document Artifact
4. Typed "It would be fine if this shows"
5. saved the Linked Document
6. closed the Linked Document editor
7. checks if it really is there (by opening it again)
     it is there
8. Generate my report from the package
    just to see, that it isn't showing

At step 3, I added a linked document to a Document Artifact that has no notes, and one with notes.
In my report I only get the notes.

skiwi

  • EA Expert
  • ****
  • Posts: 2081
  • Karma: +46/-82
    • View Profile
Re: Enlighten us about Document artifacts
« Reply #3 on: January 11, 2010, 07:08:37 am »
In your document template did you select the appropriate "linked document" checkbox?

http://www.sparxsystems.com/uml_tool_guide/modeling_with_uml/linking_documentation.html
Orthogonality rules
Using EA16.1 (1627) on Windows 11 Enterprise/64 bit. Repositories in SQLServer2019 DB Schema 1558.
WebEA on Pro Cloud Server 4.2.64

marcelloh

  • EA User
  • **
  • Posts: 192
  • Karma: +0/-0
    • View Profile
Re: Enlighten us about Document artifacts
« Reply #4 on: January 11, 2010, 05:26:24 pm »
appropriate?

I suppose I did, because it shows me the notes of that document artifact.

I've read the info on the hyperlink, and I've done it like this.

The only thing is, I did't add it to a diagram.
(See my steps.)

skiwi

  • EA Expert
  • ****
  • Posts: 2081
  • Karma: +46/-82
    • View Profile
Re: Enlighten us about Document artifacts
« Reply #5 on: January 12, 2010, 08:48:45 am »
Including the notes from an entity is not the same as including the linked document. The linked documents box needs to be checked in the document template as well. (And note there are several places wherer you may need to tick this) - I'd add a picture, but the admins in their wisdom don't allow picture directly on this forum to make it more difficult for us to help each other. S
Orthogonality rules
Using EA16.1 (1627) on Windows 11 Enterprise/64 bit. Repositories in SQLServer2019 DB Schema 1558.
WebEA on Pro Cloud Server 4.2.64

marcelloh

  • EA User
  • **
  • Posts: 192
  • Karma: +0/-0
    • View Profile
Re: Enlighten us about Document artifacts
« Reply #6 on: January 12, 2010, 05:45:08 pm »
Gheghe, I found out that they where not published via
Embedded Elements, or via Lnked Documents at all....  :'(

They where in my template via Child Elemtents.
And that has absolutely no way of reportinga Linked Document that is hidden inside (as far as I can see).

And I am talking about Document Artifacts that are childs of an Use Case.

My general rule is, if i can put stuff in, I want it in my report ;-)

Dermot

  • EA Administrator
  • EA User
  • *****
  • Posts: 591
  • Karma: +7/-0
    • View Profile
Re: Enlighten us about Document artifacts
« Reply #7 on: January 13, 2010, 11:57:03 am »
The Child Element section by default, if left clear of fields, will replicate the full Element section - which will include Element::Linked Documents if set on.  
So I suggest you set this section on but leave it unpopulated - see the standard (basic template).

marcelloh

  • EA User
  • **
  • Posts: 192
  • Karma: +0/-0
    • View Profile
Re: Enlighten us about Document artifacts
« Reply #8 on: January 13, 2010, 06:06:19 pm »
So, If I do that, I get everything else in my "Child-documentation"?
But what if I don't want that?
Recursiveness is nice, if you want the same, and if the structure is the same. Perhaps I'm still unknown with how to write a perfect Use Case Template recursive, so there must be somebody else who done this?