Jump to: navigation, search

Difference between revisions of "EDT:Deployment Introduction"

Line 1: Line 1:
 
= Introduction  =
 
= Introduction  =
  
To make our EGL application run in test or product environment, we must have the generated HTML, Java class &amp; JavaScript files packaged into WAR file which is conformed to JavaEE specification, and then deploy it to the web application server (e,g, Tomcat). EGL project itself cannot export as WAR file directly, so we introduce another concept of '''deployment '''in EDT. The deployment in EDT means that copy the generated stuffs from EGL project to a specified JavaEE project, and make sure the files &amp; directory structure after copy will conform to JavaEE specification and easily exported as WAR file. EDT users can control the deployment process by specifying the configuation in deployment descriptor. <br>
+
To make an EGL application run in a test or production environment, you must have the generated HTML, Java class &amp; JavaScript files packaged into a WAR file which conforms to the&nbsp; JavaEE specification, and then deploy it to the web application server (e.g., Tomcat).&nbsp; The EGL project itself cannot export a WAR file directly, so we introduce the concept of '''deployment '''in EDT.&nbsp;&nbsp; Deployment in EDT means to copy the generated output from an EGL project to a specified JavaEE project, and to make sure the files and directory structure after the copy will conform to the JavaEE specification, and can easily be exported as a WAR file.&nbsp; EDT users can control the deployment process by specifying the configuation in a '''deployment descriptor'''. <br>  
  
 
= Deployment Descriptor File  =
 
= Deployment Descriptor File  =
  
There will be a Deployment Descriptor (DD for short) File in each EGL project you created. As we introduced in last section an EDT Deployment Operation is needed if you are writing a EGL project with Handler or Service. The DD file maintains all the deployment needed information. The following section will introduce the details of it.  
+
There will be a Deployment Descriptor (DD for short) file in each EGL project you have created. As we introduced in the last section, an EDT Deployment operation is needed if you are writing an EGL project with a handler or service. The DD file maintains all of the information needed for deployment. The following section will introduce the details of this.  
  
<br>The DD file will be created automatically when you create any of the EGL project in EDT. In the EGLSource folder with the same name of your project. Although RUIHandler and Service deployment will added to DD file automatically when you use creation wizard, there are still some settings need your manual modification. See the points listed below.  
+
<br>The DD file will be created automatically when you create any of the EGL project types in EDT. It will be placed in the EGLSource folder with the same name as your project. Although RUIHandler and service deployment be will added to DD file automatically when you use creation wizard, there are still some settings which will need your manual modification. See the points listed below.  
  
 
== '''Overview Tab:''' <br>  ==
 
== '''Overview Tab:''' <br>  ==
  
This tab shows all status of details tabs. You may switch to specific tab by click button “Details” or double click the item in grid.  
+
This tab shows all of the status of the details tabs. You may switch to specific tab by clicking '''Details''' or by double-clicking the item in the grid.  
  
<br>Target Project combo box listed all dynamic web project in the current workspace. You should select one or create a new one for this field. When doing the deployment, this filed can not be empty.  
+
<br>The '''Target Project '''combo box lists all dynamic web projects in the current workspace. You should select one of the projects,&nbsp; or create a new one.&nbsp; When doing deployment, this filed can not be empty.  
  
 
<br>  
 
<br>  
Line 19: Line 19:
 
[[Image:Overview EDT.JPG]]  
 
[[Image:Overview EDT.JPG]]  
  
== '''Rich UI &amp; Service Deployment:'''  ==
+
== '''Rich UI and Service Deployment:'''  ==
  
One of the main purposes for DD file is to deploy Rich UI Handler and Rest Services to target project. These two types of EGL file will be added to the DD file by default when you create them by creation wizard.  
+
One of the main purposes for the DD file is to deploy Rich UI Handlers and REST services to the target project. These two types of EGL files will be added to the DD file by default when you create them with the creation wizard.  
  
<br>You can manually modify the RUIHandlers/Services you want to deploy in these two tabs.  
+
<br>You can manually modify the Rich UI Handlers and services you want to deploy in these two tabs.  
  
