This chapter introduces other services of X-UP that were not covered in the previous chapter and explains how to handle them.

X-UP Global Event

This section explains the X-UP Global Events that can be used in all models or Invoker in X-UP.

Through X-UP Global Events, the following tasks can be handled

• Handling the start and end of the Automation model (logging, session management, performance measurement, etc.).

• Handling the connection-related tasks of the datasource used during model invocation.

• Handling the start and end of the Invoker process.

• Exception handling tasks.

• Session management tasks.

The following example demonstrates how to apply X-UP Global Events for logging during model execution. The development steps are as follows

• Creating an X-UP Global Event

• Setting the target for Event application

• Writing the Interceptor Class

• Test

This section uses the model created in the Developing a Model Using SAP RFC Invokesection.

Creating an X-UP Global Event

1. Select Create Global Event icon[](1) or menu [X-UP > Create Global Event] (2) to create a Global Event.

2. If a confirmation window appears, click the OK button.

3. The screen showing the created Global Event is as follows.

Setting the target for Event application.

1. Click the Add button [] to add the applicable Event for setting the Global Event.

2. Select AutomationLogic as the TargetClass and start as the TargetMethod to apply it to all models.

3. Create a UserClass to insert the Business Logic.

4. Enter the desired class name and click the Class button [] to create the class.

5. The created UserClass is as follows.

package user.globalEvent; 
 
import com.nexacro.xup.aop.intercept.interceptor.AutomationModelInterceptor; 
import com.nexacro.xup.ParameterSet; 
import com.nexacro.xup.component.automation.AutomationFailException; 
 
public class AutomationModelTracer extends AutomationModelInterceptor { 
                                                                                   
  public void start(ParameterSet globalParameterSet) throws AutomationFailException{ 

  }

}

Writing the Interceptor Class

1. To enable data logging, add the following code inside the start method.

log("DEBUG", "AutomationModel start. data=["+globalParameterSet.getDebugInfo()+"]");

Test

1. To test if the Global Event has been applied, execute the model (1).

2. When performing the test, you can check the logged data (2).

Session Handling

This section explains how to handle sessions in X-UP.

X-UP provides a UserSession object for handling sessions.

UserSession is an object that wraps the httpSession object. In this section, we will explain how to use the UserSession object to perform functions such as session creation, session value checking, and session termination. We will demonstrate this using a sample model for login, retrieving user information, and terminating the login session.

The steps to develop a service for handling sessions are as follows

• Create an X-UP project

• Create a login Automation model

• Create the UserMethod

• Create a session value check Automation model

• Create a session termination Automation model

• Create the UserMethod

• Test

Create an X-UP project

1. Select the [File > New > X-UP Project] menu to launch the New X-UP Project Wizard.

2. In the New X-UP Project Wizard, enter the desired project name in the Project name field and click the Finish button.

3. Confirm that the X-UP project has been created in the X-UP Explorer as shown below.

Create an Automation model.

1. Select [File > New > X-UP Automation Model] menu to launch the New Model Wizard.

2. In the New Model Wizard, enter the model name in the Model Name field and click the OK button.

3. The screen that appears after completing the New Model Wizard is as shown below.

Create the UserMethod.

1. Double-click the UserMethod and enter the source code as shown below.

// session 생성
UserSession session = this.getUserSession();
session.setAttribute("USER_ID","test");
session.setAttribute("USER_PW","1234");

Create a session value check Automation model

1. Select [File > New > X-UP Automation Model] menu to launch the New Model Wizard.

2. In the New Model Wizard, enter the model name in the Model Name field and click the OK button.

3. The screen that appears after completing the New Model Wizard is as follows.

Create the user_id and user_pw parameters, and then create the UserMethod.

1. Declare two Variable parameters and name them user_id and user_pw.

2. Double-click the UserMethod component and enter the following source code

// session 생성
UserSession session = this.getUserSession();
globalParameterSet.add("user_id",session.getAttribute("USER_ID"));
globalParameterSet.add("user_pw",session.getAttribute("USER_PW"));

3. Connect the user_id and user_pw variables as output parameters to the UserMethod.

Create a session termination Automation model.

1. Select [File > New > X-UP Automation Model] menu to launch the New Model Wizard.

2. In the New Model Wizard, enter the model name in the Model Name field and click the OK button.

3. The screen that appears after completing the New Model Wizard is as shown below.

Create the UserMethod.

1. Double-click the UserMethod component and enter the following source code

// session 해제
UserSession session = this.getUserSession();
session.invalidate(true);

Cookie Handling

A cookie is a piece of text sent by a web server to the client, which is stored on the client side. When the client accesses the same web server again, the cookie is automatically sent to the server in the request header in a key=value format.

