This article outlines the details specific to updating the Report Profiles table CSV. There are several actions that can be taken through the Bulk Management feature for this section:
- Create brand new Report Profiles for any existing Accounts
- Edit the details of existing Report Profiles including changing status; (Pause currently running Profiles and Resume Profiles currently Paused)
- Delete Report Profiles
NinjaNote: A Report Profile profile must be attached to an Advertiser/Account. The Bulk Management: Report Profiles process does not create net new accounts. This is a separate function; see the article for Accounts and Account Settings in order to update/add/delete accounts at scale.
Column Header | Details |
Action |
Accepted Values: ‘Add’ : to be used when a net new row is being included in the file, symbolizing a net new report profile ‘Update’ : to be used when an already existing row is being updated in some way ‘Delete’ : to be used when a report profile should be removed ‘Ignore’: to be used if nothing should be done with the row. Leaving the cell blank is also accepted, defaulting to “ignore” ‘Pause’ : to pause a scheduled report from its set run schedule ‘Resume’ : to unpause a scheduled report and resume its set run schedule |
Status (Read Only) |
This column is considered ‘Read Only’ meaning that values will be included here in order to view, but the column itself is ignored altogether / uneditable The only value a user could expect here is ‘Paused,’ meaning that a report profile has been paused from its original runtime schedule. A blank field means it’s unpaused **system will not catch values in this column due to it being read-only. Be sure to include Pause / Resume commands in the Action column. |
Report ID | The unique Report ID for an existing Report Profile. This is not required when adding a net new report since a unique ID has not been given yet. This ID needs to remain for those existing reports that you wish to update otherwise the system will not find a match to an existing report. |
Company | This is the Company name of the Advertiser associated with the report. Required field |
NinjaCat ID | This is the Advertiser ID of the Company/Advertiser associated with the report. Required field |
Template | This is the name of the already existing template that should drive the report profile. Required field |
File Name |
The name that was given to the file. Placeholders listed in the Report Profile settings screen are accepted here [insert link out to already existing KB article that includes these] This field is Case Sensitive. Required |
File Type |
This is the type of file that will be created when the report is run. This cannot be changed after the report has been created. Accepted Values: PDF, Powerpoint, CSV Required |
Schedule Type |
Accepted Values: ‘Manual’ - to be run on demand by the user. If selected, then columns I - L are not required. ‘Daily’ - if selected, columns J and K are not required. ‘Weekly’ - if selected, then column J is not required. ‘Monthly’ - if selected, then column K is not required. Required |
Repeat |
Accepted Value here depends on the given Schedule Type If ‘Monthly,’ can be any integer from 1 to 12. Represents the number of months to wait between runs. If ‘Weekly,’ can be any integer from 1 to 52. Represents the number of weeks to wait between runs. If ‘Daily,’ can be any integer from 1 to 45. Represents the number of days to wait between runs. Required if NOT manual |
Day of Month | If Schedule Type is set to ‘Monthly,’ then this is a required field. This indicates the date(s) of the month to run on. Can be any integer from 1 to 31. Multiple values can be indicated by separating them with a semicolon. |
Weekdays | If the Schedule type is set to ‘Weekly,’ then this is a required field. This indicates the day(s) of the week to run on. Can be any day ( Monday;Tuesday;Wednesday;Thursday;Friday;Saturday;Sunday)... Multiple values can be indicated by separating them with a semicolon. |
Time | The time to run the report in format HH:MM [AM/PM] |
Date Range Type |
Accepted Values: ‘Quick’ and ‘Absolute’ *Note: ‘Relative’ is also an option to select manually through the report settings, and if a report profile is already set to ‘Relative,’ then this field would read: ‘Relative (Info not Included)’ upon export. At this time, cannot handle updates to a Relative Date Range Type nor update an existing report to use Relative. This must be managed manually through the UI. |
Quick Date Range |
Required field if Date Range Type is set to ‘Quick.’ Accepted values will be the options provided under the ‘Quick’ tab of the Date Range Override picker (see report settings). [Insert link to existing KB article with all these options listed– is there one?] |
Absolute Date Range Start Date |
The Starting Date that will be used for the Absolute Date Range for this report. Required field if Date Range Type is set to 'Absolute' Must be in the format: YYYY-MM-DD |
Absolute Date Range End Date |
The Ending Date that will be used for the Absolute Date Range for this report. Required field if Date Range Type is set to 'Absolute' Must be in the format: YYYY-MM-DD |
Absolute Days to Include | If Date Range Type is 'Absolute', can be any day ( Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday ). Multiple values can be indicated by separating them with a semicolon. |
Delivery Mode (Read Only) |
This is a Read Only column, where values listed here could be: Email, S3, SQL, Big Query, or FTP. * The user is able to update the settings of an existing report profile that is in ANY Delivery Mode (including S3, SQL, etc), but is not able to update the Delivery Mode (because Read Only). Any net new reports /rows that are imported, will always be Delivery Mode of Email. Users cannot create new reports through bulk management meant for any Delivery Mode other than Email. These must be made manually in NinjaCat since credentials are required in the Report Profile Settings in order to create this type of report. *Note: Delivery Modes of S3, SQL, Big Query, and FTP are only available to users who have had the ‘Data Pipelines’ feature enabled. Please reach out to your CSM if this is a needed feature. |
Email Mode |
if the report Delivery Mode is Email, either set to Do Not Email or Automatic Email. Use ‘Automatic’ to automatically email the report when it's run automatically (manually running a report will not send an email). ‘Do Not Email’ will still run the report as scheduled, but it will not send and be left in the Report Profile library available for download. |
Email Recipients Mode |
if the report Delivery Mode is Email, either set to Single or Multiple. Select "Single" if you want 1 email sent to all email addresses. Select "Multiple" if you want a separate email sent for each email address. |
Email Recipients |
By default, reports will be emailed to the email associated with the Account. Enter a value here to send to a different set of email addresses. Use a semicolon to separate each email if entering multiple emails (e.g. john@email.com;frank@email.com) Can be left blank |
Attachment Mode | if the report Delivery Mode is Email, either set to Include or Do Not Include |
Email Subject (Optional) |
By default, reports will use the subject configured in the Agency Settings Email Templates. Enter a value here to supply a custom subject for this report. Placeholder Clips are accepted here. Click this link to view placeholder definitions. This field is Case Sensitive. |
Email Body (Optional) |
By default, reports will use the body configured in the Agency Settings Email Templates. Enter a value here to supply a custom body for this report. Placeholder clips are accepted here [insert KB link] This field is Case Sensitive. |
Comments
0 comments
Article is closed for comments.