In this chapter, we will explain the various services that collect and fuse data from X-UP model policies and data sources defined in the X-UP model.

An X-UP model consists of metadata and logic classes. Metadata contains input/output information for the model and information about the logic classes. The execution of the model corresponds to the execution of the logic classes. Logic classes maintain a consistent structure by using the same interface, allowing applications to be developed with a consistent quality even without specialized knowledge.

What is an X-UP model?

An X-UP model consists of 3 files: .xam, AutomationLogic.java, and BaseAutomationLogic.java.

Explanation of .xam

In the .xam file, you can develop business logic by drawing a flowchart. The developed content is automatically generated into the BaseAutomationLogic.java file.

Explanation of AutomationLogic.java

This is the space where users can write their own Java code.

Explanation of BaseAutomationLogic.java

The file is automatically generated based on the xam file.

The relationship between xam, AutomationLogic.java, and BaseAutomationLogic.java.

When a model (xam) is created in an Xup project, two files, AutomationLogic.java and BaseAutomationLogic.java, are generated.
The xam file stores all the information such as the model and parameters in the editor.
The AutomationLogic.java file serves as a space where the user can directly write Java code and inherits from BaseAutomationLogic.java.
BaseAutomationLogic.java is automatically regenerated when saving or refreshing based on the xam file.
Therefore, if you code in BaseAutomationLogic.java, your modifications will be lost when the xam file is saved, as BaseAutomationLogic.java will be regenerated.

X-UP Model Compilation Process

1. When the model is saved, the model's .xam file is compiled into .xml, and the .java file is compiled into .class. The generated files are automatically copied to the Export Generated Path location.

2. Refresh is the same as saving, but it does not copy to the Export Generated Path. All models (.xam) in the X-UP project are compiled from .xam -> .xml and .java -> .class. After compilation, to call the created model through the web application project, you need to execute Export Generate Files (Copy, New).

3. Before executing Export Generate Files (Copy, New), the class files are located in (\workspace\xup\bin), and the XML files are located in (\workspace.xup\model${projectName}\model).

For dynamic web application, when publishing is performed, the files are moved to Workspace.metadata.plugins\org.eclipse.wst.server.core\tmp0\wtpwebapps and executed.

When you execute Export Generate Files (Copy, New), the compiled files are moved from .xup\bin to the web application's model folder and asynchronously moved to Workspace.metadata.plugins\org.eclipse.wst.server.core\tmp0\wtpwebapps. You can monitor the log through the fileWatcher to check the completion status and proceed with testing.

4. Although deleted from the X-UP project, there may be cases where files are not properly removed from the location \workspace.xup\model\xup\model. As a result, files that were deleted may be recreated in the Workspace.metadata.plugins\org.eclipse.wst.server.core\tmp0\wtpwebapps location due to a bug.


This bug can occur in versions prior to March 2024, especially when files are deleted from the Project Explorer instead of the X-UP Explorer.

To resolve this, you need to manually navigate to \workspace.xup\model\xup\model and delete the files directly.

Automation Model

The Automation Model uses a GUI editor to represent the logic of a service as a diagram. Each of the diagrams is called an Invoke and retrieves data from a specified data source. The data information required for data retrieval is created using the X-UP builder's editor and the Properties View. When the automation model is saved, Java class code is automatically generated, and any modifications made to the model in the GUI editor are automatically reflected in the class code.

In the automation model, X-UP Builder provides the following types of Invoke.

Additionally, it provides frequently used functions.

Additionally, the following control functions for branching are provided.

Common Properties of Invoke

When you click on an Invoke placed above the X-UP editor, you can view the information related to that Invoke through the Properties View. Below are the common properties for all Invokes.

General

When you click on the 'General' tab in the 'Properties View', the following screen will appear.

Input Binding / Output Binding

Input Binding/Output Binding serves the purpose of binding the names of in-out parameters required when the invoke is executed to the names of parameters defined in the model.

 Ex ) the input parameter name for a procedure might be 'VAR_IN,' but in the model, the parameter can be declared with the name 'var01.' When the procedure is called, the 'var01' parameter is converted to 'VAR_IN' for the procedure call, and once the call finishes, the parameter name is reverted back to 'var01.'

You can define custom parameter names regardless of the fixed in-out parameter names. The connections created with the 'Invoke' cannot be deleted, but if you want to link them to other parameters, you can modify them through 'reconnection'. Therefore, when performing 'reconnection', if a red lightning bolt symbol appears, you must check the 'Input Binding/Output Binding'.