[[Image:RichUI EDT.JPG]]<br>To modify the RUIHandlers you want to deploy, you need to uncheck the “Deploy all Rich UI Handlers” checkbox. This will enable the Rich UI Handler detail table. Then you can take a multi-selection by check the checkbox in front of the RUIHandler you want to deploy. The selected RUIHandler resources will be deployed to target project including HTML and JavaScript. Also you can modify the locale setting for the HTML file by configure the “Locale Settings” table. Just select the locales by checking the checkbox.  
+
[[Image:RichUI EDT.JPG]]<br>To modify the Rich UI Handlers you want to deploy, you need to uncheck the '''Deploy all Rich UI Handler'''s checkbox. This will enable the Rich UI Handler detail table. Then you can take a multi-selection by checking the checkbox in front of the RUIHandlers you want to deploy. The selected RUIHandler resources will be deployed to the target project, including HTML and JavaScript.&nbsp; You can also modify the locale setting for the HTML file by configuring the '''Locale Settings''' table. Just select the locale by checking the checkbox.  
  
[[Image:ServiceDeplooy EDT.JPG]]<br>In the Service Deployment tab, all Rest Services you created will be listed in the table. If you forgot to check the option “Create as Web Services” when creating service, you can modify them in this tab easily. Just click the “Add” button at the right of the table. The “Add Web Services Wizard” will pop up, and you can manage the services in this pop up window. When configuration finished, click “Finish” button to accept it.  
+
[[Image:ServiceDeplooy EDT.JPG]]<br>In the Service Deployment tab, all of the REST services you have created will be listed in the table. If you forgot to check the option '''Create as Web Services''' when creating your services, you can modify them in this tab easily. Just click the '''Add''' button at the right of the table. The '''Add Web Services''' wizard will pop up, and you can manage the services in this pop up window. When your configuration is complete, click '''Finish''' to accept it.  
  
 
== '''Resource Bindings:'''  ==
 
== '''Resource Bindings:'''  ==
  
The resource binding tab configures the DB resource or Deployed REST Service you may want to use in this project. If the project contains DB logics, EGL written REST Service or Third Party Service invocations, you may use these tab to configure these settings.<br>For details of Resource Binding, see the introduction [[EDT:Resource Binding Introduction|Resource Binding Introduction]]  
+
The resource binding tab configures the database resources or deployed REST services you may want to use in this project.&nbsp; If the project contains database logic,&nbsp; EGL REST services, or non-EGL service invocations, you may use these tabs to configure these settings.<br>For details of Resource Binding, see&nbsp; [[EDT:Resource Binding Introduction|Resource Binding Introduction]].
  
 
== '''Imports &amp; Resources:'''  ==
 
== '''Imports &amp; Resources:'''  ==
  
The imports tab allows you to reference another DD file in different projects to reuse some settings. It can make your project structure more clear. For example, you have two EGL projects. The first one including all RUIHandlers, and the other one including all services. Then when deploy the RUIHandler project, you just to import the service one. This can reduce the redundancy and have a better consistency.<br>And the resources tab allows you to modify the resources you want to deploy. By default, all resources in WebContent/generatedJava/generatedJavaScript/src folders will be deployed. For example, you can modify the resources to remove the src folder to reduce the size of target project.<br>  
+
The'''Imports''' tab allows you to reference another DD file in a different project to reuse some of the settings. It can make your project structure more clear. For example, suppose you have two EGL projects, where the first one includes all Rich UI Handlers, and the other one includes all services. Then when you deploy the Rich UI Handler project, you can simply&nbsp; import the project that contains your&nbsp; services. This can reduce&nbsp; redundancy and provide better consistency.
 +
 
 +
<br>The '''Resources''' tab allows you to modify the resources you want to deploy. By default, all resources in'''WebContent''', '''generatedJava''', '''generatedJavaScript''', and '''src''' folders will be deployed. For example, you can modify the resources to remove the '''src''' folder to reduce the size of the target project.<br>  
  
 
= Deployment Operation<br>  =
 
= Deployment Operation<br>  =
  
There are two way to trigger a deployment operation. You can trigger it by context menu of DD file -&gt; “Deploy EGL Descriptor”, or by click this button [[Image:Deploy EDT.JPG]]&nbsp;at top-right of the DD file editor view. If the target project of DD file is empty, there will be an alert notifying you to modify it. And also if no RUIHandler or Service Deployment added in the DD file, there will be an alert too.  
+
There are two way to trigger a deployment operation. You can trigger it by right-clicking on the DD file to bring up the context menu, and then select '''Deploy EGL Descriptor''', or by clicking this button [[Image:Deploy EDT.JPG]]&nbsp;at the top-right of the DD file editor view. If the target project of the DD file is empty, there will be an alert notifying you to modify it. You will also see an alert if no RUIHandler or Service Deployment has been added in the DD file.  
  
 
<br>  
 
<br>  
Line 45: Line 47:
 
= Some Tips of Deployment  =
 
= Some Tips of Deployment  =
  
