Skip to content

Commit

Permalink
Update gts-headers-in-wis2.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
tomkralidis authored Jun 13, 2024
1 parent 3b6d78d commit 7eb14ce
Showing 1 changed file with 24 additions and 26 deletions.
50 changes: 24 additions & 26 deletions docs/source/user/gts-headers-in-wis2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,46 +14,44 @@ To enable the WIS2 to GTS Gateway to correctly identify the data to be republish

.. code-block:: json

Check warning on line 15 in docs/source/user/gts-headers-in-wis2.rst

View workflow job for this annotation

GitHub Actions / main

Could not lex literal_block as "json". Highlighting skipped.

Check warning on line 15 in docs/source/user/gts-headers-in-wis2.rst

View workflow job for this annotation

GitHub Actions / main

Could not lex literal_block as "json". Highlighting skipped.
"properties": {
"gts": {
"ttaaii": "FTAE31",
"cccc": "VTBB"
}
}
"properties": {
"gts": {
"ttaaii": "FTAE31",
"cccc": "VTBB"
}
}
The wis2box can add these to your WIS2 Notifications automatically, provided you specify the additional file `gts_headers_mappings.json` that contains the required information to map the GTS headers to the incoming filenames.
wis2box can add these to WIS2 Notifications automatically, provided you specify the additional file `gts_headers_mappings.json` that contains the required information to map the GTS headers to the incoming filenames.

Note that this is optional and only required if you want to turn off the system responsible for sending data to the GTS during the transition period.
Note that this is optional and only required if you want to turn off the existing system responsible for sending data to the GTS during the transition period.

gts_headers_mapping.csv
-----------------------

If you want to add GTS headers to your WIS2 notifications, you need to create a CSV file that maps the GTS headers to the incoming filenames.
If you want to add GTS headers to your WIS2 notifications, a CSV file is required that maps GTS headers to incoming filenames.

The CSV file should be named `gts_headers_mapping.csv` and should be placed in the directory you defined using the `WIS2BOX_HOST_DATADIR` environment variable.
The CSV file should be named (exactly) `gts_headers_mapping.csv` and should be placed in the directory defined using the `WIS2BOX_HOST_DATADIR` environment variable.

The CSV should contain three columns: `string_in_filepath`, `TTAAii`, and `CCCC`.
The CSV should contain the following columns: `string_in_filepath`, `TTAAii`, and `CCCC`.

Example content for `gts_headers_mapping.csv`:

.. code-block:: console
.. code-block:: csv

Check warning on line 39 in docs/source/user/gts-headers-in-wis2.rst

View workflow job for this annotation

GitHub Actions / main

Pygments lexer name 'csv' is not known

Check warning on line 39 in docs/source/user/gts-headers-in-wis2.rst

View workflow job for this annotation

GitHub Actions / main

Pygments lexer name 'csv' is not known
string_in_filepath,TTAAii,CCCC
ISMD01LIIB,ISMD01,LIBB
ISMD02LIIB,ISMD02,LIBB
string_in_filepath,TTAAii,CCCC
ISMD01LIIB,ISMD01,LIBB
ISMD02LIIB,ISMD02,LIBB
In this example, whenever `ISMD01LIIB` or `ISMD02LIIB` is contained in the file-path of the incoming file,
the corresponding GTS-headers will be added to the WIS2 Notification Message as a dictionary in the `properties` field:
In this example, whenever `ISMD01LIIB` or `ISMD02LIIB` is contained in the filepath of the incoming file,
the corresponding GTS headers will be added to the WIS2 Notification Message as a dictionary in the `properties` field:

.. code-block:: json

Check warning on line 48 in docs/source/user/gts-headers-in-wis2.rst

View workflow job for this annotation

GitHub Actions / main

Could not lex literal_block as "json". Highlighting skipped.

Check warning on line 48 in docs/source/user/gts-headers-in-wis2.rst

View workflow job for this annotation

GitHub Actions / main

Could not lex literal_block as "json". Highlighting skipped.
"properties": {
"gts": {
"ttaaii": "ISMD01",
"cccc": "LIBB"
}
}
If the `gts_headers_mapping.csv` file is not present in the directory you defined using the `WIS2BOX_HOST_DATADIR` environment variable, the wis2box will not add any GTS headers to the WIS2 Notification Message.

"properties": {
"gts": {
"ttaaii": "ISMD01",
"cccc": "LIBB"
}
}
If the `gts_headers_mapping.csv` file is not present in the directory you defined using the `WIS2BOX_HOST_DATADIR` environment variable, wis2box will not add any GTS headers to the WIS2 Notification Message.

0 comments on commit 7eb14ce

Please sign in to comment.