How to guide

Overview

This section is intended for more experienced TIBCO EBX® users and provides high-level information on common tasks related to the EBX® Script IDE. The Administration Guide > EBX® Script section of the documentation provides details about the EBX® Script Language (ESL). The Administration Guide > EBX® Script IDE > Tutorials section provides more detailed informations on some basic use cases that are designed for less experienced users.

Create functions

Prior to writing a function in the EBX® Script IDE, you must first create a data model field using the function type. After field creation, the script is available to edit in the Script IDE.

To add a function type field to your data model:

1. Create a new data model field and set the Kind of element to Function.

2. Use the Data type field to specify the desired data type. The data type selected will automatically be reflected in the script in the IDE.

3. Save and optionally publish your data model. Note that once the field is saved, the script outline is automatically created and available to work with in the IDE. However, you cannot publish the script until the data model publication is up to date. So it might be a good idea to publish the data model at this time.

Create and manage workflow script tasks

The creation of workflow script tasks can be done directly in the Script IDE. Once a workflow script is published, it is available to use in a workflow model.

To create a workflow script:

1. If the EBX® Script IDE perspective is not open, click the icon at the top right of the EBX® toolbar and select Script IDE.

2. Create a new script by selecting Create next to the Workflow in the Navigation tab.

3. Add required information and parameters:

   1. Enter a script name, label, and optional description.

   2. Add parameters that are used as input/output to access EBX® components, such as dataspaces, datasets, tables, and records.

4. After writing the script, select the Publish button at the bottom of the Script tab.

   The script is now available to select in a workflow model task by doing the following:

   1. Select Script from the Step type menu, and click Next.

   2. For the Script set the Input mode to Script and use the Script name menu to select the workflow script.

Create triggers

Prior to writing the logic for a trigger in the EBX® Script IDE, you must first add a trigger to a data model. Once you create the trigger in the data model, it is automatically available in the EBX® Script IDE.

To add a trigger to a table in your data model:

1. Open the data model and select the Advanced properties tab of the desired data model element.

2. Add and configure a trigger that uses the [Built-in] EBX Script component.

3. Save and then optionally publish your data model. Note that once the table is saved after adding the trigger, the trigger's outline is automatically created and available to work with. However, you cannot publish the script until the data model publication is up to date. So it might be a good idea to publish the data model at this time.

Use history to roll back changes

Each script in the IDE includes a history of all revisions to the script. Each revision is created when the script is saved.

To view changes to a script:

1. If the EBX® Script IDE perspective is not open, click the icon at the top right of the EBX® toolbar and select Script IDE.

2. Select the History tab at the top of the workspace.

3. Use the Revisions column to browse changes and copy/paste or make edits to the current revision column.

4. Use the buttons at the bottom of the tab to save, compile, and publish the script.

Check the scripting logs

When you include logging in a script, you can access log output in the following location: Administration > Scripting management > Script logs > Logs.