Account Report FTP Push (FT-2006.006)
About this document
Scope
This document provides background information as well as a functional description of the FT-2006.006 Account Report FTP Push advanced feature. The described feature is supported from the release version 5.0 onwards.
Note
Account Report FTP Push is an advanced feature and requires a special license. Ensure that you have agreed with Mavoco about the usage of this feature before taking it into use.
This feature is part of the Account Dashboard & Reporting functionality with number FN-2006.
Feature Availability
Feature Version | Available from | Summary of changes |
---|---|---|
v1 | CMP Release 5.0 | Initial release |
Feature overview
Goals
The aim of the Account Report FTP Push feature is to enable Enterprises to receive the reports assigned to their Accounts via FTP push.
Out of scope
FTP push of CSP Reports
Other delivery mechanisms for Account Reports
Charge generation for the Report Push service
Any one-off check of the endpoint credentials when configured in the Account onboarding
Preconditions & Assumptions
The feature will push all assigned Account Reports to one FTP destination for an Account with the feature configured
The feature will not allow to select the reports to be pushed, i.e. either all assigned Account Reports are pushed or none
The FTP location is the same as FTP pushed invoices location
Functionality of the feature
Push Account Reports is an advanced feature. When the feature is
disabled, no Push Account Report capability is provided by CMP,
enabled, Push Account Reports feature can be configured per Account on Account onboarding.
Note that the Account Report FTP Push feature can be enabled/disabled for an Account in any Account lifecycle state.
If Push Account Reports is enabled on the Account, CMP provides fields to capture FTP parameters and credentials, that can be updated in any Account lifecycle state.
Additionally, CMP allows to specify Proxy Settings for the Remote Storage location if necessary, however, this is fully optional.
Note that defining Remote Storage and Proxy settings might require integration, to enable CMP to connect to the remote host and push the required files through.
After each report creation cycle, if configured accordingly, all of the Account Reports allocated to the Account are pushed to the chosen FTP destination. In the case of a failure, CMP will retry the report transfer up to the maximum number of retries specified in the Account FTP parameters.
CMP will report on the status of the Report Push and the Enterprise Account User will be notified via Enterprise Portal Notifications. The notification will display
the total number of reports included in the push attempt,
the number of successful reports,
the number of failures, and
the reason for the failure (error message).