BeforeDataSource

Before establishing a connection with the Legacy system through the data source used by the respective Invoke, you can add custom logic in Java code as desired.

AfterDataSource

After extablishing a connection with the Legacy system through the data source used by the respective Invoke, you can add custom logic in Java code as desired.

Exception

The Exception tab is used for exception handling of the respective Invoke, where custom logic can be added in Java code as desired.

Parameter

This is the data type used in X-UP. The types of parameters are as follows.

• Variable

• DataSet

• File

• Header

Common Properties

These are the common properties for the data types used in X-UP, which have the following basic attributes:

General

These are the common items for all nodes, including Name, Alias, Visible, and Description.

InOut

The parameter type is selected as a common attribute for all parameters.

Variable

A Variable creates parameters of the same type as the Variable in X-API.

Schema

By default, it has the same properties as other parameters, with the only difference being the definition of the Schema tab.

The Schema tab of the Variable sets the following items.

• Type: Defines the type of the variable parameter.

  • string / int / float / long / boolean / bigdecimal / date / time / datetime / blob

• Size: Defines the size of the variable parameter.

• It is simply for display purposes, so discrepancies with the database will not cause errors.

DataSet

The DataSet Parameter creates parameters of the same type as X-API's DataSet.

Schema

• Import/Export

  The Schema defines the column information of the dataset. Users can directly register column information and can import/export data using the Import/Export functionality to bring in data from or send it out to external sources.

  • When you click the Import button, the Import DataSet Schema Dialog allows you to import dataset column information from the following three sources:

  • Export saves the registered dataset column information as a PlatformData type XML file on the local PC, making it reusable in various places.

• Copy to Clipboard

  By clicking the Copy to Clipboard button, the schema of the selected DataSet is copied to the clipboard.

• toLower

  By clicking the toLower button, all column names will be converted to lowercase.

• toUpper

  By clicking the toUpper button, all column names will be converted to uppercase.

• FirstRow

  If there is a large amount of data retrieved in the Invoke and the client has to wait, the First Row feature can be used. If the defined RowCount is exceeded, a part of the data can be sent in advance via com.nexacro.xapi.tx.HttpPartPlatformResponse before responding through the HTTP response.

  * This feature is only enabled when the output is from a select invoke.

File

The File Parameter is a parameter defined for file input and output operations.

Schema

By default, it has the same properties as other parameters, with the only difference being the definition of the Schema tab.

The Schema tab of the File defines the following items:

• Content Type : Defines the file content type.

  The table below shows some formats.

Header

The Header Parameter is used to manage HTTP header input and output information.

Schema

By default, it has the same properties as other parameters, with the only difference being the definition of the Schema tab.

The Schema tab for the Header defines the following item.

• HTTP Header Key: Specifies the HTTP header key value.

  The table below shows some example formats.

SAP RFC Invoke

The SAP RFC Invoke is a component designed to generate SAP RFC information in parameter format. When invoked, it retrieves data in either Variable or Dataset format.

The SAP RFC Invoke includes an SAP RFC Invoke Dialog for creating an Invoke, along with the following property tabs.

• General : Displays or configures general information.

• InvokeInfo : Verifies the DataSource, Group, and Function used by the Invoke.

• InputBinding : Binds the names of input parameters to the corresponding parameters defined in the model.

• OutputBinding : Binds the names of output parameters to the corresponding parameters defined in the model.

• BeforeDataSource : Executes operations before calling the data source.

• AfterDataSource : Executes operations after calling the data source.

• Exception : Handles exception processing.

InvokeInfo

The InvokeInfo tab allows you to view the DataSource, Group, and Function used by the respective Invoke.

If the Invoke has fixed In-Out parameters, like other Invokes, only informational data is displayed.

For SAP RFC Invoke, the following information is displayed in InvokeInfo.

• DataSource : The selected data source (Clicking it opens the corresponding data source editor.)

• Group : The defined SAP RFC function group

• Function : The selected SAP RFC function

SAP RFC Invoke Dialog

When creating an SAP RFC Invoke, the following dialog will be displayed.

• DataSource : Select a data source (if unavailable, a new data source can be created using a button).

• Function List : Retrieve a list of functions from the selected data source.

• Input Parameter : Automatically generate input parameters from the selected function.

• Test : Execute a test and generate the output in the form of an Output Variable.

Select Invoke

