In this section, an overview of the menu and key functionalities comprising the X-UP Builder is provided.

The following diagram explains the components that constitute the X-UP Builder.

Menu Bar / Developer Toolbar

The menu bar is configured with X-UP Builder menu added to the standard Eclipse menu. The commonly used menus in Eclipse are as follows.

The following menus are additional X-UP Builder features added to the basic functionality.

• Paste

  In addition to the standard paste function, if an X-UP model (*.xam) file is present among the selected items, the following actions will be performed.

  • When pasting within the same project

    A new model will be created with a modified name, and the logic class will be generated referencing the new name as well.

  • When pasting into a different project

    In addition to the model file, the corresponding model's logic class and data source information will also be pasted. If a model with the same name exists, the 'Compare Input Dialog' will display the logic class information, allowing you to compare and review it. You can rename it if needed. If the data source name is also the same, you can compare and review it through the 'Compare Input Value Dialog' to decide whether to overwrite or ignore it.

• Rename

  In addition to the basic functionality, when the selected item is a *.xam file, the logic class name will be newly created based on the model name, which will be changed. If the logic class has been modified by the user, the modified content will be reflected and copied (the modified logic will be copied as well).

• Delete

  In addition to the basic functionality, when the selected item is a *.xam file, the related logic class will also be deleted along with the model file.

• Refresh

  In addition to the basic functionality, if the selected project is an X-UP project, the versions of all the models within the project will be checked for synchronization, and the model XML will be rebuilt.

X-UP Builder provides various menus for X-UP model development. The related features are available in various areas within X-UP Builder and can mainly be found in the following sections.

• Menu Bar > File > New

• Menu Bar > X-UP / Common

·

.

• Development Tools Toolbar

• X-UP Explorer > Mouse right click > Popup menu > New

X-UP Explorer

X-UP Explorer displays a list of X-UP projects in a tree format and provides filtering functionality. Its main features are as follows.

• Displays project information and model list.

• Displays and allows modification of selected model details.

• Provides filtering functionality.

• Enables model 'Invoke' via drag-and-drop.

• Opens the editor when double-clicking on a model.

• Supports model compilation and deployment.

X-UP Project

The basic structure of an X-UP project is as follows.

• logics : The src folder for Java files

• userLib : The folder for added user libraries

• models : The folder for X-UP models

• GlobalEvents.xaop : Global event file (Optional)

• mashup.msh : X-UP domain file

X-UP Filter

For regular users, the filtering feature in X-UP Explorer can be used to hide all components that are not directly related to model development.

The filter settings will affect all projects within X-UP Explorer. Checking a specific item in the filtering list means that the checked item will be hidden.

Refresh & Export Generated Files

* Refresh
   X-UP builder's Refresh includes two functions
    - project refresh : Updates the project's resource list.
    - compile function : The following actions are performed during refresh
        - Updates the resource list
        - Generates the corresponding *.xml files for each *.xam file
        - Generates the corresponding *.class files for each *.java file.

* Export Genereated Files
  The "Export Generated Files" function is used to copy the resources generated in the X-UP project to a web application project for deployment.

X-UP Wizard

The wizards provided by X-UP Builder are as follows

• New X-UP Project Wizard

  This wizard sets up the environment for developing and testing X-UP models. The project unit defined in X-UP Builder corresponds to the domain unit in X-UP. To develop an X-UP model, it is essential to create an X-UP project first.

• New X-UP DataSource Wizard

• This wizard is used to create a data source for use in an X-UP model. The data sources within a project can be shared across multiple models. The created data source information is registered in the mashup.msh file, and operations such as add, modify, delete, and copy can be performed through the Domain Editor.

• New X-UP Automation Model Wizard

  This wizard is used to create an automation model. Automation models address the shortcomings of existing models, expand functionality, and support service development in a visual language format through a graphical user interface (GUI) editor.

New X-UP Project Wizard

The X-UP Project Wizard can be started from various locations, but it is typically accessed using the "New X-UP Project" button( ) on the development tool toolbar.

The X-UP Project Wizard consists of a simple screen where only the project name needs to be entered. Once the project name is entered and the 'Finish' button is clicked, the project will be created with the specified name.

New X-UP DataSource Wizard

The New X-UP DataSource Wizard creates the data sources to be used during the X-UP model development in the selected X-UP project.

Here’s how to create a data source in X-UP Builder

• Window > Preferences… > X-UP > DataSource > New

  The data sources listed in the preference page’s data source list are stored by X-UP Builder. The stored list can be referenced when creating a new data source.

Other data sources are created and registered in the mashup.msh of the selected (active) X-UP project, and are used when the X-UP model retrieves data.

• Development Tools 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 data sources that can be defined are as follows.

In X-UP Builder, to create an X-UP model, data source information is required. However, it would be quite inconvenient to define a data source every time a model is created. Therefore, it is necessary to define and store data sources in a reusable form to minimize unnecessary repetitive tasks.

All DataSource definition screens provided by X-UP Builder share the following common features.

For example, in the case of the 'Copy from' function, if a datasource is defined in the X-UP Builder Preferences page ([Window > Preferences… > X-UP > DataSource]) or has been added to Preferences using the 'Add to' button from the Create DataSource Dialog, you can use the 'Copy from' function to quickly create the same datasource by copying it when creating a new one.

New X-UP Automation Model Wizard

The New X-UP Automation Wizard is a newly added wizard to create automation models.

The automation model provides an intuitive GUI editor that enables the development of business services using a more visual language.

