Skip to main content
Skip table of contents

SAP CPI Unit Test

SAP CPI Unit Test is a test that will integration flow using SAP CPI Simulation capability. It will perform validation of the simulation outbound result. This type of test can be performed on not deployed artifact.

This test type is only available for NEO SAP CPI tenants

Top of the screen with Automation Object (AO) ID, description and test type.

Basic Information

Parameter name

Description

Example

Integration flow

SAP CPI integration flow ID

PurchaseOrder_Out

CPI: Simulation Start Point

block name that the input payload should be injected

CPI: Simulation End Point

block name that the result payload should be verified


Execution Settings

In this section there are common execution settings for all test cases.

image-20250326-214543.png

Debug Log
This feature enables additional debugging messages to be included in the test execution log. Typically, this option is disabled, as a log with debugging information can become cluttered with details unnecessary for standard test execution. However, it proves invaluable during the initial phases of working with Int4 Suite, as it provides insights into each unsuccessful run and aids in identifying and resolving connectivity and security issues.

Display Wait Popup Before Validation
In specific scenarios, there may be a need for manual intervention between the message injection by Int4 Suite and the readiness for test validation. For instance, when an XML message is injected into SAP CPI, mapped to an IDoc, and subsequently transferred to SAP S/4, the IDoc may be processed automatically by the backend. However, certain configurations could hinder this automatic processing. In such cases, the tester must log into S/4 to manually request IDoc processing. The wait popup feature facilitates this by allowing Int4 Suite to send the message and display a popup before commencing backend data validation. This gives the tester time to complete the IDoc processing, return to Int4 Suite, and confirm the popup. Only after this confirmation will Int4 Suite proceed with data validations.

Delay Between Execution and Validation
Similar to the wait popup feature, these options allow for a delay to be configured between the initiation of the test run and/or between the injection of test case data and the validation of results. If it is anticipated that backend processing or integration platform mapping may require a considerable amount of time, this section allows for the configuration of such delays. As a result, Int4 Suite will pause before attempting to validate the integration platform and/or the backend, depending on the type of test being executed.


Variables

Variables are the container for values that can be used during testing. Each variable contains two values, the one that is calculated based on the reference message/document and the one that is calculated ad-hoc during test case execution.

There are various scenarios where variable processing can be beneficial:

  • Updating document/message content before test execution

  • Capturing data from document/message content after execution

  • Matching documents based on variable content

  • Passing data between test cases

For more details on Variables and their processing, read here: Variables & Variable processing

image-20250418-083747.png

Create button allows variable creation.

Parameter name

Description

Example

Name

Variable technical name

VARIABLE_1

Description

Free text for variable description

Variable One

Type

Type of variable processing

Read & Replace

Find message

Custom

Scope

Variable scope

  • Test case - variable is processed for every test execution

  • Test run - variable is processed only once within a test run

Test Case

Private

Specifies that the variable is not accessible to child test cases

Local Scripts

Local Scripts enable you to define custom scripts that are available within the context of the current Automation Object.

These scripts can be utilized in the following areas:

  • Variable Processing

  • Payload Processing

  • Custom Validations

Please consult the Int4 Aster Documentation for details on the scripting language.

image-20250418-091020.png


Payload Validations

Output payloads after processing by integration platform are validated against previously stored references.

The basic test execution in Int4 Suite will compare the messages (reference and current execution) and report any differences as errors, causing the test to fail. While this may be acceptable for some migration scenarios, not all message differences are errors; some discrepancies are even expected.

This configuration enables adding rules with exceptions that will allow for differences like document numbers, current time and date and others.

Parameter name

Description

Example

Description

Free text for the exception rule

Field1

Expression Type

Expression type. Available options:

  • unspecified

  • XPath

  • Flat expression

This field is optional for all interfaces where there is a single type of output. However, for interfaces that output might be both XML and flat file, it is mandatory to specify the expression type, then it would be only apply to specific file format (XML/JSON or flat file)

XPath

Expression

Path pointing to the field/node where the exception should be applied.

