Difference between revisions of "My smart shop"

From OS.bee documentation
Jump to: navigation, search
(General information)
(How to generate My1Shop)
 
(38 intermediate revisions by 4 users not shown)
Line 3: Line 3:
 
=== Abstract===
 
=== Abstract===
  
MySmartShop is one of the OSBP application, which based on OS.bee Software Factory.  
+
''My1Shop'' is one of the OSBP applications based on the ''OS.bee Software Factory''.<br>
Here is the introduction for this app. The requirements, app generation steps, guiding of start the app, tips of configuration are written in this document.
+
This is the introduction to this app. It contains the system requirements as well as a guide to generating, starting and configuring the app.
  
 
=== Copyright Notice ===
 
=== Copyright Notice ===
Line 11: Line 11:
 
=== License information ===
 
=== License information ===
  
The OS.bee Software Factory is distributed under a '''commercial license'''.
+
{{License information}}
 
+
The product itself is based on the OSBP Software Factory which is an [https://projects.eclipse.org/projects/technology.osbp "Eclipse Project"].
+
In addition, there are many other open source projects combined and the whole bunch of license used is listed [http://download.osbee.org/downloads/licenses/osbee-master-clean/osbp-used-lics.html "here"].
+
  
 
=== OS.bee Software Factory ===
 
=== OS.bee Software Factory ===
  
Please install OS.bee Software Factory first.  
+
Please install the ''OS.bee Software Factory'' first.  
Introduction of installation could  be found [http://download.osbee.org/documentation/index.php/OS.bee_Software_Factory_Installation here].
+
Instructions for the installation can be found [http://download.osbee.org/documentation/index.php/OS.bee_Software_Factory_Installation here].
  
== How to generate MySmartShop ==
+
== How to generate ''My1Shop'' ==
 
<br>
 
<br>
MySmartShop could be generated from Eclipse.<br><br>
+
''My1Shop'' is generated from within ''Eclipse''.<br><br>
  
# In Project Explorer, right click the mouse -> New -> Other.<br><br>[[File:Mfa 01 inst new.png]]<br><br><br><br>
+
# In '''Package Explorer''' or '''Project Explorer''', right click the mouse, then select '''New''' -> '''Other...'''.<br><br>[[File:MySmartShop01.png||600px]]<br><br><br><br>
# Select OSBP Projects -> My First App -> Next.<br><br>[[File:Mss 02 inst sel wiz.png]]<br><br><br><br>
+
# Select '''OSBP Projects''' -> '''My1App''' -> '''Next'''.<br><br>[[File:MySmartShop02.png]]<br><br><br><br>
# Now you start the generation window for MySmartShop. Select <code>My Smart Shop project</code>:<br><br>[[File:Mss 03 inst p1.png]]<br><br><br><br>
+
# Now the generation window for ''My1Shop'' appears. Select the <code>My1Shop</code> project:<br><br>[[File:MySmartShop03.png]]<br><br><br><br>
#* The Theme of UI can be changed. We use the default value <code>osbp - Classic - Classic</code> in this case. <br><br>[[File:Mss 03 inst p2.png]]<br><br><br><br>
+
#* The theme of the UI can be changed. In this case, we use the default value <code>osbp - Classic - Classic</code>.<br><br>[[File:MySmartShop04.png]]<br><br><br><br>
#* Click Next.<br><br>[[File:Mss 03 inst p3.png]]<br><br><br><br>
+
#* Click on '''Next'''.<br><br>[[File:MySmartShop05.png]]<br><br><br><br>
# The JDNI Data Source could be set up on this page.<br><br>  
+
# The JNDI Datasource is set up on this page.<br><br>  
#* The default value is h2memory, which save all data in memory.<br><br>
+
#* The default value is <code>h2memory</code>, which saves all data in memory.<br><br>
#* You can also change it to othe JDNI Data Sources, e.g. MySQL, Oracle, etc. Please configure them before start the app: [http://download.osbee.org/documentation/index.php/My_first_app#How_to_configure_MyFirstApp How to configure OSBP Application].<br><br>[[File:Mss 03 inst p4.png]]<br><br><br><br>
+
#* You can also change it to other JNDI data sources, e.g. ''MySQL'', ''Oracle'' etc. Please configure such data sources before starting the app.  To do this, see: [http://download.osbee.org/documentation/index.php/My_first_app#How_to_configure_MyFirstApp How to Configure OSBP Applications].<br><br>[[File:MySmartShop06.png]]<br><br><br><br>
#* Click Next.<br><br>[[File:Mss 03 inst p4 2.png]]<br><br><br><br>
+
#* Click on '''Next'''.<br><br>[[File:MySmartShop07.png]]<br><br><br><br>
# Set for the Mock Data generation. Click Next.<br><br>[[File:Mss 03 inst p5.png]]<br><br><br><br>
+
# Set the timepoint for mock-data generation. Click on '''Next'''.<br><br>[[File:MySmartShop08.png]]<br><br><br><br>
# Choose which location you would lick to save the files of MySmartShop.<br><br>
+
# Choose the location where you would like to save the files of ''My1Shop''.<br><br>
#* You can use the default directory:<br><br>[[File:Mss 03 inst p6 1.png]]<br><br><br><br>
+
#* You can use the default folder:<br><br>[[File:MySmartShop09.png]]<br><br><br><br>
#* or your own directory:<br><br>[[File:Mss 03 inst p6 2.png]]<br><br><br><br>
+
#* Or you can specify a different folder by unchecking the checkbox:<br><br>[[File:MySmartShop10.png]]<br><br><br><br>
#* Click Next.<br><br><br>
+
#* Click on '''Next'''.<br><br><br>
# 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.
+
# The '''XMS Memory''' allocation is usually ¼ of total physical memory. The desktop link which will be used later for starting the app is also found here.
#* If there is any other OSBP app already generated, the default port 8081 should be alrealy used for it. Please change the port to avoid the conflict.<br><br>[[File:Mss 03 inst p7.png]]<br><br><br><br>
+
#* If any other OSBP app has already been generated, then the default port 8081 should already be in use. In that case, please change the port number used by this app to avoid any conflict.<br><br>[[File:MySmartShop11.png]]<br><br><br><br>
#* Click Finish to start the generation step.<br><br>[[File:Mss 03 inst run.png]]<br><br><br><br>
+
#* Click on '''Finish''' to start the generation step.<br><br><br><br>
# When the window disappears, you could see in Project Explorer, all projects of MySmartShop are established.<br><br>[[File:Mss 04 inst pe.png]]<br><br><br><br>
+
# When the window disappears, you can see in the '''Project Explorer''' that all projects of ''My1Shop'' have been generated.<br><br>[[File:MySmartShop13.png]]<br><br><br><br>
#* 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.<br><br>[[File:Mss 05 inst bw.png]]<br><br><br><br>
+
#* 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.<br><br>[[File:MySmartShop14.png]]<br><br><br><br>
# When the <code>Building Workspace</code> symbol disappears, the generation of MySmartShop is finish. Project Explorer should be looked like this:<br><br>[[File:Mss 06 inst pe finish.png]]<br><br><br><br>
+
# When the <code>Building Workspace:</code> message disappears, the generation of ''My1Shop'' is complete. The '''Project Explorer''' should now look like this:<br><br>[[File:MySmartShop13.png]]<br><br><br><br>

Latest revision as of 15:56, 2 July 2017

General information

Abstract

My1Shop is one of the OSBP applications based on the OS.bee Software Factory.
This is the introduction to this app. It contains the system requirements as well as a guide to generating, starting and configuring the app.

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.

OS.bee Software Factory

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

How to generate My1Shop


My1Shop is generated from within Eclipse.

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

    MySmartShop01.png



  2. Select OSBP Projects -> My1App -> Next.

    MySmartShop02.png



  3. Now the generation window for My1Shop appears. Select the My1Shop project:

    MySmartShop03.png



    • The theme of the UI can be changed. In this case, we use the default value osbp - Classic - Classic.

      MySmartShop04.png



    • Click on Next.

      MySmartShop05.png



  4. The JNDI Datasource is set up on this page.

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

    • You can also change it to other JNDI data sources, e.g. MySQL, Oracle etc. Please configure such data sources before starting the app. To do this, see: How to Configure OSBP Applications.

      MySmartShop06.png



    • Click on Next.

      MySmartShop07.png



  5. Set the timepoint for mock-data generation. Click on Next.

    MySmartShop08.png



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

    • You can use the default folder:

      MySmartShop09.png



    • Or you can specify a different folder by unchecking the checkbox:

      MySmartShop10.png



    • Click on Next.


  7. The XMS Memory allocation is usually ¼ of total physical memory. The desktop link which will be used later for starting the app is also found here.
    • If any other OSBP app has already been generated, then the default port 8081 should already be in use. In that case, please change the port number used by this app to avoid any conflict.

      MySmartShop11.png



    • Click on Finish to start the generation step.



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

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

      MySmartShop14.png



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

    MySmartShop13.png