My first app

From OS.bee documentation
Revision as of 21:41, 29 December 2016 by Hamid (Talk | contribs) (→‎License information)

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, there are many other open source projects combined and the whole bunch of license used is listed here.

Requirements

Please install OS.bee Software Factory first. Introduction of installation could be found here.

How to generate MyFirstApp


MyFirstApp could be generated from Eclipse.

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

    Mfa 01 inst new.png



  2. Select OSBP Projects -> My First App -> Next.

    Mfa 02 inst sel wiz.png



  3. Now you start the generation window for MyFirstApp:

    Mfa 03 inst p1.png



    • Click Next.



  4. The JDNI Data Source could be set up on this page. Click Next.

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

    • If you want to use other JNDI Data Source, e.g. MySQL or Oracle, you can change it later.

      Mfa 03 inst p2.png



  5. Set for the Mock Data generation. Click Next.

    Mfa 03 inst p3.png



  6. Choose which location you would lick to save the files of MyFirstApp.

    • You can use the default directory:

      Mfa 03 inst p4 1.png



    • or your own directory:

      Mfa 03 inst p4 2.png



    • Click Next.


  7. The XMS Memory is usually ¼ of total physical memory. The desktop link which will be used late by starting app could be also find here.

    Mfa 03 inst p5.png



    • Click Finish to start the generation step.

      Mfa 03 inst run.png



  8. When the window disappears, you could see in Project Explorer, all projects of MyFirstApp are established.

    Mfa 04 inst pe.png



    • Please notice till now the progress is not complete finish, normally it's still building workspace (see the right bottom corner), wait until it completed.

      Mfa 05 inst bw.png



  9. When the Building Workspace symbol disappears, the generation of MyFirstApp is finish. Project Explorer should be looked like this:

    Mfa 06 inst pe finish.png



How to start MyFirstApp


  • Now we are ready to start MyFirstApp.



Launch Eclipse Application


  1. Open myfirstapp.product file from org.osbp.myfirstapp.product.

    Mfa 30 run product.png



  2. We should check the validation first, please click the button on right top.

    Mfa 31 run pd validate.png



  3. Click OK.

    • No problems were detected means it is ready to run, otherwise fix the problem first.

      Mfa 32 run validation ok.png



  4. Now click Launch an Eclipse application to start MyFirstApp.

    Mfa 33 run launch.png



  5. Open console view to see if the progress is finish, the last sentence should be TRIGGER DONE....

    Mfa 34 run console.png



Start MyFirstApp in Browser


Now you could start this page from your browser:
http://localhost:8081/myfirstapp

  1. Log in

    1. Log in Page will be shown first.

      Mfa 35 run login 1.png



    2. Enter the user name and password in log in page, e.g. Admin, Admin, save the password and log in.

      Mfa 35 run login 2.png



  2. Welcome page

    • Now you could see the Welcome page.

      Mfa 36 run welc.png



  3. Menu list

    • On the left top of the page, just beside AdminIT is the MENU button, click it to pop up the menu.

    • There are 2 main entry: Menu and Persons.

      Mfa 37 run menu.png



    1. Menu

      • 3 subentries 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 the Persons entry, the table All person will be shown directly in the menu list.

        Mfa 41 run pop pers.png



  4. Tab list

    • On the right top of the page, there are some tabs, by clicking them, you could easily to switch the pages.


How to configure MyFirstApp


MyFirstApp could be started without configuration, this part is optional. If you want to change the default settings, continue to read.

  • All Configuration do with 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 notice that, this will be not saved, please do this step every time before you start 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=863"