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
External interface functions
PUT

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 of HCL OneTest™ Server. You can find 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.
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 configuring runs for the different test types that are supported. You can also 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
    - External interface functions
      - DBLOOKUP
      - DBQUERY
      - DDEQUERY
      - EXIT
      - GET
      - JEXIT
      - PUT
      - RUN
      - RENAMEFILE
        The RENAMEFILE function renames the source file to that of the destination file. If the operation succeeds, the returned value is 0; if it fails, then an operating system-specific error number is returned.
      - HARDLINKFILE
        A hard link points or references to a specific space on the hard drive. Multiple files can be hard linked to the same space in the hard drive. If some data is changed on one of the hard linked files, all the other files reflect that change. The HARDLINKFILE function returns the hard link file's command status. On successful execution of this function: 0 is returned; on failure: an operating system-specific error code is returned.
      - SOFTLINKFILE
        A soft link points to a specific file, which in turn, references to a particular location on the hard drive. The soft link, also known as symbolic link is a second file that exists independently of its target. The SOFTLINKFILE function returns the soft (symbolic) link file's command status. On successful execution of this function: 0 is returned; on failure: an operating system-specific error code is returned.
      - COPYFILE
        The COPYFILE function copies the source file to the destination file. It returns the copy file command status. On successful execution of this function: 0 is returned; on failure: an operating system-specific error code is returned.
      - SLEEP
        The SLEEP function suspends the execution of the current map until the time-out interval elapses. The time-out or sleep interval is represented in milliseconds. On successful execution of this function: 0 is returned; on failure: -1 is returned.
    - 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.

PUT

The PUT function passes data to a target adapter.

Use PUT to route data within your map using one of the target adapters such as to a messaging system, a database, a file, and so forth.

When the PUT function is used in a map, the default OnSuccess action is adapter specific. The default OnFailure action is to rollback any changes made during map processing. The default Scope will be integral unless the map is defined to run in bursts (which is the case when one or more inputs have the FetchAs property set to Burst).

Syntax:: PUT (single-text-expression , single-text-expression , single-text-expression)
Meaning:: PUT (adapter_alias , adapter_commands , data_to_send_to_adapter)
Returns:: "None"

The adapter identified by adapter_alias is called using the specified adapter_commands and passing data_to_send_to_adapter as data to the adapter.

The PUT function is not processed if the third argument is zero-sized data or NONE.

To identify whether the function was successful, you can generally use the VALID function with the PUT function. However, for certain adapters such as E-mail and FTP, the success state is not known until after map completion and using the VALID function in such cases might consistently return "success".

Examples

This example illustrates a mapping situation in which a set of messages is being produced in the output (output card #1). However, the ultimate target for these messages is a message queue and the messages need to be placed on the queue one at a time.

To accomplish this, the first output card builds the set of messages and its Target is defined as Sink. So, this set of messages is constructed in memory, but is discarded after the map completes. A second output card, uses the following PUT function to put each output message (from output card# 1), individually, on the output queue.

Message(s) = PUT ("MQS", "-QMN myqueuemgr -QN chips_queue -T", PACKAGE (PaymentMessage:CHIPS_Payment_Message))

The first argument, MQS, identifies that the data is to be routed using the IBM WebSphere MQ (server) adapter.
The second argument, "-QMN myqueuemgr -QN chips_queue -T", provides the adapter commands needed by the adapter to put the message on the queue.
The third argument, PACKAGE, passes the data that is to be sent as the body of the message.

Related functions

FAIL
GET
LASTERRORCODE
LASTERRORMSG
VALID