feat (#1207) document changes on start_from property #1208
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Update schedules document to include update on start_from.
1yuv
changed the title
garethbowen
suggested changes
Oct 19, 2023
| @@ -21,7 +21,7 @@ The `schedules` key contains an array of schedule objects, each representing the | |||
| |`name`|A unique string label that is used to identify the schedule. Spaces are allowed.|yes| | |||
| |`summary`|Short description of the of the schedule.|no| | |||
| |`description`|A narrative for the schedule.|no| | |||
| |`start_from`|The base date from which the `messages[].offset` is added to determine when to send individual messages. You could specify any property on the report that contains a date value. The default is `reported_date`, which is when the report was submitted.|no| | |||
| |`start_from`|The base date from which the `messages[].offset` is added to determine when to send individual messages. You could specify any property on the report that contains a date value. Starting 4.5.0, array of property names is also supported; in this case, first non-undefined field is used. The default is `reported_date`, which is when the report was submitted.|no| | |||
There was a problem hiding this comment.
Suggested change
| |`start_from`|The base date from which the `messages[].offset` is added to determine when to send individual messages. You could specify any property on the report that contains a date value. Starting 4.5.0, array of property names is also supported; in this case, first non-undefined field is used. The default is `reported_date`, which is when the report was submitted.|no| | |
| |`start_from`|The base date from which the `messages[].offset` is added to determine when to send individual messages. You could specify any property on the report that contains a date value. Starting from 4.5.0, an array of property names is also supported; in this case, the first defined field is used. The default is `reported_date`, which is when the report was submitted.|no| |
| @@ -57,3 +57,25 @@ This sample shows a schedule with a single message, which will be sent on Monday | |||
| } | |||
| ] | |||
| ``` | |||
|
|
|||
| Following sample schedules a message for 270 days from `lmp_date`. If `lmp_date` doesn't exist on report, it will schedule a message for 270 days from `fields.lmp_date`. If both fields don't exist, it will create schedule from `reported_date`. This feature on `start_from` is supported from CHT 4.5.0+. | |||
There was a problem hiding this comment.
Suggested change
| Following sample schedules a message for 270 days from `lmp_date`. If `lmp_date` doesn't exist on report, it will schedule a message for 270 days from `fields.lmp_date`. If both fields don't exist, it will create schedule from `reported_date`. This feature on `start_from` is supported from CHT 4.5.0+. | |
| The following sample schedules a message for 270 days from `lmp_date`. If `lmp_date` doesn't exist on report, it will schedule a message for 270 days from `fields.lmp_date`. If neither field exists, it will create schedule from `reported_date`. Using an array for `start_from` is supported from CHT 4.5.0+. |
|
Thanks @garethbowen , I have applied the suggestion. Also, I noted that I documented a behavior slightly wrong on the example previously and have corrected that. |
5 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update schedules document to include update on start_from. Required documentation for medic/cht-core#8633