Available syntaxes: XPath, JSONPath, Int4 Flat File Syntax or REGEX

JSONPath and XPath are well-known and popular standards for structured data manipulation. You can find a lot of references and educational material on-line. Worth noting are the testing tools that allow You to experiment with XPath or JSONPath definitions. See here:

Please note that Int4 does not maintain these tools and can’t guarantee for their accuracy.

//ORDER/DATE/text()  (XPATH expression) or START_TAG(BGM+220+)&&END_TAG(+)&& (Flat file expression) or
$.order.date (JSONPath expression) or
REGEX(BGM\+220\+(.*)\+) (REGEX expression)

Rule

Says how the difference should be marked

  • Warning
    Marks the compared fields with yellow color as a "warning".

  • Warning when different based on variable replacement
    In case compared values are different Int4 Suite compares them with specified variable. If reference/current value pair from comparison matches variable values result is marked as "warning".

    Variable name used for checking the values has to be specified in the Processing Parameter column.

  • Warning when different based on value mapping object
    In case compared values are different Int4 Suite compares them with specified values in the Mapping Object. If reference/current value pair from comparison matches mapping values result is marked as "warning".

    Mapping Object name used for checking the values has to be specified in the Processing Parameter column.

  • Ignore
    Even if it is different in the content, it is not highlighted.

  • Change Request
    The difference will be highlighted green in the test report.

Change Request rule are active only when Test Case is run within Test Run type: Change Request Test

 

Parameter

Additional parameter for rules

 

Custom Validations

Custom Validations offer enhanced flexibility for evaluating test case results by allowing the implementation of custom logic using ASTER Scripts.

image-20250418-090503.png

Within the script, you can access test execution data using built-in Int4 Suite functions such as:

  • GET_TC_VAR – to retrieve test case variables

  • GET_VALIDATION_PAYLOADS – to access payloads used during validation

For the test case to be marked as successful, the script must return a _TRUE_ value.


Number Ranges

Int4 Suite uses own number ranges for data processing needs. Quite often, when sending test data to test systems again and again, the message can’t be exactly the same. For example, sending the same purchase order to generate sales order in S/4 could result in an error, if the system is configured to treat such situations as duplicates. Also, having a specific data field in the document might be mandatory to find another document - e.g. by generating an unique PO number for the Sales Order, we can find the newly created Sales Order in the database. The actual mechanics for such replacements of original document numbers or other values is described in the section Variables & Variable processing.

Below you will find information how to create a new number range.

The number range used to replace the source system document number should always be configured to not overwrite the original numbers. It means that documents generated by Int4 Suite should have their own subset of the original document number. Usually, it might be a subset of the upper limit of the original number range.

It is essential that automated testing with Int4 Suite doesn’t consume numbers that the source system will generate during manual testing. Additionally, if testing environment data is refreshed from the production system, more documents would be created in the testing environment. If the Int4 Suite number were configured in the same range, it would start creating duplicates.

For example, the original number range for document numbers from the source system is 560000 - 590000. It would be wise to set the Int4 Suite number range from 590000 to 600000. However, suppose the SAP backend system uses an external number range. It is essential to stay in the original range. In that case, the Int4 Suite number range may be set as 585000-590000, which gives space for 5000 testing documents. Using range from upper interval reduces the risk that the number will be overwritten.

Additionally, the good practice is to use prefixes or suffixes that will quickly separate source system documents and the ones created by Int4 Suite. It should always be used when there is no document number validation by the SAP backend.

Each Object Definition can contain an unlimited number of number ranges. This way, each variable declared in an object can use its specific number range.

Parameter name

Description

Example

Number range

Provide a name for the number range. This name would be passed as a parameter in variable processing for actions that will generate values from it.

NUM_RAN

Prefix

The alphanumeric characters to be appended at the beginning of the document number to separate original documents from source systems and the one created during Int4 Suite testing (optional).

INT4_

Low value

The first number of our range.

1

High value

The last number of our range.

999999

Current value

When the number range is used during testing, it would increment per each use.

23

Suffix

