The New Pieces Added Report provides you with a recurring report on all pieces created within a past time period that you can specify. This time period is entered in days, allowing you to include pieces that were created within the past day, two days, three days, etc.
This report comes in the form of a CSV, TSV, or XML file. Unlike the Download Piece Report action which provides very detailed information about the pieces, this report contains only some basic information about the pieces. You can download an example report here.
Setup
To set up the New Pieces Added Report action in Easy Send Automate …
- Click Setup on the homepage.
- Click Add at the top of the Setup page.
You’ll be brought to the Action Settings page.
Website settings
First, select the URL that contains easysenddigital.com. This represents the production endpoint. The other option in this dropdown represents a test environment and should only be used when troubleshooting with our support team.
Then, within the Easy Send Digital web-app, find your integration credentials. Copy and paste your Integration ID into the Username field and your Integration Key into the Password field. You can see instructions on creating or finding your integration credentials here.
Action settings
Make sure the Enable Action checkbox is checked, then select Easy Send New Pieces Added Report from the Action dropdown. Once this is selected, you’ll see a few more options appear under the Variables section.
You can choose to add a Description to this action to be able to identify it easier.
Next, select an Output Path. This is the exact location in your local environment where the reports will be saved.
The Postprocess field is an optional field that allows you to upload a VB script file. This script will run after each report is downloaded, allowing you to automate any kind of processing you’d like to execute for each file.
Variables
First, choose your preferred Poll Time in minutes from the dropdown menu. This determines the frequency at which the report will be ran. You can choose from 60, 120, 240, 480, 720, or 1440 minutes.
Next, select the time period you would like to report on in the Number of Previous Days to Include field. You can choose from 0, 1, 7, 14, 30, 60, or 90 days.
Finally, select your preferred File Format. You can choose from CSV, TSV, or XML.
Once you’re done, click Save, and your action will be created. You are now set up to have the reports automatically downloaded to your local environment each day.
Viewing downloaded reports
Once the action is set up, you’ll see a new report appear in your designated output folder at the frequency you’ve specified for the Poll Time. The file name will follow the default naming convention:
PiecesAdded_[created_date:yyyymmddHHmmss]
[created_date:yyyymmddHHmmss] represents the date and time the action was ran in the format of yyyymmddhhmmss.
