Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

NOTE If you want to synchronize files or folders with Documents via the command line interface, please use Documents CLI Sync . If you want to import or synchronize files or folders with a desktop GUI utility, please use Documents Bulk Uploader .

Prerequisites

  • The Make sure that the latest version of Documents app installed in your Jira instance.

...

  • Download the newest version of Documents CLI Uploader compatible with your Documents app from here:

View file
nameDocumentsCLIUploader_v2.1.0.zip

  • Extract the content of the ZIP archive on your computer

  • Open the app.properties file from the bin folder for editing.

  • Set the application settings as indicated in the table below and save the changes.

Setting

Description

Example of valid value

jira.base.url

The Jira Base URL. Make sure not to specify the trailing slash at the end.

https://myjiraserver/jira

jira.username

The Jira users used for authentication. The user must have the necessary permissions for creating documents.

admin

jira.password

The Jira user's password.

password

jira.ignore.ssl.cerficate.errors

Set to 1 if you want the potential SSL certificate errors to be ignored. Otherwise, set it to 0.

1

  • Open a command prompt and execute doc-upload.bat from the bin folder with the following command line parameters:

Parameter

Description

Example of valid value

Param 1

Key of Target Folder - the key (Unique ID) of the folder in which the source file will be uploaded.

"102"

Param 2

Document Title - the title of the document.

"My Document"

Param 3

Source File Path - the local path of the file to be uploaded.

"c:\My Documents\FileToUpload.txt"

Param 4 (optional)

Sub-folder structure to be created in the target folder. The uploaded file will be created in the last sub-folder.

"Folder1/Folder2"

Example:

Code Block
doc-upload.bat "102" "My Document" "c:\My Documents\FileToUpload.txt" "Folder1/Folder2"

...