Wiki

Clone wiki

Documents Add-On / GUI Uploader v1.1.0

Documents Bulk Uploader v1.1.0

Documents Bulk Uploader is a Java application that allows importing files as documents in a bulk manner. With Documents Bulk Uploader you can upload the files located in a folder from your local drive (the "source folder") into a specified folder of a JIRA project (the "destination folder"). In the source folder you can have as many sub-folders as you want; the upload process will create a folder structure in Documents as the one from the specified source folder. The files are imported as documents of type File.

Documents Bulk Uploader can be used for day-by-day document import, but also when migrating from another document management system.

Prerequisites

  • A version of Documents add-on installed in your JIRA instance, which is compatible with this version of Documents Bulk Uploader. Click here to see the version compatibility.
    NOTE You should always use the version of Documents Bulk Uploader that is compatible with the version of your Documents add-on.
  • Java must be installed on the computer on which the Documents Bulk Uploader is installed.
    Java can be downloaded from here: http://www.java.com/en/download/index.jsp

Uploading files with Documents Bulk Uploader

  • Download newest the Documents Bulk Uploader compatible with your Documents add-on. See the Prerequisites section.
  • Extract the content of the ZIP archive on your computer
  • Launch Documents Bulk Uploader utility by running doc-upload-gui.bat from the bin folder. The main window is displayed.
    NOTE If the main window is not displayed, most probably you do not have Java installed. See the Prerequisites section.
  • When you run the utility for the first time, you are promoted to enter the authentication information used to connect to JIRA.

    Specifying the information needed to connect to your JIRA instance
  • Enter the Username and Password for the JIRA user that you use to upload the files. After uploading the files, the documents will appear as being created by this user.
    NOTE The user must have View and Create permissions (see Configuring the add-on permissions).
  • Specify your JIRA instance by typing its JIRA Base URL
  • In case of a secure (https) JIRA Base URL, check Ignore SSL certificate error to suppress any errors or warnings related to the SSL certificate.
  • Use the Validate button to check the info you entered. After it passes the validation, click OK.
    NOTE You can edit this information later, by accessing the File> Edit authentication information menu.
  • Assuming that you already prepared the folder containing the files that you want to upload, click the Select folder� button from the toolbar.

    The button for selecting the source folder
  • Select the folder that contains the files that you want to upload. In the source folder you can have as many sub-folders as you want; the upload process will upload its content in Documents by creating a similar sub-folder structure as the one from the specified source folder.

    Selecting the source folder

    The files from the source folders are loaded and listed in a grid.

    The grid showing the files to be uploaded

    NOTE No folders are created in Documents during the upload process for the empty sub-folders of the source folder.
  • The documents that will be created will have as title the name of their file. Optionally, you can change the title of the files to be imported by double clicking a row in the grid or by clicking the Edit document title button from the toolbar.

    Changing the title of a document before starting the upload
  • When you are done with editing the document titles, click the Start upload� button from the toolbar.
    The button for starting the upload
  • You are asked to enter the Key of the destination folder in which the files will be uploaded. The Key is a number that uniquely identifies a folder or document. Assuming that you already have a destination folder, you can obtain its key from the Documents tab of the project.

    Determining the key of the destination folder

    Once you determined the key, enter it in the edit box and then click OK.

    Specifying the key of the destination folder
  • The specified document Key is validated. If it passes the validation, a confirmation message is displayed. Click OK to begin the upload.

    Confirmation message for the specified document's key
  • The files from the grid are uploaded one-by-one and the upload status of each file is displayed in the grid. You can pause the upload by clicking the Pause upload button from toolbar or stop it by clicking Stop upload.

    The grid showing the upload result for the files

    When the upload is finished you can check the content of the destination folder on the Documents tab of the project. It contains the documents and the folders created during the upload process.

    The files uploaded in the destination folder
  • You can upload a new folder by repeating the above steps.

Updated