The Select Invoke performs the Select function of the database.

The properties of the Select Invoke include the following tabs.

• General : Displays or configures general information.

• InvokeInfo : Displays the SQL to be executed by the Invoke, with an option to enable the Surround CDATA checkbox.

• BeforeDataSource : Executes before the data source is called.

• AfterDataSource : Executes after the data source is called.

• Exception : Handles exceptions.

InvokeInfo

• DataSource : The selected DataSource (clicking opens the corresponding DataSource editor).

• Select SQL : The defined SQL query.

• Surround CDATA : Wraps the defined SQL query in CDATA.

Select Invoke Dialog

The Select Invoke Popup consists of 4 main components.

• DataSource Combo

• SQL Textarea

• Enable Surround CDATA Checkbox

• Test Button

DataSource Combo

The combo displays DataSource (DB) items. You can select the desired DataSource (DB) to use. If none exists, a new DataSource can be created.

• Changing the DataSource does not delete the existing query.

• Be cautious as no error will appear even if the new DataSource has no relation to the existing query.

• Use the Test button to quickly check for errors.

SQL Textarea

X-UP automatically generates an SQL query for data retrieval. The generated SQL query is a Select SQL that retrieves all columns without any WHERE conditions. You can modify the automatically generated SQL as needed to query specific data. Binding variables in the SQL are represented by placing ‘#’ before and after the parameter (Parameter) name.

CDATA Checkbox

If the SQL query contains special characters, selecting the ‘Enable Surround CDATA’ option will wrap the entire SQL query in a CDATA section.

Dynamic SQL Support

iBatis provides dynamic SQL elements that can be used within mapping statements to improve the reusability and flexibility of SQL.

Since X-UP supports iBatis, you can use existing iBatis dynamic SQL queries directly without modification. However, note that X-UP does not support 100% of iBatis features, so be sure to distinguish which features are available for use.

For detailed guidance on various dynamic SQL elements, refer to the section on Dynamic SQL.

Event Handler

Event handlers are provided in Select Invoke and Modify Invoke, allowing users to define additional logic within the event during the Invoke operation.

To add an event handler, select the desired node, right-click > Select Add Event, and then choose the event to add. This will insert the start and end nodes for the event in the selected node.

The event handlers for Select Invoke are as follows.

• onBegin : Called just before the Invoke operation starts.

• onRowAdded : Called every time a row is added.

• onEnd : Called just before returning the generated ParameterSet after the Invoke operation is completed.

Modify Invoke

Modify Invoke performs Insert, Update, and Delete SQL operations using input parameters.

X-UP determines whether a row in a dataset should be Inserted, Updated, or Deleted based on the type of the row during the Modify Invoke operation. The row type in the dataset can be manually set, but typically, the type is automatically determined when adding, modifying, or deleting rows in the dataset.

The criteria for handling rows in X-UP are as follows.

• The values of rows present in the dataset are reflected directly to the table's record.

• Rows in the table corresponding to rows not present in the dataset are ignored.

• Rows in the table corresponding to rows deleted from the dataset are also deleted.

According to these rules, if a specific row in the dataset already exists in the table, it will be updated; if it doesn't exist, it will be inserted. The rows marked for deletion are those removed by calling removeRow() or clearData() in the dataset.

To quickly create a Modify Invoke node in X-UP, select the Modify item from the Palette or drag a table from the X-UP DataSource View into the editor and choose Modify Invoke.

The properties of Modify Invoke include the following tabs.

• General : Displays or sets general information.

• InvokeInfo : Displays the SQL that the Invoke will perform, along with the TargetDataset and the Enable Surround CDATA checkbox.

• SqlTypeBinding : Binds the row type of the dataset to the SQL query.

• Filtering: Defines conditions to exclude Modify actions if the input parameter's value satisfies certain conditions.

• BeforeDataSource : Performs actions before the data source is called.

• AfterDataSource : Performs actions after the data source is called.

• Exception : Handles exceptions.

InvokeInfo

InvokeInfo provides the essential information required to perform the Modify Invoke.

Modify Invoke Dialog

The Modify Invoke Dialog consists of 6 components.

• DataSource

• Target DataSet

• SQL Textarea & Tab

• Enable Surround CDATA Checkbox

• isBatch

• Test Button

DataSource Combo

The combo displays DataSource (DB) items. You can select the desired DataSource (DB) to use. If none exists, a new DataSource can be created.

• Changing the DataSource does not delete the existing query.

