.. _step-Jinja2Template:


Jinja2Template
==============

Transforms the incoming data using a defined Jinja2 template

.. versionadded:: 1.0.0

* **Friendly name:** ``Jinja Template Data Render``
* **Step class:** ``base_steps_syncpack.steps.Jinja2Template.Jinja2Template``
* **Step version:** ``1.0.0``
* **Required parameters:** ``template``

Parameters
----------

.. list-table::
   :header-rows: 1
   :widths: 22 16 8 16 38

   * - Name
     - Type
     - Required
     - Default
     - Description
   * - ``template``
     - jinja2 template
     - yes
     - --
     - The Jinja2 template to use for rendering desired data

Every step also accepts the platform parameters common to all steps --
see :ref:`platform-parameters`.

Dependencies
------------

* **Inherits from:** ``Jinja2Template`` -> ``BaseStep`` -> ``Serializable``
* **SyncPack modules:** ``base_steps_syncpack.util.steps_env_utils``
* **External packages:** ``ipaascommon``, ``ipaascore``, ``jinja2``

.. include:: /_step_notes/Jinja2Template.rst

API
---

.. autoclass:: base_steps_syncpack.steps.Jinja2Template.Jinja2Template
   :members:
   :show-inheritance: