Items Render that contains File Render

Prerequisites

Modules

• osp-web

git checkout origin/osp-web-configuration .

Vscode extension

• osp-composer

Example configuration

git checkout origin/example-template-playbook-itemsrender-contain-filesrender .

Description

This example demonstrates how to include marked files File Render directly into a target of type Items Render. Target conversion is described here here.

Example

1. Create an Inventory

This inventory contains the definition of two sites.

source;destination;rule;variable-dashboardName;variable-advancedView;
templates.sources;root.fribourg;;Fribourg;true
templates.sources;root.lausanne;;Lausanne;false

2. Define a playbook

This playbook define one generation rules of type Items Render who take the source definition from templates/inventory/data.csv

[
    {
        "type": "ItemsRender",
        "source": "templates/inventory/data.csv",
        "fileRenderContext": {

        }
    }
]

Here we can see that there is no additional context injected using fileRenderContext. But all variables defines in inventory are expose by default in context of FileRender. This mean that FileRender has a variable advanceView that will be true when rendering Items Fribourg and false when rendering Lausanne.

3. Create the dashboard

The file use a variable named dashboardName that is defined in Inventory.

templates/sources/dashboard/dashboard.view.nunjucks

  "configuration": [
    {
      "type": "Text",
      "id": "bM8TpZoD",
      "title": "{{ dashboardName }}",
      "textWidgetSettings": {
        "text": "{{ dashboardName }}"
      }
    }
    {% if advancedView %}
    ,{
      "type": "Text",
      "id": "bM8TpZoD1",
      "title": "{{ dashboardName }}",
      "textWidgetSettings": {
        "text": "{{ dashboardName }}"
      }
    }
    {% endif %}
  ],
  "layout": {
    "lg": [
      {
        "w": 6,
        "h": 1,
        "x": 0,
        "y": 0,
        "i": "bM8TpZoD"
      }
      {% if advancedView %}
      ,{
        "w": 6,
        "h": 1,
        "x": 0,
        "y": 0,
        "i": "bM8TpZoD1"
      }
      {% endif %}
    ]
  },

On top of that, variable advanceView will once add a second text widget during Fribourg generation and once hide the second widget when generating Lausanne.

4. Execute the playbook

Generate the playbook template with one of the given command :

• Playbook template [execute-all]

• Playbook template [execute a unique target] and select the example.playbook then press enter.

5. Push the configuration

Warning

Always use the command [execute-all] before pushing to be sure that there is no file auto-generated who are not used anymore (example a csv line is deleted).

git add .
git commit -m "Add two example dashboard"
git push

6. Visualize the result

On the following image, we see two dashboard named automatically from inventory. On top of that, we see that one of them has on more widget.