My first app

From OS.bee documentation
Jump to: navigation, search

General information

Abstract

My1App is an OSBP application created purely from models, based on the 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 (Model-Driven Software Development) with OS.bee.

In this introduction, you will find the system requirements for running the app, the steps needed to generate the app, how to start the app and tips for configuring the app.

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 My1App


My1App is generated from within Eclipse.

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

    MyFirstAppNeon01.png



  2. Expand the entry OSBP Projects, select My1App and then click on Next.

    MyFirstAppNeon02.png



  3. The general configuration window for My1App will then be displayed.

    MyFirstAppNeon03.png



    • Click on Next.



  4. The JNDI 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 JNDI Data Source, e.g., MySQL or Oracle, you can change it later.

      MyFirstAppNeon04.png



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

    MyFirstAppNeon05.png



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



    • You can use the default location:

      MyFirstAppNeon06.png



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

      MyFirstAppNeon07.png



    • Click on Next when done.


  7. The XMS Memory is usually ¼ of total physical memory, but you can change it if you want. The desktop link which will be used later to start the application can also be found here.

    MyFirstAppNeon08.png



    • Click on Finish to start the application generation step.

      MyFirstAppNeon09.png



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

    MyFirstAppNeon10.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.

      MyFirstAppNeon11.png



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

    MyFirstAppNeon12.png



How to start My1App


  • Now we are ready to start My1App.



Launch Eclipse Application


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

    StartMy1App01.png



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

    StartMy1App02.png



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

    StartMy1App03.png



  4. Now, click on Launch an Eclipse application to start My1App.

    StartMy1App04.png



  5. 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....

    StartMy1App05.png



Starting My1App in a Browser


To start My1App, point your browser to this address:
http://localhost:8081/my1app

  1. Login

    1. The login screen is displayed first.

      StartMy1App06.png


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

      StartMy1App07.png


  2. Welcome screen

    • The welcome screen is now displayed.

      StartMy1App08.png


  3. Menu list

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

    • There are two main menus: Menu and Persons.

      StartMy1App09.png


    1. Menu

      • There are two submenus under Menu:

        1. Persons:

          StartMy1App10.png


        2. User administration:

          StartMy1App11.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 My1App


Note that this part is optional, since My1App can always 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.my1app.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 My1App. Or, you can access the Preferences for org.osbp.my1app.product by right-clicking org.osbp.my1app.product and selecting Properties

    ConfigureMy1App01.png



Detail Configuration


No configuration is necessary for My1App to run. However, if you wish to change anything, you can.
Click on the '>' symbol next to OSBP Application Configuration to expand the tree.

  1. Configure Authentication.

    ConfigureMy1App03.png



  2. Configure Bpm Engine.

    ConfigureMy1App04.png



  3. Configure Controls.

    ConfigureMy1App05.png



  4. Configure Data Sources.

    • All data sources can be set up here.

      ConfigureMy1App06.png



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

      ConfigureMy1App07.png



  5. Configure Email.

    ConfigureMy1App08.png



  6. Configure External Data Sources.

    ConfigureMy1App09.png



  7. Configure Localization.

    ConfigureMy1App10.png



  8. Configure PersistenceUnits.

    • All details about Persistence Units can be changed here.

      ConfigureMy1App11.png



    • Click + to expand the tree. You can then change the JNDI Data Source, DDL Generation etc.

      ConfigureMy1App12.png

      ConfigureMy1App13.png



  9. Configure Project Wizard.

    ConfigureMy1App14.png



  10. Configure Service Communication.

    ConfigureMy1App15.png



  11. Configure Verify Dependencies.

    • If you see all green points, it means My1App is ready to start without any dependency errors. If you see any red points, you must fix the errors before starting the app.

      ConfigureMy1App16.png



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) 2018 Compex Systemhaus GmbH