Skip to content

Commit

Permalink
Merge pull request #132 from FirelyTeam/vonk/v3.9.3
Browse files Browse the repository at this point in the history
vonk: releasenotes for hotfix 3.9.3
  • Loading branch information
cknaap committed Jan 13, 2021
2 parents b1ee67e + e8cdfb1 commit e8b81a7
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 3 deletions.
6 changes: 4 additions & 2 deletions firelyserver/features/subscription.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,13 @@ You can control the period and the batchsize. If an evaluation of a Subscription
"RepeatPeriod": 20000,
"SubscriptionBatchSize" : 1,
"RetryPeriod": 60000,
"MaximumRetries": 3
"MaximumRetries": 3,
"SendRestHookAsCreate": false
},

* ``Enabled`` allows you to quickly enable or disable the evaluation of Subscriptions. Default value is 'false', which implies that Subscription evaluation is also off if this section is left out of the settings.
* ``RepeatPeriod`` is expressed in milliseconds. In the example above the period is set to 20 seconds, meaning that after a change a subscriber will be notified in at most 20 seconds.
* ``SubscriptionBatchSize`` is expressed in number of Subscriptions that is retrieved and evaluated at once. Default is 1, but you can set it higher if you have a lot of Subscriptions.
* ``RetryPeriod`` is expressed in milliseconds. In the example above the period is set to 60 seconds, meaning that the Firely Server will retry to send the resources after a minimum of 60 seconds. Retry is included in the normal evaluation process, so the RetryPeriod cannot be smaller than RepeatPeriod.
* ``RetryPeriod`` is expressed in milliseconds. In the example above the period is set to 60 seconds, meaning that Firely Server will retry to send the resources after a minimum of 60 seconds. Retry is included in the normal evaluation process, so the RetryPeriod cannot be smaller than RepeatPeriod.
* ``MaximumRetries`` is the maximum amount of times Firely Server will retry to send the resources.
* ``SendRestHookAsCreate``: in versions < 3.9.3, Vonk sent RestHook notifications as a create operation using a POST. That was not compliant with the specification that requires an update operation using a PUT. The default value of ``false`` provides compliant behaviour. Only set it to ``true`` if you need Firely Servder to keep sending create operations as it did previously.
23 changes: 22 additions & 1 deletion firelyserver/releasenotes/releasenotes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,28 @@ Upgrading Firely Server

See :ref:`upgrade` for information on how to upgrade to a new version of Firely Server.

.. _vonk_releasenotes_393:

Release 3.9.3 hotfix
--------------------

.. attention::

We changed the behaviour of resthook notifications on Subscriptions. See Fix nr 1 below.

Database
^^^^^^^^

#. SQL Server: The migration that adds the indexes described in :ref:`vonk_releasenotes_392` might run longer than the timeout period of 30 seconds. Therefore we added scripts to apply and revert this migration manually. If you encounter the timeout during upgrade: shut down vonk, run the script using SQL Server Management Studio or any similar tool, then start Vonk 3.9.3 again. In both scripts you only need to provide the databasename for the database that you want to upgrade. If you run your administration database on SQL Server you can but probably do not need to run this script on it. The administration database is typically small enough to complete the script within 30 seconds.

#. apply: <vonk-dir>/data/2021211113200_AddIndex_ForCountAndUpdateCurrent_Up.sql
#. revert: <vonk-dir>/data/2021211113200_AddIndex_ForCountAndUpdateCurrent_Down.sql

Fix
^^^

#. :ref:`feature_subscription`: A resthook notification was sent as a FHIR create operation, using POST. This was not compliant with the specification that states it must be an update, using PUT. We changed the default behaviour to align with the specification. In order to avoid breaking changes in an existing deployments, you may set the new setting ``SubscriptionEvaluatorOptions:SendRestHookAsCreate`` to ``true`` - that way Vonk will retain the (incorrect) behaviour from the previous versions.

.. _vonk_releasenotes_392:

Release 3.9.2 hotfix
Expand Down Expand Up @@ -701,4 +723,3 @@ Known to-dos
#. :ref:`feature_subscription`: do not work for R4 yet.
#. :ref:`feature_terminology`: operations do not work for R4.
#. During :ref:`conformance_import`: Files in the import directory and Simplifier projects are only imported for R3.

0 comments on commit e8b81a7

Please sign in to comment.