Defining Service Output - 23.1

Spectrum Dataflow Designer Guide

Version
23.1
Language
English
Product name
Spectrum Technology Platform
Title
Spectrum Dataflow Designer Guide
First publish date
2007
Last updated
2024-05-09
Published on
2024-05-09T23:01:03.226155

The Output stage defines the output fields that the service or subflow returns. Follow the steps below to define the service output.

  1. Double-click the Output icon on the canvas. The Output Options dialog box appears. When you open the Output Options dialog box for the first time, a list of fields defined in the Input is displayed.
  2. To add a new field to the field list, click Add. The Add Custom Field dialog box appears. You can also modify or delete a custom field.
  3. Click Add again.
  4. Type the field name in the text box.
  5. Select the Data type and press OK. These data types are supported:
    bigdecimal
    A numeric data type that supports 38 decimal points of precision. Use this data type for data that will be used in mathematical calculations requiring a high degree of precision, especially those involving financial data. The bigdecimal data type supports more precise calculations than the double data type.
    boolean
    A logical type with two values: true and false.
    bytearray
    An array (list) of bytes.
    Note: Bytearray is not supported as an input for a REST service.
    date
    A data type that contains a month, day, and year. For example, 2012-01-30 or January 30, 2012. You can specify a default date format in Spectrum Management Console.
    datetime
    A data type that contains a month, day, year, and hours, minutes, and seconds. For example, 2012/01/30 6:15:00 PM.
    double
    A numeric data type that contains both negative and positive double precision numbers between 2-1074 and (2-2-52)×21023. In E notation, the range of values is -1.79769313486232E+308 to 1.79769313486232E+308.
    float
    A numeric data type that contains both negative and positive single precision numbers between 2-149 and (2-223)×2127. In E notation, the range of values -3.402823E+38 to 3.402823E+38.
    integer
    A numeric data type that contains both negative and positive whole numbers between -231 (-2,147,483,648) and 231-1 (2,147,483,647).
    list
    Strictly speaking, a list is not a data type. However, when a field contains hierarchical data, it is treated as a "list" field. In a list is a collection of data consisting of multiple values. For example, a field Names may contain a list of name values. This may be represented in an XML structure as:
    <Names>
        <Name>John Smith</Name>
        <Name>Ann Fowler</Name>
    </Names>
    It is important to note that the list data type different from the XML schema list data type in that the XML list data type is a simple data type consisting of multiple values, whereas the list data type is similar to an XML complex data type.
    long
    A numeric data type that contains both negative and positive whole numbers between -263 (-9,223,372,036,854,775,808) and 263-1 (9,223,372,036,854,775,807).
    string
    A sequence of characters.
    time
    A data type that contains the time of day. For example, 21:15:59 or 9:15:59 PM.

    You can also add a new, user-defined data type if necessary, and that new type can be a list of any defined data type. For example, you could define a list of names (string), or a new data type of addresses that includes AddressLine1 (string), City (string), StateProvince (string) and PostalCode (string). After you create the field, you can view the data type by accessing the Input Options dialog and pressing the button in the Data Type column. The Data Type Details dialog box will appear, showing the structure of the field.

  6. Click OK again.
  7. Click the check box next to Expose to select the check box of all fields in the field list. Selecting a field in the field list exposes it to the dataflow for stage operations. Click the check box again to clear the check box for all fields in the list. Clearing the check box of one or more fields in the field list and clicking OK deletes the field from the field list.
    Note: If you define hierarchical data in the input fields, you will not be able to import data or view the data vertically.
  8. Click OK to return to the canvas.