How to configure locations in the XML?

Editions: Ultimate, Enterprise, Campus, Module Media Import
Versions: 3.6.0+

In the <locations> node you define the locations where the media files shall be imported from and the way you want to import those media files (local filesystem, FTP/FTPS or SFTP/SCP).

The locations node is only required

  • if you choose XML in the import dialogue to upload your XML directly in the VIMP backend
  • and if the media files you want to import are not stored in the same folder as your XML file.

Sample XML with all possible locations:

  <locations> 
 
    <location id="local" type="filesystem">
      <path>/path/to/_import/</path>
    </location>


    <location id="ftp" type="ftp">
      <path>ftps://username:password@ftp.server.com:21/path/to/_import</path>
      <passive>true</passive>
    </location>

    <location id="ftps" type="ftp">
      <path>ftps://username:password@ftp.server.com:21/path/to/_import</path>
      <passive>true</passive>
    </location>



    <location id="ssh_sftp" type="ssh">
      <path>sftp://username:password@ssh.server.com:22/path/to/_import</path>
    </location>

    <location id="ssh_scp1" type="ssh">
      <path>ssh://username:password@ssh.server.com:22/path/to/_import</path>
    </location>

    <location id="ssh_scp2" type="ssh">
      <path>scp://username:password@ssh.server.com:22/path/to/_import</path>
    </location>
 
  </locations>

Local import:

    <location id="local" type="filesystem">
      <path>/path/to/_import/</path>
    </location>
With the attribute type="filesystem" you decide to import from a local directory on your (web)server.
Please always enter an absolute path here.

Import via FTP and FTPS (FTP over SSH):

    <location id="ftp" type="ftp">
      <path>ftps://username:password@ftp.server.com:21/path/to/_import</path>
      <passive>true</passive>
    </location>

    <location id="ftps" type="ftp">
      <path>ftps://username:password@ftp.server.com:21/path/to/_import</path>
      <passive>true</passive>
    </location>
The example with attribute id="ftp" defines a FTP connection. The example with id="sftp" defines a location for SFTP.
The attribute type="ftp" of the location node defines to use FTP or FTPS.
FTP or FTPS is defined by the protocol of the path node (ftp:// or ftps://).

Import via SFTP or SCP:

    <location id="ssh_sftp" type="ssh">
      <path>sftp://username:password@ssh.server.com:22/path/to/_import</path>
    </location>

    <location id="ssh_scp1" type="ssh">
      <path>ssh://username:password@ssh.server.com:22/path/to/_import</path>
    </location>

    <location id="ssh_scp2" type="ssh">
      <path>scp://username:password@ssh.server.com:22/path/to/_import</path>
    </location>
The example with id="ssh_sftp" defines a SFTP connection.
The type="SSH" attribute of the location node defines to import via SFTP or SCP. The protocol is defined by the path element (sftp://...)
The examples id="ssh_scp1" and id="ssh_scp2" both define a SCP connection.
The type="SSH" attribute of the location element defines to import via SFTP or SCP.
ssh:// or scp:// in the path node define to import via SCP.

Last update on 2017/02/15 by Admin.

Go back