VI Timeseries Process Object

The Visual Integrator (VI) Timeseries process object simplifies the creation of time period columns based on a set of rows. This object functions like the time series function in ProDiver with options to simplify the calculation of time series columns.

Icon for VI Timeseries process object

The Timeseries process object combines rows that are identical for a set of dimension columns, but differ based on a period column. It creates a set of summary columns that represent sums of these columns, based on different selections of the rows.

The Timeseries process object has Closedthree panes where you set attributes.

VI Timeseries Object All Panes

You set attributes for the Timeseries process object in the Closedobject attributes pane.

Example of VI Timeseries process object attributes

Attribute Description
Input

Defines the object from which the data flow arrives. Use one of the following methods to attach the Timeseries object to an input data flow object:

  • Right-click the input data flow object, and click New Object after this > Process > Timeseries.

  • Place the Timeseries object on the task flow, and click its Input attribute's browse button. Move the pointer to the task flow, and note that a dotted-line connector is attached to the Timeseries object. Attach this connector to the input data flow object.

    NOTE: The Timeseries object's Input attribute is now populated with the name of the input data flow object.
InputPeriodColumn Defines the input column used to define the time period for the row. Click in InputPeriodColumn box, and use the list to choose the appropriate column. The data in this column must be in the form of YYYY-MM or YYYY/MM.
OutputPeriodColumn Defines the output column that returns the time period for the row. The data in this output column is returned in the form of YYYY-MM or YYYY/MM, based on the format used for the End attribute.
Start Defines the start of the time period. Use either YYYY-MM or YYYY/MM format.
End Defines the end of the time period. Use either YYYY-MM or YYYY/MM format.
FiscalEnd Defines the month that ends the fiscal year for fiscal time periods. Must be an integer between 1 and 12 inclusive. The default value is 12. Do not use this attribute if using the FiscalEndColumn attribute because these attributes are mutually exclusive.
FiscalEndColumn Defines an input column that determines the end of the fiscal year for fiscal period types. The contents of the column must be an integer from 1 through 12, inclusive. Use this attribute to vary the fiscal year. Do not use this attribute if using the FiscalEnd attribute because these attributes are mutually exclusive.
PeriodUnit Defines the period unit. Currently, the value is set to month and cannot be changed.
Period_Types

Defines one or more period columns that the Timeseries object creates in the output flow. For each Period_Type defined, a new column is generated in the output flow with the Period_Type name.

  1. Click the browse button in the Period_Type box.

    The ClosedPeriod_types for <object_name> dialog box opens.

    Example of an empty Period_Types dialog box

  2. Enter a type and press Enter to enter Closedadditional types.

    Example of full Period_Types dialog

  3. Click OK.

  4. The types now display in the Period_Types Closedattribute box.

Supported values fall into the following three categories:

  • MONTH (Month)—Defines the period of the end month.
  • SMLY (Same Month Last Year)—Defines the period of the end month for the year previous to the end year.
  • YTD (Year To Date)—Defines the period from January through the end month of the end year.
  • LYTD (Last Year To Date)—Defines the period from January through the end month for the year previous to the end year.
  • LY (Last Year)—Defines the period from January through December in the previous year.
  • FYTD (Fiscal Year To Date)—Defines the period from the beginning of the fiscal year (defined by the FiscalEnd attribute) through the end month.
  • FLYTD (Fiscal Last Year To Date)—Defines the period from the beginning of the previous fiscal year (defined by the FiscalEnd attribute) through the end month a year ago.
  • FLY (Fiscal Last Year)—Defines the period from the beginning of the previous fiscal year (defined by the FiscalEnd attribute) through the end of the previous fiscal year.
  • R<n> (Rolling <n>)—Defines the period starting from <n>-1 months before the end period through the end period. The value <n> is a number from 2 through 100. For example, R3 includes three months, that is, the end month plus the two previous months.
  • R<n>LY (Rolling <n> Last Year)—Defines the period starting from <n>-1 months before the end month in the previous year, through to the end month in the previous year. The value <n> is a number from 2 through 100.
Custom_Period_Types

