API clients

For Drive to install and run, it must authenticate with Autopay Online Plus. For more information, see the section API clients.

Payment and collection profiles

Drive also requires a suitably configured payment profile to be available, as this profile determines how the associated payments are processed.

Drive upload is enabled by configuring the payment or collection profile on the File import tab. Several Drive options can be set here, including

• The location from which Drive will collect files (the “watch folder”).
• Whether files should be transmitted in encrypted form.

Any configuration changes take effect at the next auto-refresh (as defined by the Polling Interval) or when Drive is restarted.

Drive can only be configured on profiles where the data entry method is File import.

Any Bacs reports associated with a collection profile are downloaded via the payment profile specified within the collection profile configuration.

Configuring a payment profile

1. Log in to Autopay Online Plus as an administrator.

2. Navigate to the Settings menu, and select Payment profiles.

3. Access the payment profile and select the File Import tab.

4. If the data entry type is Manual entry, this profile is not suitable for Drive upload – amend the data entry type to File import, or create a new profile.

5. When the File import option is selected, the following fields are made available:

4. When the Allow imports from Drive option is selected, the following extra fields are made available:

5. If Watch folder pattern is specified, Drive will start watching that folder for files which it will then try to upload.

   • If the Watch folder pattern is left blank, a folder will be created within the Drive install directory with a name as a ‘slug’ of the payment profile name.
   • If you specify an absolute or relative path in the Watch folder pattern, ensure that the folder path is valid on the PC or VM where Drive is running and the folder is already created.
   • If Drive is running as a Windows Service, the Service ‘Log on as’ account will also require the relevant permissions (read/write) to the path.

6. By choosing Delete local files upon successful upload, Drive will delete the files after successfully uploading them. If this option is not specified, then after successful upload the files will be moved into the uploaded folder within the watch folder or as specified in the Archive folder in the settings.xml file.

7. Enabling the Automatically download Bacs Messages option will allow Drive to automatically retrieve Bacs messages. See the section Downloading Bacs reports.

Configuring a collection profile

1. Log in to Autopay Online Plus as an administrator.
2. Navigate to the Settings menu, and select Collection profiles.
3. Access the collection profile and select the File Import tab.
4. When the File import option is selected, the following fields are made available:

3. When the Allow imports from Drive option is selected, the following extra fields are made available:

4. If Watch folder pattern is specified, Drive will start watching that folder for files which it will then try to upload.

   • If Watch folder pattern is left blank, a folder will be created within the Drive install directory with a name as a ‘slug’ of the payment profile name.
   • If you specify an absolute or relative path in the Watch folder pattern, ensure that the folder path is valid on the PC or VM where Drive is running and the folder is already created.
   • If Drive is running as a Windows Service, the Service ‘Log on as’ account will also require the relevant permissions (read/write) to the path.

5. If Delete local files upon successful upload is selected, Drive will delete the files after successfully uploading them. If this option is not specified, then after successful upload the files will be moved into the uploaded folder within the watch folder or as specified in the Archive folder in the settings.xml file.

6. If Enable encrypted file import is selected, Drive will import encrypted files into Autopay Online Plus.