This chapter describes the X-UP Builder configuration menu and its features.
An image and descriptions of the X-UP Builder layout are shown below:
Component | Description | |
---|---|---|
1 | Menu Bar | Basic Eclipse menu items and X-UP model development items are provided in the menu bar. |
2 | Development Toolbar | The development toolbar contains commonly-used menu items, represented as icons, for Eclipse and X-UP model development. |
3 | X-UP Explorer | X-UP Explorer displays the contents of activated projects in tree form and provides a filtering function for X-UP projects. |
4 | Outline View | The outline view is linked to the current activated editor and displays related information in tree form. Domain Editor: All of the defined property information from each of the Domain Editor's tabs is displayed in a brief tree form. X-UP Editor: All of the defined nodes from the Model Editor are displayed in tree form, and a scrollable thumbnail view of the entire screen is output. |
5 | Content Pane | The content pane is a workspace for a selected project or activated file, and an editor related to the corresponding file is generally located in this area. The Domain Editor, Gathering Editor, Transaction Editor, Automation Editor and Java Editor can be found in X-UP Builder. |
6 | Editor View | All views provided in X-UP Builder can be found in the editor view. The view layout is divided into top and bottom sections. Views associated with the model editor are provided: Editor Info View Function View Result DataSet View Properties View Other Eclipse Views |
7 | Editor Palette | The palette is a group of components needed for model development in the model editor. It consists of a basic drawing menu, output datasets, and function components. |
8 | X-UP DataSource View | All data source information defined in a project can be retrieved and output in the X-UP datasource view. In addition, you can easily and intuitively create required components for model development with drag and drop. |
Menu and Development Toolbars
The menu bar features a basic Eclipse menu and additional X-UP Builder menu items. Basic information regarding Eclipse can be found on the Eclipse website (http://www.eclipse.org).
The common menu items typically used in Eclipse are as follows:
Name | Icon | Description | |
---|---|---|---|
New | File > New | Create a new project or file. | |
Open | File > Open | Open an existing project or file. | |
Save | File > Save | Save a project or file. | |
File > Print | Print. | ||
Eclipse Help | Help > Help Contents | Display the help menu. |
The following menu items are features unique to X-UP Builder in addition to the basic functions.
Paste
In addition to the default paste function, the following functions can be performed when X-UP model files (*.xam) exist in a selected item.
If pasting in the same project:
The model name is changed to create a new model, and a logic class is also created with the corresponding name.
If pasting in a different project:
The model name as well as the respective logic class and data source information are pasted. Note that if a model of the same name already exists, the logic class information is displayed in the Compare Input dialog for comparison/review and possible name change. When a data source of the same name already exists, it will be displayed in the Compare Input Value dialog for comparison/review. You may decide to ignore or overwrite the name.
Rename
In addition to the default rename function, the model name to be changed is referenced for the logic class name when the selected item is an .xam file. If the logic class is modified by the user, the modified contents are reflected. (The modified logic is also copied.)
Delete
In addition to the default delete function, the model file, as well as any relevant logic classes, are deleted when the selected item is an .xam file.
Refresh
In addition to the default refresh function, all associated model versions are checked and synchronized and the model XML is rebuilt if the selected project is an X-UP project.
X-UP Builder provides a variety of menu functions for X-UP model development. The X-UP menu is located in various places throughout X-UP Builder and can usually be found in the following areas:
# Menu bar > File > New
# Menu bar > X-UP > Common
·
.
# Development toolbar
X-UP Explorer > Mouse right click > Popup menu > New
Name | Shortcut Key | Description |
---|---|---|
create X-UP Project | Alt+1 | Create a new X-UP project. |
create Automation Model | Create a new automation model. | |
new X-UP DataSource | Alt+4 | Create a new data source. |
Create GlobalEvent | Create a global event. | |
generate Remote Test Source | Ctrl+Shift+1 | Create a test class for remote testing based on a selected model. |
generate Junit Test Class | Ctrl+Shift+3 | Create a simple JUnit test case to test a selected model. |
generate All Junit Test Class | Ctrl+Shift+2 | Create a JUnit test case to test all models that exist in a selected project. |
X-UP Log Masking | Define the log encryption for server URLs defined in a selected project. | |
X-UP License Manage | Manage the license for server URLs defined in a selected project. | |
deploy X-UP Model | Alt+0 | Deploy a model to a server. |
Validate | Ctrl+Shift+6 | Validate other models' schemata being used in the current model. |
Validate All | Ctrl+Shift+7 | Perform Validate for all the models in the selected project. |
X-UP Explorer
X-UP Explorer displays the X-UP project list in tree form and provides a filtering function.
Key Features:
Output project information and model list.
Output and modify detailed model information.
Filtering function.
Invoke models using drag and drop.
Open editor when model is double-clicked.
X-UP Project
A basic X-UP project structure is as follows:
logics: Src folder for a Java file.
userLib: Folder for added user libraries.
models: Folder for X-UP models.
GlobalEvents.xaop: Global events file. (Optional)
mashup.msh: X-UP domain file.
The above folder and file names that exist when a project is created are internally determined and therefore must not be changed or deleted.
X-UP Filter
For general users, any component not directly related to model development in an X-UP project can be hidden by using the filter function in X-UP Explorer.
The filter settings affect every project that exists in X-UP Explorer. A checked box in the filtering list indicates that the selected item will be hidden.
Name | Description |
---|---|
.* resource | Hides resources with names that start with a '.' |
*BaseAutomationLogic.java | Hide *BaseAutomationLogic.java |
*BaseTransactionLogic.java | Hide *BaseTransactionLogic.java |
bin folder | Hide bin folder |
Empty parent packages | Hides empty packages which do not contain Java files but other sub-folders |
Libraries from external | Hides libraries from external |
Libraries in project | Hides local libraries i.e. those contained inside the project itself |
metadata folder | Hide *.metadata folder |
Non X-UP Project | Hides all projects without XSB nature |
Package declaration | Hide package declaration |
The BaseAutomationLogic.java file is automatically generated by the editor when developing a model.
X-UP Wizard
The following four wizards are provided in X-UP Builder:
New X-UP Project Wizard
The New X-UP Project Wizard configures an environment for X-UP model development and testing. The project units defined in X-UP Builder correspond to the domain units in X-UP. You must first create an X-UP Project to develop an X-UP model.
New X-UP DataSource Wizard
The New X-UP DataSource Wizard creates a data source for use in an X-UP model. Data sources that exist in a project can be shared by multiple models. The resulting data source information is registered in mashup.msh, and you can add, edit, delete, and copy information using the Domain Editor.
New X-UP Automation Model Wizard
This is a wizard to create an automation model, which is extended and improved from previous versions. An automation model employs the GUI editor, enabling users to develop services visually.
New X-UP Project Wizard
The X-UP Project Wizard can be started from various places, but most commonly by the New X-UP Project button () on the development toolbar.
The X-UP Project Wizard consists of a simple screen for entering a project name. When finished, a project with the corresponding name will be created.
Because a project name is used in multiple places, names that begin with numbers, blank spaces, and special symbols are not supported. When an X-UP project is created in X-UP Builder, the domain name is automatically assigned with the project name but can be changed using the rename function.
New X-UP DataSource Wizard
The New X-UP DataSource Wizard creates data sources to be used when an X-UP model is developed in an X-UP project.
Data sources can be created in X-UP Builder in the following locations:
Window > Preferences… > X-UP > DataSource > New
X-UP Builder will store the list of data sources on the Preference page. The list can be used as a reference when creating data sources.
Other data sources will be registered in the mashup.msh file of a selected (or being developed) X-UP project and be used when the model scrapes data.
Development toolbar > New DataSource
mashup.msh > Domain Editor > DataSource tab > DataSource List > New
New Model Editor Wizard Datasource Page
X-UP DataSource View New DataSource
The following data sources can be defined:
data source | Description |
---|---|
WebService | General web service data source |
OpenApi | Used when you want to process canonicalized data imported through http URL access. |
DB | DataBase data source |
X-UP | TOBESOFT X-UP data source |
SAP RFC | SAP RFC connection |
Data source information is required when creating X-UP models in X-UP Builder. It would be quite inconvenient to define a data source each time you create a model. So, there is a need to define and store data sources in a reusable form to minimize unnecessary repetitive tasks.
The following features are common in all data source definition screens provided in X-UP Builder:
features | Description |
---|---|
Test Connection | Test |
Import | Import data source .xml files stored on your own PC. |
Export | Save data source information as .xml files on your PC. |
Copy from | Copy registered data source information to X-UP Builder preferences. |
Add to | Save data source information to X-UP Builder preferences. |
Example: If data sources were defined in the environment settings page([Window > Preferences… > X-UP > DataSource]) or data sources registered to Preferences using the [Add to] button exist on the Create DataSource dialog screen, the [Copy from] function can be used to quickly generate data sources of the same type.
The data source information defined in Preferences is for reference and reuse, but not for model linkage. In other words, even if a data source existing in Preferences is selected on the DataSource definition screen, the information is simply copied - not linked - when a new model is created.
New X-UP Automation Model Wizard
The New X-UP Automation Wizard was newly added to create automation models.
Automation models integrate transaction models and supplement their inadequacies to allow the development of business services in a visual language using a graphical GUI editor.
Name | Description |
---|---|
Model Name | Enter the name of the automation model in Model Name. The name must not be a duplicate of an existing name, and only English strings are permitted. |
Description | Enter a brief description of the model in Description. |
Charset | Character set defines the string encoding type. |
X-UP Editor
Domain Editor
The Domain Editor opens when the mashup.msh file is double-clicked. The user name, project description, deployment path, data source definitions, and model group definitions can be configured.
The Domain Editor consists of two tabs:
Overview
A brief description of the domain and the deployment path can be set in Overview.
DataSource
Register data sources.
Overview
Register the author name, project description, and deployment path on the Overview page.
Name | Description |
---|---|
Author | User name (Optional) |
Description | Description (Optional) |
Server | This list of URLs is used when deploying developed models on a server. It is possible to simultaneously deploy to more than one URL, and exclusions can be set by unchecking the checkboxes next to URLs that you do not want deployed. |
DataSource
On the DataSource page, you can register, edit, delete, and copy data sources used during X-UP model development.
Name | Description |
---|---|
New | Create a new data source. |
Edit | Modify the selected data source. (Name cannot be modified.) |
Delete | Delete the selected data source. |
Copy as | Copy the selected data source, and create a new data source with a different name. |
Add to preference | Register the selected data source under X-UP DataSource in Preferences. |
The following warning message will be displayed when trying to delete a data source that is being used.
To delete a data source that is being used in a model, you must first change to a different DataSource before deleting.
Automation Model Editor
The X-UP Automation Model (XAM) is a model in which graphical development of business services are possible. The intuitive XAMs supplement the limitations of the gathering and transaction models and minimize user source coding, allowing users to easily develop services with drag and drop.
Palette
The palette consists of basic tools available for use in the XAM Editor.
The following features are currently provided:
Common : Select / Connect / Note
Parameters : DataSet / Variable / File / Header
Control : Decision / Break / Continue
Invoke : SAP RFC / SAP Table / DB Select / DB Modify / DB Procedure / X-UP Model / Remote X-UP / OData
Function : Merge / XML Parser / User Method / Extract DataSet / Extract Variable / DataSet Loop / Quick Merge
Select is selected by default and can select or move a node in the editor. Choose Select directly from the palette or click the background in the editor to automatically switch from Connect mode to Select mode.
Connect can create a connection between nodes. When Connect is selected, you can continue to create connections until it changes to Select mode. The connection type is determined automatically according to the type of the node to which the connection is made.
Other remaining items can be found in the following detailed information.
Drawing Pane
The drawing pane is an editor for designing services. It allows you to visually build a business service with minimal coding and drag and drop.
When a model is first created, only the start and end nodes exist.
The start and end nodes indicate the start and end of a service, and you can freely compose a business service by dragging and dropping the desired components. The XAM Editor can quickly and easily implement the desired service with a combination of components and connections. In addition, users can directly input Java code to operate with other components.
The following connection types are available in XAM Editor:
A process connection that defines the process flow.
A data connection that shows the data flow.
An event connection that connects to event handlers.
A conditional connection that connects to decision nodes.
Process Connection
A process connection represents an execution order for activating a service.
Because it represents the execution order of each component from start to end, and an intuitive service implementation is possible, readability is enhanced.
A component without a process connection is left with only one method and is excluded from the actual service. However, it is possible to execute the component if the user calls the method directly with the source code.
Data Connection
A data connection represents a component's data flow.
All data in an XAM is managed as parameters and information is intuitively expressed, including which parameter is used as input and which is generated as output as a result of component execution.
Parameters can be used as input for more than one component, and output parameters can also be reused as inputs for other components.
Event Connection
An event connection is automatically generated when an event is added to a component and indicates that the event is actually added.
When two events are added, for example, the event start and end nodes are created, and event connections are linked to the corresponding component. Event types and methods vary by each component, and business logic can be configured within an event with the desired component. In addition, another event can be added in a component that is called in the event.
Conditional Connection
A conditional connection is automatically defined when a connection is made to a decision start node. The user can directly enter a conditional code to determine whether to run the following component.
If, else if, and else are available, and the user can directly code conditional logic for conditional connections excluding else.
public boolean decisionconnection(ParameterSet globalParemeterSet) throws AutomationFailException { int currRowIndex = globalParemeterSet.getIntValue("rIndex"); DataSet ds = globalParemeterSet.getDataSet("dataset1"); if (currRowIndex == ds.getRowCount()) { return false; } else { return true; } }
Menu & Development Toolbar
Frequently-used editor functions can be found in the XAM Editor menu and toolbar. The following functions are available when you right-click in the editor.
Name | Description |
---|---|
Undo | Restore previous state. |
Redo | Revert the effects of the undo action. |
Copy | Copy an editor node to the clipboard. |
Paste | Paste copied data from the clipboard. |
Delete | Delete |
Select All | Select all |
Show All with Alias | Show all aliases. |
Align | Align Align Left / Center / Right / Top / Middle / Bottom |
Zoom | Zoom Zoom In / Zoom Out |
InOutType | In/Out type definition In / Out / Normal / In+Out |
Save | Save |
Save to image file | Save the editor screen as an image file. |
Import Parameters | Import parameters from an external source. (.xml file) |
Export Parameters | Export parameters as an .xml file. |
Validate | Error-check invoked item. |
Add BreakPoint | Add breakpoint. |
Remove BreakPoint | Delete breakpoint. |
Test | Execute model test. |
Debug | Execute debug mode. |
Input Test Value | Input parameter required for model testing. |
Show Properties | Activate the properties view. |
Outline
The outline summarizes, sorts, and displays information written in the editor. In addition, the outline and editor are synchronized so that information that is modified in one is reflected in the other.
The outline tree is largely divided into the following two sections:
Parameters
Processes
Validate and Error Mark
X-UP Builder includes a validation function to prevent errors that may occur during automation model development. When an error is detected, an error mark is indicated on the respective node.
A schema comparison window (before and after change) is output when a model's key information is changed among other self-referencing models.
If the model information is changed while a reference exists, an error mark is indicated on the respective node on the referred model file and editor.
A validation check can be performed using the toolbar and menu, and not one, but all models in a project can be checked simultaneously. When the cause of an error is resolved, the corresponding error mark is deleted.
X-UP View
A variety of views are available in X-UP Builder. Several views are commonly used during model development. Views commonly used during model development:
Result DataSet View
Outline View
Properties View
X-UP DataSource View
Result DataSet View
The Result DataSet View outputs resulting dataset information from a test in table form. If more than one dataset exists, they are separated by tabs.
The Result DataSet View is displayed to show resulting values after the following operations:
When the [Preview] button is clicked in the type-specific view of each model:
When a test is conducted after completing model development in each model editor.
Name | Description | |
---|---|---|
1 | DataSet Tab | If more than one dataset exists, they are separated by tabs with their respective names. |
2 | DataSet Table | Dataset information |
3 | Save | Save the dataset information in a .csv file |
Outline View
Brief information is displayed in tree form with respect to the currently activated editor.
Scrollable thumbnails are displayed at the bottom of the Model Editor’s Outline view, and the entire workspace for the active editor is downscaled to fit the screen. The entire view is shown, including the hidden area in the editor screen, and the editor screen can be moved by dragging the viewpointer with the mouse.
Properties View
The Properties View is used in various places throughout Eclipse. This view is often used in X-UP Builder to set a particular node's property value in the model editor.
X-UP DataSource View
The X-UP DataSource View can access and retrieve a detailed list using registered data source information in a project. It allows for fast invoke creation using drag and drop during model development. SAP RFC, DB, X-UP, and OData data sources are currently supported with plans to add support for more in the future.
The features provided in the X-UP DataSource View are as follows:
Icon | Name | Description |
---|---|---|
Refresh | Update all X-UP projects in the workspace. | |
Collapse All | Collapse all expanded trees. | |
Link with Editor | Automatically select a project in which the selected editor's model is located. | |
New DataSource | Create a new data source. | |
Go Home | Go to the top-level root tree. | |
Go Back | Go to the parent tree node. | |
Go Into | Output only the sub-tree of the selected node. | |
Select Project | Select a project. | |
Select DataSource | Select a data source. | |
Filter | Filter with a specific string. | |
Show Data | Retrieve all data in a selected table. | |
Copy select sql to clipboard | Create a basic select SQL and copy it to the clipboard with respect to the selected table. | |
Copy insert sql to clipboard | Create a basic insert SQL and copy it to the clipboard with respect to the selected table. | |
Copy update sql to clipboard | Create a basic update SQL and copy it to the clipboard with respect to the selected table. | |
Copy delete sql to clipboard | Create a basic delete SQL and copy it to the clipboard with respect to the selected table. | |
Create Select Invoke | Select a particular table, and then drag and drop it to the editor to rapidly create a select invoke. | |
Create Modify Invoke | Select a particular table, and then drag and drop it to the editor to rapidly create a modify invoke. | |
Create Procedure Invoke | Select a particular procedure or function, and then drag and drop it to the editor to rapidly create a procedure invoke. |