Skip to content

Custom VBA macros via APIs

Introduction

CCH Tagetik provides public VBA APIs that can be used within the macros inserted in a form to automate operations such as opening a form, showing the mode in which a form was opened, and returning metadata on the form.

Parameter syntax

Run parameters can be specified in human-readable syntax. To save these elements, the system uses variable string and constant string VBA script. In the form, these variables can be used as arguments of run functions, or can be read automatically based on one or more cells of the current form.

An example of syntax specifying dynamic global filters is provided below:

Entity=A01;=*N1;CustDim2={DA,DB};

Global filters have the following particular features:

  • the individual filter on a lowest level element is assigned using the syntax DimensionName=LeafCode (without double inverted commas). The dimension name is equivalent to the name used in the corresponding cell fields (without the initial "$")
  • a hierarchy dimension is indicated between square brackets as
  • a filter on a node is indicated by adding an asterisk as a prefix
  • multiple filters are separated with a semicolon ";"
  • an OR clause of multiple filters is indicated between braces, with values separated by a comma ",".
  • to represent parameters (e.g. SP=2004C;PP=12)
  • the individual filter on an lowest level element is assigned using the syntax ParameterCode=LeafCode (without double inverted commas)
  • OR filter and filters on nodes are not permitted