• Be cautious as no error will appear even if the new DataSource has no relation to the existing query.

• Use the Test button to quickly check for errors.

Target DataSet

Modify Invoke operates in a loop based on the Target Dataset.
When multiple Datasets are connected, only the Target Dataset will loop, and the other Datasets will have their RowIndex fixed at 0.

SQL Textarea & Tab

Modify Invoke automatically generates SQL queries for insert, update, and delete on each tab.

• Insert : Generates an insert query for all columns of the DB schema.

• Update : Generates an update query with a WHERE condition based on columns that have a Primary Key in the DB schema.

• Delete : Generates a delete query with a WHERE condition based on columns that have a Primary Key in the DB schema.

Enable Surround CDATA Checkbox

If the SQL query contains special characters, selecting the ‘Enable Surround CDATA’ option will wrap the entire SQL query in a CDATA section.

isBatch

The isBatch checkbox is used when performing insert, update, or delete operations using batch processing.
In this case, Dynamic SQL cannot be used.

Dynamic SQL 지원

iBatis provides dynamic SQL elements that can be used within mapping statements to improve the reusability and flexibility of SQL.

Since X-UP supports iBatis, you can use existing iBatis dynamic SQL queries directly without modification. However, note that X-UP does not support 100% of iBatis features, so be sure to distinguish which features are available for use.

For detailed guidance on various dynamic SQL elements, refer to the section on Dynamic SQL.

SqlTypeBinding

binds the Row type of the dataset to the SQL query.

• default : Automatically maps the dataset's Row type to SQL.

• - SQL Execution based on Row Type

  • normal row type → No execution

  • insert row type → Executes Insert SQL

  • update row type → Execute Update SQL

  • delete row type → Execute delete SQL

Filtering

Filtering defines conditions to exclude certain Modify actions if the input parameter value meets specific criteria.

• Rule Name : Define the name of the filtering rule.

• Parameter : Select the input parameter.

• Comparator : Choose the condition for comparison.

• Value : Enter the condition value.

Event Handler

• onBegin : Called just before the execution of the Invoke.

• onEnd : Called right before returning the generated ParameterSet after the Invoke execution.

• onBeforeInsert: Called just before executing the insert statement when the RowType of the dataset's row is DataSet.ROW_TYPE_INSERTED.

• onAfterInsert: Called immediately after executing the insert statement when the RowType of the dataset's row is DataSet.ROW_TYPE_INSERTED.

• onBeforeUpdate: Called just before executing the update statement when the RowType of the dataset's row is DataSet.ROW_TYPE_UPDATED.

• onAfterUpdate: Called immediately after executing the update statement when the RowType of the dataset's row is DataSet.ROW_TYPE_UPDATED.

• onBeforeDelete: Called just before executing the delete statement when the RowType of the dataset's row is DataSet.ROW_TYPE_DELETED.

• onAfterDelete: Called immediately after executing the delete statement when the RowType of the dataset's row is DataSet.ROW_TYPE_DELETED.

Procedure Invoke

Procedure Invoke executes database procedures and functions. This Invoke automatically configures input and output parameters based on the actual results of calling the database procedure or function, after performing a test using the provided DataSource and Entity information.

In X-UP Builder, you can quickly create a Procedure Invoke by selecting the Procedure item from the Palette or by dragging a Procedure or Function from the X-UP DataSource View into the editor.

Procedure Invoke consists of the Procedure Invoke Dialog and the following property tabs.

• General : Displays or sets general information.

• InvokeInfo : Displays the DataSource, Type, Catalog, Schema, and Entity used in this Invoke.

• InputBinding : Binds the input parameter names to those defined in the model.

• OutputBinding : Binds the output parameter names to those defined in the model.

• BeforeDataSource : Executes before calling the data source.

• AfterDataSource : Executes after calling the data source.

• Exception : Handles exceptions.

InvokeInfo

The necessary information for performing an Invoke is displayed.

For Procedure Invoke and Model Invoke, where the input-output structure is pre-defined, only information is displayed without modification.

In the case of Procedure Invoke, the InvokeInfo section provides the following details

• DataSource : The selected data source (Clicking opens the corresponding DataSource editor).

• Type :Either PROCEDURE or FUNCTION.

• Catalog : The selected catalog.

• Schema : The selected schema.

• Entity : The selected entity.

Procedure Invoke Dialog

When creating a Procedure Invoke, the following dialog is displayed.

