Difference between revisions of "My first app"

Revision as of 11:00, 1 December 2016

General information

Abstract

MyFirstApp is one of the OSBP application. Here is the introduction for this app. The requirements, app generation steps, guiding of start the app, tips of configuration in this document.

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.
   
   
   
   
   
   
2. Select OSBP Projects -> My First App -> Next.
   
   
   
   
   
   
3. Now you start the generation window for MyFirstApp:
   
   
   
   
   
   
   • 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.
     
     
     
     
     
     
5. Set for the Mock Data generation. Click Next.
   
   
   
   
   
   
6. Choose which location you would lick to save the files of MyFirstApp.
   
   
   • You can use the default directory:
     
     
     
     
     
     
   • or your own directory:
     
     
     
     
     
     
   • 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.
   
   
   
   
   
   
   • Click Finish to start the generation step.
     
     
     
     
     
     
8. When the window disappears, you could see in Project Explorer, all projects of MyFirstApp are established.
   
   
   
   
   
   
   • 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.
     
     
     
     
     
     
9. When the Building Workspace symbol disappears, the generation of MyFirstApp is finish. Project Explorer should be looked like this:
   
   
   
   
   
   

How to start MyFirstApp

• Now we are ready to start MyFirstApp.

• If you want to change any setting before starting the app, this will help : How to configure MyFirstApp.

Launch Eclipse Application

1. Open myfirstapp.product file from org.osbp.myfirstapp.product.
   
   
   
   
   
   
2. We should check the validation first, please click the button on right top.
   
   
   
   
   
   
3. Click OK.
   
   
   • No problems were detected means it is ready to run, otherwise fix the problem first.
     
     
     
     
     
     
4. Now click Launch an Eclipse application to start MyFirstApp.
   
   
   
   
   
   
5. Open console to see if the progress is finish, the last sentence should be TRIGGER DONE....
   
   
   
   
   
   

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.
      
      
      
      
      
      
   2. Enter the user name and password in log in page, e.g. Admin, Admin, save the password and log in.
      
      
      
      
      
      
2. Welcome page
   
   
   • Now you could see the Welcome page.
     
     
     
     
     
     
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.
     
     
     
     
     
     
   1. Menu
      
      
      • 3 subentries under Menu:
        
        
        1. Persons:
           
           
           
           
           
           
           
        2. Company:
           
           
           
           
           
           
           
        3. Company group:
           
           
           
           
           
           
           
   2. Persons
      
      
      • Click the Persons entry, the table All person will be shown directly in the menu list.
        
        
        
        
        
        
4. Tab list
   
   
   • On the right top of the page, there are some tabs, by clicking them, you could easily to switch the pages. Default tabs are OPEN and WELCOME.
     
     
   • OPEN tab is the first tab. Click it, the Open perspective menu will be shown. Perspectives such as Datainterchange, BI, BPM etc. could be selected here.
     
     
     
     
     
     

• TODO: the perspective pages should be added later.

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.
  
  
  
  
  
  

• The Desktop URL link could 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.