Difference between revisions of "My first app"

Revision as of 21:51, 30 December 2016

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.
   
   
   
   
   
   
2. Select OSBP Projects -> My First App and then click on Next.
   
   
   
   
   
   
3. Now you see the general configuration window for MyFirstApp.
   
   
   
   
   
   
   • 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.
     
     
     
     
     
     
5. Setup for the mock data generation. Click on Next.
   
   
   
   
   
   
6. Choose the location where you would like to save the files of MyFirstApp.
   
   
   • You can use the default location:
     
     
     
     
     
     
   • Or you can specify your own folder by unchecking the checkbox:
     
     
     
     
     
     
   • 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.
   
   
   
   
   
   
   • Click on Finish to start the generation step.
     
     
     
     
     
     
8. When the window disappears, you can see in Project Explorer that all projects of MyFirstApp have been established.
   
   
   
   
   
   
   • 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.
     
     
     
     
     
     
9. When the Building Workspace message disappears, the generation of MyFirstApp is complete. Project Explorer should now look like this:
   
   
   
   
   
   

How to start MyFirstApp

• Now we are ready to start MyFirstApp.

• If you want to change any settings before starting the application, please see: How to configure MyFirstApp.

Launch Eclipse Application

1. Open the file myfirstapp.product contained in the org.osbp.myfirstapp.product project.
   
   
   
   
   
   
2. First, the product definition should be validated. Please click the button at the top right.
   
   
   
   
   
   
3. If no problems were detected, click on OK. Otherwise, fix the problem first.
   
   

1. Now, click on Launch an Eclipse application to start MyFirstApp.
   
   
   
   
   
   
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....
   
   
   
   
   
   

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.
      
      
      
      
      
      
   2. Enter the user name and password, e.g., Admin, Admin, then click on Login to continue.
      
      
      
      
      
      
2. Welcome screen
   
   
   • Now the welcome screen appears.
     
     
     
     
     
     
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.
     
     
     
     
     
     
   1. Menu
      
      
      • There are three submenus under Menu:
        
        
        1. Persons:
           
           
           
           
           
           
           
        2. Company:
           
           
           
           
           
           
           
        3. Company group:
           
           
           
           
           
           
           
   2. Persons
      
      
      • Click on the Persons entry, the table All persons will appear directly in the menu list.
        
        
        
        
        
        
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.
  
  
  
  
  
  

• The Desktop URL link can be found here.
  http://localhost:8081/myfirstapp
  
  
  
  
  
  
  

Detail Configuration

Click > before OSBP Application Configuration to extend the tree.

1. Configure Authentication.
   
   
   
   
   
   
2. Configure Bpm Engine.
   
   
   
   
   
   
3. Configure Controls.
   
   
   
   
   
   
4. Configure Data Sources.
   
   
   • All data sources could be set up here:
     
     
     
     
     
     
   • 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.
     
     
     
     
     
     
5. Configure Email.
   
   
   
   
   
   
6. Configure External Data Sources.
   
   
   
   
   
   
7. Configure Localization.
   
   
   
   
   
   
8. Configure PersistenceUnits.
   
   
   • All details about Persistence Units could be changed here.
     
     
     
     
     
     
   • Click + to extend the tree, and then you could change the data source, DDL Generation, etc.
     
     
     
     
     
     
     
     
9. Configure Project Wizard.
   
   
   
   
   
   
10. Configure Service Communication.
    
    
    
    
    
    
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.