• DataSource

  • DataSource : Select a DataSource (If none exist, a new one can be created).

• Select Procedure or Function :

  • Choose either a Procedure or Function.

  • Entity : Select the desired entity.

• Information :

  • Displays the input-output information of the selected entity.

  • The output information may differ from the actual result, so always verify by running a Test.

• void type procedure or function

  • If no result is returned, the Invoke can be set as a void type.

  • In this case, the Invoke will be created without returning any results.

  • The void checkbox must be enabled using the Test button before it can be used.

• enable auto commit mode

  • Allows enabling Auto Commit Mode.

• Test :

  • Runs a test execution and displays the results.

  • Input test values into the Value field to obtain Test Result.

OpenApi Invoke

OpenApi Invoke is used to generate HTTP request parameters for API calls. When invoked, it retrieves HTTP headers and HTML body as parameterized values.

In X-UP Builder, you can quickly create an OpenApi Invoke by selecting the OpenApi item from the Palette and dragging it into the editor.

OpenApi Invoke includes the OpenApi Invoke Dialog for creating an Invoke and provides the following property tabs.

• General : Displays or configures general information.

• InvokeInfo : Contains details about the Invoke, including the associated DataSource, Base Path, Sub Path, Input Parameters, and Send Only Value option.

• InputBinding : Maps input parameter names to those defined in the model.

• OutputBinding : Maps output parameter names to those defined in the model.

• BeforeDataSource : Executes before invoking the data source.

• AfterDataSource : Executes after invoking the data source.

• Exception : Handles exceptions.

InvokeInfo

Essential information required to execute the Invoke is displayed.

Similar to other Invoke types, if the In-Out information is predefined, only the Information section is displayed.

For OpenApi Invoke, the InvokeInfo section includes the following details.

• DataSource : The selected data source (click to open the corresponding data source editor).

• Base Path : The base path URL defined for the selected data source.

• Sub Path : The defined sub-path.

• Input Parameters : The required input parameters.

• Send only value : The defined send-only value.

OpenApi Invoke Dialog

When creating a OpenApi Invoke, the following dialog will be displayed.

• DataSource : Select the OpenApi data source (if none exists, a new data source can be created).

• Base Path : The URL defined for the selected data source.

• Sub Path : Enter any additional URL to append after the base path.

• Input Parameter : Add any URL parameters if they exist.

  • Post : Check this box if you want to send the selected parameters via the POST method when invoking.

• Send only value : Sends only the parameter value during the invocation.

Sub Path와 Input Parameter

The complete URL used to collect data from OpenApi is constructed as follows.

<Data source HTTP URL> + <SubPath> + <Data source parameter> + <input parameter>

Generally, the OpenApi URL provided by a site uses the same base URL, but the sub path may differ depending on the service being offered. The same base URL is always defined in the data source, and different sub paths for each service are defined in each Invoke. Similarly, parameters that must always be passed when calling OpenApi, such as an authentication key, should be defined in the data source, while parameters that are input by the client (user) are defined in the Invoke.

Result

When data is collected from OpenApi, a parameter named 'BODY' is created to store the collected results. Additionally, the values of the HTTP Header received in the response are generated as parameters in the format of HEADER + INDEX. (However, if the data defined as a Header is specified as an output, it will be returned with the information defined in the HTTP Response Header.)

X-UP Invoke

X-UP Invoke is a component used to call an already created and deployed X-UP model from another server.

X-UP Invoke calls the model on a remote X-UP server to retrieve data and generate new parameters.

X-UP Invoke has the following property tabs.

• General

• InvokeInfo

• InputBinding

• OutputBinding

• Exception

InvokeInfo

Essential information required to execute the Invoke is displayed.

Similar to other Invoke types, if the In-Out information is predefined, only the Information section is displayed.

For X-UP Invoke, the following information is displayed in InvokeInfo.

• DataSource : The selected data source (click to open the data source editor).

• Target Domain : The target domain of the selected server.

• Target Model : The target model to be called within the target domain.

Model Invoke

Model Invoke is a component used to call another X-UP model that has already been created within the same project.

You can quickly create a Model Invoke by selecting the Model item in the Palette or by directly selecting a model from the X-UP Explorer and dragging it into the editor.

When creating a Model Invoke from the Palette, the X-UP Model List Dialog appears, and it includes the following property tabs.

• General : Displays or sets general information.

• InvokeInfo : Displays the model name.

• InputBinding : Binds the input parameter names to the parameter names defined in the model.

