MagicRQ 16.5 Read me

About MagicRQ 16.5

Issue Resolved with MagicRQ 16.5 sp4

Software License of Apache components included by MagicRQ

Installation Instructions

Limitation of MagicRQ 16.5

Known Issues in MagicRQ 16.5

Finding Out More

About MagicRQ 16.5
MagicRQ is a MagicDraw plugin that creates an association between a MagicDraw model element and a requirement from the requirement tool. MagicRQ 16.5 supports IBM Rational RequisitePro® (Henceforth Referred referred in this document as "RequisitePro") and Telelogic DOORS® (Henceforth Referred referred in this document as "DOORS") as well as integrating with MagicDraw 16.6 and above.
Top
Issues Resolved in MagicRQ 16.5 sp4
  • MagicDraw support
    • Support MagicDraw 16.6
    • Unable to update the object association status between MagicDraw and Doors whenever a project is saved in MagicDraw.
    • New attributes that have been created in either ReqPro/Doors do not show in MagicDraw after synchronization.
    • The RequisitePro/Doors client starts whenever a new project is created in MagicDraw.
    • Unable to remove the MagicRQ menu from Doors after uninstallation has been completed.
  • RequitePro support
    • RequisitePro starts whenever a project is saved in MagicDraw.
    • Exception occurs whenever an associated RequitePro element is double-clicked.
    • The warning message does not show whenever a MagicDraw element is dragged to RequisitePro without an authorized user access right.
    • All RequisitePro data types are shown as String.
  • Doors support
    • Synchronizing data back to Doors fails whenever a special character is entered into MagicRQ properties.
    • Unable to handle child requirements.
  • View and Report
    • The element list status does not refresh whenever an association is deleted or cleared.
  • Open Associated item dialog
    • The Associated item type and owner are not listed.
  • Data synchronization
    • Unable to update the object heading attributes using the overwrite option.
  • MagicRQ Layout
    • The Clear status does not work in the item properties dialog.
  • MagicRQ Explorer
    • If a requirement is created using the Create requirement dialog, the MagicRQ associated icon for that particular requirement does not show in MagicRQ Explorer.
