01 - Overview

EBX Development

Last updated October 2013

2Agenda

On the 1st day:1. Overview2. Libraries3. Repository4. Server5. Module6. Field constraints7. Computed fields8. Table triggers9. Field editors10. Form layouts

On the 2nd day:11. Permissions12. Workflow user tasks13. Workflow script tasks14. Workflow conditions15. UI services for data sets16. UI services for data spaces17. UI services in workflows

3Agenda

Optional chapters:18. Portal integration19. Data services20. Directory21. Table constraints22. Foreign key filters

4Overview

Intent Prerequisites Training archive download Training archive installation Directory structure

Eclipse execution Workspace projects Server execution Product documentation Training documentation Training support

5Overview:Intent

Learn how to configure: An EBX repository An EBX server An EBX module

6Overview:IntentAnd learn how to develop custom: Field constraints Computed fields Table triggers Field editors Form layouts Permissions Workflow user tasks Workflow script tasks Workflow conditions UI services for datasets UI services for data spaces UI services in workflows

7Overview:Prerequisites

Experience: EBX Foundations, Java, XML and JSP

Hardware: A PC having at least 2GHz and 2GB

Operating system: Windows or Linux

Web browser: Firefox 4+, Chrome 10+ or Explorer 8+

Training archive: ebx-training-.zip file

8Overview:Training archive download

Get the address of the training archive from your training coordinator:The name of the archive is ebx-training-.zip

Download the training archive into any local directory:The archive should be downloaded beforehand, since it is a large file

9Overview:Training archive installation

Decompress the training archive into any local directory:The resulting directory is named ebx-training-

Note: If the archive utility indicates that some paths are too long,then use another one or decompress into a directory having a short path

10

Overview:Directory structure

The archive root directory contains: Readme.html to log in the EBX server conveniently StartEBXServer-.bat to start the EBX server StopEBXServer-.bat to stop the EBX server

Note: Within this training, those *.bat files will not be used,since the Eclipse development environment will be used instead

See illustration

11


12


The Documentation directory contains: The EBX Foundations slides The EBX Development slides

See illustration

13


14


The Tools directory contains: The Ant automation tool The Eclipse development environment The Firefox web browser The Java Development Kit

Note: This web browser is delivered as a fallback and may be used, when experiencing any problem using your own web browser

See illustration

15


16


The Workspace directory contains: All the Eclipse projects of the training The OrchestraNetworks.epf Eclipse preference file

Note: The Eclipse projects will be described in a subsequent sectionNote: The Eclipse preference file is mainly used to style the code

See illustration

17


18

Overview:Eclipse execution

Open the Eclipse environment, by executing the following file:Tools / Eclipse / eclipse- / eclipse.exe

Note: The opened workspace is referenced in the eclipse.ini fileNote: The Java Development Kit is referenced in the eclipse.ini file

19

Overview:Workspace projects

The Eclipse workspace contains the following projects: EBX Home contains the EBX repository EBX Server contains the EBX web server Libraries contains the EBX libraries and third party libraries Store contain the solutions of the programming exercises

Note: Each project will be described in the subsequent chapters

See illustration

20

Overview:Workspace projects

21

Overview:Server execution

Start the EBX server, by selecting the following Eclipse toolbar item:Run / Start Default Server

Open the following Readme file, using a supported Web browser:ebx-training- / Readme.html

Log in the EBX server, by selecting any hyperlink in the Readme file:As Administrator, Data Analyst, Data Owner or Data Steward

See illustration

22

Overview:Server execution

23

Overview:Product documentation

The product documentation can be accessed through different ways: Moving the cursor over a piece of code in an Eclipse Java editor Using the Eclipse Help menu

See illustration

24


25


26


27

Overview:Training documentation

The training documentation is located in the following directories: ebx-training- / Documentation / EBX Development / Diagrams ebx-training- / Documentation / EBX Development / Slides

Note: It is recommended to print the diagrams beforehand,since they will often be useful within the training

28

Overview:Training support

Trainees have the following sources of help: The product documentation The training documentation The training exercise solutions The training support at [email protected]

Note: It is recommended that trainees share their requests,before sending them to the training support

01 - Overview

Documents