Radarc User Manual Icinetic TIC S.L. Version 4.0

Radarc User Manual
Icinetic TIC S.L.
Version 4.0
February 4, 2014
Contents
1
.
.
.
.
.
3
3
3
4
5
5
.
.
.
.
6
6
6
7
7
3
Radarc User Guide
3.1 Generation Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3.2 Files Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
8
12
14
4
Disclaimer
16
2
Radarc
1.1 What is Radarc? . . . .
1.2 Software Prerequisites
1.3 Installation Guide . . .
1.4 Uninstallation Guide .
1.5 Update Guide . . . . .
.
.
.
.
.
Formulas
2.1 What is a Formula? . . .
2.2 Formulas Installation . .
2.3 Formulas Uninstallation
2.4 Formulas Export . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
1
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
List of Figures
1.1
1.2
1.3
Radarc menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Radarc new project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Uninstall Radarc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4
4
5
2.1
Formulas. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
6
3.1
3.2
3.3
3.4
3.5
3.6
3.7
3.8
3.9
3.10
3.11
3.12
Radarc menu . . . . . . . . . . . . . .
Radarc new project. . . . . . . . . . .
Architecture and Formula selection.
Example: Radarc wizard. . . . . . . .
New Radarc project deployed. . . . .
MVC Formula modeling project. . .
Radarc generation panel. . . . . . . .
Radarc generation options. . . . . . .
Custom and base code files. . . . . .
Excluded folder. . . . . . . . . . . . .
Generated files tab. . . . . . . . . . .
Orphan files detected. . . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
© Icinetic TIC S.L. 1996 – 2013. http://www.icinetic.com
C/ Leonardo da Vinci, 18
Tecnoincubadora Marie Curie, 4th floor - Module C
41092, Seville, Spain, EU.
Tel: +34 954 462 266
Email: [email protected]
Typesetted with LATEX and MiKTEX.
2
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
8
8
9
9
10
11
11
12
12
13
14
15
1 Radarc
1.1
What is Radarc?
Radarc is a development software accelerator created by Icinetic TIC S.L.1 It is provided as a Microsoft
Visual Studio extension package. Radarc provides a modeling and a code generation environment able to
target different solution architectures and technologies.
1.2
Software Prerequisites
Radarc has been tested and can be installed on the following operating systems:
Windows XP (x86) with Service Pack 3 - all editions except Starter Edition
Windows Vista (x86) with Service Pack 3 - all editions except Starter Edition
Windows 7 (x86 & x64)
Windows 8 (x86 & x64)
Windows Server 2003 (x86 & x64) from Service Pack 2
Windows Server 2003 R2 (x86 & x64)
Windows Server 2008 (x86 & x64) from Service Pack 2
Windows Server 2008 R2 (x64)
Supported Architectures:
32-Bit (x86)
64-Bit (x64)
Other software requirements:
Microsoft Visual Studio 2012 Professional, Enterprise or Ultimate
Microsoft Visual Studio 2013 Professional, Enterprise or Ultimate
Depending on the Formula you have chosen, you might need to install additional prerequisite software. For more information, please refer to www.radarc.net and check your Formula software requirements.
1
Radarc™ is a trademark of Icinetic TIC S.L. www.icinetic.com
3
Radarc Manual
1.3
Installation Guide
Radarc is installed as a Visual Studio extension using a Microsoft Installer (MSI file).
Installation procedure:
1. Download Radarc installer from www.radarc.net.
2. Save Radarc4.Installer.msi file in your hard drive.
3. Double click on Radarc4.Installer.msi to install the product. Take care to close all Visual Studio
instances before running the installer.
4. Now, when opening Visual Studio, a new menu option named RADARC is available.
Figure 1.1: Radarc menu
5. Go to File → New → Project.
6. Select Radarc on Templates panel and start modeling!
Figure 1.2: Radarc new project
4
Radarc Manual
1.4
Uninstallation Guide
1. To uninstall Radarc you just have to access to the Programs and Features from Windows Control Panel.
2. Then locate Icinetic Radarc entry and press Uninstall.
Figure 1.3: Uninstall Radarc
Remember to close all Visual Studio instances before running the uninstaller.
1.5
Update Guide
To updated Radarc you need uninstall the current version (as described in section 1.4 Uninstallation guide
reference), and then, install the new version (following the steps described in section 1.3 Installation guide
reference).
In the incoming Radarc versions this operation will not be required and upgrade will be performed a
uninstall and then a fresh install.
5
2 Formulas
2.1
What is a Formula?
A Formula is a self-contained code generator implementing a complete software architecture, delivering a
set of models, code generation templates and best practices to accelerate software development using the
referenced technical architecture.
2.2
Formulas Installation
Radarc allows you to install different Formulas so you can use the one that fits better to your needs. To
install a new Formula follow these steps:
1. Obtain your Formula downloading from www.radarc.net
2. Save your Formula (.rff or .rfp file) in your hard drive.
3. On Visual Studio go to the menu option: Radarc → Radarc Formulas.
4. Click on Install Formula button.
Figure 2.1: Formulas.
6
Radarc Manual
5. On the open file dialog, select your Formula.
6. Click on accept button and it is done! Your new Formula is now installed.
7. Remember to check your Formula software requirements to avoid experiencing problems during
its usage.
If you would like to get more information about the installed Formula, just double-click in the corresponding item and the official Formula web page will be shown with all the specific information to this
specific Formula.
2.3
Formulas Uninstallation
To uninstall a Formula, follow these steps:
1. On Visual Studio select on the menu Radarc → Radarc Formulas.
2. Click on the Formula you want to uninstall.
3. Click on Uninstall button and then click on the Yes button to confirm.
After uninstalling a Formula, you will still be able to work with your projects although you cannot use
Radarc on them.
2.4
Formulas Export
This option allows you to extract an installed Formula from your system and save it as .rff or .rfp file. This
way, you can share your Formula with others or keep it in a safe place. To export a Formula you just need
to follow these steps:
1. On Visual Studio go to Radarc → Radarc Formulas.
2. Click on the Formula you want to export.
3. Click on Export button and select a location in your hard drive to save it.
7
3 Radarc User Guide
Radarc is installed as a Visual Studio extension package. After installation a new option will appear in the
main menu called Radarc.
Figure 3.1: Radarc menu
To create a new Radarc Project, just follow these steps:
1. Go to File → New Project.
Figure 3.2: Radarc new project.
8
Radarc Manual
2. Select Radarc on Templates panel, enter a name for the project, a folder, and click the OK button.
3. Select the architecture you want to deploy and the Formulas you want to use for each role.
Figure 3.3: Architecture and Formula selection.
4. The Radarc wizard will guide you through the deployment configuration process. This wizard will
show different options depending on your Formula. For further information, please check your
Formula documentation.
Figure 3.4: Example: Radarc wizard.
9
Radarc Manual
5. Once you have completed the deployment configuration process, Radarc will deploy a complete
Visual Studio solution according to your Formula’s architecture. During deployment Radarc messages will be shown on Visual Studio Output panel as a trace-log.
Figure 3.5: New Radarc project deployed.
6. Every Radarc Formula includes a modeling project named DomainModeling. In this project you
will find an empty model that allows you to start working with Radarc. The modeling tool and
DSLs depends on the Formula been used. For further information, please check your Formula
documentation.
10
Radarc Manual
Figure 3.6: MVC Formula modeling project.
Once you have modelled your system and you are ready to generate the code of the application,
click on Radarc option to access to Radarc panel.
Figure 3.7: Radarc generation panel.
11
Radarc Manual
3.1
Generation Tab
On this tab you can select which parts you want to generate and how to do it. First of all, you have to
decide if you want to generate your whole system or just a part of it. To do this, select one of the options:
1. Application: it means that the whole system will be generated, including all the assets of all the
elements modelled.
2. Assets: this option allows you to choose which model elements and which assets will be generated.
Every Formula has different model elements that generate different assets, check your Formula
documentation for further information.
There are different ways to generate code that can be selected via switches from the Options link:
Figure 3.8: Radarc generation options.
The available options are:
1. Overwrite custom code: Some Formula’s assets are generated to two different code files:
(a) Base code file: contains all the basic code that is generated by the Formula. This code is
overwritten every time you executes the Generate action in Radarc.
(b) Custom code file: allows to add new and specific code that is not generated by the Radarc
formula. This code is not overwritten unless you check the ”Overwrite custom code” option.
Figure 3.9: Custom and base code files.
12
Radarc Manual
2. Generate on Build: if this option is checked, every time the solution is built, rebuilt or executed,
Radarc will check whether there has been any changes in the model. If it is the case, Radarc will
generate the assets detected before proceeding with the build, rebuild or run.
3. Generate to Excluded Folder: if this option is checked, all the assets are generated in the DomaingModeling/GeneratedCode folder. Note that this folder is not included in the solution.
Figure 3.10: Excluded folder.
13
Radarc Manual
3.2
Files Tab
On the Files tab, you can see all the files generated by Radarc.
Figure 3.11: Generated files tab.
This form shows the following data:
Custom Code: Shows whether the file is a base code or a custom code file.
Model element: The model element that has provoked the generation of that code file.
Generation time.
Generate file: The physical path of the code file.
14
Radarc Manual
If you have removed any element from your model and you regenerate your solution, some elements
will remain orphan in the system, this means, the code files will be still there but they will not be related
to any elements in the model. When this happens, Radarc warns you through the “Orphan files detected”
option, so you can remove them from your solution.
Figure 3.12: Orphan files detected.
15
4 Disclaimer
The information provided applies only to the cited version of the product. Icinetic could change the
specifications and evolve the technology used in future versions of this product or change this document
at any time to fix any inaccuracy or typographical errors found.
Icinetic TIC S.L. http://www.icinetic.com
Leonardo da Vinci, 18
Tecnoincubadora Marie Curie, 4th floor, Module C
41092, Seville, Spain, EU.
Tel: +34 954 462 266
Email: [email protected]
16