This chapter explains the handling of exceptions occurring in X-UP and how to manage ErrorCode and ErrorMsg that can be processed in the Nexacro application callback.

Exception handling method

Describes the exception handling method when exceptions occur in Legacy, X-UP Model's Logic class, and X-UP Engine.

In the model above, if an exception occurs in the SAP RFC Invoke, it can be handled in the following manner.

When an exception occurs, the ErrorCode and ErrorMsg are transmitted

In case of an error occurring in the SAP RFC Invoke, and the exception is thrown to prevent further logic execution, but you wish to transmit a custom error code instead of the default error code (-1), you can do this by coding in the Exception tab of the SAP RFC Invoke

if(e instanceof AutomationFailException) {
	AutomationFailException exception = (AutomationFailException) e;
	exception.setErrorCode(-9999);
	throw exception;
} else {
	AutomationFailException exception = new AutomationFailException(e.getMessage(), e);
	exception.setErrorCode(-9999);
	throw exception;
}

How to ignore an exception when it occurs

How to create and throw an InvokeSkip Exception in the following cases

• When an error occurs and the invoke processing needs to be stopped to proceed to the next logic.

• When an exception occurs in the SAP RFC Invoke.

• When the logic after the SAP RFC Invoke should be stopped and immediately proceed with the UserMethod.

InvokeSkip invokeSkipException = new InvokeSkip(e.getMessage(), e);
throw invokeSkipException;

How to handle displaying ErrorCode and ErrorMsg on the UI

globalParameterSet.getParameter("ErrorCode").setValue(new Integer(-999));
globalParameterSet.getParameter("ErrorMsg").setValue("consumption data failed.");
InvokeSkip invokeSkipException = new InvokeSkip(e.getMessage(), e);

throw invokeSkipException;

How to throw an exception when an exception occurs

If an exception occurs during the Invoke process and you do not want the model's logic to continue, no special handling is required. The exception will automatically prevent further execution and output the error.

How to handle ErrorCode and ErrorMsg

Describes how X-UP handles ErrorCode and ErrorMsg for processing in the Callback Function of Nexacro application

When ErrorCode and ErrorMsg are not handled

If the developer does not handle it separately, X-UP processes it as follows.

• Normal Processing

  • ErrorCode: 0

  • ErrorMsg: Blank

• When an Exception Occurs

  • ErrorCode: -1

  • ErrorMsg: [Requested Model Information] + [System Error Code] + Exception Message

How to handle ErrorCode and ErrorMsg

The ErrorCode and ErrorMsg in the model's logic are handled as follows

1. Define Variables Named ErrorCode and ErrorMsg Within the Model

2. Assign Desired ErrorCode and ErrorMsg Values to Variables in UserMethod or Exception Handling Sections

globalParameterSet.getParameter("ErrorCode").setValue(new Integer(-999));
globalParameterSet.getParameter("ErrorMsg").setValue("consumption data failed.");

Additional Exception Handling for Modify Invoke

• RowSkip: Applicable only to Modify Invoke. If an exception occurs while processing a specific row during row-level processing, the exception for that row is ignored, and the next row is processed.

The following is an example of RowSkip.

throw new RowSkip("ignore exception", e);

The onExceptionOccured(ParameterSet globalParameterSet, Throwable e, InvokingErrorInfo errInfo) method is invoked when an exception occurs during the execution of an Invoke.

The following describes the parameters of the onExceptionOccured method

• globalParameterSet: A ParameterSet containing all parameters required for the Invoke process and those retrieved from the data source.

• e: The exception that occurred during the execution of the logic.

• errInfo: An object containing detailed information about the exception.