<variable>

Name

Required

Description

name

yes

The required name for a variable, input parameter or output parameter. Parameter names must be unique within the scope of the mashup script. Names for variables must be unique within the scope of the mashup, if the variable has a global scope, or within the statement in which the variable is declared.

type

yes

The required data type for this variable. Valid values for this include:

boolean

date (deprecated, use datetime instead)

datetime

document (complex, structured data)

number

string

Any token that identifies a data type defined by a published mashable. Tokens are typically used for input or output parameters where the service has metadata for a named datatype.

schema, an extension type for dataset schemas used with the Real-Time Analytics Query Language. See RAQL Extensions for Dataset Schemas for more information.

variable:schema-type-variable-name, refers to variable of that name within the mashup that has a type of schema. This schema-type variable defines datatype and optional path or other information for the dataset in this variable.

This is an extension type for variables that hold datasets used with the Real-Time Analytics Query Language. See RAQL Extensions for Dataset Schemas for more information.

See also subtype.

subtype

Optionally further defines the datatype of a document-type variable. If subtype is not present, document-type variables are represented as well-formed XML.

Note:

Currently, subtype is only supported for parameters and variables for the <mashup>, <macro>, <directinvoke> and <raql> statements.

Valid subtypes include:

HTML

Setting subtype="HTML" can help prevent parsing errors for HTML results received from web sites or web services.

JSON

For web services that return JSON responses, setting subtype ensures that the JSON response is not converted to XML.

Note:

With responses left in JSON format, you cannot process the response with other EMML statements except <script> using JavaScript code. See Handling JSON Responses or Inputs for more information and examples.

CSV

This is an extension for datasets used with the Real-Time Analytics Query Language. See Supported Data Formats for RAQL for more information.

service

The optional name of the published mashable that has metadata defining the data type for this parameter or variable. This is required if the value of the type attribute is a token.

default

The optional, simple default value to use for this variable, input parameter or output parameter. You cannot set default values for document-type variables or parameters.

output-cdata-section-elements

A list of element names, separate by whitespace, whose text content should be wrapped in CDATA sections when output. For more information and examples, see Wrapping Results or Variables in CDATA Sections.

datafile

An extension attribute for use with other extensions from the Real-Time Analytics Query Language. See RAQL Extensions to <variable> for File Data Sources for more information.

stream

An extension attribute for use with other extensions from the Real-Time Analytics Query Language. See RAQL Extensions to EMML Statements for Streaming for more information.

Can Contain	Typically empty, but can contain text and any well-formed literal XML.
Allowed In	mashup \| catch \| else \| elseif \| for \| foreach \| if \| macro \| operation \| sequence \| try \| while