From 8fe39852c9838c7e116f2f414b6315abf6ecdf3a Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Wed, 16 Apr 2025 19:01:34 -0700 Subject: [PATCH] UI hint, docs --- docs/usage.md | 3 +- src-ui/messages.xlf | 147 +++++++++--------- .../workflow-edit-dialog.component.html | 10 +- 3 files changed, 88 insertions(+), 72 deletions(-) diff --git a/docs/usage.md b/docs/usage.md index f9bf17466..1f741581e 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -381,7 +381,8 @@ Currently, there are three events that correspond to workflow trigger 'types': 3. **Document Updated**: when a document is updated. Similar to 'added' events, triggers can include filtering by content matching, tags, doc type, or correspondent. 4. **Scheduled**: a scheduled trigger that can be used to run workflows at a specific time. The date used can be either the document - added, created, updated date or you can specify a (date) custom field. You can also specify a day offset from the date. + added, created, updated date or you can specify a (date) custom field. You can also specify a day offset from the date (positive + offsets will trigger before the date, negative offsets will trigger after). The following flow diagram illustrates the three document trigger types: diff --git a/src-ui/messages.xlf b/src-ui/messages.xlf index 09876cd98..0f5a651de 100644 --- a/src-ui/messages.xlf +++ b/src-ui/messages.xlf @@ -1284,19 +1284,19 @@ src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 201 + 209 src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 220 + 228 src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 287 + 295 src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 306 + 314 src/app/components/common/input/permissions/permissions-form/permissions-form.component.html @@ -1319,19 +1319,19 @@ src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 209 + 217 src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 228 + 236 src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 295 + 303 src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 314 + 322 src/app/components/common/input/permissions/permissions-form/permissions-form.component.html @@ -1357,11 +1357,11 @@ src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 234 + 242 src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 320 + 328 src/app/components/common/input/permissions/permissions-form/permissions-form.component.html @@ -3691,7 +3691,7 @@ src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 163 + 171 @@ -4115,7 +4115,7 @@ src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 188 + 196 @@ -4133,7 +4133,7 @@ src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 189 + 197 @@ -4645,381 +4645,388 @@ Offset days src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 126 + 128 + + + + Positive values will trigger the workflow before the date, negative values after. + + src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html + 132 Relative to src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 129 + 137 Custom field src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 133 + 141 Custom field to use for date. src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 133 + 141 Recurring src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 139 + 147 Trigger is recurring. src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 139 + 147 Recurring interval days src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 143 + 151 Repeat the trigger every n days. src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 143 + 151 Trigger for documents that match all filters specified below. src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 148 + 156 Filter filename src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 151 + 159 Apply to documents that match this filename. Wildcards such as *.pdf or *invoice* are allowed. Case insensitive. src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 151 + 159 Filter sources src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 153 + 161 Filter path src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 154 + 162 Apply to documents that match this path. Wildcards specified as * are allowed. Case-normalized.</a> src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 154 + 162 Filter mail rule src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 155 + 163 Apply to documents consumed via this mail rule. src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 155 + 163 Content matching algorithm src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 158 + 166 Content matching pattern src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 160 + 168 Has any of tags src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 169 + 177 Has correspondent src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 170 + 178 Has document type src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 171 + 179 Action type src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 181 + 189 Assign title src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 186 + 194 Can include some placeholders, see <a target='_blank' href='https://docs.paperless-ngx.com/usage/#workflows'>documentation</a>. src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 186 + 194 Assign tags src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 187 + 195 Assign storage path src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 190 + 198 Assign custom fields src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 191 + 199 Assign owner src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 195 + 203 Assign view permissions src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 197 + 205 Assign edit permissions src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 216 + 224 Remove tags src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 243 + 251 Remove all src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 244 + 252 src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 250 + 258 src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 256 + 264 src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 262 + 270 src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 268 + 276 src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 275 + 283 src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 281 + 289 Remove correspondents src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 249 + 257 Remove document types src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 255 + 263 Remove storage paths src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 261 + 269 Remove custom fields src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 267 + 275 Remove owners src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 274 + 282 Remove permissions src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 280 + 288 View permissions src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 283 + 291 Edit permissions src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 302 + 310 Email subject src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 330 + 338 Email body src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 331 + 339 Email recipients src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 332 + 340 Attach document src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 333 + 341 Webhook url src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 341 + 349 Use parameters for webhook body src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 343 + 351 Send webhook payload as JSON src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 344 + 352 Webhook params src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 347 + 355 Webhook body src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 349 + 357 Webhook headers src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 351 + 359 Include document src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html - 352 + 360 diff --git a/src-ui/src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html b/src-ui/src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html index 4e5d5ba9b..c9869bfcb 100644 --- a/src-ui/src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html +++ b/src-ui/src/app/components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component.html @@ -123,7 +123,15 @@

Set scheduled trigger offset and which date field to use.

- +