Home
Macros for HCL Unica
Macros can be used in Unica Campaign and Unica Interact to enhance your flowcharts.
Macros Reference
This section describes each available macro that is available for use in Campaign, Interact, or both. Macros are listed in alphabetical order.
EXTERNALCALLOUT macro
The EXTERNALCALLOUT macro is available only in Unica Interact.

Macros for HCL Unica
Macros can be used in Unica Campaign and Unica Interact to enhance your flowcharts.
- Using Macros in Unica Campaign
  This chapter provides usage information about Unica Campaign macros. Be sure to read this chapter before you attempt to use macros in Unica Campaign.
- Using macros in Unica Interact
  This chapter provides usage information about Unica Interact macros. Be sure to read this chapter before you attempt to use macros in Unica Interact.
- Macros Reference
  This section describes each available macro that is available for use in Campaign, Interact, or both. Macros are listed in alphabetical order.
  - Valid Format Keywords
    The following table shows the keywords for valid formats, with a description and example of each.
  - ABS macro
    The ABS macro is available only in Unica Campaign.
  - ACOS macro
    The ACOS macro is available only in Unica Campaign.
  - ACOT macro
    The ACOT macro is available only in Unica Campaign.
  - ADD_MONTHS macro
    The ADD_MONTHS macro is available in Unica Campaign. For ORACLE, DB2 and MSSQLServer databases execution is preferred on the database instead of Campaign Server.
  - AND macro
    The AND macro is available in Unica Campaign and Unica Interact.
  - ASIN macro
    The ASIN macro is available only in Unica Campaign.
  - ATAN macro
    The ATAN macro is available only in Unica Campaign.
  - AVG macro
    The AVG macro is available in Unica Campaign and Unica Interact.
  - BETWEEN macro
    The BETWEEN macro is available only in Unica Campaign.
  - BIT_AND
    The BIT_AND macro is available in Unica Campaign and Unica Interact.
  - BIT_NOT
    The BIT_NOT macro is available in Unica Campaign and Unica Interact.
  - BIT_OR
    The BIT_OR macro is available in Unica Campaign and Unica Interact.
  - BIT_XOR
    The BIT_XOR macro is available in Unica Campaign and Unica Interact.
  - CEILING macro
    The CEILING macro is available only in Unica Campaign.
  - COLUMN macro
    The COLUMN macro is available only in Unica Campaign.
  - COS macro
    The COS macro is available only in Unica Campaign.
  - COSH macro
    The COSH macro is available only in Unica Campaign.
  - COT macro
    The COT macro is available only in Unica Campaign.
  - COUNT macro
    The COUNT macro is available only in Unica Campaign.
  - CURRENT_DATE macro
    The CURRENT_DATE macro is available in Unica Campaign and Unica Interact.
  - CURRENT_DAY macro
    The CURRENT_DAY macro is available in Unica Campaign and Unica Interact.
  - CURRENT_JULIAN macro
    The CURRENT_JULIAN macro is available only in Unica Campaign.
  - CURRENT_MONTH macro
    The CURRENT_MONTH macro is available in Unica Campaign and Unica Interact.
  - CURRENT_TIME macro
    The CURRENT_TIME macro is available only in Unica Campaign.
  - CURRENT_WEEKDAY macro
    The CURRENT_WEEKDAY macro is available in Unica Campaign and Unica Interact.
  - CURRENT_YEAR macro
    The CURRENT_YEAR macro is available in Unica Campaign and Unica Interact.
  - DATE
  - DATE_FORMAT macro
    The DATE_FORMAT macro is available in Unica Campaign and Unica Interact.
  - DATE_JULIAN macro
    The DATE_JULIAN macro is available only in Unica Campaign.
  - DATE_STRING macro
    The DATE_STRING macro is available only in Unica Campaign.
  - DAY_BETWEEN macro
    The DAY_BETWEEN macro is available only in Unica Campaign.
  - DAY_FROMNOW macro
    The DAY_FROMNOW macro is available only in Unica Campaign.
  - DAY_INTERVAL macro
    The DAY_INTERVAL macro is available only in Unica Campaign.
  - DAYOF macro
    The DAYOF macro is available only in Unica Campaign.
  - DISTANCE
    The DISTANCE macro is available in Unica Campaign and Unica Interact.
  - DIV macro
    The DIV macro is available in Unica Campaign and Unica Interact.
  - EQ macro
    The EQ macro is available in Unica Campaign and Unica Interact.
  - EXP macro
    The EXP macro is available only in Unica Campaign.
  - EXTERNALCALLOUT macro
    The EXTERNALCALLOUT macro is available only in Unica Interact.
  - FACTORIAL macro
    The FACTORIAL macro is available only in Unica Campaign.
  - FLOOR macro
    The FLOOR macro is available only in Unica Campaign.
  - FORMAT macro
    The FORMAT macro is available in both Unica Campaign and Unica Interact (from version 12.1.1).
  - FRACTION macro
    The FRACTION macro is available only in Unica Campaign.
  - GE macro
    The GE macro is available in Unica Campaign and Unica Interact.
  - GET macro
    The GET macro is available in Unica Interact.
  - GROUPBY macro
    The GROUPBY macro is available only in Unica Campaign.
  - GROUPBY_WHERE macro
    The GROUPBY_WHERE macro is available only in Unica Campaign.
  - GT macro
    The GT macro is available in Unica Campaign and Unica Interact.
  - IF macro
    The IF macro is available in Unica Campaign and Unica Interact.
  - IN macro
    The IN macro is available in Unica Campaign and Unica Interact.
  - INCLUDE macro
    The [NOT] INCLUDE macro is available in Unica Interact.
  - INT macro
    The INT macro is available only in Unica Campaign.
  - INVERSE macro
    The INVERSE macro is available only in Unica Campaign.
  - IS macro
    The IS macro is available in Unica Campaign and Unica Interact.
  - ISERROR macro
    The ISERROR macro is available only in Unica Campaign.
  - ISODD macro
    The ISODD macro is available only in Unica Campaign.
  - ISEVEN macro
    The ISEVEN macro is available only in Unica Campaign.
  - ISODD macro
    The ISODD macro is available only in Unica Campaign.
  - LE macro
    The LE macro is available in Unica Campaign and Unica Interact.
  - LIKE macro
    The LIKE macro is available in Unica Campaign and Unica Interact.
  - LN or LOG macro
    The LN or LOG macro is available only in Unica Campaign.
  - LOG2 macro
    The LOG2 macro is available only in Unica Campaign.
  - LOG10 macro
    The LOG10 macro is available only in Unica Campaign.
  - LOWER macro
    The LOWER macro is available in Unica Campaign and Unica Interact.
  - LT macro
    The LT macro is available in Unica Campaign and Unica Interact.
  - LTRIM macro
    The LTRIM macro is available in Unica Campaign and Unica Interact.
  - MAX macro
    The MAX macro is available in Unica Campaign and Unica Interact.
  - MEAN macro
    The MEAN macro is available in Unica Campaign and Unica Interact.
  - MIN macro
    The MIN macro is available in Unica Campaign and Unica Interact.
  - MINUS
    The MINUS macro is available in Unica Campaign and Unica Interact.
  - MOD macro
    The MOD macro is available in Unica Campaign and Unica Interact.
  - MONTHOF macro
    The MONTHOF macro is available only in Unica Campaign.
  - MULT macro
    The MULT macro is available in Unica Campaign and Unica Interact.
  - NE macro
    The NE macro is available in Unica Campaign and Unica Interact.
  - NOT macro
    The NOT macro is available in Unica Campaign and Unica Interact.
  - NUMBER macro
    The NUMBER macro is available in Unica Campaign and Unica Interact.
  - OR
    The OR macro is available in Unica Campaign and Unica Interact.
  - POSITION macro
    The POSITION macro is available only in Unica Campaign.
  - PLUS macro
    The PLUS macro is available in Unica Campaign and Unica Interact.
  - POW
    The POWER macro is available in Unica Campaign and Unica Interact.
  - RANDOM macro
    The RANDOM macro is available only in Unica Campaign.
  - RANDOM_GAUSS macro
    The RANDOM_GAUSS macro is available only in Unica Campaign.
  - ROUND macro
    The ROUND macro is available only in Unica Campaign.
  - ROWNUM macro
    The ROWNUM macro is available only in Unica Campaign.
  - RTRIM macro
    The RTRIM macro is available in Unica Campaign and Unica Interact.
  - SIGN macro
    The SIGN macro is available only in Unica Campaign.
  - SIN macro
    The SIN macro is available only in Unica Campaign.
  - SINH macro
    The SINH macro is available only in Unica Campaign.
  - COUNT_DIM macro
    The COUNT_DIM macro is available in Unica Interact.
  - SORT macro
    The SORT macro is available in Unica Interact.
  - SQRT macro
    The SQRT macro is available only in Unica Campaign.
  - STDV or STDEV macro
    The STDV or STDEV macro is available in Unica Campaign and Unica Interact.
  - STRING_CONCAT macro
    The STRING_CONCAT macro is available in Unica Campaign and Unica Interact.
  - STRING_HEAD macro
    The STRING_HEAD macro is available only in Unica Campaign.
  - STRING_LENGTH macro
    The STRING_LENGTH macro is available only in Unica Campaign.
  - STRING_PROPER macro
    The STRING_PROPER macro is available only in Unica Campaign.
  - STRING_SEG macro
    The STRING_SEG macro is available only in Unica Campaign.
  - STRING_TAIL macro
    The STRING_TAIL macro is available only in Unica Campaign.
  - SUBSTR or SUBSTRING macro
    The SUBSTR or SUBSTRING macro is available in Unica Campaign and Unica Interact.
  - SUM macro
    The SUM macro is available in Unica Campaign and Unica Interact.
  - TAN macro
    The TAN macro is available only in Unica Campaign.
  - TANH macro
    The TANH macro is available only in Unica Campaign.
  - TOTAL macro
    The TOTAL macro is available in Unica Campaign and Unica Interact.
  - TRUNCATE macro
    The TRUNCATE macro is available only in Unica Campaign.
  - UPPER macro
    The UPPER macro is available in Unica Campaign and Unica Interact.
  - VARIANCE macro
    The VARIANCE macro is available only in Unica Campaign.
  - WEEKDAY macro
    The WEEKDAY macro is available only in Unica Campaign.
  - WEEKDAYOF macro
    The WEEKDAYOF macro is available only in Unica Campaign.
  - XOR
    The XOR macro is available in Unica Campaign and Unica Interact.
  - YEAROF macro
    The YEAROF macro is available only in Unica Campaign.

