Book a Demo

Author Topic: Documenting Receptions in EA  (Read 3005 times)

lmilojevic

  • EA Novice
  • *
  • Posts: 3
  • Karma: +0/-0
    • View Profile
Documenting Receptions in EA
« on: September 20, 2022, 12:43:42 am »
I have an Interface Block that contains both Operations and Receptions as well as the values that get passed from one block to another using either operations or receptions.  I would like to create documentation that contains tables of all operations and receptions including parameters and notes.  I was able to create a table that contains the operations using the EA Document Templates  Designer and Content Panel by using the below section markers to the template but I can’t find proper checkboxes in the Content Panel to show receptions.  What is a proper way to document receptions?

method>
{Meth.Name}                parameter> {MethParameter.Name}:{MethParameter.Type}<parameter              {Meth.Notes}
<method
« Last Edit: September 20, 2022, 12:45:37 am by lmilojevic »

jcampos

  • EA Novice
  • *
  • Posts: 15
  • Karma: +1/-0
    • View Profile
    • Andes Architecture
Re: Documenting Receptions in EA
« Reply #1 on: September 20, 2022, 11:10:35 pm »
Hi Imilojevic,

You should create a Model Document, calling the tags or properties needed using an EA Document template as a base.

Please watch this video with the new V16 functionality to create a new template: https://sparxsystems.com/products/ea/16.0/videos/custom_documents.mp4

After that, read this article: https://sparxsystems.com/enterprise_architect_user_guide/16.0/model_publishing/createadocumentobject.html

If you need help, don't doubt to contact me.

Jhon Campos
EA user, Colombia.
If you need any help, don't doubt in contact me.

Jhon Campos
Andes Architecture, Colombia.

lmilojevic

  • EA Novice
  • *
  • Posts: 3
  • Karma: +0/-0
    • View Profile
Re: Documenting Receptions in EA
« Reply #2 on: September 22, 2022, 06:29:03 am »
I have master document and model documents and that works fine to generate a document.  My issue is that only Operations are shown inside the document but not Receptions.  I tried using the below Custom SQL Fragment search under Document Options which gets both Operations and Receptions reported but this search now only reports Operations that have parameters and skips one withouth any parameters.  Here is the SQL search that I am using if anyone has suggestions on how to improve to show both?

SELECT t_operation.Name as Name, t_operationparams.Name as Param, t_operationparams.Type as OType, t_operation.Notes as Notes
FROM t_operation, t_operationparams
WHERE t_operation.OperationID = t_operationparams.OperationID AND t_operation.Object_ID = #OBJECTID#

lmilojevic

  • EA Novice
  • *
  • Posts: 3
  • Karma: +0/-0
    • View Profile
Re: Documenting Receptions in EA
« Reply #3 on: September 22, 2022, 10:33:35 am »
I figured it out.  I should have used LEFT JOIN instead of INNER JOIN