Topic
  • 5 replies
  • Latest Post - ‏2013-02-11T15:36:13Z by SystemAdmin
SystemAdmin
SystemAdmin
14225 Posts

Pinned topic Referring RSA model element from external document

‏2013-02-05T15:12:12Z |
Hi,

I'd like to add references to elements of an RSA model (e.g. states, transitions, classes etc.) from an external document (an MS Word file).
What is the best way to do this?
Is it possible to add a Hyperlink to the Word doc that opens RSA and automatically selects the given element in the Project Explorer when clicking on it?
If that does not work, then maybe I could add a textual reference to the document that the user could copy&paste and use in RSA to navigate to the element directly.
The "qualified name" would be ideal for that, as it identifies model elements unambiguously, but RSA doesn't seem to support navigating to or searching for elements by their qualified name.

Any help would be appreciated.

Thanks,
Tamás
Updated on 2013-02-11T15:36:13Z at 2013-02-11T15:36:13Z by SystemAdmin
  • SystemAdmin
    SystemAdmin
    14225 Posts

    Re: Referring RSA model element from external document

    ‏2013-02-05T16:13:42Z  
    Hello Tamás,

    I think that if you exposed the models via Rational Software Architect Design Manager, then you would get addressable URLs for various model elements.

    http://www-01.ibm.com/software/rational/products/swarchitect/designmanager/
    https://jazz.net/products/design-management/

    Alternatively, you might consider publishing the RSA Model with the Web Publisher, host that generated web site somewhere stable, and create links to that.

    http://pic.dhe.ibm.com/infocenter/rsahelp/v8r5/index.jsp?topic=%2Fcom.ibm.ccl.erf.doc%2Ftopics%2Ft_publish.html

    Thank you and regards, Lara
  • SystemAdmin
    SystemAdmin
    14225 Posts

    Re: Referring RSA model element from external document

    ‏2013-02-05T17:10:11Z  
    Hello Tamás,

    I think that if you exposed the models via Rational Software Architect Design Manager, then you would get addressable URLs for various model elements.

    http://www-01.ibm.com/software/rational/products/swarchitect/designmanager/
    https://jazz.net/products/design-management/

    Alternatively, you might consider publishing the RSA Model with the Web Publisher, host that generated web site somewhere stable, and create links to that.

    http://pic.dhe.ibm.com/infocenter/rsahelp/v8r5/index.jsp?topic=%2Fcom.ibm.ccl.erf.doc%2Ftopics%2Ft_publish.html

    Thank you and regards, Lara
    Hello Lara,

    Thank you very much for the tips!
    I'll check the Web Publisher, it may be just what I need.

    Regards,
    Tamás
  • SystemAdmin
    SystemAdmin
    14225 Posts

    Re: Referring RSA model element from external document

    ‏2013-02-05T17:29:47Z  
    Hello Lara,

    Thank you very much for the tips!
    I'll check the Web Publisher, it may be just what I need.

    Regards,
    Tamás
    Hello Tamás,

    Upon further reflection: please verify that if you re-generate the web published model the generated URLs remain the same. I have not tested this, and if it is not the case, it would make this approach practically unusable.

    Note that you can also generate Word documents from a model, including model diagrams, using BIRT. In this case you would not "link" to artifacts in the model, you would produce a document where the information extracted from the model is embedded.

    See:
    http://www.ibm.com/developerworks/rational/tutorials/dw-r-umlbirtreport/index.html

    Thank you and regards, Lara
  • SystemAdmin
    SystemAdmin
    14225 Posts

    Re: Referring RSA model element from external document

    ‏2013-02-06T16:51:18Z  
    Hello Tamás,

    Upon further reflection: please verify that if you re-generate the web published model the generated URLs remain the same. I have not tested this, and if it is not the case, it would make this approach practically unusable.

    Note that you can also generate Word documents from a model, including model diagrams, using BIRT. In this case you would not "link" to artifacts in the model, you would produce a document where the information extracted from the model is embedded.

    See:
    http://www.ibm.com/developerworks/rational/tutorials/dw-r-umlbirtreport/index.html

    Thank you and regards, Lara
    Hello Lara,

    It seems that the generated URL remains the same, even if I change the name of the element! This is very good news.

    In the long run I plan to integrate all textual documentation into the model, so the ability to generate Word documents from the model may be very useful for me.

    Thank you again for your help!

    Regards,
    Tamás
  • SystemAdmin
    SystemAdmin
    14225 Posts

    Re: Referring RSA model element from external document

    ‏2013-02-11T15:36:13Z  
    Hello Lara,

    It seems that the generated URL remains the same, even if I change the name of the element! This is very good news.

    In the long run I plan to integrate all textual documentation into the model, so the ability to generate Word documents from the model may be very useful for me.

    Thank you again for your help!

    Regards,
    Tamás
    Hello Tamás,

    Thank you for sharing your results.

    Best regards, Lara