Transfer Report to SFTP

Before you configure this integration, you must do the following:

1. Configure Access to Integrations.
2. Get the URL, User, and Password for the APIGatewayServer.

3. Generate the reports that you need to transfer. This integration transfers only completed reports and only in the following formats:

   • PDF
   • XLSX
   • Interactive
   • CSV

Deploy the Transfer Report to SFTP integration

For more information, see the Deploy Integrations topic.

1. Open the Integration Template Designer: Select Main Menu  > Administration > Application Setup > Integrations Setup > Design Integration Templates.

   Note: If prompted, enter your Username and Password. Click Tap Log in.

2. Make sure that the Account is correct. If not, select the right account.

3. Select the Deploy tab > Integration Packs.

1. From the list in the left column, search for and select the Pro WFM Transfer Report to SFTP Extension integration.

2. From Unattached Environments, select the environment in which to deploy the integration process for the selected integration. Click Tap the double-left arrows button .

Configure the Transfer Report to SFTP integration settings

Select the environment

1. Select the Manage tab > Atom Management.
2. Select your environment.

Select environment extensions

1. In Administration, click tap Environment Extensions.
2. In Process Filter, click tap the magnifying glass . It can take several seconds before the button becomes active.

3. Scroll to and select the integration pack: Transfer Report to SFTP > TransferReportToSFTP_iPack_v2.

Configure connection settings

Caution: If you select Use Default for the connection settings and process properties, ensure that Value is blank. If Value is not blank, that value overrides the default value whether or not Use Default is selected or cleared. Example: If the default value is abc, but Value shows xyz, the integration uses xyz regardless of the setting of Use Default.

1. Select Connection Settings.

2. From the Connection list, select and configure the following:

   Connection Settings

   Setting	Required	Actions
   TransferReportToSFTP_iPack_v2_APIGatewayServer	Required	To change the default API gateway server: Clear Use Default. Enter the URL to the server. Example: <tenantURL>/api
   TransferReportToSFTP_iPack_v2_SFTPServer	Required	The SFTP server setting defines the connection to the file that contains the records. Integrations access only the internal SFTP account. To change the default SFTP server parameters: For each field, clear Use Default. Enter the following values: Enter the name of the internal Host. Enter the number of the Port for the internal SFTP account. In User, enter the username for the internal SFTP account. In Password, select <Encrypted>. Enter the new password for the internal SFTP account. Click Tap Apply.

After the integrations are deployed and the connection settings and process properties are configured, install the integrations to make them available for running or scheduling.

1. Select Main Menu  > Administration > Application Setup > Integrations Setup > Install Integrations.
2. Click Tap Create .
3. In Integration Name, enter a unique name, such as TransferReportToSFTP_iPack_v2.
4. (Optional) Enter a Description.

Note: Do not select API Integration.

5. In File Access, select None to not select a connection.

6. (Optional) Select Re-Run to allow repeated runs of the integration with the same parameter values as the previous run.

7. Email Notifications

   (Optional)

   1. Select Yes to send email and control center notifications for integration runs.
   2. Enter the email addresses of the recipients for the following types of run status. For multiple recipients, separate the addresses by a comma, but no spaces:

      In Progress — The integration run started and has not finished.

      Completed — The integration ran successfully without errors.

      Failed — The integration ran successfully, but one or more records have errors. The integration run is treated as failed. If Abort on Failure is configured in an integration set, the integration set stops.

      Completed with Errors — The integration run has errors or could not run.

8. In Skip Configuration, select None (default) to allow multiple integrations to run at the same time or with the same data without restrictions.

Note: Do not select Allow Minute Interval.

9. Integration template and parameters
   1. In Integration Template, select TransferReportToSFTP_iPack_v2.
   2. Click Tap Assign .
   3. In Integration Parameters, you can override default settings. Click Tap Create.
   4. Complete the configuration for each parameter value.

   5. Click Tap Save.

      Repeat this step for each integration parameter that supports the Transfer Report to SFTP process.

Integration parameters

Parameter name	Description / User prompt / Mandatory	Template parameter	Parameter type
Completed Start Date	The start date of the time period when the report was generated. User prompt = True Required if Use Latest Completed Report is false. Supported format: MM-DD-YYYY .	CompletedStartDate	Date
Completed End Date	The end date of the time period when the report was generated. User prompt = True Required if Use Latest Completed Report is false. Supported format: MM-DD-YYYY .	CompletedEndDate	Date
Report Name	The published name of the report: Note: The name is the unique Report Name and not the Description; it is case-insensitive. User prompt = True Mandatory = True	ReportName	Text
Completed Start Time	The start time of the time period when the report was generated. User prompt = True Required if Use Latest Completed Report is false. Supported format: hh:mm.	CompletedStartTime	Time
Completed End Time	The end time of the time period when the report was generated. User prompt = True Required if Use Latest Completed Report is false. Supported format: hh:mm.	CompletedEndTime	Time
Use Latest Completed Report?	(Optional) Whether to transfer the most recently completed version of the report. User prompt = True Supported values include: true (default): Transfer the most recently completed version of the report. false: Transfer any version of the report that was generated during the time period that is defined by Completed Start Date, Completed End Date, Completed Start Time, and Completed End Time.	UseLatestCompleteReport?	Boolean
Append Timestamp To Report	(Optional) Whether to add a time stamp to the end of the file name of the report. User prompt = False Supported values include: None (default): Do not add a time stamp. ReportStartDateTime Timestamp: Add the start date and time to the end of the file name. ReportEndDateTime Timestamp: Add the end date and time to the end of the file name.	AppendTimestampToReport	Dropdown
Transferred File Name	(Optional) Alternative file name to replace the Report Name when the report is exported. User prompt = True	TransferredFileName	Text
SFTP Action	The action to perform when exporting the report to the SFTP site if a previous version of the report is in the /Output directory. User prompt = False Mandatory = True Supported values include: Create New Name (default): Save the new version as a new file with a unique name. Append: Add the data from the new version of the report to the end of the existing report file. Overwrite: Replace the previous version of the report with the new version. Error: Do not save the new version of the report and send an error message to the Run Summary.	SFTPAction	Dropdown
OutputDirectory	The directory on the SFTP server to archive the output files. User prompt = False Mandatory = True Default = /Outbound	OutputDirectory	Text

