How do you run this agent?

As a scheduled EIA (EQuIS Information Agent).

Manually/on demand (in Enterprise or Professional), or as a scheduled EIA.

Note: The Data Deriver Agent is run as a scheduled EIA in most cases, and the Data Deriver Update Agent is run manually, if the source data changes.

What series does it process?

User selected series, or if no series are selected, ALL active (STATUS_FLAG = 'A') DT_LOGGER_SERIES rows where SERIES_FUNCTION = 'EarthSoft.Live.Reports.DataDeriverAgent' and SERIES_FUNCTION_INFO is not NULL.

User selected series; see Source Series and Derived Series parameters in the next section.

Start Date

The next time period, after the series' last calculated time period.

User selected Start Date; see Start Date parameter in the next section.

End Date

The maximum time period for which we have ALL of the necessary source data.

The maximum time period for which we have ALL of the necessary source data, OR the user selected End Date; see End Date parameter in the next section for more details.

Updates existing derived data?

No

Yes, if UPDATE parameter is checked, but only if there is source data for that time period.

Inserts new derived data?

Yes, and inserts NULL if there is no source data for that time period.

Yes, if INSERT parameter is checked, but only if there is source data for that time period.

Deletes existing DERIVED data?

No, unless the derived series is the source to another derived series; see next row.

Yes, if DELETE parameter is checked, and there is no source data for that time period.

Deletes existing SOURCE data?

Yes, if deleteInputDataAfter is specified in the derived series' SERIES_FUNCTION_INFO.

No

Runs exportSql in a series' SERIES_FUNCTION_INFO?

Yes

No, use exportSqlProcedure as it contains a couple of additional parameters: @deriver_end_date DATETIME, and @deriver_update_yn CHAR, needed for updating; see exportSqlProcedure example in Data Deriver Agent.

Source Series

Select one or more source series to update all derived series that use it/them.

A derived series 'uses' another series if its DT_LOGGER_SERIES.SERIES_FUNCTION_INFO sourceSeriesId array contains that other series' LOGGER_SERIES_ID. This 'usage' can be recursive, if the sourceSeriesId array contains a DERIVED series' LOGGER_SERIES_ID.

Note: If you select a DERIVED series, the derived series you select is also updated (in addition to the derived series that use it).

The source series list includes all source DT_LOGGER_SERIES rows, including derived series, if they are sources to other derives series.

Derived Series

Select one or more derived series to update.

Notes:

•This list includes ALL active (STATUS_FLAG = 'A') DT_LOGGER_SERIES rows where SERIES_FUNCTION = 'EarthSoft.Live.Reports.DataDeriverAgent' and SERIES_FUNCTION_INFO is not NULL.

•ONLY these derived series are updated—not any of their source series, or any of the series that use them.

Start Date

Update derived data >= this date.

Warning: If deleteInputDataAfter is specified in the series' SERIES_FUNCTION_INFO, or if you are using the Data Expiration Agent to delete older data, pay close attention to the Start Date that you select. If a time period has PARTIAL source data, it may produce inaccurate derived data.

End Date

Update derived data <= this date.

Includes the whole day, plus one time period for the derived series is added to it. Thus, it includes all of the SOURCE series data <= this date.

Parameter 'If inserting new derived data, stop at the maximum time period for which we have ALL of the necessary source data, or at End Date, whichever comes first?' may override this parameter, if it is checked.

SAVE changes to database?

Check this box to save the changes to the database, or uncheck it to display the changes without saving them.

This parameter is initially unchecked: it will show the changes, but not save them to the database.

Note: The exportSqlProcedure will NOT be executed if this parameter is unchecked.

UPDATE existing derived data if source data was changed?

Check this box to update existing derived data if source data was changed, added, or deleted, in one or more time periods with existing derived data. Derived data is not updated if a time period has no source data. This option does not INSERT new derived data; use the INSERT parameter to insert.

INSERT new derived data if source data was added?

Check this box to insert new derived data if source data was added to one or more time periods with no existing derived data. Derived data is not inserted if a time period has no source data.

If inserting new derived data, stop at the maximum time period for which we have ALL of the necessary source data, or at End Date, whichever comes first?

Check this box to stop inserting new derived data at the maximum time period for which we have ALL of the necessary source data, or at End Date, whichever comes first, OR uncheck this box to insert new derived data until End Date, even if we may not have all of the necessary source data. Either way, derived data will not be inserted if a time period has NO source data. However, if unchecked, derived data will be inserted if a time period has PARTIAL source data.

Tip: The Data Deriver Agent stops inserting new derived data at the maximum time period for which we have ALL of the necessary source data. So, if you are not sure, keep this box checked just to be safe.

DELETE existing derived data if source data was deleted, or if derived data date times have changed?

Check this box to delete existing derived data if source data was deleted, leaving one or more time periods with no source data, or if derived data date times have changed.