EBX Development

Last updated October 2013

Agenda
On the 1st day:
1. Overview
2. Libraries
3. Repository
4. Server
5. Module
6. Field constraints
7. Computed fields
8. Table triggers
9. Field editors
10. Form layouts

On the 2nd day:

11. Permissions
12. Workflow user tasks
13. Workflow script tasks
14. Workflow conditions
15. UI services for data sets
16. UI services for data spaces
17. UI services in workflows

Agenda

Optional chapters:
18. Portal integration
19. Data services
20. Directory
21. Table constraints
22. Foreign key filters

Overview

Intent
Prerequisites
Training archive download
Training archive installation
Directory structure

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

Overview:
Intent

Learn how to configure:

An EBX repository
An EBX server
An EBX module

Overview:
Intent
And 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
6

Overview:
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-<version>.zip file

Overview:
Training archive download

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

Download the training archive into any local directory:

The archive should be downloaded beforehand, since it is a large file

Overview:
Training archive installation

Decompress the training archive into any local directory:

The resulting directory is named ebx-training-<version>
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

Overview:
Directory structure

The archive root directory contains:

to log in the EBX server conveniently
Readme.html
StartEBXServer-<version>.bat to start the EBX server
StopEBXServer-<version>.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
10

Overview:
Directory structure

11

Overview:
Directory structure

The Documentation directory contains:

The EBX Foundations slides
The EBX Development slides

See illustration
12

Overview:
Directory structure

13

Overview:
Directory structure

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
14

Overview:
Directory structure

15

Overview:
Directory structure

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 section
Note: The Eclipse preference file is mainly used to style the code

See illustration
16

Overview:
Directory structure

17

Overview:
Eclipse execution

Open the Eclipse environment, by executing the following file:

Tools / Eclipse / eclipse-<version> / eclipse.exe
Note: The opened workspace is referenced in the eclipse.ini file
Note: The Java Development Kit is referenced in the eclipse.ini file

18

Overview:
Workspace projects

The Eclipse workspace contains the following projects:

contains the EBX repository
EBX Home
contains the EBX web server
EBX Server
contains the EBX libraries and third party libraries
Libraries
contain the solutions of the programming exercises
Store
Note: Each project will be described in the subsequent chapters

See illustration
19

Overview:
Workspace projects

20

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-<version> / 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
21

Overview:
Server execution

22

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
23

Overview:
Product documentation

24

Overview:
Product documentation

25

Overview:
Product documentation

26

Overview:
Training documentation

The training documentation is located in the following directories:

ebx-training-<version> / Documentation / EBX Development / Diagrams
ebx-training-<version> / Documentation / EBX Development / Slides
Note: It is recommended to print the diagrams beforehand,
since they will often be useful within the training

27

Overview:
Training support

Trainees have the following sources of help:

The product documentation
The training documentation
The training exercise solutions
The training support at training-support@orchestranetworks.com
Note: It is recommended that trainees share their requests,
before sending them to the training support

28