You are on the Xporter Server documentation. If you are looking for Xporter Cloud documentation, you can find it in this page.

Introduction

This is the first exercise of the Advanced Level. The main goal of this exercise is to give you an idea of how to set up and manage Xporter for Jira File Servers.

The File Servers section enables administrators to define locations to which Xporter documents generated by Scheduled Reports or Workflow Post Functions will be uploaded as well as manages such documents. 

In order to perform the initial setup, navigate to File Servers on the Xporter for Jira administration section Add-ons page of the Jira Administration. You'll see a warning message informing you that There are no Xporter for Jira File Servers configured. There is a + Add New File Server button and an empty table below it. Once a File Server is configured, its entry will be displayed on that grid.

Right now, the only option available to you is the + Add New File Server button, that will display a pop-over dialog where you'll input your File Server details and settings.


In order to perform this exercise properly, you'll need to have an Application Link with a Confluence instance, as well as an FTP server available.

For more information on how to create Application Links, please refer to the Atlassian documentation here.

On the Confluence instance, you need to create new space and name it Academy. On that Space, create a File Lists section, and name it Xporter documents.

The Exercise(s)

1) Adding a Confluence File Server 

On the File Servers on the Xporter for Jira administration section Add-ons page of the Jira Administration, click + Add New File Server. On the Type, select Confluence. Enter Academy Confluence  as the name of you File Server and on the Instance selector, choose the Confluence with which you've created an Application Link.

On the Space selector choose Academy, and on the Page select Xporter Documents.

Input the Username and Password of the user you use to authenticate on the Confluence instance. Click Test Server.

If you input a wrong set of credentials, an Error! message will be displayed informing you that it is Unable to connect to file server.

Once you get the File server connected with success message, the Create button will become visible. Click it and a Success! message will be displayed informing you that the File Server was successfully added.

It will now be displayed with an entry on the Xporter for Jira File Servers grid, along with its Type, the Host and Authentication details.

If the File Server name is already in use, an Error! message will be displayed when clicking the Create button, informing you of the conflict.


2) Adding an FTP File Server 

On the File Servers on the Xporter for Jira administration section Add-ons page of the Jira Administration, click + Add New File Server. On the Type, select FTP. Enter Academy FTP as the name of the file server. On the Host field, enter your FTP server address as well as its Port and Base Path to which the generated documents will be sent.

Input the Username and Password of the user you use to authenticate on the FTP instance, and click Test Server.

If you input a wrong set of credentials, an Error! message will be displayed informing you that it is Unable to connect to file server.

Once you get the File server connected with success message, the Create button will become visible. Click it and a Success! message will be displayed informing you that the File Server was successfully added.

It will now be displayed with an entry on the Xporter for Jira File Servers grid, along with its Type, the Host and Authentication details.


If the File Server name is already in use, an Error! message will be displayed when you click the Create button, informing you of the conflict.

3) Editing a File Server entry

On any of your File Server entries, click Edit on the Operations column. A pop-over dialog will be displayed.

Enter a Description to your File Server and, after successfully testing the server, click Update. Now, your File Server entry will have its description displayed as well.


When editing, you can change the Name and Description.

4) Setting a File Server as Default

On the entry of any of your File Servers, click the Set as Default button on the Operations column. The Default label will be displayed next to that template entry. Also, it will appear selected automatically on any dialog selector related with File Servers, either when Managing Scheduled Reports or Xporter for Jira Create Document Post Functions.

This Exercise is now complete. Proceed to Exercise 2 to learn how to manage your Xporter for Jira Scheduled Reports.

If you like this exercise, please leave a comment or a (thumbs up). Your feedback is very important to us.

Thank you in advance.

Enjoy our product. (big grin)

  • No labels