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

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

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


``append_new_data``
    If new data is to be appended.

    **Default:** ``False``
``bobcat_sales``
    Bobcat Sales Auth Configuration
    `Bobcat Sales Auth Configuration <#bobcat-sales-auth-configuration>`__
``bobcat_ticketing``
    Bobcat Ticketing Auth Configuration
    `Bobcat Ticketing Auth Configuration <#bobcat-ticketing-auth-configuration>`__
``bobcat_auth``
    Bobcat Auth Configuration
    `Bobcat Auth Configuration <#bobcat-auth-configuration>`__
``chunk_size``
    Size of chunk that will be fetched during export.

    **Default:** ``100``
``downloader``
    Downloader Configuration
    `Downloader <#downloader>`__
``end_date``
    End date of the export.

    **Default:** ``None``
``export``
    Export configuration
    `Export <#export>`__
``export_period``
    Export period in days (if specified will be added to the ``start_date`` to set ``end_date``).

    **Default:** ``None``
``export_delay``
    Delay export end date by X hours.

    **Default:** ``None``
``export_specifications``
    Export specification configuration
    `Export Specification <#export-specification>`__
``inspector``
    Inspector Configuration
    `Inspector <#inspector>`__
``logging``
    Logging configuration
``mongodb``
    Mongo Configuration
    `Mongo <#mongo>`__

``start_date``
    Start date of the export.

    **Default:** ``None``
``time_range_before``
    Hour (if not set, current time will be used to calculate 'before' parameter).

    **Default:** ``None``
``traveller``
    Traveller Configuration
    `Traveller <#traveller>`__
``sftp``
    SFTP configuration
    `SFTP <#sftp>`__

Advania
~~~~~~~
``url``
    URL to ``Advania`` service.

    **Default:** ``None``

``auth``
    Authorization.

    **Default:** ``None``

**Example**::

    url: http://127.0.0.1:8001
    auth: basic:user:password

Bobcat Auth Configuration
~~~~~~~~~~~~~~~~~~~~~~~~~
``url``
    URL to ``sales`` service.

    **Default:** ``None``

``client_cert_sha1``
    Certificate fingerprint.

    **Default:** ``None``

**Example**::

    bobcat_auth:
      url: http://localhost:8081/api/v1/auth/bobcat_export
      client_cert_sha1: "1111111111111111111111111111111111111111"

Bobcat Sales Auth Configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
``url``
    URL to ``sales`` service.

    **Default:** ``None``

``auth``
    Authorization.

    **Default:** ``None``

**Example**::

    bobcat_sales:
      url: http://localhost:8000/api/v1
      auth: basic:export:test

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

    **Default:** ``None``

``auth``
    Authorization.

    **Default:** ``None``

**Example**::

    bobcat_ticketing:
      url: http://localhost:8080/bobcat/api/v1
      auth: bobcat_auth

Downloader
~~~~~~~~~~
``files``
    List of files to downloaded.

    **Default:** ``[]]``


**Example**::

    downloader:
      files: ["https://opendata.straeto.is/fara/fara_stops.txt"]

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

    **Default:** ``successful-runs.csv``
``transitive_dir``
    Transitive directory.

    **Default:** ``./transitive``
``output_dir``
    Output directory.

    **Default:** ``./output``
``sftp_path``
    SFTP path.

    **Default:** ``default``
``break_flow_on_error``
    Break flow on error.

    **Default:** ``None``
``file_temp_extension``
    Extension file name.

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

    **Default:** ``None``
``reuse_request_session``
    Indicates whether the request session will be reused.

    **Default:** ``True``

**Example**::

    export:
      successful_runs_file_name: successful-runs.csv
      transitive_dir: .transitive
      output_dir: .output
      sftp_path: bobcat-reporting
      break_flow_on_error: False
      file_temp_extension: temp
      version: v2
      reuse_request_session: True

Export Specification
~~~~~~~~~~~~~~~~~~~~
    Export specification.

    **Default:** ``None``

**Example**::

    export_specifications:
      bobcat_sales:
        tags:
          generator_class: SimpleReportGenerator
          transform_function: transform_tags
          inspection:
            - generator_class: bobcat_reports.inspection.inspect:ReportDataCompatibilityInspector
              input_data:
                - dataset: tags.txt
                  required_headers:
                    - name
          headers:
            - name
            - title
          output_names:
            - tags.txt
          additional_params:
            anonymize: true
            pii: false
          disable_time_range: true

Inspector
~~~~~~~~~
``break_flow_on_error``
    Break flow on inspector error.

    **Default:** ``False``

**Example**::

    inspector:
      break_flow_on_error: True

Mongo
~~~~~
``host``
    The host name of the ``mongod db`` instance to connect to

    **Default:** ``None``

**Example**::

    mongodb:
      host: mongodb://localhost:27017/reports

Traveller
~~~~~~~~~
``break_flow_on_update_error``
    Break flow on error.

    **Default:** ``False``

``tags``
    List of tags to be fetched from ``mtb_prodcuts``

    **Default:** ``[]``
``advania``
    Advania Configuration
    `Advania <#advania>`__

**Example**::

    traveller:
      break_flow_on_update_error: True
      tags: ["tc_e"]
      advania:

SFTP
~~~~
``break_flow_on_error``
    Break flow on error.

    **Default:** ``False``

``pkk_path``
    Private key path.

    **Default:** ``None``
``host``
    Host.

    **Default:** ``None``
``port``
    Port.

    **Default:** ``None``
``user``
    User.

    **Default:** ``None``

**Example**::

    sftp:
      break_flow_on_error: False
      pkk_path: key.pkk
      host: 10.149.100.73
      port: 2222
      user: fara_sftp