• OutputBinding : Binds the output parameter names to the parameter names defined in the model.

• Exception : Handles exceptions.

InvokeInfo

Model Invoke displays the required information for execution.

• Name : Displays the name of the invoked model.

Clicking the model name will navigate you to the model editor.

The Refresh menu in the top-right corner allows you to refresh the information if the invoked model's details have changed.

OData Invoke

OData Invoke is an invoke used to consume data via HTTP(s)-based OData. It consumes data through Entity Sets and Function Imports based on CSDL and retrieves the data in parameter format.

In X-UP Builder, OData Invoke can be created quickly by selecting the OData Invoke from the Palette or choosing an OData DataSource from the X-UP DataSource View. After selecting a service from the service list that appears, it can be dragged into the editor.

OData Invoke has the following property tabs for creating the invoke:

• General : Displays general information or settings.

• InvokeInfo : Displays DataSource, Service URI, and the Selected Operation List.

• InputBinding : Binds the in parameters with the names defined in the model.

• OutputBinding : Binds the out parameters with the names defined in the model.

• BeforeDataSource : Performs actions before the data source call.

• AfterDataSource : Performs actions after the data source call.

• Exception : Handles exceptions.

InvokingInfo

Essential information required to execute the Invoke is displayed.

Similar to other Invoke types, if the In-Out information is predefined, only the Information section is displayed.

For OData Invoke, the InvokeInfo section includes the following details.

• DataSource : The selected data source (click to open the corresponding data source editor).

• Service URI : The URI of the selected service, excluding the HOST.

• Selected Operation List : The list of names of the selected operations.

OData Invoke Dialog

When creating a OData Invoke, the following dialog will be displayed.

• DataSource : Select the OData data source (a new data source can be created if none exists).

• Service URI : The service provided by the OData server that you want to invoke.

• Service List : Metadata information of the service selected from the Service URI.

• Operations : The target Entity Set or Function Import that you want to execute.

• Properties : The option values for a single operation when executed.

HTTP Method

When the Invoke is executed, it is bound to the RESTful HTTP Method. The supported HTTP Methods are as follows.

1. GET - Retrieves data. This is bound to the HTTP Method GET. Additional settings can be configured when querying data.

• Get Method Option

  • Multi Value : Retrieves multiple data.

  • Single Value : Retrieves single data.

• System Query

  • When querying data, the default option settings specified by the OData specification are provided.

  • Available settings include: ($filter, $select, $orderby, $top, $count, $search, $levels).

2. POST - Adds data.

3. PUT - Modifies data.

4. DELETE - Deletes data.

Batch Request 지원

OData allows both single requests in REST format and multiple requests in BATCH format.

In X-UP, data is transmitted in REST format only when the operation is a single request and the HTTP method is GET. For all other cases, the requests are processed in Batch format.

In/Out Parameter Information

This section displays the input and output information for the selected operation. The information is bound to the HTTP method.

• When the GET method is selected, the data will be in output format.

• When POST, PUT, or DELETE methods are selected, the data will be in input format.

The data type conversion between OData and X-UP is as follows.

Visual Cobol Invoke

Visual Cobol Invoke is a component used to call resources created using Visual Cobol.

In X-UP Builder, a Visual Cobol Invoke can be quickly created by selecting the Visual Cobol Invoke from the Palette or by selecting the Visual Cobol DataSource from the X-UP DataSource View and dragging the method into the editor.

Visual Cobol Invoke has the following property tabs.

• General

• InvokeInfo

• InputBinding

• OutputBinding

• BeforeDataSource

• AfterDataSource

• Trim

• ReturnCode

• Exception

InvokeInfo

Essential information required to execute the Invoke is displayed.

Similar to other Invoke types, if the In-Out information is predefined, only the Information section is displayed.

• DataSource : The selected data source (click to open the data source editor).

• Class : The class name of the selected resource.

• Method : The method name of the selected resource.

Cobol Invoke Dialog

Below is the dialog that appears when you double-click on Visual Cobol Invoke.

• DataSource

  • DataSource : Select the data source (If none exists, a new data source can be created).

• Select Method

  • Choose the method to be used.

• In/Out Parameters :

  • he input-output information of the selected entity is displayed.

  • Please note that the output information may differ from the actual result, so it is essential to verify the results through testing.

• Test :

  • Displays the results of the test execution.

  • If you input a test value, the test result will be shown.

Trim