1. If you are using Java external type in your projects, you should have configured the java build path of your EGL project to make sure no compile error in generatedJava codes. But when you deploy the EGL project to target project, the external JAR can not be deployed to target project. You need to modify the Java build path again in the target project manually.  
+
If you are using Java external types in your projects, you should have configured the Java build path of your EGL project to make sure there are no compile errors inthe&nbsp; generated Java code. But when you deploy the EGL project to the target project, the external JAR can not be deployed to the target project. You need to modify the Java build path again in the target project manually.  
  
[[Category:EDT]]
+
<br>
  
<br>
+
[[Category:EDT]]

Revision as of 18:56, 18 January 2012

Introduction

To make an EGL application run in a test or production environment, you must have the generated HTML, Java class & JavaScript files packaged into a WAR file which conforms to the  JavaEE specification, and then deploy it to the web application server (e.g., Tomcat).  The EGL project itself cannot export a WAR file directly, so we introduce the concept of deployment in EDT.   Deployment in EDT means to copy the generated output from an EGL project to a specified JavaEE project, and to make sure the files and directory structure after the copy will conform to the JavaEE specification, and can easily be exported as a WAR file.  EDT users can control the deployment process by specifying the configuation in a deployment descriptor.

Deployment Descriptor File

There will be a Deployment Descriptor (DD for short) file in each EGL project you have created. As we introduced in the last section, an EDT Deployment operation is needed if you are writing an EGL project with a handler or service. The DD file maintains all of the information needed for deployment. The following section will introduce the details of this.


The DD file will be created automatically when you create any of the EGL project types in EDT. It will be placed in the EGLSource folder with the same name as your project. Although RUIHandler and service deployment be will added to DD file automatically when you use creation wizard, there are still some settings which will need your manual modification. See the points listed below.

Overview Tab:

This tab shows all of the status of the details tabs. You may switch to specific tab by clicking Details or by double-clicking the item in the grid.


The Target Project combo box lists all dynamic web projects in the current workspace. You should select one of the projects,  or create a new one.  When doing deployment, this filed can not be empty.


Overview EDT.JPG

Rich UI and Service Deployment:

One of the main purposes for the DD file is to deploy Rich UI Handlers and REST services to the target project. These two types of EGL files will be added to the DD file by default when you create them with the creation wizard.


You can manually modify the Rich UI Handlers and services you want to deploy in these two tabs.

RichUI EDT.JPG
To modify the Rich UI Handlers you want to deploy, you need to uncheck the Deploy all Rich UI Handlers checkbox. This will enable the Rich UI Handler detail table. Then you can take a multi-selection by checking the checkbox in front of the RUIHandlers you want to deploy. The selected RUIHandler resources will be deployed to the target project, including HTML and JavaScript.  You can also modify the locale setting for the HTML file by configuring the Locale Settings table. Just select the locale by checking the checkbox.

ServiceDeplooy EDT.JPG
In the Service Deployment tab, all of the REST services you have created will be listed in the table. If you forgot to check the option Create as Web Services when creating your services, you can modify them in this tab easily. Just click the Add button at the right of the table. The Add Web Services wizard will pop up, and you can manage the services in this pop up window. When your configuration is complete, click Finish to accept it.

Resource Bindings:

The resource binding tab configures the database resources or deployed REST services you may want to use in this project.  If the project contains database logic,  EGL REST services, or non-EGL service invocations, you may use these tabs to configure these settings.
For details of Resource Binding, see  Resource Binding Introduction.

Imports & Resources:

TheImports tab allows you to reference another DD file in a different project to reuse some of the settings. It can make your project structure more clear. For example, suppose you have two EGL projects, where the first one includes all Rich UI Handlers, and the other one includes all services. Then when you deploy the Rich UI Handler project, you can simply  import the project that contains your  services. This can reduce  redundancy and provide better consistency.


The Resources tab allows you to modify the resources you want to deploy. By default, all resources inWebContent, generatedJava, generatedJavaScript, and src folders will be deployed. For example, you can modify the resources to remove the src folder to reduce the size of the target project.

Deployment Operation

There are two way to trigger a deployment operation. You can trigger it by right-clicking on the DD file to bring up the context menu, and then select Deploy EGL Descriptor, or by clicking this button Deploy EDT.JPG at the top-right of the DD file editor view. If the target project of the DD file is empty, there will be an alert notifying you to modify it. You will also see an alert if no RUIHandler or Service Deployment has been added in the DD file.


Some Tips of Deployment

If you are using Java external types in your projects, you should have configured the Java build path of your EGL project to make sure there are no compile errors inthe  generated Java code. But when you deploy the EGL project to the target project, the external JAR can not be deployed to the target project. You need to modify the Java build path again in the target project manually.