Show TOC

 Using ModificationsLocate this document in the navigation structure

Use

In Web item Analysis, modifications allow you to influence how items are displayed and how they behave using modules.

You enter the modules using the Modification (MODIFICATION) parameter. If you are using more than one module, follow the sequence of the modules. Changed rows are passed on to subsequent modules for further processing.

A module is only called if it is active. The Active parameter can be used to active and deactivate modules at runtime.

Note

The default value for parameter Active is inactive, meaning that that module will not be called. Activate the parameter by specifying a module.

You can specify the modules for an output format so that the change in behavior only affects output in HTML, for example, and not output in PDF.

You can find a list of possible modules under Examples of Modules .

Structure

The parameters that a module can have depend on the module: The documentation for the modules describes which parameters are supported and their meaning. The following is a general description of the parameters.

Modification

Parameter Description

Modification (MODIFICATION)

You can use this parameter to specify one more modules that change the display or behavior of Web item Analysis.

Possible values:

  • None (NONE)
  • Single Module (MOD_SINGLE_MODULE)
  • Module List (MOD_MODULE_LIST)

None (NONE)

The default value is to use no modifications.

Single Module (MOD_SINGLE_MODULE)

This selection makes it possible to specify one single module.

Module List (MOD_MODULE_LIST)

This selection makes it possible to specify a list of single modules. The modules are called in the specified sequence, meaning that subsequent modules modify existing cells.

This means for example that the column widths can be defined first, and that comments can then be displayed in a given column.

Single Module

Parameter Description

Alias (MOD_ALIAS)

The Alias parameter makes it possible to enter a name. The name is displayed in the Web item parameters and simplifies identification of a module. The alias is particularly important for the Set Status of Module command if several modules are being used.

Active (ACTIVE)

The Active parameter defines whether a module is active or not. If it is not active, the table is not modified. You can use this parameter and the Set Status of Module command to activate or deactivate a modification at runtime.

Formats (MOD_TARGETS)

You use this parameter to define the formats for which the module is called.

  • All (ALL)
  • Selections (MOD_CLIENT_SELECTION)

If you choose Selections, all formats are displayed (HTML, PDF or CSV, for example). Each format can be activated individually. This means that a modification can only be used in certain formats.

Type (MOD_SELECT)

This parameter always has the value Generic Module (MOD_GENERIC_MODULE). The details of this parameter are described below.

Generic Module

Parameter Description

Name of the Implementation (MOD_REFERENCE)

You use this parameter to specify the technical name of the module.

You can find a list of possible values under Examples of Modules .

Parameter List (MOD_PARAMETER_LIST)

The parameter list contains one or more parameters (PARAMETER). The parameters that can be used depends on the chosen module: The parameters are generic and can be used flexibly. Selecting the type makes specific input help possible. The details for a parameter are described below.

Parameter

Parameter Description

Name/Expression (MOD_PARAM_NAME)

You use this parameter to specify the technical name of a parameter.

You can find the possible values in the documentation for the individual modules. As well as technical names, modules can support simple expressions.

Value (MOD_PARAM_VALUE)

The value of a parameter has a certain type. Depending on this type, a value can be specified.

The following types are supported:

  • None (NONE)
  • String (STRING)
  • Boolean (BOOLEAN)
  • Integer (INTEGER)
  • Image (IMAGE)
  • Action (ACTION)
  • Data Provider (DATA_PROVIDER_REF)
  • Characteristic (CHARACTERISTIC)
  • Characteristic Value (CHARACTERISTIC_MEMBER)
  • Structure (STRUCTURE)
  • Structure Value (STRUCTURE_MEMBER)
  • Attribute Name (INFO_OBJECT_ATTRIBUTE)
  • Data Cell (DATA_CELL)
  • Array (MOD_VALUE_ARRAY)

Selecting a type makes specific input help possible for each type.

If Action is selected, the command wizard starts. If Data Provider is selected, all data providers in the Web template are displayed.

Note

In some cases, the generic input help does not provide the required values. Whenever this happens, you need to enter the technical name manually. You can use Query Designer to find the technical names of structures, structural components and so on.

Placeholder List (MOD_PLACEHOLDER_LIST)

With some modules, it is necessary to specify more than one value. You can use the placeholder list to do this.

The Name/Expression parameter can contain placeholders that are replaced with the values in the placeholder list.

The values in the placeholder list also have a type. The available types are described under the Value parameter (MOD_PARAM_VALUE).