Defines custom period types beyond those supported in the Period_Types attribute.

  1. Click the Custom_Period_Types attribute's browse button

    The ClosedEdit Custom Period Types dialog box opens.

    Example of a VI Timeseries Custome Period Types dialog box

  2. Click Add, and a new period type is added with the default name (NewCustomPeriodType).

  3. Select the new period type, and change the name.

  4. Set any of the following attributes that apply, and click OK:

    The custom period type is added to the Custom_Period_Types attribute box. Multiple entries are separated by a comma.

    • Type—Defines the subtype of the period type. Choose one of the following:

      • Year—Default range is set from the beginning of the year through the end of the year.
      • YTD (Year To Date)—Default range is set from the beginning of the year through the end period.
      • Month_Range—Define the months by the start_offset and end_offset attributes.

    • Name—Change the default NewCustomPeriodType name for the custom period type.

    • fiscal_end_column—Defines an input column that determines the fiscal end of the year for the period type. Use this attribute to vary the fiscal year. Do not use this attribute if using the fiscal_end attribute as these attributes are mutually exclusive.

    • fiscal_end—Defines the month that ends the fiscal year for fiscal time periods. Must be an integer from 1 through 12, inclusive. The default value is 12. Do not use this attribute if using the fiscal_end_column attribute as these attributes are mutually exclusive.

    • fiscal—When selected, use the fiscal_end attribute as defined by the fiscal_end_column attribute (if specified), the fiscal_end attribute (if specified), or the top-level FiscalEnd attribute.

      Defining a fiscal_end_column or fiscal_end value implies a fiscal period type. The fiscal check box is used only for a fiscal period type that should pick up the fiscal end from the top-level FiscalEnd attribute.

    • start_offset—Defines an offset for the start range of the period. This attribute is required for Month_Range period types.

      • For Month_Range period types, this is an offset from the end period.
      • For YTD period types, this is an offset from the beginning of the year.
    • end_offset—Defines an offset for the end range of the period. For all period types, this is an offset from the end period.
    • delta—Defines the number of months subtracted for each succeeding period type defined. Typically, this is set to 12, indicating that each succeeding period type is a year earlier.

You can use the Remove button to delete period types from the list.
AutoSort

This optional attribute determines whether or not the Timeseries object automatically sorts the input flow according to the dimensions.

  • true (default)—The Timeseries object creates an anonymous Sort object with sort columns matching the dimensions. This sort uses default values for Sort attributes, such as temp_directory and sort_size. If you need to set these attributes or your data is larger than the available memory, use an explicit Sort object before the Timeseries object.
  • false—The Timeseries object does not perform an automatic sort on the input flow.
WarnLimit

This optional attribute controls how many data integrity warnings are displayed in the log. By default, this attribute is not set. If a limit is set and reached, the log displays the following message:

Further data integrity warnings suppressed for Timeseries object "<object_name>". Increase the warn_limit attribute to see more.

KeepBlankRows

Determines if the object returns rows with blank Timeseries columns.

  • true—All possible rows for all output periods are returned.
  • false (default)—Only rows where a Timeseries column is set are returned.

These returned columns are columns that are used by later objects. For example, the number of rows that are returned varies by which columns are listed in the output object's column grid attributes.
KeepAllOtherColumns

Determines if all the input columns are preserved and passed to the output from the Timeseries object.

True—All columns are passed to the output flow, including those not marked as Timeseries columns.

False (default)—Only the Timeseries columns are passed to the output flow.

Each object has an area where you can enter comments.

It is a DI best practice to enter a note for every object in a VI script. You can set a VI preference to give a warning for each object without a note. For more information, see Visual Integrator Preferences.

ClosedTimeseries process object with comments

Example comments for VI Timeseries process object

The ClosedTimeseries column grid displays the input columns and other attributes, which you can set.

Example of a VI Timeseries process object's column grid

Attribute Description
Input Column Displays the name of each input column. This attribute is read-only.
Source Object Displays the name and object type of the source object. Double-click the Source Object for a column to change the task flow focus to that object.
Dimensions

Defines the input columns used to combine rows. Rows that have identical values for all the dimension columns are combined. Select the Dimension check box for columns that you want to set as dimensions.

Summary

Defines input columns that are totaled. These columns are summed into summarized output rows in the data flow. Select the Summary check box for numeric columns that you want summarized. These columns must be numeric or blank (null). Null values are treated as zeros and do not effect the summary calculation, but return null if all values are null.
Other Defines input columns that are preserved and passed to the output data flow. Select the Other check box for input columns that you want to pass to the output data flow. This optional attribute is useful for keeping data intact.
Remove

Manages which columns are removed from the output data flow. Select the Remove check box for columns that you want to explicitly suppress from the output data flow.

NOTE: Use the Remove check boxes only when no Keep check boxes are checked.
Dimcount

Defines the input columns whose distinct values are assigned to output flow columns based on the period. For each Dimcount column, there is a new Timeseries column for each Period_Type attribute specified. The new output columns have the name in the following format:

<period><dimcount columns> Count

The value is the number of distinct values of the Dimcount count that appears for that period.

NOTE: Keep in mind the following notes while setting the check boxes in the Timeseries process object column grid:

  • Input columns can be set as one of the following: Dimension, Summary, or Other. At least one dimension is required.
  • Only input columns set for Dimension, Summary, or Other are passed to the output data flow.
  • Only numeric columns can be marked as Summary.
  • The Other and Remove check boxes are mutually exclusive.