The alphanumeric characters to be appended at the end of the document number to separate original documents from source systems and the one created during Int4 Suite testing (optional).

_TEST

Add zeros

If this box is checked, zeros will be automatically appended to the beginning of the document number, such as 000500.

 

Incr. per Test Run

If this indicator is selected, the number range is incrementing once per test run. If multiple test cases with the same Automation Object exist in the test run, they will receive the same value.

 


Data Scrambling

Data scrambling enables to reduce or remove GDPR, privacy and security concerns when it comes to testing. When Int4 Suite is extracting the test data from existing messages or reports testing results, the visibility and availability of sensitive data could be an issue. To avoid this issue, sensitive data can be scrambled. Scrambling can occur at test case creation time and during the test execution. Actual behaviour of the scrambling engine is configured by a set of rules.

Parameter name

Description

Example

Rule Type

Rule type. Available options:

  • Test Case Creation - in case you want to scramble data during the creation of a test case

  • Runtime - in case you want to scramble data during runtime - when the interface is executed, and additional data is loaded to test case data.

Test Case Creation

Rule

Free text to specify scrambling rule name for identification.

NAME

Method

Choose a scrambling method from a list. Available methods:

  • CONSTANT Replace value with constant
    The current value will contain the constant passed in the parameter. The constant should be provided as is without any brackets.

  • GUID Generate GUID

    Generate random value in a GUID format. 

  • RANDOM Generate a random value

    Generates a random value. The value of the parameter defines the upper limit of the range. It is also possible to generate negative numbers. For example, passing -100 in parameter will generate random numbers from -1 to -100

  • HASH create a hash based on value
    Calculates a hash based on the given value using algorithm passed in parameter (default 'SHA1').

  • MASK - replace each character with constant
    Replace each character with a constant passed in parameter. For example, passing X in the parameter will replace scrambled data with X signs.

  • CUSTOM - create custom method
    create a CUSTOM method (implementing an interface /INT4/IFTT_IF_DATA_SCRMBL_METH).

HASH

Expression Type

Expression type. Available options:

  • unspecified

  • XPath

  • Flat expression

This field is optional for all interfaces where there is a single type of output. However, for interfaces that output might be both XML and flat file, it is mandatory to specify the expression type.

XPath

Expression

Path pointing to the field/node where the exception should be applied.

//ORDER/DATE/text()  (XPATH expression) or

START_TAG(BGM+220+)&&END_TAG(+)&& (Flat file expression) or

$.order.date (JSONPath expression) or

REGEX(BGM\+220\+(.*)\+) (REGEX expression)

Parameter

Specify Additional Parameter suitable for a chosen scrambling method like X (for Mask method), SHA1 (for HASH Method)

Payload Matching

Some integration scenarios permit one-to-many mappings. In such cases, there might be no guarantee that the integration platform will prepare messages in the same order as the historical flow. Payload matching allows for comparing the payloads in the same order. The solution is to sort the messages before comparison.

Parameter name

Description

Example

Rule

Free text for rule name

Rule1

Expression Type

Expression type. Available options:

  • unspecified

  • XPath

  • Flat expression

This field is optional for all interfaces where there is a single type of output. However, for interfaces that output might be both XML and flat file, it is mandatory to specify the expression type.

XPath

Expression

Path pointing to the field/node where the exception should be applied.

//ORDER/DATE/text()  (XPATH expression) or

START_TAG(BGM+220+)&&END_TAG(+)&& (Flat file expression) or

$.order.date (JSONPath expression)

REGEX(BGM\+220\+(.*)\+) (REGEX expression)

Rule Type

Rule type. Available options:

  • Exact match - value from reference and current payload has to be the same

  • Variable - value from reference and current payload is compared based on variable values and variable replacement

  • Mapping object - value from reference and current payload is compared based on mapping object value replacement

 

Parameter

Additional parameter for Rule Type like Variable or Mapping Object name

 

Group

Free text grouping field.
All rules with from the same group have to be fulfilled to match payloads.
At least one group has to be fulfilled to match payloads.
Rules within group are linked with AND operator. Groups are linked with OR operator.

 

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.