DownloadDownLoad   PurchasePurchase      
About interfaces with external command and external program.
Create 02-Sep-2009
Last Update 16-Nove-2009
Below are for Build 077 or later.

Call of external command

Configuring a setting file enables to set a menu of external tool at RaQuest's Main menu | Tool.

Setting

Create an arbitrarily name folder under the installation folder and then create an ini extension file under it. The format of the ini file is as follows.

MENUNAME=menu name
EXECFILE=command full path
ARGUMENT=command argument
EXECDIR=command execution directory
SHORTCUT=displaying order (shortcut key)
DESKTOP=Action with Enterprise Architect desktop edition
SHOWWINDOW=Window's show status

  • ARGUMENT
    • $f The file path/connection string of the current project
    • $k type of selected element
    • $g GUID of selected element
    • $e EAID of selected element
    • $p GUID of project
    • $%id% etc. attribute value of requirement when selected element is requirement
      ($%(user-defined attribute name)% etc.)
    Double quote when needed to match the number of attributes.
  • EXECDIR can be omitted. When omitted, directory is set to an ini file's folder.
  • SHORTCUT is from 1 to 10. Omittable.
    Shortcut keys correspond with CTRL+F1 to CTRL+F10.
  • DESKTOP can be omitted. The choices are CLOSE/NG/OK.
    CLOSE is to close the project once and re-open it after execution with Enterprise Architect Desktop edition.(default)
    NG is un-executable with Enterprise Architect Desktop edition.
    OK is executable with Enterprise Architect Desktop edition.
  • SHOWWINDOW can be omitted. When omitted, show normal.
    0 is hidden window.
    1 is show normal window.
Example:
MENUNAME=menu name
EXECFILE=C:\test.bat
ARGUMENT="$f" $g
EXECDIR=C:\
SHORTCUT=1
DESKTOP=CLOSE
SHOWWINDOW=1

In the above configuration:
  • Display "menu name" in menu.
  • Executable file is C:\test.bat
  • Argument is currently opening project file($f), and selected element GUID($g).
  • Execution directory is C:\.
  • Shortcut key is CTRL+F1.
  • Action with EA desktop edition closes the project once, and re-open it after execution.
  • Show normal window.

Selection/update of requirements from external program

Use library (RaQuestMessageLib.dll in the installation directory)

Library function

  • SetTargetProjectGUID: Specify the project targeted to be sent message.
  • FindTargetInstance: Find a currently opening specified target project from RaQuests
  • UpdateRequirement: Send updating message of requirement
  • SelectRequirement: Send selection message of requirement
  • CloseMessage: End of sending message

Sample program

sample of call external command

Create a folder under RaQuest's installation directory, and then put the extracted files from the downloaded zip file.

sample of call external command

Sample of external command (No messages from the external program)

Sample of external command, which is called from RaQuest to change the data. In this sample, when "review required" attribute of a requirement is True, UML Items combined with the requirements by realization connection is bookmarked. (A sample which reflects status of requirements to UML Items)

Sample which reflects "review required" status of requirements to bookmarks of UML Items.(EA-API edition)
Sample which reflects "review required" status of requirements to bookmarks of UML Items.(SQL edition)
Sample source which reflects "review required" status of requirements to bookmarks of UML Items.(VC6)(EA-API edition)(registered users only)
Sample source which reflects "review required" status of requirements to bookmarks of UML Items.(VC6)(SQL edition)(registered users only)

Sample of external command (Messages from the external program)

Sample of external command, which is called from RaQuest to change the data and send messages to RaQuest. In this sample, change "review required" attribute of requirement combined with bookmarked UML Items by realization connection to True, and send a message to update the reviewed requirements' display. (Sample which reflects status of UML Items to requirements.)

Sample which reflects bookmarks of UML Items to "review required" status of requirements.
Sample source which reflects bookmarks of UML Items to "review required" status of requirements.(VC6)(registered users only)
Sample source which reflects bookmarks of UML Items to "review required" status of requirements.(VB6)(registered users only)

© 2004-2018 Sparx Systems Japan Co., Ltd. All rights Reserved.
Please direct your comments to global@sparxsystems.jp