Difference between revisions of "Scheduled Reports"

From SmartWiki
Jump to: navigation, search
(Redirected page to Scheduled Report Export)
 
(14 intermediate revisions by one other user not shown)
Line 1: Line 1:
==Overview==
+
#REDIRECT [[Scheduled Report Export]][[Category:Reports]]
* [[System Administrator]]s can schedule reports to be run periodically (daily, weekly, monthly).
 
* Scheduled reports can be configured to store custom field values to SmartSimple records, allowing for the periodic aggregation of data.
 
* The following types of SmartSimple records can be updated:
 
:*[[Organization]] records
 
:*[[Contact]] records
 
:*[[UTA]] records, i.e. {{l1}}, {{l2}} and {{l3}} records
 
* Typical use cases might include:
 
:* On a monthly basis, automatically storing the total number of reviews that have been performed by a given user on their contact [[profile]].
 
:* On a weekly basis, automatically updating a user's profile to indicate whether or not timesheets have been filled out in SmartSimple.
 
:* On a daily basis, automatically updating on a company's [[profile]] a summation of the total number of grants for which contacts of that organization has applied.
 
<!--22927 - new scheduled reports-->
 
 
 
==Settings for Scheduled Reports==
 
 
 
''Scheduled Reports'' are built using SmartSimple's [[Reports|integrated reporting subsystem]]. The settings for ''scheduled reports'' are available on the [[Edit Report Page: Advanced Settings Tab|Advanced tab]] of the Edit Reports page.
 
 
 
[[Image:FieldCaching.jpg|link=]]
 
 
 
* '''Frequency''' - The frequency of scheduled reports can be set as follows
 
:* ''Disabled'' - This is the default setting, and indicates that a report will not run on an automated schedule.
 
:* ''Daily'' - The report will run every morning.
 
:* ''Weekly'' - The report will run every Sunday.
 
:* ''Monthly'' - The report will run on the first of every month
 
* '''Identifier Column''' - ''Match Field'' - This setting will draw from the list of columns selected in the [[Report Builder]]. This setting indicates the matching field which allows the system to know which record to update.
 
* '''Custom Field Value Column''' - ''Source Field'' - This setting also draws from the list of columns selected in the [[Report Builder]]. This setting represents the values the system will use to update the ''Custom Field'' specified below.
 
* '''Custom Field''' - ''Destination Field'' - The custom field that will be updated when the report is run.
 
* '''Last Run''' - Indicates when the scheduled report has last automatically run.
 
 
 
==Configuring Scheduled Reports==
 
 
 
To configure a scheduled report, the settings are configured as follows.
 
 
 
Take, as an example, the following [[Report Builder]] configuration:<br />
 
[[Image:ScheduledReportsReportBuilder.png|link=]]
 
<br />In the above configuration, the ''Name'' field is drawn from {{l1}} and the ''Fund Amount'' and ''Remaining Funds'' fields are drawn from {{l2}}. The [[Group By]] row will sum the amounts from the ''Fund Amount'' and ''Remaining Funds'' fields and show the totals for these fields, broken out by distinct values in the ''Name'' field. The report will produce results as follows:<br />
 
[[Image:ScheduledReportsReportResults.png|link=]]
 
 
 
 
 
[[Image:ScheduledReportsSelectIdentColumn.png|link=]]
 
[[Image:ScheduledReportsSelectCFVColumn.png|link=]]
 
[[Image:ScheduledReportsSelectCustomField.png|link=]]
 
 
 
==See Also==
 
* [[Edit Report Page: Advanced Settings Tab]]
 
 
 
[[Category:Reports]]
 

Latest revision as of 10:28, 13 February 2020