Welcome
Reference Guide
This guide describes conceptual information about data design environment components when you want to use the data fabrication feature in HCL OneTest™ Server.
Schema design
A schema is a graphical data dictionary that contains metadata definitions of the structure of a document to generate test data. Schema provides visual cues for understanding the structure and complete definition of an object.
Functions and expressions
Error handling functions
FAIL

Release Notes
This document includes information about What’s new, installation and upgrade instructions, known issues, and contact information of HCL Customer Support.
System Requirements
This document includes information about hardware and software requirements for HCL OneTest™ Server.
Getting Started Guide
This guide provides an overview and describes the task flows to get you started with HCL OneTest™ Server. This guide is intended for new users.
Administrator Guide
This guide describes how to install HCL OneTest™ Server software. After you install the software, you can perform administration tasks such as license configuration, user management, security, memory, and disk usage management, back up and restore user data. This guide is intended for administrators.
Test Author Guide
This guide describes how to create test assets in HCL OneTest™ Server and publish test assets to the Git repository that you have configured. This guide is intended for testers and test managers.
Test Execution Specialist Guide
This guide describes tasks that you must complete before you can configure and run tests in HCL OneTest™ Server. You can find information about other tasks that you can perform on the Resource Monitoring Service, Virtualization, and Integrations with third-party applications. This guide is intended for testers or test execution specialists.
Test Manager Guide
This guide describes how to manage and track your overall test effort. This guide is intended for test managers.
Reference Guide
This guide describes conceptual information about data design environment components when you want to use the data fabrication feature in HCL OneTest™ Server.
- Files
  You add a file to a project to use it as input in the project. You can upload a file from your local file system to a project from the Files tab to generate test data. Alternatively, you can upload it when you define an action.
- Connections
  A connection defines the properties that are required to connect to an external resource. An action uses a connection to provide source data to a project or write data from a source to a target. Multiple actions can use the same connection. You can define both connections and actions at the project level.
- Schema design
  A schema is a graphical data dictionary that contains metadata definitions of the structure of a document to generate test data. Schema provides visual cues for understanding the structure and complete definition of an object.
  - Introduction to schema design
    Use the Schemas tab to define, modify, and view schemas. A schema describes the syntax, structure, and semantics of your data.
  - Type properties
    The properties of a type define the characteristics of the data objects of that type.
  - Item restrictions
    Item restrictions are an optional feature you can use to specify valid or invalid data objects for an item type. Item restrictions are grouped into three categories: Value, Character, and Range.
  - Components
  - Partitioning
  - Type inheritance
  - Schema analyzer
  - Distinguishable objects
  - Functions and expressions
    - Expressions and evaluations
    - Using functions
    - Syntax of a function
    - Function argument syntax
    - Functions that convert character-set encoding to the native code page
    - General functions
    - Bidirectional functions
    - Bit manipulation and testing functions
    - Conversion functions
    - Date/time functions
    - Error handling functions
      - CONTAINSERRORS
      - FAIL
      - GETXMLERRORMSG
        Use this function on an output card to return an XML validation error message when a map runs against invalid XML input.
      - ISERROR
      - ONERROR
      - REJECT
      - QUIT
      - VALID
    - External interface functions
    - Inspection functions
    - Logical functions
    - Lookup and reference functions
    - Math and statistics functions
    - Text functions
    - XML functions
    - Custom functions
    - Date and time format strings
    - Number format strings
    - RUN function return codes
    - Character set codes for CPACKAGE, CSERIESTOTEXT, and CTEXT
Troubleshooting Guide
This guide describes how to analyze and resolve some of the common problems that you might encounter while you work with HCL OneTest™ Server.
All Guides (PDF)
You can find the link to view or download the content of the release notes, system requirements, and persona guides of HCL OneTest™ Server as a PDF file.
Security Considerations
This document describes the actions that you can take to ensure that your installation is secure, customize your security settings, and set up user access controls.
Notices
This document provides information about copyright, trademarks, terms and conditions for the product documentation.

FAIL

You can use the FAIL function to abort a map based on map or application specific logic.

Syntax:: FAIL (single-text-expression)
Meaning:: FAIL (message_to_return)
Returns:: "None"

The FAIL function returns "none" to the output to which the function is assigned, aborts the map, and returns message_to_return as the map completion error message included in the execution audit. The map return code will be "30", indicating that the map failed through the FAIL function.

Examples

AcctID = EITHER (LOOKUP (CustomerID:.:Xref , MyKey:.:Xref = ID:.:Input ) , FAIL ( "Unknown Customer (" + ID:.:Input + "). Processing Terminated." ) )
In this example, the FAIL function is being used in conjunction with the EITHER function to conditionally fail the map if a record in the customer cross-reference file does not exist for a given CustomerID.

For example, the ID in Input is ABC123. If the LOOKUP succeeds, the CustomerID result is assigned to AcctID and the map continues.

If the LOOKUP fails, AcctID is assigned a value of "none", the map aborts, and the message Unknown Customer (ABC123). Processing Terminated.is written to the execution audit log.
Message = VALID (RUN ("Map1Msg.mmc", "-AE -OMMSMQ1B `-QN .\aqueue -CID 2001'" ), FAIL ("Failure on RUN (" + TEXT (LASTERRORCODE ( ) ) + "):" + LASTERRORMSG ( ) ) )
In this example, the FAIL function is being used in conjunction with the VALID, LASTERRORCODE, and LASTERRORMSG functions to fail (abort) the map if the map executed by the RUN function (Map1Msg.mmc) fails. In this example, the map fails and returns the error code and error message reported by the RUN function using the LASTERRORCODE and LASTERRORMSG functions.

If Map1Msg fails because one or more of its inputs was invalid, Message is assigned a value of "none". The map aborts and the following message is reported in the execution audit log:

"Failure on RUN (8): One or more inputs was invalid."

Related functions

LASTERRORCODE
LASTERRORMSG
QUIT
VALID