(r3) XeoPrimerStudioIntroduction < WebXEO

WebXEO Web>XeoPrimer>XeoPrimerStudioIntroduction (revision 3) (raw view)~~EditAttach~~
- Main.PedroRio - 15 Dec 2010
---+ XEO Studio

XEO Studio is a plugin to the popular Java IDE [[http://www.eclipse.org][Eclipse]] and is the preferred development environment for a XEO Application. The XEO Studio plugin automates several routine tasks when developing a XEO application, such as configuring the database connection, upgrading to a newer version of the XEO Framework, creating Object Models and viewers, as well as providing tools such as visual editors for Object Models and content assist for Viewers.
---+++++ Installing XEO Studio

XEO Studio requires the [[http://www.eclipse.org/modeling/mdt/?project=uml2][UML2 Plugin]], so you must install that one before (use the Eclipse Repositories to search for the UML2 Plugin)

To install the XEO Studio plugin just *copy the XEOStudio.jar to the Eclipse plugins* *folder* and start/restart Eclipse. *A JDK6 must also be installed* to create a XEO Application.

Note: The XEO Studio.jar file comes bundled with a release of the XEO Framework, however not every XEO Framework release originates a XEO Studio release, so do download the latest stable release.
---+++++ Creating a new Project

To create a new XEO Project, go to the "File" menu and select "XEO Project" from the selection menu, as depicted in figure XStudio.1

<img width="800" alt="XEO Studio Project Creation" src="http://wiki.itds.pt/pub/WebITDS/XeoPrimerStudioIntroduction/NewProjectWizard.png" title="XEO Studio Project Creation" height="477" />

__Figure XStudio.1 - New XEO Project creation in XEO Studio__

Next, you'll be presented with the screen to choose the name of the project, as depicted in figure XStudio.2. Write "XEOLibrary" as the project name and press next. __(Project Names cannot have spaces, i.e. "XEO Library" is not a valid name, but "XEO_Library" or "XEOLibrary" are)__.

<img width="800" alt="NPWProjectName.png" src="http://wiki.itds.pt/pub/WebITDS/XeoPrimerStudioIntroduction/NPWProjectName.png" title="NPWProjectName.png" height="481" />

__Figure XStudio.2 - Project name in new XEO Project Wizard__

In the next screen, depicted in figure XStudio.3 you need to choose the version of the XEO Framework to create the project with (XStudio.3 label 1), and for that you can use the default version bundled with your version of XEO Studio, or choose the XEOCore.xar (more information about _.xar_ files in the following sections) from the file system. (The XEOMeta option in figure does not currently work).

Next, you need to choose the J2EE Application Server (XStudio.3 label 2), currently only Oracle's OC4J is supported directly in XEO Studio for development, but XEO is a compliant J2EE framework and any compliant J2EE server (such as JBOSS or Glashfish) works.

In label 3 and 4, (Figure XStudio.3) you choose the web context root for your web application and the port for you application. If you write xeo/8888 in the fields, you're application will be accessible at http://localhost:8888/xeo.

<img width="570" alt="XEO Studio WebApp" src="http://wiki.itds.pt/pub/WebITDS/XeoPrimerStudioIntroduction/NPWWebApp.png" title="XEO Studio WebApp" height="699" />

__Figure XStudio.3 - XEO Framework version and WebApplication/WebServer definition__

By pressing the Next button you'll be taken to the Database Configuration screen (depicted in Figure XStudio.4, bellow) The Database configuration screen allows to choose on the supported databases (currently, Oracle 9i+, MySQL 5.1+ or MS SQL Server 2005+, see label 1 of the figure) and then fill the required connection information as well as user credentials. When connecting the XEO application to a database you can create a new user or reuse an existing one (MS SQL Server is the exception, you can only reuse an existing user), in label 2 of the figure there's the checkbox which allows to create a new database user (if it's unchecked it'll use the credentials of an existing user [fields bellow label 4]). Label 3 in the figure is the area where connection parameters are defined, the host where the database is located, the port and, in Oracle's case, the SID (if it were MySQL it would be the database name)

The XEO Database User Settings (label 4 in the figure) allows you to input your database user credentials (with Oracle's database you'll also need the Tablepsace and the Temporary Tablespace).

<img width="569" alt="Project Database Definitions" src="http://wiki.itds.pt/pub/WebITDS/XeoPrimerStudioIntroduction/NPWDatabase.png" title="Project Database Definitions" height="700" />

__Figure XStudio.4 - Database Definitions__

After all values are filled, you need to press the "Test Settings" button (label 5, in figure XStudio.4) to check if everything is correct. If no problems occur the "Finish" button will become active so that the project can be initialized. A small message will appear at the top of the screen if everything is ok (see Figure XStudio.5), if anything is wrong a popup with the error message will appear. Pressing the "Finish" button will create the project in your workspace.

<img width="571" alt="Database Settings OK" src="http://wiki.itds.pt/pub/WebITDS/XeoPrimerStudioIntroduction/NPWDatabaseOK.png" title="Database Settings OK" height="695" />

__Figure XStudio.5 - Database Connection OK__

When the wizard finishes, we can launch/deploy the project directly from Eclipse, because XEO Studio in the process of creating the XEO Project also added a Degug/Run Launch Configuration to Eclipse, as seen in Figure XStudio.5a. Open the "Debug Configurations" menu and select the newly created configuration. Eclipse will deploy the application in the application server (in this case, OC4J).

<img width="1167" alt="Launch Project" src="http://wiki.itds.pt/pub/WebITDS/XeoPrimerStudioIntroduction/LaunchProject.png" title="Launch Project" height="554" />

__Figure XStudio.5a - Debug Configuration Menu after XEO Project creation__

When the project is deployed, you should see in Eclipse's console the message: "<em>Oracle Containers for J2EE 10g (10.1.3.3.0) initialized</em>". As depicted in figure XStudio.5b

<img width="1084" alt="Project Deployed in Console" src="http://wiki.itds.pt/pub/WebITDS/XeoPrimerStudioIntroduction/ProjectDeployedConsole.png" title="Project Deployed in Console" height="253" />

<strong><em>Figure XStudio.5b - Console message when a XEO Project is deployed in the application server</em></strong> 

After this, launch your web browser and point it to http://localhost:8888/xeo/Login.xvw. Since it's the first time the project is deployed the XEO Builder will kick-in an make the initial build.

<img width="1275" alt="Xeo Builder" src="http://wiki.itds.pt/pub/WebITDS/XeoPrimerStudioIntroduction/XeoBuilder.png" title="Xeo Builder" height="458" />

__Figure XStudio.5b - XEO Builder after project creation__

The Build process is relatively quick in a new project (varies depending on database, Oracle is faster than MySQL) but depends on the number of XEO Object Models, because each Object Model has to be converted to a Java class, compiled and then the database tables must be created/altered. *This is done only time the project is created, when you add another XEO Object Model to your project only that Object Model will go through these steps*. After the XEO Builder is complete, you'll be taken to the Login page (Login.xvw), use the default system username SYSUSER/ABC.

---+++++ Understanding the XEO Project Stucture

Every XEO Application has the same structure (in terms of files/folders), depicted in figure XStudio.6, to allow XEO Studio to recognize each folder and put objects/viewers and XEO related files in their right places. The structure (following the labels in figure XSTudio.6) is as follows:

   1 Src - Java source code (you're code goes in here, just like a regular Java Project)
   1 J2EE Libs, Modules, Module Libs - Where all the Jars that are required from XEO Core System and XEO Modules are put
   1 bodef - The folder where XEO Packages (which will contain XEO Object Models) are placed, includes a packages.xeodesc file with descriptions of each XEO Package
   1 A XEO Package, each XEO Package can have any number of XEO Object Models, including XEO Sub-Packages
   1 XEO Lovs (List of values) - XEO Packages can store not only XEO Object Models, but also static lists of values which can be reused by the Object Models to declared the possible values of a given attribute, these are *.xeolov files
   1 uidef/default - Default Profiles for the Application, which will be discussed further in the documentation. Users in a XEO application can have profiles which may be used to restrict their actions, files in this folder contains definitions of profiles to be created by the XEO Builder.
   1 Default web app - All your web resources (including *.xvw files [Viewers]) go in here.

<img width="360" alt="XEO Project Structure" src="http://wiki.itds.pt/pub/WebITDS/XeoPrimerStudioIntroduction/ProjectStructure.png" title="XEO Project Structure" height="810" />

__Figure XStudio.6 - XEO Project Structure__

Inside the bodef folder is where all XEO Object Models are placed (both the XEO Models that are provided by the XEO framework as well as the XEO Models specifically created for the application.
---+++++ XEO *.xar files

A XAR (Xeo ARchive) file is basically a container for XEO Projects (including the XEO Framework). The XEO framework is distributed inside a XAR file, you can export a XEO Project as a XAR file and import that Project in another XEO Project.
---+++++ XEO Builder Integration

As explained in the [[XeoPrimerConcepts][XEO Concepts section]], At the heart of XEO
---+++++ Deploying the Project

aaaaa
Attachments
Topic attachments
I	Attachment	Action	Size	Date	Who	Comment
png	LaunchProject.png	manage	18.8 K	2010-12-16 - 08:29	PedroRio
png	MainAdmin.png	manage	37.0 K	2010-12-16 - 09:16	PedroRio
png	NPWDatabase.png	manage	17.1 K	2010-12-15 - 15:31	PedroRio
png	NPWDatabaseOK.png	manage	17.2 K	2010-12-15 - 15:48	PedroRio
png	NPWProjectName.png	manage	24.7 K	2010-12-15 - 14:33	PedroRio
png	NPWWebApp.png	manage	18.1 K	2010-12-15 - 14:41	PedroRio
png	NewProjectWizard.png	manage	28.2 K	2010-12-15 - 14:27	PedroRio	XEO Studio Project
png	ProjectDeployedConsole.png	manage	15.3 K	2010-12-16 - 08:47	PedroRio
png	ProjectStructure.png	manage	17.5 K	2010-12-15 - 16:22	PedroRio	XEO Project Structure
png	XeoBuilder.png	manage	32.2 K	2010-12-15 - 17:22	PedroRio
Topic revision: r3 - 2010-12-16 - PedroRio
No permission to view TWiki.WebTopBar
No permission to view TWiki.WebBottomBar