X-UP Editor

Domain Editor

The Domain Editor is the editor that appears when you double-click the mashup.msh file. It is used for defining user names, project descriptions, deployment paths, data source definitions, model group definitions, and more.

The Domain Editor consists of two tabs.

• Overview

  One tab defines a brief description of the domain and the deployment path.

• DataSource

  The other tab registers the data sources.

Overview

The Overview page registers the author name and project description.

DataSource

In the DataSource page, you can register, modify, delete, and copy data sources used in X-UP model development.

When attempting to delete a data source in use, the following warning message will appear.

If you wish to delete a data source that is being used in a model, you must first change the data source in the model to another one before deleting it.

Automation Model Editor

X-UP Automation Model (XAM) is an X-UP model that enables intuitive business service development. XAM is designed to be intuitive, minimizing user source coding, and allows for easy service development through drag-and-drop functionality.

Palette

The Palette contains basic tools that can be used in the XAM editor.

The current available items are as follows

• Common : Select / Connect / Note

• Parameter : DataSet / Variable / File / Header

• Control : Decision / Break / Continue

• Invoke : SAP RFC / DB Select / DB Modify / DB Procedure / X-UP Model / Remote X-UP / Visual Cobol

• Function : Merge / XML Parser / User Method / Extract DataSet / Extract Variable / DataSet Loop / Quick Merge

Select is the default selected mode, which allows you to select or move nodes in the editor. To switch from Connect mode to Select mode, you can either select "Select" directly from the Palette or click on the desktop in the editor, which will automatically switch to Select mode.

Connect allows you to create connections between nodes. Once a connection is selected, you can continue creating connections until you switch back to Select mode. The type of connection is automatically determined based on the type of the connected nodes.

Other features can be found in the detailed functionality information below.

Drawing Pane

The Drawing Pane is the editor used for designing actual services. It allows for intuitive business service creation with minimal coding, using a drag-and-drop approach.

When a model is first created, only the Start and End nodes exist.

The Start and End nodes represent the beginning and end of a service, and you can freely drag and drop desired components to build the business service. The XAM editor allows for fast and easy service implementation by combining components and connections, and users can also directly add Java code in the editor to work with other components.

The XAM editor includes the following types of connections:

• Process Connection: Defines the flow of the process.

• Data Connection: Represents the flow of data.

• Event Connection: Linked to an event handler.

• Decision Connection: Linked to a Decision node.

Process Connection

A process connection represents the execution order required for a service to operate.

It shows the execution sequence of each component from start to finish, which helps to create intuitive services and enhances readability.

Components that are not connected by a process connection remain as standalone methods and are excluded from the actual service. However, users can manually invoke and execute these methods through source code.

Data Connection

A data connection represents the flow of data based on the components.

In XAM, all data is managed as parameters, and it intuitively shows which parameters are used for input and which parameters are generated as output as a result of component execution.

Parameters can be used as input parameters in one or more components, and output parameters can also be reused as input parameters for other components.

Event Connection

Event connections are automatically created when an event is added to a component, indicating that an event has been introduced.

For example, when two events are added, start and end nodes for the events are created, and the event connection is linked to the corresponding component. The type and usage of the event vary depending on the component, and within the event, business logic can also be constructed with the desired components. Additionally, further events can be added from the component called within the event.

Decision Connection

A decision connection is automatically defined when a connection is linked to the Decision Start node, allowing the user to input custom condition code to determine whether subsequent components will execute.

There are three types: if, else if, and else. Except for the else condition, the user can write the condition logic directly in code.

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 Bar / Developer Toolbar

The menu and toolbar for the XAM editor contain frequently used editor options. The menu items that appear when you right-click within the editor are as follows:

Outline

The Outline summarizes the information created in the editor and reorders it for better clarity. Additionally, the Outline and the editor are synchronized, meaning that any changes made in the editor will automatically reflect in the Outline as well.

The Outline tree is primarily divided and organized into the following two categories.

• Parameters

• Processes

Validate

X-UP Builder has a validation feature to prevent errors that may occur during the development of automation models. When an error is detected, an error mark is displayed on the respective node.

If there are other models referencing the current model and the major information of the current model is changed, a schema comparison window showing the differences between the before and after changes will be displayed.

If a model's information is changed even though references exist, the referenced model files and the respective node in the editor will be marked with an error.

The validation check can be performed through the toolbar and menu, and it is possible to check not only individual models but also all models in the project at once. Once the cause of the error is resolved, the error mark will be removed accordingly.

X-UP View

X-UP Builder offers various views, with several common views that are frequently used during model development. These common views include the following

• Result DataSet View

• Outline View

• Properties View

• X-UP DataSource View

Result DataSet View

The Result DataSet View displays the result dataset information in a table format after a test is conducted. If multiple datasets exist, they are separated and displayed with tabs.

The Result DataSet View appears after performing the following actions

• Clicking the Preview button in the respective model type's view.

• Testing a model after completing its development in the model editor.

Outline View

It shows a brief overview of the currently active editor in a tree format.

Properties View

In Eclipse, the Properties View is used in various contexts. In X-UP Builder, it is mainly used to set the attribute values of a specific node in the model editor.

X-UP DataSource View

The X-UP DataSource View holds the information of the registered data sources in the project and allows you to connect and query detailed lists. It enables quick creation of invokes via drag-and-drop during model development. Currently, it supports SAP RFC, DB, X-UP, and OData data sources, with more to be added in the future.

The features provided by the X-UP DataSource View are as follows.