Configuration File
==================

Following properties are set in configuration file ``/etc/bobcat/config.yaml``.

Change config location in runtime by ``--config=../example/config.yaml``


``bobcat_sales``
    Bobcat Ticketing Batch Configuration
    `Bobcat Ticketing Batch Configuration <#bobcat-ticketing-batch-configuration>`__

``export``
    Export configuration
    `Export <#export>`__
``logging``
    Logging configuration
``purge``
    Purge configuration
    `Purge Configuration <#purge>`__

Bobcat Ticketing Batch Configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
``url``
    URL to ``sales`` service.

    **Default:** ``None``

``auth``
    Authorization.

    **Default:** ``None``

**Example**::

    bobcat_ticketing_batch:
      url: http://localhost:8080/bobcat/api/v1
      auth: basic:user1:test

Export
~~~~~~
``successful_runs_file_name``
    Successful runs file name.

    **Default:** ``None``
``transitive_dir``
    Transitive directory.

    **Default:** ``None``
``output_dir``
    Output directory.

    **Default:** ``None``
``version``
    Export data version.

    **Default:** ``None``

**Example**::

    export:
      successful_runs_file_name: successful-runs.csv
      transitive_dir: examples/export/transitive/default/
      output_dir: examples/export/output/default/
      version: v2

Purge
~~~~~
``output_dir``
    Transitive directory.

    **Default:** ``None``
``successful_runs_file_name``
    Successful runs file name.

    **Default:** ``None``
``purgers``
    Purgers definition list.
    `Purger <#purger>`__

**Example**::

    purge:
      output_dir: output/purge/
      successful_runs_file_name: successful-runs.csv
      purgers:
        - generator_class: bobcat_purge.purge.purge_batches:BatchesPurger
          config:
            break_flow_on_error: False
            dry_run: False
            batches:
              - client: bobcat_ticketing_batch
                endpoint: /batch/geo_data_removal

Purger
~~~~~~
``generator_class``
    Purge class to handle data removing.

    **Default:** ``None``

``config``
    Purge configuration data

    **Default:** ``None``

**Example**::

  generator_class: bobcat_purge.purge.purge_batches:BatchesPurger
  config:
    break_flow_on_error: False
    dry_run: False
    batches:
      - client: bobcat_ticketing_batch
        endpoint: /batch/geo_data_removal