Attach RIS document
rillsoft_document_ris_createStores a local file as a new document in the Rillsoft Integration Server DMS, attaching it to a task by task UUID and DMS folder ID. Requires a saved project and DMS create permissions.
Instructions
Stores a local file as a new document in the document management of the Rillsoft Integration Server and hangs it on a task, a subproject or the project itself - the 'Add' button of the documents page. Today the server accepts documents on tasks only: a subproject or the project itself answers ris_not_found (the text says why), so give the uuid of a task. Takes effect on the server at once: no undo step, the project itself is not marked as changed, and rillsoft_history_undo does not take it back; rillsoft_document_ris_delete removes it. Requires the project to be stored on the server (rillsoft_project_ris_save_as first for a new one), the DMS license function and the create role; refused in an open portfolio, as in the documents dialog; the answer is the document as the server holds it afterwards.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | absolute path of the local file to store; its file name becomes the document name | |
| uuid | No | UUID of the task or subproject the document hangs on; missing = the project itself | |
| folderId | Yes | id of the DMS folder the document goes into, from folders[] of rillsoft_document_ris_list | |
| description | No | description stored with the document |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | file name of the document | |
| note | No | hints of the product path; missing when there were none | |
| uuid | Yes | UUID of the element the document hangs on - a task, a subproject or the project itself | |
| fileSize | Yes | size of the stored file in bytes | |
| folderId | Yes | id of the DMS folder the document lies in | |
| createdAt | Yes | time the document was stored, DD.MM.YYYY hh:mm; empty when the server reports none | |
| projectId | Yes | id of the project the document belongs to | |
| documentId | Yes | id of the document on the server; what _get, _update and _delete take | |
| folderPath | Yes | names of the DMS folders from the root, joined by ' / '; empty when the folder is unknown to the tree | |
| description | Yes | description; empty when none is set | |
| elementName | Yes | name of that element | |
| createdUserName | Yes | user who stored it; empty when the server reports none |