10. Ensure that the generic data access profiles (GDAP) allow access by the people who need to run the installed integrations. See Configure Access to Integrations.

Run integrations to test that the configuration is set up correctly.

Before you start

Generate the reports that you need to transfer. This integration transfers only completed reports and only in the following formats:

• PDF
• XLSX
• Interactive
• CSV

Run the integration

1. Select the integration:
   1. Select Main Menu  > Maintenance > Integrations. 
   2. Click Tap Run an Integration . 
   3. Select the TransferReportToSFTP_iPack_v2 integration from the list. Click Tap Select. 
   4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the default name ends with a date and time stamp.
2. Set parameters as follows:
   • Report Name: Enter the published name of the report.
   • (Optional) Use Latest Completed Report?: Select whether to transfer the most recently completed version of the report.
   • (Required if Use Latest Completed Report is false) Completed Start Date: Select the start date of the time period when the report was generated.
   • (Required if Use Latest Completed Report is false) Completed End Date: Select the end date of the time period when the report was generated.
   • (Required if Use Latest Completed Report is false) Completed Start Time: Enter the start time of the time period when the report was generated. Use the format hh:mm.
   • (Required if Use Latest Completed Report is false) Completed End Time: Enter the end time of the time period when the report was generated. Use the format hh:mm.
   • (Optional) Transferred File Name: Enter an alternative file name to replace the Report Name when the report is exported.

3. Select the following:

   • Run Integration: If this is the first time this integration is being run.
   • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter values again. Click Tap Yes to continue, or No to not run the integration and to return to the parameter settings.

4. Wait for the confirmation that the integration completed or failed. Close the panel.
5. Click Tap Refresh . 
6. To see details, select the integration run. Select Run Summary.

Check the results

Status indicators

•  In-Progress: The run of this integration has not yet completed.
•  Completed: The integration ran successfully without errors.
•  Scheduled: This integration is scheduled to run later or repeatedly.
• (Grayed out) Scheduled but Deleted: This integration is scheduled to run, but the integration template has been deleted. When it runs, it will generate an error. To prevent this error, delete the scheduled integration run.
•  Completed with Errors: The integration ran successfully, but one or more records have errors. The integration run is treated as failed. If Abort on Failure is configured in an integration set, the integration set stops.
•  Failed: The integration run has errors or could not run.
• To troubleshoot and resolve errors, do the following:

  Check the Run Summary for details.

  • To troubleshoot all types of errors, or if the Run Summary shows a large number of errors, click tap Go to Additional Details (if available), or click tap the Source File to open and examine the input source file.
  • (Only for import integrations) To troubleshoot and resubmit integrations that have transactional or data errors, click tap Go to Transaction Assistant.

To check the results in more detail, do the following:

1. To see detailed results, click tap the tile for the integration run.
2. Click Tap Run Summary to see the results of the integration run.

   Example Run Summary details

   Note: The available details vary by integration and configuration.

   • Integration Run Name: Name of this run of the integration.
   • Process Name: Name of any integration set that includes this integration.
   • Integration Name: Name of the installed integration.
   • Integration Reference ID: Unique identifier for this integration run (to help in troubleshooting errors).
   • User: The person or user account that ran the integration.
   • Integration Type: Import, Export, or None
   • Start Date: Date and time when the integration run started.
   • End Date: Date and time when the integration run finished.
   • Status: In-Progress, Completed, Completed with Errors, or Failed.
   • Records Processed: Number of records that were processed.
   • Records Created: Number of records that were created.
   • Errors: Number of records that failed.
   • Source Files, Output File, and Error Files: For file-based import integrations, use Manage SFTP to access the source and output files on the inbound (source) and outbound (destination) SFTP folders. See the Manage SFTP topic.
3. Check the exported reports to make sure that they are saved correctly to the SFTP site.

Note: You can schedule integrations and integration sets to run once later or at a recurring frequency. See the topic.

API details

API name	API section	Type	Resource path	Location
Retrieve Report History	Platform	GET	/v1/platform/report_executions	_RetrieveReportHistory
Retrieve Report Output	Platform	GET	/v1/platform/report_executions/{id}/file	_Retrieve Report Output
Process Callback	Platform	POST	/v1/platform/integrations/update_status	_WFD CallBack