My first app

From OS.bee documentation
Revision as of 21:54, 30 December 2016 by Hamid (Talk | contribs) (→‎Select OSBP Application Project)

Jump to: navigation, search

General information

Abstract

MyFirstApp is an OSBP application created purely from models, based on OS.bee Software Factory.

If you want to have a basis on which you can explore OS.bee this is a good starting point. You can try to modify models and see the resulting changes. The models show everything from persistence up to the UI and demonstrate a lot of the stunning features and simplicity of MDSD with OS.bee.

The requirements, app generation steps, guiding of start the app, tips of configuration are written in this introduction.

Copyright Notice

All rights are reserved by Compex Systemhaus GmbH. In particular, duplications, translations, microfilming, saving and processing in electronic systems are protected by copyright. Use of this manual is only authorized with the permission of Compex Systemhaus GmbH. Infringements of the law shall be punished in accordance with civil and penal laws. We have taken utmost care in putting together texts and images. Nevertheless, the possibility of errors cannot be completely ruled out. The Figures and information in this manual are only given as approximations unless expressly indicated as binding. Amendments to the manual due to amendments to the standard software remain reserved. Please note that the latest amendments to the manual can be accessed through our helpdesk at any time. The contractually agreed regulations of the licensing and maintenance of the standard software shall apply with regard to liability for any errors in the documentation. Guarantees, particularly guarantees of quality or durability can only be assumed for the manual insofar as its quality or durability are expressly stipulated as guaranteed. If you would like to make a suggestion, the Compex Team would be very pleased to hear from you.

(c) 2016-2024 Compex Systemhaus GmbH

License information

The OS.bee Software Factory is distributed under a commercial license.

The product itself is based on the OSBP Software Factory which is an Eclipse Project. In addition, the software depends on several other open source projects, and the entire list of licenses used can be found here.

Requirements

Please install the OS.bee Software Factory first. Instructions for the installation can be found here.

How to generate MyFirstApp


MyFirstApp is generated from within Eclipse.

  1. In Project Explorer, right click the mouse, then select New -> Other.

    Mfa 01 inst new.png



  2. Select OSBP Projects -> My First App and then click on Next.

    Mfa 02 inst sel wiz.png



  3. Now you see the general configuration window for MyFirstApp.

    Mfa 03 inst p1.png



    • Click on Next.



  4. The JDNI Data Source can be set up on this page. Click Next when done.

    • The default value is h2memory, which saves all data in memory.

    • If you want to use a different JDNI Data Source, e.g., MySQL or Oracle, you can change it later.

      Mfa 03 inst p2.png



  5. Setup for the mock data generation. Click on Next.

    Mfa 03 inst p3.png



  6. Choose the location where you would like to save the files of MyFirstApp.

    • You can use the default location:

      Mfa 03 inst p4 1.png



    • Or you can specify your own folder by unchecking the checkbox:

      Mfa 03 inst p4 2.png



    • Click on Next when done.


  7. The XMS Memory is usually ¼ of total physical memory. The desktop link which will be used later to start the application can also be found here.

    Mfa 03 inst p5.png



    • Click on Finish to start the generation step.

      Mfa 03 inst run.png



  8. When the window disappears, you can see in Project Explorer that all projects of MyFirstApp have been established.

    Mfa 04 inst pe.png



    • Please note that up until this point, the application has not yet been completely generated. Typically, the workspace is still being built (see the bottom right corner of the window). Wait until this process has completed.

      Mfa 05 inst bw.png



  9. When the Building Workspace message disappears, the generation of MyFirstApp is complete. Project Explorer should now look like this:

    Mfa 06 inst pe finish.png



How to start MyFirstApp


  • Now we are ready to start MyFirstApp.



Launch Eclipse Application


  1. Open the file myfirstapp.product contained in the org.osbp.myfirstapp.product project.

    Mfa 30 run product.png



  2. First, the product definition should be validated. Please click the button at the top right.

    Mfa 31 run pd validate.png



  3. If no problems were detected, click on OK. Otherwise, fix the problem first.

Mfa 32 run validation ok.png



  1. Now, click on Launch an Eclipse application to start MyFirstApp.

    Mfa 33 run launch.png



  2. While the application is being launched, open the Console view to monitor the progress. One of the last lines displayed should end with the phrase TRIGGER DONE....

    Mfa 34 run console.png



Start MyFirstApp in Browser


To start MyFirstApp, point your browser to this address:
http://localhost:8081/myfirstapp

  1. Login

    1. The login screen will appear first.

      Mfa 35 run login 1.png



    2. Enter the user name and password, e.g., Admin, Admin, then click on Login to continue.

      Mfa 35 run login 2.png



  2. Welcome screen

    • Now the welcome screen appears.

      Mfa 36 run welc.png



  3. Menu list

    • At the top left of the window, just beside AdminIT, is the MENU button. Click it to pop open the menu.

    • There are two main menus: Menu and Persons.

      Mfa 37 run menu.png



    1. Menu

      • There are three submenus under Menu:

        1. Persons:

          Mfa 38 run pers menu.png
          Mfa 38 run pers.png



        2. Company:

          Mfa 39 run comp menu.png
          Mfa 39 run comp.png



        3. Company group:

          Mfa 40 run compGrp menu.png
          Mfa 40 run compGrp.png



    2. Persons

      • Click on the Persons entry, the table All persons will appear directly in the menu list.

        Mfa 41 run pop pers.png



  4. Tab list

    • At the top right of the window, there are some tabs. By clicking on them, you can easily switch between pages.

How to configure MyFirstApp


This part is optional, since MyFirstApp can be started without additional configuration. If you want to change the default settings, however, please continue reading.

  • All configuration is performed within Eclipse.



Select OSBP Application Project


  • The first step of the configuration is to change the Product Configuration from workspace to org.osbp.myfirstapp.product in Preferences -> OSBP Application Configuration. Please note that this entry is not saved. You must repeat this step each time you wish to configure MyFirstApp.

    Mfa 10 conf ac 2.png



Detail Configuration


Click > before OSBP Application Configuration to extend the tree.

  1. Configure Authentication.

    Mfa 11 conf auth.png



  2. Configure Bpm Engine.

    Mfa 12 conf bpm.png



  3. Configure Controls.

    Mfa 13 conf control.png



  4. Configure Data Sources.

    • All data sources could be set up here:

      Mfa 14 conf ds 1.png



    • If you want to use other data sources, please configure it first. Click + to extend the tree, and then set all necessary information, e.g. Server Name, Server Port, Database Name, etc.

      Mfa 14 conf ds 2.png



  5. Configure Email.

    Mfa 15 conf email.png



  6. Configure External Data Sources.

    Mfa 16 conf eds.png



  7. Configure Localization.

    Mfa 17 conf loc.png



  8. Configure PersistenceUnits.

    • All details about Persistence Units could be changed here.

      Mfa 18 conf pu 1.png



    • Click + to extend the tree, and then you could change the data source, DDL Generation, etc.

      Mfa 18 conf pu 2.png

      Mfa 18 conf pu 3.png



  9. Configure Project Wizard.

    Mfa 19 conf pw.png



  10. Configure Service Communication.

    Mfa 20 conf sc.png



  11. Configure Verify Dependencies.

    • If you see all green points, it means MyFirstApp is ready to start without dependencies’ error; if you see the red point, fix the error before starting.

      Mfa 21 conf vd.png



Retrieved from "https://download.osbee.org/documentation/index.php?title=My_first_app&oldid=905"