This chapter describes the X-UP Server and X-UP Builder environment settings required for development.
X-UP Server Setup
A variety of environment settings files are provided to configure an X-UP Server. The following describes environment settings files under the assumption that X-UP Server is already installed.
Go to [webapps > xup > WEB-INF > xup > conf] in the WAS installation path to see the many environment settings files shown below.
Name | Description |
---|---|
authInfo.xml | This file contains account information for X-UP Server. |
log4j_config.xml | This file contains information on X-UP error log configuration. |
xup_config.xml | This file contains X-UP startup configuration information. |
xup_env.property | This file contains X-UP environment settings information. |
X-UP_Server_License.xml | This is the X-UP Server license file. |
xup_config.xml
The xup_config.xml file contains the following X-UP Server environment settings information.
Name | Type | Description |
---|---|---|
isBundleDevMode | Boolean | This option is used when developing a bundle to be run in X-UP. |
isManageMode | Boolean | Enable/disable X-UP administrator mode. |
isDebugMode | Boolean | Enable/disable debug mode. Logs are only recorded when set to true regardless of the log setting. (Unrelated to system log and user log.) |
execption.loglevel | Int | Setting log level for exception handling. |
enableModelSingleton | Boolean | Enable/disable model singleton. |
logger.Api.enabled | Boolean | Enable/disable X-UP Server API-level logging. |
logger.Parameter.enabled | Boolean | Enable/disable logging when handling X-UP Server's parameters. |
logger.DataSetBuilder.enabled | Boolean | Enable/disable logging when model raw data is converted to a dataset conversion. |
logger.ParameterSetBuilder.enabled | Boolean | Enable/disable invoke logging. |
enableModelSingleton- You need to exercise caution in using a class member field Variable if Singleton is set and the model is made by adjusting a Java source. The reason is that Variable, a member field between threads, can be shared.
The exception log levels used in X-UP Server are as follows:
Level | Description | |
---|---|---|
1 | allException | Send all stack traces and messages for all exceptions. |
2 | allException shortly | Send brief stack traces and messages for all exceptions. |
3 | userException | Send all stack traces and messages for the current exception. |
4 | userException | Send brief stack traces and messages for the current exception. Level 4 exception log is the most minimal. |
The isDebugMode setting in the xup_config.xml file takes precedence with respect to logging. If isDebugMode is set to false, logging is disabled regardless of the log4j.xml file.
log4j.xml
To help users with rapid and effective logging, X-UP supports log4j, an open source project by Apache.
A brief guide on log4j:
Name | Description |
---|---|
Logger(Category) | A logger transmits logging messages to appenders. |
Appender | An appender plays an intermediary role to determine whether transmitted logging messages will be recorded in a file, output to the console, or saved in a DB. |
Layout | After an appender determines the output method, the logging messages are output in the designated layout. |
Log4j Logging Level
Level | Description |
---|---|
FATAL | Used for the most critical errors. |
ERROR | Used for general errors. |
WARN | Used for non-errors that require caution. |
INFO | Used for general information. |
DEBUG | Used for general information details. |
auth_info.xml
The auth_info.xml file contains X-UP account information.
The default account is xup/xup. Modify the <password></password> value to change a password, and enter new <user> information in <userList></userList> and save to add a new account.
<?xml version='1.0' encoding='uft-8'>
<authInfo>
<userList>
<user>
<name>xup</name>
<password>xup</password>
<roles>admin</roles>
</user>
<user>
<name>administrator</name>
<password>admin</password>
<roles>admin</roles>
</user>
</userList>
</authInfo>
When an account name and password are modified in auth_info, the changes are reflected in an X-UP administrator account.
web.xml
The web.xml file is located in xup/WEB-INF under the X-UP Server web application root folder. It's responsible for servlet, servlet mapping, filtering, and encoding settings.
<?xml version="1.0" encoding="ISO-8859-1"?> <!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd"> <web-app> <servlet> <servlet-name>FrontControllerServlet</servlet-name> <servlet-class>com.tobesoft.xup.service.FrontControllerServlet</servlet-class> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>FrontControllerServlet</servlet-name> <url-pattern>*.do</url-pattern> </servlet-mapping> </web-app>
JCO Library
We recommend placing the below libraries in the system path that was configured in the SAP instruction manual.
Libraries Required for JCo v2.0 | Libraries Required for JCo v3.0 |
---|---|
librfc32.dll sapjcorfc.dll sapjco.jar | sapjco3.dll sapjco3.jar |
X-Up provides libraries for JCo for more convenient development with X-UP Builder. In the case of JCo 2.0, users are required to load librfc32.dll within X-UP and then sapjcorfc.dll within JCo. For JCo 3.0, users are not required to load any file within X-UP because all they need to do is loading sapjco3.dll within JCo.
The following explanations are about JCo 3.0 with sapjco3.dll applied.
When using NetWeaver
X-UP does not load JCo-related libraries.
Using xup_env.property com.tobesoft.useJcoStandalone= false
Deleting sapjco3.jar and sapjco3.dll of SAP RFC DataSource
For development and administration
When X-UP loads sapjco3.jar
Loading the library from SAP RFC DataSource
When sapjco3.jar located in System Path
Using xup_env.property com.tobesoft.useStandAlone = false
- *** Deleting sapjco3.jar and sapjco3.dll of SAP RFC DataSource
When using a Java ext folder
Using xup_env.property com.tobesoft.useStandAlone = false
Moving sapjco3.jar of SAP RFC DataSource to the Java ext folder
Moving sapjco3.dll of SAP RFC DataSource to the Java bin folder
Identical settings must be applied to OS Platform, JRE, and SAP DLL bit version if the following errors occur.
caused by java.lang.NoClassDefFoundError :
message=Could not initialize class com.sap.conn.jco.rt.JCoRuntimeFactory
or Error getting the version of the native layer:
java.lang.UnsatisfiedLinkError: no sapjco3 in java.library.path
X-UP Builder Preferences Setup
All X-UP Builder environment settings can be configured in X-UP's preferences. X-UP's preferences can be found at [Window > Preferences… > X-UP].
Currently, the X-UP preferences consist of two pages.
X-UP Page: General X-UP Builder settings.
DataSource Page: Frequently-used data source management.
X-UP
You can define common environment settings in the X-UP page.
You can output log messages to the console by enabling the "Show X-UP Builder log messages to console" option. In addition, you can enable the "Include package and class debug line messages" sub-option to include package and class line messages in the output.
You can limit the possible retrieval of too much data by defining a constraint in the "SAP RFC GROUP Search limit count" option. More environment settings are planned to be added in the future.
DataSource
The DataSource page includes frequently-used data sources for reference or reuse when creating X-UP models.
Registered data sources can be referenced anywhere regardless of the project or model.
Name | Description | |
---|---|---|
1 | DataSource Table | The data source table displays a list of registered data sources. Name: Data source name. CheckBox: Only data sources with their respective checkboxes checked are displayed in the data source selection screen during model development. Description: Description registered when creating a data source. Service: Output registered data source types. The following data source types are available for output. - DB - SapRfc - X-UP - Cobol - WebService - UDDI - OpenApi - X-POP - OData |
2 | Action Buttons | New: Create a new data source. Edit: Edit an existing data source. Remove: Delete a selected data source. Copy as: Copy the selected data source. Import: Import an external data source. Export: Export and save all registered data sources in an .xml file format to the desired directory (backup). |
3 | Preview | Preview a selected data source's detailed information. |
Defining Data Sources in X-UP Builder Preferences
Go to [Window > Preferences…] and run the Preferences Wizard.
Select [DataSource] from the [X-UP] menu to display the data source configuration screen.
Click the [New] button to define a new data source.
As shown in the above image, a defined data source can be copied in an X-UP project. Click the [Copy From…] button in the [Define DataSource] window of the New X-UP Model Wizard, and copy a data source defined in [Preferences].
Compiler Version Change
JRE version 1.6 is used in X-UP Builder. The user can change the compiler version in X-UP Builder as shown below.
The following instructions explain how to change the compiler version to 1.5 using the Preferences Wizard in X-UP Builder.
Go to [Window > Preferences…] and run the Preferences Wizard.
Click [Compiler] from the [Java] menu.
Select "1.5" from the [Compiler compliance level] drop-down menu under JDK Compliance, and then click the [Apply] button.