After performing the Invoke, you can choose whether to apply Trim to the String Type columns in the output dataset.

The Trim tab of the Visual Cobol Invoke displays the following information.

• Column name : The name of the column in the output.

• Trim : Whether to apply the string trim functionality (You can enable or disable the feature by clicking with the mouse).

  • If checked, the value is True; if unchecked, the value is False.

ReturnCode

The feature allows handling exceptions based on the value of the Return value.

The ReturnCode tab of the Visual Cobol Invoke displays the following information.

• Return value

• Exception message

• Exception code

User Method Function

Characteristics of UserMethod

1. UserMethod allows users to write custom code directly during model development.

2. When a UserMethod is created, a corresponding method with the same name is generated in Automation.java

3. It can perform all the functionalities of invokes, as well as handle tasks like session management.

4. When visual representation becomes challenging due to high complexity, UserMethod can be used to simplify the process.

The properties provided in the User Method are as follows.

• General : General information

• Source : Java code editor window

DataSetRowLoop Function

The DataSetRowLoop Function is a function in the X-UP Builder Automation model editor that triggers events for each row in the DataSet. When a DataSet is connected to the DataSetRowLoop function, it will loop through the number of rows in the dataset, triggering events accordingly.

After connecting the DataSet to the DataSetRowLoop function with the mouse, right-click on the DataSetRowLoop component and select AddEvent > loopEvent. This will create the Start and End events. In the Start Event, parameters for a Variable type rowIndex and a DataSet type dataset will be extracted.

The properties provided by the DataSetRowLoop function are as follows.

• General : General information

• DataSet RowType : DataSet's row type settings window

  • Normal

  • Inserted

  • Updated

  • Deleted

Quick Merge Function

Quick Merge Function is a component used to create a new dataset by merging two datasets.

The Quick Merge Function has the following property attributes.

• General : General information

• InvokeInfo : Displays information about the configured merge

• Exception : Exception handling

The development of a merge model for this type of merging process follows these steps.

• Set target datasets

• Implement merge logic

Set target datasets

The datasets to be used for the merge are configured. These can be datasets generated by the X-UP model or datasets passed by the user as parameters.

Implement merge logic

The merge is provided in two forms: using the SortMerge algorithm and using the HashJoin algorithm.

SortMerge: The two datasets are merged after sorting based on the provided KeyColumn. You can specify the JoinType (Inner Join or Outer Join) for sorting, and you can exclude duplicate columns from the merge. If the two datasets are already sorted, the Sort Option can be disabled.

HashJoin: The two datasets create a Hash Table based on the configured KeyColumn, and the merge is performed using these hash values. Like SortMerge, the JoinType option is available for selection.

Quick Merge API

The API that performs the same functionality as the Function is provided.

The provided API Class is as follows:

• com.nexacro.xapi.data.DataSetSortMerger

• com.nexacro.xapi.data.DataSetHashMerger

For detailed information, please refer to the X-UP API documentation.

Merge Function

The Merge Function is a component used to create a new dataset by merging multiple datasets.

This functionality is executed through SQL queries expressed by the built-in DBMS, applying the logic to merge structured multiple datasets.

The Merge Function has the following property tabs.

• General : General information

• InvokeInfo : Displays information about the SQL query used to perform the merge.

• Index : Sets the index columns for the parameters connected as input parameters.

• Decimal : Sets the decimal places (for columns of the BigDecimal type in the input parameters).

• Exception : Handles exception.

The process for developing a merge model is as follows.

• Set up the target datasets

• Implement the merge logic and SQL query

• Create a new dataset

Target Dataset Configuration

Set the datasets to be used for the merge. These datasets can either be defined by the X-UP model or passed by the user as parameters.

Implement Merge Logic and SQL Query

X-UP uses a built-in DBMS for merging, and the merge logic is implemented using the SQL SELECT statement. X-UP passes the SQL query written by the developer and the configured target datasets to the built-in DBMS. The result returned from the SQL query is then processed to create the merged raw data.

Create New Dataset

The merged raw data from the built-in DBMS is not directly returned; instead, it is transformed into a newly created dataset.

XML Parser Function

The XML Parser Function is a component used to parse XML information and convert it into parameter format. Upon invocation, it retrieves the data in either Variable or Dataset format.

The XML Parser Function consists of the following property tabs in the XML Parser Function Dialog used for creating an Invoke:

• General

• InvokeInfo

• InputBinding

• OutputBinding

• Exception

InvokeInfo

