Skip to content

Commit 6f40064

Browse files
committed
document "download file from variable"
Closes #66
1 parent e3de222 commit 6f40064

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

CamundaLibrary/CamundaLibrary.py

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ def get_deployments(self, deployment_id: str = None, **kwargs):
282282
@keyword(tags=['message'])
283283
def deliver_message(self, message_name, **kwargs):
284284
"""
285-
Delivers a message using Camunda REST API: https://docs.camunda.org/manual/7.15/reference/rest/message/post-message/
285+
Delivers a message using Camunda REST API: https://docs.camunda.org/manual/latest/reference/rest/message/post-message/
286286
287287
Example:
288288
| ${result} | deliver message | msg_payment_received |
@@ -333,7 +333,7 @@ def fetch_workload(self, topic: str, async_response_timeout=None, use_priority=N
333333
`Get Fetch Response`
334334
335335
The only mandatory parameter for this keyword is *topic* which is the name of the topic to fetch workload from.
336-
More parameters can be added from the Camunda documentation: https://docs.camunda.org/manual/7.14/reference/rest/external-task/fetch/
336+
More parameters can be added from the Camunda documentation: https://docs.camunda.org/manual/latest/reference/rest/external-task/fetch/
337337
338338
If not provided, this keyword will use a lock_duration of 60000 ms (10 minutes) and set {{deserialize_value=True}}
339339
@@ -548,6 +548,15 @@ def complete_task(self, result_set: Dict[str, Any] = None, files: Dict = None):
548548

549549
@keyword(tags=['task', 'variable', 'file'])
550550
def download_file_from_variable(self, variable_name: str) -> str:
551+
"""
552+
For performance reasons, files are not retrieved automatically during `fetch workload`. If your task requires
553+
a file that is attached to a process instance, you need to download the file explicitly.
554+
555+
Example:
556+
| ${variables} | *fetch workload* | _first_task_in_demo_ |
557+
| | *Dictionary Should Contain Key* | _${variables}_ | _my_file_ |
558+
| ${file} | *Download File From Variable* | ${variables}[my_file] | |
559+
"""
551560
if not self.FETCH_RESPONSE:
552561
logger.warn('Could not download file for variable. Maybe you did not fetch and lock a workitem before?')
553562
else:

0 commit comments

Comments
 (0)