Date: Fri, 29 Mar 2024 13:14:14 +0100 (CET) Message-ID: <1991519826.2018.1711714454970@nm-docs> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_2017_1719034119.1711714454969" ------=_Part_2017_1719034119.1711714454969 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
Report Wizard provides a report template that you can use to generate a = web portal report. A web portal report is a report published in HTML format= so it can be viewed in a web browser. With the web portal report, you can = share your project and virtually make your models readable to the other sta= keholders, including those who do not understand MagicDraw models. The web = portal report allows the readers to provide feedback on any element or diag= ram in the model by commenting on it. This web portal report template is on= ly available in MagicDraw Enterprise edition. In other editions, MagicDraw = provides a demo version of the web report template, which can contain, at m= ost, 10 symbols per view.
A web portal report simplifies the complexity of a model by reducing les= s needed elements from the model tree and displays the most relevant views = of your project. For example, a MagicDraw project report includes views suc= h as Glossary, Requirements, Architecture, Implementation, and so forth, an= d a SysML Plugin project report includes views such as Requirements, Struct= ure, Interfaces, Constraints, and so forth. It helps you generate your proj= ect in a user-friendly and easy-to-browse environment.
The web portal report features a quick search to help you find elements = and diagrams for faster content viewing.
Generating a web portal report is as easy as generating any other report= s with Report Wizard.
If your MagicDraw has a plugin that provides another template for genera=
ting a web portal report, you can find this template in a separate package.=
For example, if you have installed SysML Plugin, you should expand the
3. Click Next.
4. If you need to allow comments on the report= , do the following:
5. If you want ScreenTips to appear on the rep= ort when it opens for the first time, do the following:
Click the Variable b= utton. The Report Variable dialog will open.
In the value cell of the Show= Tip variable, type either True or true.
Click OK.
6. Click Next.
7. Select the elements you need to include in = the report and click Next. For more information, refe= r to Select Element Scope Pane.
9. Save your report in a specific location, ty= pe the report name (for example, report.html), and specify other output opt= ions if desired.
10. Click Generate.
As a web portal report includes a number of files and folders, it is str= ongly recommended that you save the report in a separate folder. For more i= nformation, refer to Generate Outpu= t Pane.
11. You can open the report by double-clicking the H= TML/HTM file in the location specified in step 6 (in this example, report.h= tml).
12. You can place the report in a shared directory o= r on a web server to make it available for the other stakeholders.
If a web portal report enables feedback or comments, you can write somet= hing about a model element or a diagram in the report. See step 4 in Generating Repor= ts for more information on how to enable feedback or comments in = a web portal report.
Type your comment in details in the Description box.
IMPORTANT! Your comments in the Description box should = not exceed 1500 characters. Comments exceeding the limit will not be includ= ed.
Click Send. The global address of the selected elem= ent or diagram, the name of that element or diagram, and the contents in bo= th the Summary and Description boxes will= be sent to the web server.
There are several ways to deliver comments on elements and diagrams in a= web portal report and allow others to read them. You can choose to deliver= them through an issue tracking system, such as JIRA, or an e-mail platform= , such as Gmail or Outlook.
The following example shows how to deliver comments, if you need to get = the comments to a certain account on JIRA as issues of the type =E2=80=98Bu= g=E2=80=99:
Copy the following script:
<?ph= p $contentUrl =3D $_GET['url'];=09=09=09=09=09=09=09 // Global address of t= he commented =09=09=09=09=09=09=09 // element or diagram. $contentTitle =3D $_GET['contentTitle'];=09=09=09=09 // Name of the comme= nted element =09=09=09=09=09=09=09 // or diagram. $contentSummary =3D $_GET['commentSummary']; // Summary text of= the comment. $contentCommentArray =3D $_GET['comment'];=09=09=09 // Text of the commen= t. $contentComment =3D implode(" ", $contentCommentArray); $description =3D $contentTitle . " \\\\ " . $contentComment . " \\\\ " . "L= ink to the content: \\\\" . $contentUrl; $issue =3D array( 'type'=3D>'1',=09=09=09=09 // Type of JIRA is= sue 'project'=3D>'TEST', =09 = =09=09// that stores the comment. =09=09=09// '1' means 'Bug'. // Name of JIRA proj= ect =09=09=09=09 // that stores the comm= ents (3.1). 'description'=3D> $description,=09=09=09=09=09=09// Description cont= ents =09'summary'=3D> $contentSummary, // of JIRA issu= e that =09'priority'=3D>'2',=09 // stores the c= omment. 'assignee'=3D>'username',=09 // Summary t= ext of JIRA issue =09'reporter'=3D>'username',=09 // that store= s the comment. =09=09=09=09=09=09 // '2' means 'Critical'. =09=09=09=09=09 // Username of JIRA account, =09=09=09=09=09=09 // to which the comment i= s sent (3.2). =09=09=09=09=09 // Username of JIRA account, =09=09=09=09=09=09 // which sends the commen= t (3.3). ); $soapClient =3D new SoapClient("https://example.com/rpc/soap/jirasoapservic= e-v2?wsdl");=09=09=09=09=09=09=09=09=09// (3.4) $token =3D $soapClient->login('username', 'password'); =09=09=09=09=09= =09=09=09=09 // (3.5) $soapClient->createIssue($token, $issue); ?>
Create a new file and paste the script onto the file.
Change the following values (the red ones in the script):
The name of a JIRA project.
The assignee=E2=80=99s username.
The reporter=E2=80=99s username.
The global address of a web service, which provides JIRA.
The username and password of the JIRA account wherein a new issue is= created from the comment data.
Save the file as jiraExample.php.
Upload the file to your web server, for example, Apache Tomcat.
<= /li>When enabling comments in your web portal report (step 4 in Generating Report= s), specify <web server address>/jiraExample.php (for example, example.com/jiraExample.php) as the value of the WebComment = variable.