This section explains how to handle cookies. It describes how to read the header values coming from the client using X-UP's header parameters and how to modify the cookie values among them.

The development steps for the model in this section are as follows

• Create an X-UP project

• Create an Automation model

• Create the Header parameter and UserMethod

• Implement the logic in the UserMethod and configure the output parameters

• Test

Create an X-UP project

1. Select [File > New > X-UP Project] menu to launch the New X-UP Project Wizard.

2. In the New X-UP Project Wizard, enter the desired project name in the Project name field and click the Finish button.

3. Confirm that the X-UP project has been created in the X-UP Explorer as shown below.

Create an Automation model

1. Select [File > New > X-UP Automation Model] menu to launch the New Model Wizard.

2. In the New Model Wizard, enter the model name in the Model Name field and click the OK button.

3. The screen that appears after completing the New Model Wizard is as follows.

Create the Header parameter and the UserMethod

1. Add the header parameter, and set the name as "cookie" and the schema as "cookie".

2. Add the UserMethod and connect the cookie parameter as an input parameter to the created UserMethod.

Implement the logic in the UserMethod and configure the output parameters accordingly

1. Double-click the UserMethod and enter the following source code

//Get the cookie value from the header received from the client.
MashupHeader cookie= globalParameterSet.getHeader("cookie");
//Parse the value in the key=value format.
String [] arrCookie = cookie.getValue().trim().split(";");
String cookieFullValue = "";
for(int iKey = 0; iKey < arrCookie.length; iKey++) {
	String[] cookieKeyVal = arrCookie[iKey].trim().split("=");
	String key = "";
	String value = "";
	if(cookieKeyVal.length == 1) {
		key = cookieKeyVal[0];
		value = "";
	} else {
		key = cookieKeyVal[0];
		value = cookieKeyVal[1];
	}
	if(key.equals("g_emp_no")) {
		value = "54321";
	}
	cookieFullValue += key+"="+value+"; ";
}
MashupHeader cookie1= globalParameterSet.getHeader("out_cookie");
cookie1.setValue(cookieFullValue);

2. Add the header parameter, set the name as "out_cookie", the schema as "Set-Cookie", and the InOut type as "out".

3. Connect the UserMethod with the created out_cookie parameter.

Create Test Screen

Creating a Project in UX-Studio and Creating a Form Screen are omitted.

1. Launch UX-Studio and create a form screen named "header_Form."

2. Create the following variables in GlobalVariables.

3. Add a button to the created screen and double-click it to enter the following function script.

function Button00_onclick(obj:Button, e:ClickEventInfo)
{
	alert(g_emp_no);
	var svcID = "testService";
	var svcparam = "domain=XupCOMM" // X-UP 도메인 이름
		+"&model=header_sample&service=xupservice" // X-UP 모델 이름
		+"&format=xml"
		+"&version=xplatform";

	var svcurl = "SERVER::xupservice.do?" + svcparam;
	var inputDataset = "";
	var outputDataset = "";
	var strArgument = "";
	transaction(svcID, svcurl, inputDataset, outputDataset, strArgument, 	
		"CallbackFunc",false);
}

function CallbackFunc(strSvcID, nErrorCode, strErrorMag)
{
	if (nErrorCode != 0)
	{
		alert(nErrorCode + " : " + strErrorMag);
		return;
	}
	alert(g_emp_no);
}

4. Run the form screen and click the button.

5. Verify that the initial cookie value is displayed as empty.

6. Click the OK button once again to verify if the updated cookie value is received.

File Handling

This section explains the model development method using File parameters.

The model development steps using File parameters described in this section are as follows.

• Create an X-UP Project

• Create an Automation Model

• Create the File Parameter and UserMethod

• Implement UserMethod logic and configure test parameters.

• Create Modify Invoke and Select Invoke, and configure the output logic.

• Test

Create an X-UP Project

1. Select the [File > New > X-UP Project] menu to launch the New X-UP Project Wizard.

2. In the New X-UP Project Wizard, enter the desired project name in the Project name field and click the ‘Finish’ button.

3. Confirm that the X-UP project has been created in X-UP Explorer as shown below.

Create an Automation Model

1. Select the [File > New > X-UP Automation Model] menu to launch the New Model Wizard.

2. In the New Model Wizard, enter the model name in the Model Name field and click the OK button.

3. The screen displayed after completing the New Model Wizard is as follows.

Create File Parameter and UserMethod

1. Add a File parameter, and set the name as 'file' and the schema as 'text/xml'.

2. Add the UserMethod function, and then connect the previously added file parameter as an input parameter to the created UserMethod function.

Implement UserMethod Logic and Configure Test Parameters

