Introduction

Aimed at reporting specialists, the advanced mode provides more detailed control over the ad hoc orders as well as scheduled orders. It allows users to directly view and edit the JSON representation of an order. This page provides an in depth description along with many examples on how the advanced mode can be used.

Using the Advanced Mode

In the detail view of a scheduled order or in the ad hoc order, click the tab advanced mode. You now see the JSON representation of the order. The editor provides several features to help with the editing process:

• Mismatched brackets, commas etc. are highlighted.

• Alt+Shift+F formats the order.

• Extended search functionality. Click on the editor field to make sure it is focused. Then, press CTRL+F

Example Orders

Simple ad hoc order

{
  "reportType": "sample_TwoPager",
  "outputFormat": "pdf",
  "parameters":{
      "portfolioId": "E0002",
      "reportingDate": "2019-03-31",
      "reportLanguage": "en"
  }
}

Simple manually scheduled order

• orderType = manual

• orderStatus and orderName are set

{
  "reportType": "sample_TwoPager",
  "outputFormat": "pdf",
  "orderType": "manual",
  "parameters": {
    "reportLanguage": "en",
    "portfolioId": "E0002"
  },
  "orderStatus": "active",
  "orderName": "E0002 monthly two pager EN"
}

Simple automatically scheduled order

• orderType = scheduled and has scheduling property.

• orderStatus and orderName are set

{
  "reportType": "sample_TwoPager",
  "outputFormat": "pdf",
  "orderType": "scheduled",
  "scheduling": {
    "availabilities": [
      {"availability": "eventDriven"}
    ],
    "frequency": "monthly",
    "startDate": "2018-01-01"
  },
  "parameters": {
    "reportLanguage": "en",
    "portfolioId": "E0002"
  },
  "orderStatus": "active",
  "orderName": "E0002 monthly two pager EN"
}

Order scheduled once

Automatic scheduled order but:

• start and end date are set to the same day

• frequency = daily

{
  "reportType": "sample_TwoPager",
  "outputFormat": "pdf",
  "orderType": "scheduled",
  "scheduling": {
    "availabilities": [
      {"availability": "eventDriven"}
    ],
    "frequency": "daily",
    "startDate": "2018-01-01",
    "endDate": "2018-01-01"
  },
  "parameters": {
    "reportLanguage": "en",
    "portfolioId": "E0002"
  },
  "orderStatus": "active",
  "orderName": "E0002 monthly two pager EN"
}

Batch Orders

The advanced mode allows a greater deal of flexibility for batch orders. In the JSON representation, some properties in an order can be “starred“, i.e. postfixed with *. These are the properties that cause the batch orders to yield multiple reports. In simple cases this can easily be set up using the default mode, for example when creating the same report for multiple portfolioIDs and languages. What is unique to the JSON representation, is that multiple sets of parameters can be configured with parameters*. This allows for a fine granular configuration for each of the resulting reports.

Batch Order Rules

There are three simple rules: 

1. Any property name ending in a star * is an array which implies multiple (sub-)orders, with the (star-less) property iterated over its elements.

2. If both "parameters" and "parameters*" are present, each element of "parameters*" produces one orders with "parameters" merged in (or multiple ones, if sub-parameters are also starred) .

3. The orders and executions created correspond to the cross product of all properties ending in a star.

Batch Order Examples

Simple batch order example

Batch order with multiple portfolioIDs and languages. The following order creates 6 executions.

Introduction

Aimed at reporting specialists, this page introduces concepts that can be used to utilize the full extent of Cinnamon’s parameters. This can be achieved by directly editing the JSON used internally to represent a report order.

Advanced mode

The advanced mode allows you to edit the full JSON representation of an order directly. If the JSON here is modified in a way that makes it invalid, e.g. by having mismatched brackets, Cinnamon will prevent you from saving the order. To enter the advanced mode, click the tab advanced mode in the detail view of a scheduled order or in the ad hoc order. The editor provides several features to help with the editing process:

• Mismatched brackets, commas etc. are highlighted.

• Alt+Shift+F formats the order.

• Extended search functionality. Click on the editor field to make sure it is focused. Then, press CTRL+F

To exit the advanced mode, click on the tab default view at the top. Any changes made in the advanced mode are also reflected in the default view.

Additional parameters

The setting “Additional parameters”, found in the default mode under Additional Settings > Other Customizations,contains a JSON of parameters that otherwise have no input field in the UI. This allows you to set arbitrary parameters. In the advanced mode, the parameters inserted using this setting can be found under parameters alongside the parameters that can be set in the UI. Conversely, if such an arbitrary parameter is added to parameters in the advanced mode, it will show up under Additional Parameters in default mode.

Parameters*

When using starred parameters in a batch order (e.g. portfolioId*, reportLanguage*), the result is a cross product of all values for those parameters. However, you may only want some of those combinations. To allow this, parameters* contains sets of parameters, rather than single values. Each of those parameter sets is treated like a single starred parameter. As an example, consider fund factsheets for a specific share class. Here, you may want to hide a particular section for retail clients but not for professional investors. Using parameters*, you can set this hide parameter to true only for retail clients. If a value is set under parameters*, the advanced mode has a corresponding property parameters*. It is also possible to directly insert this property parameters* in advanced mode.

Batch Orders in Depth

In the JSON in the advanced mode, some properties in an order can be “starred“, i.e. postfixed with *. This is equivalent to selecting multiple values for a property in default mode. These are the properties that cause the batch orders to yield multiple reports. In most cases this can easily be set up using the default mode, for example when creating the same report for multiple portfolioIDs and languages. If a more detailed configuration is required, parameters* can be used. Parameters* contains an array of JSON objects:

[
  {
    "portfolioId": "2041",
    "showTWR": false
  },
  {
    "portfolioId": "2044",
    "showTWR": true
  },
  {
    "portfolioId": "2090",
    "showTWR": true
  }
]

"parameters*" : [
  {
    "portfolioId": "2041",
    "showTWR": false
  },
  {
    "portfolioId": "2044",
    "showTWR": true
  },
  {
    "portfolioId": "2090",
    "showTWR": true
  }
]

There are three simple rules: 

1. Any property name ending in a star * is an array which implies multiple (sub-)orders, with the (star-less) property iterated over its elements.

2. If both "parameters" and "parameters*" are present, each element of "parameters*" produces one orders with "parameters" merged in (or multiple ones, if sub-parameters are also starred) .

3. The orders and executions created correspond to the cross product of all properties ending in a star.

Examples: Different Kinds of Orders

Ad hoc vs. stored orders

{
  "reportType": "sample_TwoPager",
  "outputFormat": "pdf",
  "parameters":{
      "portfolioId": "E0002",
      "reportingDate": "2019-03-31",
      "reportLanguage": "en"
  }
}

{
  "reportType": "sample_TwoPager",
  "outputFormat": "pdf",
  "orderType": "scheduled",
  "scheduling": {
    "availabilities": [
      {"availability": "eventDriven"}
    ],
    "frequency": "monthly",
    "startDate": "2018-01-01"
  },
  "parameters": {
    "reportLanguage*": ["de", "en"],
    "portfolioId*": ["E0002", "E0001"]
  },
  "orderStatus": "active",
  "orderName": "E0002 monthly two pager EN"
}

Manual vs. Automatic Scheduling vs. Once

{
  "reportType": "sample_