Essential information required to execute the Invoke is displayed.

Similar to other Invoke types, if the In-Out information is predefined, only the Information section is displayed.

For XML Parser Function, the InvokeInfo section includes the following details.

• Parser List: Displays the list of defined parsers.

• Parser Information : Displays the parsing information for the selected parser.

XML Parser Function Dialog

When creating an XML Parser Function, the following dialog appears.

• Parse List: List of XML parsers available.

• XML Content : You can input the XML content directly here for parsing.

• Preview : Displays a preview of the parsed result.

• Parse Info : Defines the parsing information for the selected parser.

  • The left tree view displays the XML data in a tree structure.

  • XPath : Defines the XML path for the selected item in the tree.

  • Const column : Defines constant columns if the data is in a dataset.

  • Condition : Defines specific conditions for parsing only items that meet the condition.

  • Options : Defines a delimiter for handling duplicate item names during value processing.

Extract DataSet Function

The Extract DataSet Function automatically converts a set of Variables into a single dataset when connected as input parameters to the Extract DataSet function.

In other words, it converts Variables → DataSet.

When multiple Variables are connected to the Extract DataSet function, a dataset is automatically created and returned as the output.

• When Variables connected to the Extract DataSet function are updated (added or removed), the existing output dataset is deleted, and a new one is created based on the updated variables.

• If no Variables are connected to the Extract DataSet function, the output dataset is deleted.

The Extract DataSet function has the following properties.

• General

Extract Variable Function

The Extract Variable Function is a function that easily converts the column values of a dataset into output type variable parameters, such as Column Name, Column Value, and Column Size.

In other words, it converts DataSet → Variable.

When the Extract Variable Function is connected to a Dataset, it extracts the variables as output values based on the number, name, type, size, and value of the columns in the dataset.

For example, if the dataset has 4 columns, 4 variables will be output. The name, type, size, and value of each variable will match the respective column name, type, size, and value in the dataset.

The Extract Variable Function has the following property tabs.

• General

Decision

The Decision component allows for branching based on conditions. Specific processes can be executed when a given condition is satisfied.

The conditions are categorized into if, else if, and else, and the desired condition type can be selected by choosing the corresponding connection.

The properties of the condition connection are as follows.

• General : Common to all components

• Connection Info : Common to all connection nodes

• Condition Type : Choose between if, else if, or else

• Source : Input the condition logic

General

In the General section of the Decision connection, three pieces of information can be defined: Alias, Visible, and Description.

In particular, the Visible property is different from other components' visible properties, as it does not include Name / Alias information. It determines whether to display the Alias in the center of the connection.

Connection Info

The connection information properties are common to all connections, and the condition connection follows the same rules.

Routing : Determines the connection routing type. (In the case where the option on the right in the image below is checked)

When the connection is BendPoint routing, the user can define the connection shape as desired.

Binding : For condition connections, it determines whether to display the condition type name. If unchecked, strings such as if, elseIf, and else that were previously shown on the connection are hidden.

Condition Type

The condition type allows the user to select the type of condition.

• You can choose between if, elseIf, or else.

Source

The condition logic can be defined by the user in Java code.

All parameters available in the editor exist within the globalParameterSet, so you can use the desired parameter to define the condition logic.

Make sure that the logic returns a true or false result.

All Java code editor fields in the properties have the same assist pop-up and Java syntax error-checking functionality as the Java editor.

Repeat Task

The Repeat Task function is used to implement loops and is processed using the Decision node.

When a connection is made from the Decision End node to the Decision Start node, a Repeat connection is automatically created. At this point, only one condition is allowed; if more than one condition connection exists, the Repeat connection will not be created.

The Break and Continue nodes can only be used within the Repeat structure and are used when you want to stop or continue the loop at a specific point.

When selecting the Break or Continue node, the source code will appear in the Properties Condition Code. By right-clicking on the source code and selecting "Edit," you can define the Condition Code manually.

Debug and Break Point

The Automation Model allows you to add breakpoints directly to nodes in the editor for model debugging. Once a breakpoint is added to a node, the editor will automatically register the breakpoint at that line when generating the source code.

Breakpoints can be added by selecting individual nodes or by selecting multiple nodes at once to add them in bulk.

The added breakpoints can be removed using the Remove BreakPoint menu.

There are two main methods for debugging the Automation Model.

• Quick debugging through the Debug menu in the editor.

• Creating a JUnit Test Class and running it in debug mode.