Create an SFTP export configuration

You configure settings so that a user can export files from Inspire to your organization's Secure File Transfer Protocol (SFTP) server.

Requirements

  • You must have administrator permissions to work with export configurations.
    • If you go to the top menu and can see the Administration option, then you have the necessary permissions.
    • If you can't see the Administration menu, contact your local administrator.
  • You must have already contacted your Vasont representative to add this functionality.
    • The SFTP server configuration is completed by a Vasont Operations team member.

      You must provide Vasont with the details needed to connect to your SFTP server.

  • Vasont will configure an export plugin to add support for sending Inspire files to your SFTP server.

    • Review your list of plugins, and verify that one exists called ExportToSFTP. Follow the steps in: View your export plugins.

To create an SFTP export configuration:

  1. From the Administration_TopMenuOpt Administration menu, select Export configuration.
  2. On the Export configuration tab, click Create.
  3. On the Details tab:
    1. In Name, enter a unique title for this export configuration in 50 or fewer characters. For example, Export to SFTP Server.
    2. In Export Type, select SFTPServer.
  4. On the Details tab, specify any optional information:
    1. In Description, enter additional information for this export configuration in 1000 or fewer characters.
    2. If you don't want users to see this configuration when exporting, clear the Active checkbox.
    3. To automatically use this export configuration when users export, select the Default checkbox. Keep in mind that users can select an option other than the default.
  5. Optionally, to add an element name and limit the export to only the specified element relationship:
    1. On the Create Export Configuration dialog, select the Relations tab.
    2. Click Add.
    3. On the Add Relations dialog, select the checkbox next to one or more relations, and then click Add.
    4. To limit the export configuration to a specific element relationship, in the relations row, click the Elements column, and use the drop-down arrow mapeditor_move_down to select the element name.

      By default, the element name is empty, and all relations apply to all element types defined within the relation.

  6. Optionally, to limit the downloaded content to only the types you specify:
    1. On the Create Export Configuration dialog, select the Source Component Types tab.
    2. Click Add.
    3. On the Add Source Component Types dialog, select the checkbox next to one or more source component types.
    4. Click Add.
  7. To use the SFTP plugin:
    1. On the Create Export Configuration dialog, select the Plugins tab.
    2. Click Add.
    3. On the Available Plugins screen, select the checkbox for ExportToSFTP.
    4. Click Add.
  8. Optionally, to limit which users and roles can select this export configuration:
    1. On the Create Export Configuration dialog, select the Permissions tab.
    2. Click Add.
    3. On the Select Users/Roles dialog, select the checkbox next to one or more users and roles.
    4. Click Select.
  9. Optionally, to use an XSLT to transform output:
    1. On the Create Export Configuration dialog, select the Transforms tab.
    2. Click Add.
    3. On the Select Components screen, in the Folders pane, locate the folder that contains the XSLT file.
    4. In the Components pane, select the XSLT file and then click Select.
    5. On the Create Export Configuration dialog, repeat steps b-d to add more XSLT files if necessary.
    6. If you have multiple rows of stylesheets, you can set the order in which they are applied.
      ● To move an XSLT up in the order, click the up arrow .
      ● To move an XSLT down in the order, click the down arrow .
  10. On the Create Export Configuration screen, click Create.

    Results:

    • On the Export Configuration tab, your export configuration is listed in the grid.
    • When a user opens the Components browser, selects a component, and chooses Export, there is an option for Export to SFTP (or whatever name you gave to the configuration.)

      The user receives the following notifications:

      • The export process has begun
      • Export to SFTP Server Submitted Successfully
      • Export to SFTP Server Updated (indicating that export request has been received by the Inspire SFTP server)
      • Export to SFTP Server Completed Successfully