Top
Issues Resolved in MagicRQ 16.5 sp2
  • Support RequisitePro users with multiple access rights in order to have a better control over the features that the RequisitePro authenticated users can perform with MagicRQ.
  • Display login dialog if the security credentials are required to open a RequisitePro project (this fixes the problem that blocks RequisitePro to start if MagicRQ can't connect to this product due to the authentication failure).
  • Better support on using multiple language in MD elements.
  • Support special characters or new line brakes in the Description field of DOORS projects in order to fix an issue that leads to the impossibility of adding DOORS project to MagicRQ.
Top
Software License of Apache components included by MagicRQ
This product includes software developed by the Apache Software Foundation (http://www.apache.org/). The included software parts are covered by the Apache following copyright and disclaimer. For details regarding the Apache Software License, refer to the included LICENSE file.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Copyright (c) 2000 The Apache Software Foundation. All rights reserved.
Top
 
Installation Instructions

Install from MagicDraw

  1. From the Help main menu in the MagicDraw UML application, choose Resource/Plugin Manager. Check for available updates and new resources.
    (Note: Specify HTTP Proxy Settings for connection to start MagicDraw UML updates and resources).
  2. Select the check box near the MagicRQ Plugin and click Download/Install.
  3. Restart MagicDraw.

Install from Download

  1. From the Help main menu in MagicDraw UML application, choose Resource/Plugin Manager.
  2. Click the Import button to specify the MagicRQ Plugin file location. Plugin will be extracted and installed automatically.
  3. Restart MagicDraw.

NOTE:

  • MagicRQ supports Windows only.

To complete integration process, follow these steps:
(For RequisitePro)

  1. Open the RequisitePro application. From the Tools main menu, choose Adds in.
  2. In the opened Add-in dialog box, click the Add button and browse for the magicrq-16_5.mnu file in the <MagicDraw home>\plugins\com.nomagic.magicdraw.magicrq directory.
  3. In the Name text box, type plugin name MagicRQ and click OK.
  4. Restart the RequisitePro application to activate the MagicRQ plugin.

(For DOORS)

  1. Go to MagicRQ -> Options in the MagicDraw menu
  2. Select Telelogic DOORS in the Default Requirement Tool in General Tab
  3. Select the DOORS Install Location, (eg:C:\Program Files\Telelogic\DOORS_ET)
  4. Select the DOORS Version that you installed. 8.0 is selected by default
  5. Click Apply to apply the changes and click OK
  6. Restart your computer to activate the MagicRQ plugin.

Supported DOORS Version

MagicRQ 16.5 supports DOORS 8.0, 8.1, 8.2, 8.3, and 9.0.
To integrate with MagicRQ with DOORS, you must define the DOORS Install Path and Version from the MagicRQ Option, General Tab

Supported RequisitePro Version

MagicRQ 16.5 supports RequisitePro 7.0 or later.

Supported MagicDraw Version

MagicRQ 16.5 supports MagicDraw 16.5 or later.

 

Top
Limitation of MagicRQ 16.5

Limitation of MagicRQ in MagicDraw

Undo/Redo for MagicRQ association is not supported If you creates an association and deletes the association, when you attempts to undo the deletion, magicrq can't recover the deleted association.
Missing "Orphan" association in View When deleting an element that has an association. The status changes to "Orphan". But we can't see this association in view and report in MD Side because the hyperlink has been removed.
SysML plugin must be loaded in order to create SysML requirement or SysML Requirement Diagram SysML plugin is necessary to create SysML Requirement or SysML Requirement Diagram from the Requirement Tool.
MagicRQ works with the last opened MagicDraw Application if there is more than one MagicDraw running. MagicRQ functions work with the last opened MagicDraw application if there is more than one MagicDraw Applications running.
The dialog style create association, create element, create diagram is not supported with teamwork server project.

Currently, MagicRQ does not support teamwork server projects to work with dialog style create association, create element or create diagram.

You should use the MagicRQ Layout to create association or create element for teamwork server projects.

Overwriting associated element/requirement

MagicRQ will use the current data to overwrite during data synchronization. However, MagicRQ will use the data from xml when you overwrite from Overwrite command after changing the No Sync to Sync.

You should perform data synchronize after changing status from No Sync to Sync.

Open association When you open an association to DOORS or RequisitePro, its application window will not automatically pop up
SysML link Synchronization is not supported when SysML link is removed.
Cannot Create new Requirement if element contains DOORS's Read-only attribute When synchronizing data from DOORS to MagicDraw, you cannot create a new requirement if the element contains DOORS' read-only attributes.

Limitation of MagicRQ integration with RequisitePro

Missing Path Variable When you migrates associations from a previous version of MagicRQ, the path variable is not created.
Missing attributes when create element or data synchronize Some of the RequisitePro attributes fail to copy to the element when creating element or data synchronization.
Connection fails if the dialog is opened MagicRQ can not connect to RequisitePro if the dialog is opened in RequisitePro application. All the dialogs from RequisitePro application must close in order to create connection from MagicRQ.
The associated requirement cannot be opened when RequisitePro opens the other view MagicRQ cannot open and highlight the associated requirement when the RequisitePro open the other view ( for example: All Features).

Limitation of MagicRQ integration with DOORS

Operation Failed during process due to Invalid DOORS Access Rights The "Operation Failed" dialog will appear when creating requirement or synchronizing because the requirement is not allowed to be UPDATED
Cannot support DOORS formal module outside a folder inside the project MagicRQ will not support any DOORS formal module located outside a folder in the project. In order to create DOORS formal module, you must create a folder inside the project then create DOORS formal module inside that particular folder.

Top
Known Issues in MagicRQ 16.5
Known Issues Description Solution
No association will be shown in View and Report if using data from previous version of MagicRQ No association will be shown in View and Report if you are using data from previous version of MagicRQ until you create an association in MagicRQ 16.5 sp2 You must create an association in MagicRQ 16.5 sp2 before using the View and Report function.
Cannot migrate association from MagicRQ 2.0 to MagicRQ 16.5 sp2 Cannot migrate association from MagicRQ 2.0 to MagicRQ 16.5 sp2 if no association created in MagicRQ 16.5 sp2 before. You must create association in MagicRQ 16.5 sp2 before using the migrate function.
MagicRQ plugin will not be removed from DOORS and RequisitePro when the uninstall process is completed. After finish uninstalling MagicRQ, the MagicRQ plugin file in DOORS and RequisitePro will not be removed. The plugin will still exist in the applications. You can manually delete the file:
  1. Delete the MagicRQ folder in <DOORS_FOLDER>\lib\dxl\addins
  2. Go to <DOORS_FOLDER>\lib\dxl\addins\user and delete the following files:
    • magicrq_helper.dxl
    • MagicRQ_BrowseFunctions.dxl
    • MagicRQ_LinkManagementFunctions.dxl
    • MagicRQ_ObjManagementFunctions.dxl
    • mrq_a.bmp
    • mrq_s.bmp
  3. Go to <DOORS_FOLDER>\lib\dxl\config\formalPopupFiles and delete:
    • magicrq.dxl
MagicRQ will not automatically start DOORS version from the Configuration Option dialog if there are many versions of DOORS are installed on the machine. MagicRQ will not automatically start a DOORS version from the configuration option dialog if many versions of DOORS are installed on the machine.

By default, MagicRQ will automatically start the first version of DOORS installed on the machine.
You can manually open a DOORS version that needed.
Cannot perform Synchronization between MagicDraw and other tools if the tools are not open. When synchronizing between a MagicDraw project and a project from third party tools. The third party tools must be opened. Otherwise, your data might be lost. Manually open the third party tool before performing any data synchronization.
Cannot perform any migration if the location of the project is changed. If you change the location of your projects before the migration of association data takes place, the migraton process will fail.. You can change the location after the migration is completed.
New RequisitePro/DOORS attribute is not show in tags field of MD element immediately. After new RequisitePro/DOORS attribute is added the value of new attribute is not shown to tags field in property panel of MagicDraw The synchornize in MagicDraw is required to make the value of new attribute be shown in tags field

Top
Finding Out More

Web page

To download the demo of this version and to get contact information, please go to: http://www.magicdraw.com/

E-mail

support@magicdraw.com - for questions about product installation, features, questions like "How do I...", and suggestions.

sales@magicdraw.com - questions regarding academic and site discounts, delivery, customer profile, invoices and related issues.

contact@magicdraw.com - email for other contacts

We are awaiting your comments and suggestions. More than half of the features of the current version were added because our demo version users have requested them. Do not miss the chance to see your desired features in future versions!

Bug Reports

Your bug reports are welcome at support@magicdraw.com. These reports allow us to fix bugs as soon as possible and release known-bug-free maintenance releases. While sending the bug report, please, include (if applicable):

  • MagicDraw UML version number and the name of the edition (Standard, Enterprise, Professional Java, Professional C++, Professional C#, Demo, or Academic).

  • Source where you got the version from (demo CD or our homepage download).

  • Your OS name and version.

  • JDK version and JVM vendor.

For information about your JVM and OS, see the Info tab in About dialog from the MagicDraw UML Help menu. If you have a file that MagicDraw is not able to load and it is not a confidential one, please, attach it as well. This would help us to analyze the problem.

Bugs can be submitted directly from the MagicDraw application - Help->Submit a Bug.

Top