1. Double-click the UserMethod and enter the following source code.

MashupFile file = globalParameterSet.getParameter("file").getFile();

String name = file.getName();
String path = file.getPath();

DataSet dataset1 = globalParameterSet.getDataSet("dataset1");

int row = dataset1.newRow();
dataset1.set(row, "NAME", name);
dataset1.set(row, "PATH", path);

globalParameterSet.add("dataset1", dataset1);

2. Add a DataSet with the name "dataset1" and define the schema as follows.

3. Connect the output parameter from the UserMethod to "dataset1".

Create Modify Invoke and Select Invoke, and configure the output logic

1. Add Modify Invoke.

2. The target DataSet is dataset1, and connect it as the input parameter to the Modify Invoke.

3. Double-click the Modify Invoke and enter the insert query as follows.

insert into FILETEST (NAME, PATH) values (#dataset1.NAME#, #dataset1.PATH#)

4. Click the Test button.

5. After testing, delete the automatically generated RESULT0 output parameter.

6. Add a Select Invoke and enter the following query in the Invoke Select SQL window.

select
	NAME,
	PATH
from FILETEST

7. Click the Test button and then click the OK button.

Test

Right-clicking in the model editor will display a popup menu. By selecting "Test" from the popup menu, you can test the model.

After the test is completed, the model's output will be displayed in the Result ParameterSet view.

User Library Handling

When creating an X-UP model, in addition to the X-UP functions provided by the editor, users can add libraries to use custom functions.

The User Library is registered to the project via the Import User Library Dialog, making it available for use when developing the X-UP Model.

The Import User Library Dialog can be executed by selecting the project, right-clicking the mouse, then choosing Import > X-UP > User Libraries.

When selecting a user library and clicking Finish, if the userlib folder does not exist in the project, it will be automatically created. The selected JAR file will be copied to the userlib folder, and the JAR file will be automatically registered in the classpath.

The process of excluding a user library from the Build Path is as follows

After selecting the library to be deleted, choose [Build Path > Remove from Build Path].

Selecting "Remove from Build Path" will exclude the file from the build path, and the file will be visible under the userlib folder. Files visible under the userlib folder can be permanently deleted or added back to the build path later.

The process of adding a user library back to the Build Path after it has been excluded is as follows

After selecting the library you want to add, choose [Build Path > Add to Build Path].

The process of deleting a user library excluded from the Build Path in the project is as follows

Select the library you want to delete and then choose Delete.

X-UP Server Management

Execution and Stopping

X-UP operates as a web application on a Web Application Server (WAS). Therefore, the starting and stopping of the server depend on the startup methods of the WAS where X-UP is installed.

Project Reporting

X-UP Builder provides the Export Project Report Dialog, a feature that generates detailed documentation of X-UP Models developed with X-UP Builder, allowing you to view them at a glance. X-UP Project Reporting can be executed through [Select Project > mouse right-click > Export > X-UP > Project Report]

Clicking the Next button will proceed as follows.

After selecting the model for Project Reporting, choose the desired File Format. The available formats are HTML (html), Text (txt), MS Word (docx), and MS Excel (xlsx). The Target Directory specifies the folder where the Project Reporting file will be created. After configuring these settings, click the Finish button, and the file in the chosen format will be generated.

4o mini

The following images represent the reports in the four formats (Text, Excel, MS Word, HTML).

Transaction Management

X-UP supports distributed transactions.

X-UP recommends that users do not explicitly perform commit and rollback operations. Transaction control is already handled by X-UP, and the details are as follows.

• Distributed Transaction Handling

  • Transaction Start: The point at which X-UP receives the user's request and begins processing.

  • Transaction End: The point at which X-UP outputs the user's response.

The Commit and Rollback of legacy connections, such as DB Connection and SAP JCO Connection, are determined according to the following policies

• Commit

  • When the process reaches the normal completion point without throwing any exceptions.

  • When the 'ErrorCode' output parameter is either absent, or exists but has a value of 0 or a positive number.

• Rollback

  • When an exception is thrown and handled.

  • When the 'ErrorCode' output parameter exists and its value is negative.

Therefore, if you want to perform a Rollback, you can either handle an exception or create an 'ErrorCode' parameter and set it to a negative value. In this case, a Rollback will be performed for the legacy connection related to the request.

Multilingual Support

X-UP handles multilingual support based on the following principles

• Client Charset Handling: The character set from the client request is used to request data from the dataset and return the data to the client in the same character set.

• Charset Mismatch Handling: If the character set of the client request differs from the character set of the data retrieved from the data source, the data is converted to the client’s character set before being returned.

For example, if the character set in the client's request is 'euc-kr', the dataset will use the 'euc-kr' character set to retrieve data. The collected and processed data will then be returned to the client in the 'euc-kr' character set. However, if the data retrieved from the data source is in 'UTF-8', it will not be re-encoded to 'euc-kr' but will be directly transmitted to the client in 'UTF-8'.

The following is the logic for determining the character set from the client's request.

1. Get the character set specified in the data itself (e.g., in XML files).

2. If not present, check the HttpRequest for the character set from the request.

3. Get the character set from the 'CONTENT-TYPE' header.

4. If not present, get the character set from the 'ACCEPT-CHARSET' header.

5. If still not present, determine the character set based on the language in the 'ACCEPT-LANGUAGE' header.

6. If none of the above, use the character set configured in the model.

7. Retrieve the character set set in the model's metadata.

8. If not available, get the character set configured for the datasource used by the model.

9. If all else fails, default to 'UTF-8' as the character set.

Junit & Remote Class Creation

X-UP provides a feature that automatically generates JUnit classes and Remote classes to offer users convenient debugging capabilities.

When the user selects the model to test and clicks the menu below, a simple JUnit class and Remote class will be generated.

How to Create JUnit Test Class

1. Select the model to be tested.

2. Click on the [] icon in the development toolbar.

3. Verify that a JUnit Test class with the original class name followed by ‘_junit’ is created in the logics folder.

• Another method is to select [Common > Generate JUnit Test Class] from the Menu Bar.

• To generate JUnit Test classes for all models in the project, select the project and then choose [Common > Generate All JUnit Test Classes]

4. Another method is to select the project and then right-click [Mouse Right-click > X-UP > Generate All JUnit Test Classes]

After generating the JUnit Test Class, run it in debug mode

To debug the model, add a BreakPoint and then generate the test case Java file through the JUnit Test Case auto-generation menu. After that, run it in Java debug mode.

After that, it's the same as regular Java debugging.

How to Generate Remote Test Source

1. Select the model to be tested.

2. Click the [] icon in the development tool bar.

3. Confirm that the Remote Test Source class, with '_remote' appended to the original class name, has been created in the logics folder.

• Another method is to select "Common > Generate Remote Test Source" from the Menu Bar.

How to Create a Quick Model

SAP RFC Invoke

When a DataSource is available, select the desired DataSource [] from the X-UP DataSource view to retrieve the table list.

If there is no DataSource, create a DataSource as shown below.

In the X-UP DataSource view on the right side of the screen, select "new DataSource" to launch the Wizard.

Select the DataSource "RFC_EC6" and click the "search Entities" button [] to retrieve the list of functions registered on the server.

Search for the desired group.

Double-click the desired Function Group to query.

You can perform a search using the '*' wildcard when searching for groups (functions).

1. Select the Function you want to create as an Automation Model (multiple Functions can be selected).

2. Right-click the mouse.

3. Click Create Automation SapRfc Model.

• Checking "Enable FileName Prefix" allows you to set a prefix for the generated model's name (optional).

• In the Overwrite Options, selecting "Overwrite all" will overwrite the model if a model with the same name already exists within the Domain. Selecting "Skip all" will skip the creation of the model and not generate it.

Click the Finish button.

You can confirm that the following files have been created.

Select Invoke

When a DataSource is available, select the desired DataSource [] from the X-UP DataSource view to retrieve the table list.

If there is no DataSource, create a DataSource as shown below.

In the X-UP DataSource view on the right side of the screen, select "new DataSource" to launch the Wizard.

• Select "SampleDB" from the DataSource.

• Choose the table(s) from SampleDB for which you want to create a Quick Model (multiple selections are allowed).

• Right-click and click on "Create Automation Select Model."

• If you check "Enable FileName Prefix," you can set a prefix for the generated model's name (optional).

• In the Overwrite Options, selecting "Overwrite all" will overwrite the model if its name already exists in the domain. If you select "Skip all," the model will be skipped and not created.

Click the Finish button.

The result of the generated model is as follows

Modify Invoke

When a DataSource is available, select the desired DataSource [] from the X-UP DataSource view to retrieve the table list.

If there is no DataSource, create a DataSource as shown below.

In the X-UP DataSource view on the right side of the screen, select "new DataSource" to launch the Wizard.

• Select "SampleDB" from the DataSource.

• Choose the table(s) from SampleDB that you want to create the Quick Model for (multiple selections are allowed).

• Right-click and select "Create Automation Modify Model".

• Checking "Enable FileName Prefix" allows you to set a prefix for the generated model name (optional).

• In the Overwrite Options, selecting "Overwrite all" will overwrite the model if the name already exists in the domain. Selecting "Skip all" will skip creating the model.

Click the Finish button.

The result of the generated model is as follows.