EXTERNALCALLOUT macro

The EXTERNALCALLOUT macro is available only in Unica Interact.

Syntax

EXTERNALCALLOUT( calloutName,
arg1, ...)

Parameters

calloutName

The name of the callout you created using the ExternalCallout API. This name must match the name of the External Callout category you created in Platform.

arg1

An argument required by your callout, if required.

Description

EXTERNALCALLOUT enables you to call an external application to add data to your interactive flowchart. EXTERNALCALLOUT can return whatever you have created the callout to do. You must write this callout in Java™ using the ExternalCallout API. For more details, see the Unica Interact Administrator's Guide.

Examples

EXTERNALCALLOUT(getStockPrice, UNCA)

Calls the callout getStockPrice passing the name of the stock, UNCA, as the argument. This user defined callout returns the stock price as defined by the callout.

INDEXOF macro

The INDEXOF macro is an internal macro available only in Unica Interact. This macro is passed as a parameter in the EXTERNALCALLOUT macro. The macro gets added to EXTERNALCALLOUT with the start of server. No external configuration is required to use this macro.

Syntax

EXTERNALCALLOUT(‘indexOf’,dimension field expression)

Parameters

‘indexOf’

indexOf is passed as a predefined callout name in the EXTERNALCALLOUT macro. This parameter is mandatory and case insensitive.

Dimension field expression

An argument required by the ‘indexof’ callout. The users are required to pass a condition, which can involve multiple dimension table fields.

Description

‘indexOf’ macro provides the capability to query multiple dimension table fields. This macro returns the list of indexes satisfying the given condition for each customer. While creating an interactive flowchart, users can get records based on a given expression. The macro generates an error, if incorrect number of arguments are passed to it. In the event of any syntax errors, the error message is displayed while running the flowchart.

A syntax check does not validate these errors.

Examples

For the following dimension table Account_details, EXTERNAL_CALLOUT(‘IndexOf’, Account_details.AccountId>1000 AND account_details.Status=='G')

AccountId	Balance	Status
101	1100	G
102	800	G
103	1600	G
104	2100	G

The above expression using ‘INDEXOF’ returns a list containing indexes 1 and 4.

Have feedback?
Google Analytics is used to store comments and ratings. To provide a comment or rating for a topic, click Accept All Cookies or Allow All in Cookie Preferences in the footer of this page.