Difference between revisions of "EDT:Deployment Introduction"

From Eclipsepedia

Jump to: navigation, search
Line 5: Line 5:
 
= Deployment Description  =
 
= Deployment Description  =
  
There will be a Deployment Description (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.<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.  
+
There will be a Deployment Description (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.
 +
 
 +
<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.  
  
 
== '''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 status of details tabs. You may switch to specific tab by click button “Details” or double click the item in 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>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>
 +
 +
[[Image:Overview EDT.JPG]]
 +
 +
== '''Rich UI &amp; 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.
 +
 +
<br>You can manually modify the RUIHandlers/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: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:Overview_EDT.JPG]]
+
== '''Resource Bindings:'''  ==
  
== '''Rich UI &amp; Service Deployment:''' ==
+
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 RESOURCE BINDING. And SERVICE INTRODUCTION
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. <br>You can manually modify the RUIHandlers/Services you want to deploy in these two tabs.<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.<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.
+
  
== '''Resource Bindings:''' ==
+
== '''Imports &amp; Resources:''' ==
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 RESOURCE BINDING. And SERVICE INTRODUCTION
+
  
== '''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 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>
  

Revision as of 22:58, 3 January 2012

Contents

 Introduction

If you are developing Web Client Project or project with Services, then a EDT Deployment Operation is need to deploy your RUIHandlers or Services to target dynamic web project. Different with deploy to app server, your generated Java/JavaScript/Html files in EGL project will be copied to the target project. By doing this, a pure dynamic web project will be created and with no EGL feature. And also, the resource binding will be set in the target project to make it works. Then you can deploy this new project to your app server.

Deployment Description

There will be a Deployment Description (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.


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.

Overview Tab:

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.


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.


Overview EDT.JPG

Rich UI & 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.


You can manually modify the RUIHandlers/Services you want to deploy in these two tabs.

RichUI EDT.JPG
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.

ServiceDeplooy EDT.JPG
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.

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.
For details of Resource Binding, see the introduction RESOURCE BINDING. And SERVICE INTRODUCTION

Imports & 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.
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.

Deployment Operation

There are two way to trigger a deployment operation. You can trigger it by context menu of DD file -> “Deploy EGL Descriptor”, or by click this button 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.


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.