Home
Macro Language Elements
The section contains detailed specifications for all 1010data Macro Language elements.
Blocks
Blocks allow users to reuse sections of Macro Language code and to parameterize values in that code for greater flexibility and power.
<signal>
Send a user-defined message to an end-user.

Macro Language Elements
The section contains detailed specifications for all 1010data Macro Language elements.
- Data Transformation
  Data transformation operations use functions and expressions to functionally alter tabular data. These operations take 0, 1, or 2 tables as input and produce a single table as a result.
- Blocks
  Blocks allow users to reuse sections of Macro Language code and to parameterize values in that code for greater flexibility and power.
  - Block basics
    A block is identified by a given name and can take any number of user-defined attributes, which act as variables within the block code.
  - Reusing blocks
    One of the most powerful features of the <block> statement is the way it allows for the reuse of Macro Language code.
  - Scalar expressions in 1010data
    Scalar expressions allow for the storage and access of individual variables and values in 1010data.
  - Nested block structures
    Block forms can be defined and/or called within the context of other block structures, providing a powerful and expressive mechanism for controlling query execution and behavior.
  - <block>
    Blocks of Macro Language code defined with <block> allow for parameterized variables, block-control forms, and code reusability.
  - <blocklet>
    Blocks of Macro Language code defined with <blocklet> allow for parameterized variables and block-control forms without defining a named block.
  - <call>
    The <call> element allows you to place a <block> of Macro Language code into the Macro Language query you are currently working in, but not access the encapsulating <block>'s variables.
  - <code>
    The <code language_="[LANGUAGE]"> block form expands into an inert <content type_="[LANGUAGE]"> form containing source code in the specified language. (Available as of version 11.09)
  - <data>
    Set a variable to a table value containing the data from executing a query.
  - <declare>
    <declare> can be included within a block or block definition to specify metadata about the block.
  - <defblock>
    A <defblock> is very similar to <block> code, except the Macro Language code associated with a <defblock> will not execute in the macro until it is referenced with an <insert> call.
  - <defop>
    <defop> allows for the creation of user-defined operations that contain complex logic or syntax, but can subsequently be expressed as a "standard" 1010data operation.
  - <def_gfun>
    <def_gfun> may be used to define new g_functions in the MDB expression language. (Available as of version 12.20)
  - <def_ufun>
    <def_ufun> may be used to define new user functions in the MDB expression language. (Available as of version 12.19)
  - <expand>
    The <expand> element allows you to expand a <block> of Macro Language code in the calling context, as well as access and modify variables from the outer scope.
  - <for>
    <for> creates a set of data transformation operations based on the variables and specifications of the construct.
  - <foreach>
    <foreach> creates a set of data transformation operations based on the items in a specified list.
  - <html>
    The <html> block form expands into an inert <content type_="html"> form containing an HTML string. (Available as of version 11.09)
  - <if>
    The <if> construct is used within block code to control what Macro Language code is included during expansion given a particular condition.
  - <import>
    The <import> element makes an entire <library> of <block> statements available to a macro.
  - <insert>
    The <insert> element allows you to place a <block> of Macro Language code into the Macro Language query you are currently working in, as well as access the encapsulating <block>'s variables.
  - <issue>
    <issue> is an expansion-control form that inserts the contents of an XML expression at a particular point in the query. (Available as of prod-9)
  - <itext>
    The <itext> block form expands into an inert <content type_="itext"> form. It is intended to contain text as well as certain styling attributes. (Available as of version 11.13)
  - <let>
    <let> is used within a <block>, or independently in place of a <block>, and can be used to assign new values to variables defined within the block or to define new variables.
  - <letseq>
    <letseq> is used within a <block>, or independently in place of a <block>, and can be used to assign new values to variables defined within the block or to define new variables. In addition, variables may be defined in terms of earlier variables in the same <letseq>.
  - <library>
    The <library> element contains an arbitrary number of <block> statements that can be used within a macro.
  - <pack>
    <pack> is a special operation that allows multiple values to be stored in a dictionary variable. The values are subsequently accessed via dot notation.
  - <query>
    Stores a set of MDB query operations and performs the calculations when results are required for use.
  - <quote>
    Delays expansion and execution of block code until needed. May be used in conjunction with <unquote> to then execute the code. Also allows for the insertion of Macro Language code into a variable that can be referenced. (Available as of prod-9)
  - <resource>
    The <resource> form may be used to define resources that exist in a unique namespace and are global to the session. (Available as of version 12.20)
  - <set>
    <set> is a special operation that allows for user-defined variables and for setting their values. Values may be constant or defined by a 1010data Macro Language query; however, all values set must be scalar.
  - <setv>
    <setv> is a special operation that allows for user-defined variables and for setting their values. Values may be constant or defined by a 1010data Macro Language query; however, all values set must be scalar.
  - <signal>
    Send a user-defined message to an end-user.
  - <switch>
    <switch> creates a set of conditional statements in which each condition triggers a specific response from the system.
  - <text>
    The <text> block form expands into a text string. (Available as of version 11.09)
  - <unquote>
    Carries out block code expansion on its contents. (Available as of prod-9)
- Application Development

`<signal>`

Send a user-defined message to an end-user.

Description

The <signal> returns a message defined by the QuickApp creator. The message is returned to all possible interfaces via a 1010data XML API transaction: [rc=1, msg="{@msg}"].

Syntax

<signal msg="[MESSAGE_TEXT]"/>

Attributes

msg: msg="" accepts the message that should be displayed to the end user.

Example

<base table="pub.demo.retail.item"/>
<block name="store_select" store_id="">
    <if test="{@store_id<1 | @store_id>3}">
      <then>
        <signal msg="That is not a valid store selection for this dataset"/>
      </then>
      <else>
        <sel value="store={@store_id}"/>
      </else>
    </if>
</block>