documentation,report,documentation-generation,enterprise-architect , Documentation with Diagram “Hyperlinks” in Enterprise Architect?


Documentation with Diagram “Hyperlinks” in Enterprise Architect?

Question:

Tag: documentation,report,documentation-generation,enterprise-architect

I'm struggling to get all the required (and only the required) information into the documentation of my Enterprise Architect Project. Precisely: we have modelled various requirements and displayed the source "standards" for these requirements in our diagrams by using the "hyperlink"-element out of the common toolbox. (This allows us to capture a title, the website where the documentation is found and a description of this documentation).

Now this element is visible on the diagram, but not in the package-view of our model and it does not get generated in our word (docx) documentation.

I can see that it should be possible to get this in the documentation, because a "Model Report" which basically prints everything does print the hyperlinks. But I can't find what I have to select in my template (in the package-tree view, as a package field, element field or diagram field) in order to get this printed. I can't just use the model report since this basically dumps the whole database in the document and reverse-engineering this model report has proven too difficult for me. Actually I would expect this to be in some kind of documentation for EA, but could not find such a thing with this level of detail... is there, is there a reproducible way of finding such things out in further cases? (btw I'm using EA 11.0)

[sorry there were illustrations here, but I'm not allowed to upload them...]


Answer:

As Geert has already noted, there is a difference between "proper" elements and diagram-only elements. This is actually reflected in the document template editor, where there is an "Element" section inside the "Diagram" section. This will produce output for all elements in the diagram, whether or not they are also in the project browser.

Here's an example of the information you can pull out of your hyperlinks. Given a diagram with a hyperlink:

Diagram

... and a template which outputs name, alias and hyperlink for each element in the diagram:

Template

... EA will generate a document will the following contents:

Document

So if you want the hyperlink to result in a hyperlink in the document, use the HyperlinkAlias field.

What might be a bit confusing is the fact that in addition to the Hyperlink element type in the Common diagram toolbox, EA allows you to create hyperlinks in regular elements (in the Element Properties dialog, Related tab: Files, which can be local files or web addresses).

In fact, I would recommend that you use those in your Requirement elements rather than diagram-only Hyperlinks if traceability is a priority in your model. The diagram-only Hyperlinks, on the other hand, give you a clearer visual.

Selecting a subset of the elements in a diagram ("only the required information") is a little more involved and depends on how your model is structured. Template fragments will get the job done, but you might be able to achieve your desired result by just using the filters in the document generation dialog.


Related:


Will leveldb method put update a value?


api,documentation,leveldb
Will the method put update a value or is it necessary to first delete it and then put the new one?

Why does VarType() ALWAYS return 8204 for Arrays


vbscript,documentation
In the VarType MSDN Microsoft documentation for VBScript's VarType function it says (With bold emphasis): "Remarks The VarType function never returns the value for Array by itself. It is always added to some other value to indicate an array of a particular type. The value for Variant is only returned...

I don't undestand documentation about ALAssetPropertyAssetURL


ios,objective-c,documentation,alassetslibrary,alasset
I get asset URL by calling [asset valueForProperty:ALAssetPropertyAssetURL] sometimes it returns nil or may be asset is nil (I've seen it in the crash logs). I've read in the documentation: ALAssetPropertyAssetURL The key to retrieve a URL identifier for the asset. The corresponding value is an NSURL object. This URL...

In BIRT how to change the default time range into week base


java,report,birt
I meet a problem that I have two parameters, the start date and end date. I want the default date automatically change into week base. For example, today is may 24, so the default start date should be may 17, and the default end date should be today, and then...

Problems adding DataTable as datasource in C1Report (VB) ComponentOne


vb.net,report,componentone
I'm having troubles to assign a datasource to a code-generated c1report. This is the datatable data. This is the output result pdf view. I'm using Visual Studio 2008 with ComponentOne 2009. The result pdf file as not the correct data, only the titles repeated to bottom. Then, this is the...

SQL Datename within a function


sql,tsql,report
I'm having issues when trying to get a datename Month within a conversion. My current query is used to check the time a Trolled passed 'South Shop' however I now require the query to take the conversion then display me the month only. Current query snippet: dbo.fn_ConvertUTCtoShopDateTime( Visit.ORGID, dbo.fn_GetTrolleyreportcrossingafter (...

Document Restful API created in Node.JS


javascript,node.js,documentation,swagger
I have created Restful APIs in Node.js and now I plan to document them so they can be shared with others. I spent the past couple of days researching in to this and I found Swagger and started exploring what it had to offer. I really like Swagger-UI, It takes...

Passing arguments to a perl package while using it


perl,documentation,arguments,standards,packages
it is possible to pass some arguments while using a package, for example: use Test::More tests => 21; I wasn't able to find any valuable documentation about this featue. Are there any pros and cons of passing such arguments? Best, R....

BiqQuery which tool is used to produce reports online? [closed]


report,google-bigquery
I'am new to BigQuery and I come to Google cloud from "oracle forms/reports"... Can someone give me some direction which tool is used to produce some kind of report connected to BigQuery? For now I have tried to export BigQuery datas into CSV and use that data in Excel or...

Where can I find official and up-to-date documentation for the WebRTC API?


google-chrome,firefox,documentation,webrtc
I know about adapter.js, which tries to: insulate apps from spec changes and prefix differences. But adpater.js only covers the very basic WebRTC API's. I'll just use setRemoteDescription as an example. In 2013 it was called like this: pc.setRemoteDescription(offer); According to https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection, the current API is? pc.setRemoteDescription(new RTCSessionDescription(offer), function() {...

Undocumented intrinsic routines


delphi,documentation,intrinsics
Delphi has this list: Delphi Intrinsic Routines But that list is incomplete. Which undocumented intrinsic functions exist, since when and what is their purpose? ...

How can i generate domain model diagrams, and documentation


import,documentation,enterprise-architect,domain-model,generated
I imported my project files into Enterprise Architect, under the Domain Model section. The program imported the files correctly, but it did not create domain model diagrams, so i can generate documentation about it, but it is empty. If i imported the project files under the Class model section, class...

Power and timing reports of two different vhdl designs


performance,report,vhdl,timing,area
Let's suppose I have two circuits (described in vhdl), the first one performs the following algorithm in loop(pseudo code): C<=A+B; D<=C+F; RES <= D; I represent this algorithm applying the Finite State Machine(FSM) logic. Thus: State1:C<=A+B; out_ready<='0';--the result is not ready yet nextstate<=State2; State2:D<=C+F; nextstate<=S_out; S_out: RES<=D; out_ready<='1';--the result is...

Does java.util.HashSet not Adhere to its Specification?


java,documentation,hashset,specifications
As a relative Java noob, I was baffled to find out the following: Point.java: public class Point { ... public boolean equals(Point other) { return x == other.x && y == other.y; } ... } Edge.java: public class Edge { public final Point a, b; ... public boolean equals(Edge other)...

Is possible to save Realm documentation for offline reading?


android,ios,documentation,realm
I'm going to vacations this Saturday and I need to have Realm API documentation available for offline reading (https://realm.io/docs/swift/latest/api/index.html). Does it exist somewhere for download? Thanks

Active Reports 9: Multi-Colum SectionReport, is this possible?


c#,report,activereports
I'm trying to get a SectionReport to have more than one column. The report is very long and there is plenty of space on the right side of the list (see upload) How can I do that in Visual Studio 13 (C#) using Active Reports 9? The data comes from...

What is the use of PyCharm's docstring template? How do I use it effectively?


python,coding-style,documentation,pycharm,docstring
PyCharm, the Python IDE generate a template for docstring as I start to type in the docstring. This is the template generated for a simple function. def add_them(x, y): """ :param x: :param y: :return: """ z = x + y return z I dont find it anything similar to...

Don't produce report if there is no data - PDF


reporting-services,report,suppress
I have a report for which there is sometimes no data to output. This report is run along with several other reports and all are then output to PDF. However, this report still produces the header and footer with a blank page even tho there is no data. I can...

How to read javascript frameworks documentation?


javascript,node.js,mongodb,documentation
Coming from the .NET world I am having a hard time consuming documentation for javascript frameworks. I will take "Node.js MongoDB Driver API" as an example. There is a Collection object which has the count() method. Here is the link for it: http://mongodb.github.io/node-mongodb-native/2.0/api/Collection.html#count From there I see that count() takes...

SSRS - Fields working in Data Set, but won't appear in report


sql,sql-server,reporting-services,dataset,report
I have a data set that gets its values from a stored procedure, and I'm positive that the stored proc is working correctly since I'm getting results in SQL Server. However, when I call the fields in an expression (for example, =Fields!CustomerName.Value) and preview, it just displays a blank spot...

Enunciate reporting - How to Exclude few APIs and include few APIs from a same class


java,rest,documentation,javadoc,maven-javadoc-plugin
I would like to exclude few API methods in a class from Enunciate documentation. Is there a way to achieve it using enunciate ? Thanks in Advance...

MS Access 2010 Date range results not as desired


sql,ms-access,report
I am using this command to open a report DoCmd.OpenReport "fullreport_rpt", acViewReport, , _ "[Assignment] ='" & lngMyEmpID & "' AND [Start] BETWEEN DateValue(#" & Me.DateRange1_txt & "#) AND DateValue(#" & Me.DateRange2_txt & "#)", _ acDialog, OpenArgs:=Me.reporting_combo & " For " & Me.rMonthly_txt & Me.DateRange1_txt & "-" & Me.DateRange2_txt [Start]...

How to show absolute URLs in API endpoint docs with RAML?


rest,documentation,raml
I'm using RAML to document my REST API. In the RAML doc, I specify the base URL at the root-level baseUri: http://api.example.org/api/{version} version: v1 Then in the API endpoints section of the doc, I specify their URL relative to this base, e.g. /foo/bar: get: description: blah blah blah When I...

Drill through reports in SSRS


sql,reporting-services,charts,report,ssrs-2008-r2
I am making a report that takes in date parameters to filter result and shows the result in a pie-chart. I want to create a drill-through (could be drill down or any other type) where if a user clicks on a part of a pie chart which is divided by...

Official documentation for seeding in Ruby on Rails


ruby-on-rails,documentation,seeding
Is there any official documentation on seeding in Ruby on Rails? I've come across third-party documentation in the form of a Railscast episode on it, but I'd also like to know what documentation if any the Rails team has produced. In the Rails guides post on ActiveRecord Migrations, there's a...

R Knitr PDF: Is there a posssibility to automatically save PDF reports (generated from .Rmd) through a loop?


r,pdf,dynamic,report,knitr
I would like to create a loop, which allows me to automatically save PDF reports, which were generated from a .Rmd file. For instance, if a variable "ID" has 10 rows, I would like R to automatically save me 10 reports, into a specific directory. These reports shall vary based...

Possible to use newline inside roxygen2 code block?


r,documentation,r-package
I'm wondering if it's possible to insert newlines inside code blocks in roxygen2 when documenting a function? If I have something inside \code{}, roxygen2 collapses all newlines into single spaces by default. I tried inserting \cr inside to enforce a line break, and I get the desired behaviour, but then...

Font data could not retrieved PdfSharp/MigradDoc


asp.net-mvc,azure,report,pdfsharp,migradoc
I have an ASP .NET MVC web application and I'm using PdfSharp/MigraDoc to generate the reports. When I publish the application to azure and print the report the following exception is raised: Internal error. Font data could not retrieved. I have this method that define the report style and I...

Best way to document “splatted” parameter with YARD?


ruby,parameters,documentation,yard,splat
I have a method that should take 1+ parameters of any class, similar to Array#push: def my_push(*objects) raise ArgumentError, 'Needs 1+ arguments' if objects.empty? objects.each do |obj| puts "An object was pushed: #{obj.inspect}" @my_array.push obj end end What is the best way to document the method parameters using YARD syntax?...

Cognos Duplicate maximum count Column value


report,cognos-10
I am trying to flag the occurrences of a data item in column [Customer] determined by column [Division] and set three values for it in column [flag]. If data item [Customer] has both ‘Q’ and ‘Z’ data item values for column [Division] in separate rows I want the value of...

Copy to Clipboard and edit the Clipboard


windows,excel,documentation
Let's say I've copied from Google Excel Sheet this content: Click Here I would like to edit the Clipboard to be something like: <div class="button">Click Here</div> Is there a way that I can do that on Windows?...

What does File.exists? do in Ruby?


ruby,documentation,standard-library
So I was looking through the Ruby standard library docs on how to read a file when I found File.exists?, with this fascinating and illuminating description: exists?(p1)   (A Google search turns up a similar amount of information) It's a real method, as verified by attempting to call it and...

Commenting Cassandra's keyspace, table, column


cassandra,documentation
In Oracle there is possibility to add a comment about a table, view, materialized view, or column into the data dictionary, e.g. COMMENT ON COLUMN employees.job_id IS 'abbreviated job title'; I found this particularly usefull as a tester when trying to understand ideas behind the names which are not necessarily...

Only include specific issues in maven-changes-plugin JIRA report


java,maven,report,jira,maven-plugin
I'm currently using the maven-changes-plugin to generate a JIRA report for a given fixVersionId, as follows: <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-changes-plugin</artifactId> <version>2.9</version> <configuration> <fixVersionIds>16355</fixVersionIds> </configuration> </plugin> However, what if instead of specific fixVersionIds, I want to be able to include specific issues? Is there a way to do that? I don't see...

Digital Metaphors Report Builder Surround Group Inside Box


delphi,report,reportbuilder
I'm interested in creating a report that contains a group in it. I'd like the group to be enclosed in a box where the box surrounds the group in every page I've tried this using lines and placing them in such a way that there is one on the group...

Multiple subreports for each value in a field for a parameter


stored-procedures,reporting-services,ssrs-2008,report,subreport
I have a Report and a Subreport, with the Report having 30 instances of the Subreport organized to fit neatly on the page. The only parameter for the Subreport is Child and the only parameter for the Report is Parent (not the actual values but it might make it easier/more...

MS Access WhereConditions in xml export


sql,xml,ms-access,report,where
I'm trying make an XML export of Report. It works, but I cant make filter criteria. I want to filter by DATE, 4 months to the past. Dim sXMLPath As String sXMLPath = "z://export1.xml" ExportXML acExportReport, "export1", sXMLPath, , , , , , [DATUM] > Date - 120 And [DATUM]...

Export Moodle report in csv file


php,database,csv,report,moodle
Does anyone know any Moodle built in feature to export custom report into a csv file? I've tried to find in documentation but there is nothing. There's this old book which also have no practical information on exporting report into a csv file. I've tried to dig into the source...

Where did the internal Rust docs go?


documentation,installer,rust
I just updated my nightly Rust toolchain (rustc 1.2.0-nightly (7c4eedc21 2015-05-25) (built 2015-05-25)) and the docs it installs are now vastly reduced – it's missing all rustc_... crates (apart from rustc_unicode). Is there a possibility to get them back? Do I have to build from source?...

why do angular docs advice not to use public and private scope variables


javascript,angularjs,api,documentation
I'm currently using $$ & $ variables from location service, I just stumbled upon this piece of documentation. It says not to use them but does not provide reason. Please enlighten me! https://code.angularjs.org/1.3.15/docs/api Angular Prefixes $ and $$: To prevent accidental name collisions with your code, Angular prefixes names of...

Visual Studio 2013 Report RDLC with related datasets


visual-studio-2013,report,relational-database,rdlc
I currently have two tables in a database "customer" and "pricelist" where a customer can have multiple pricelist items linked to their ID. I'm trying to build a report in VS2013 where it lists all customers [alphabetically], then all of their pricelist items [alphabetically], then page break between each customer....

How to turn off auto changing of words in reports like Height, Width and Count in Access 2000


ms-access,report,ms-access-2000
For a (old) project I created a report in Access 2000. In this report I wanted to create a field that multiplies 3 table fields values, namely: Aantal, Hoogte and Breedte. So I put it in my text field the following: =[Hoogte] * [Breedte] * [Aantal]. The language of my...

Macro commands to control Excel [closed]


excel,excel-vba,documentation
There is plenty of scripts that use Excel, and they usually have statements like $xlCenter=-4108 $xlTop=-4160 $xlOpenXMLWorkbook=[int]51 $xlConditionValues=[Microsoft.Office.Interop.Excel.XLConditionValueTypes] $xlTheme=[Microsoft.Office.Interop.Excel.XLThemeColor] $xlChart=[Microsoft.Office.Interop.Excel.XLChartType] $xlIconSet=[Microsoft.Office.Interop.Excel.XLIconSet] $xlDirection=[Microsoft.Office.Interop.Excel.XLDirection] I am trying to find a reference to all these commands. I tried googling the variables themselves, but it...

List&Label 16: Stop header of table to be copied on new page


forms,report,reporting,listlabel
I have a combit List & Label 16 form in which i have a reportcontainer with a table. The table is pretty simple and looks basically like this: Header ------------------------------------- Row 1 Column 1 | Row 1 Column 2 Row 2 Column 1 | Row 2 Column 2 ... Now...

What is this error about perllocale in Perldoc?


osx,perl,debugging,documentation,locale
I was discussing here about setting no locales in Perl and was recommended to run this perldoc perllocale in OSX Yosemite 10.10.3 but I get the error: Error while formatting with Pod::Perldoc::ToMan: at /System/Library/Perl/5.18/Pod/Perldoc.pm line 1346. at /usr/bin/perldoc5.18 line 11. Got a 0-length file from /System/Library/Perl/5.18/pods/perllocale.pod via Pod::Perldoc::ToMan!? at /usr/bin/perldoc5.18...

How to make QR Page Footer or Band to be under Band Details not at the page end?


delphi,layout,report,quickreports
I need to make report, that has summary after Details had printed, not after every each Detail. I only know the Page Footer, but it's at page bottom not after the Detail Band. Is there a QRBand that could go after Detail Band? Or can you make PageFooter height resize...

On youtube api v3 how can I get access to content duration, and genres ? by search or get details


search,youtube,documentation
I tried to use this : https://www.googleapis.com/youtube/v3/playlistItems?part=snippet,contentDetails&{playlist_id}&key={key}&maxResults=50 and https://www.googleapis.com/youtube/v3/search?part=snippet&q=YouTube+Data+API&type=video&videoCaption=closedCaption&key={key}&maxResults=50 It says in the documentation it is contentDetails.duration but this doesn't seem to be present in the data I receive....

How to get API documentation to be shown inside Eclipse Help window?


java,eclipse,reference,documentation,javadoc
I've downloaded jdk-8u45-docs-all.zip from here, wrote it's link to my jdk's javadoc location in Eclipse. Everything works just well, when I hover over something the tooltip appears, when I press shift+F2 offline API documentation opens in browser. The only thing that doesn't work - When I write some search query...

R functions' aliases documentation


r,documentation
I'm working on R package. I set aliases for some functions this way: foo <- function(){ do_something } foo_alias <- foo I have the documentation for 'foo' function, so when typing: ?foo I get the created documentation. Unfortunately it does not work for foo_alias. When I type: ?foo_alias I get...

What program does apple uses to create modular javascript files


javascript,module,documentation
When I looked at the new MacBook website from Apple I saw a nice smooth scrolling effect on the wireless page. I started digging in the JavaScript and found an uncompressed JavaScript file and I was blown away. (https://www.apple.com/v/macbook/a/scripts/wireless.built.js) There were so many comments, and you could almost follow what...