# tcmnode properties #

![TCM node icon](https://dataplatform.cloud.ibm.com/docs/content/wsd/nodes/scripting_guide/clementine/images/tcmnodeicon.png)Temporal causal modeling attempts to discover key causal relationships in time series data\. In temporal causal modeling, you specify a set of target series and a set of candidate inputs to those targets\. The procedure then builds an autoregressive time series model for each target and includes only those inputs that have the most significant causal relationship with the target\.

<!-- <table "summary="tcmnode properties" class="defaultstyle" "> -->

tcmnode properties  

Table 1\. tcmnode properties

| `tcmnode` Properties              | Values                                                                                                                                                                                             | Property description                                                                                                                                                                                                                                                   |
| --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `custom_fields`                   | *Boolean*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `dimensionlist`                   | \[*dimension1 \.\.\. dimensionN*\]                                                                                                                                                                 |                                                                                                                                                                                                                                                                        |
| `data_struct`                     | `Multiple`  <br>`Single`                                                                                                                                                                           |                                                                                                                                                                                                                                                                        |
| `metric_fields`                   | *fields*                                                                                                                                                                                           |                                                                                                                                                                                                                                                                        |
| `both_target_and_input`           | \[*f1 \.\.\. fN*\]                                                                                                                                                                                 |                                                                                                                                                                                                                                                                        |
| `targets`                         | \[*f1 \.\.\. fN*\]                                                                                                                                                                                 |                                                                                                                                                                                                                                                                        |
| `candidate_inputs`                | \[*f1 \.\.\. fN*\]                                                                                                                                                                                 |                                                                                                                                                                                                                                                                        |
| `forced_inputs`                   | \[*f1 \.\.\. fN*\]                                                                                                                                                                                 |                                                                                                                                                                                                                                                                        |
| `use_timestamp`                   | `Timestamp`  <br>`Period`                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `input_interval`                  | `None`  <br>`Unknown`  <br>`Year`  <br>`Quarter`  <br>`Month`  <br>`Week`  <br>`Day`  <br>`Hour`  <br>`Hour_nonperiod`  <br>`Minute`  <br>`Minute_nonperiod`  <br>`Second`  <br>`Second_nonperiod` |                                                                                                                                                                                                                                                                        |
| `period_field`                    | *string*                                                                                                                                                                                           |                                                                                                                                                                                                                                                                        |
| `period_start_value`              | *integer*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `num_days_per_week`               | *integer*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `start_day_of_week`               | `Sunday`  <br>`Monday`  <br>`Tuesday`  <br>`Wednesday`  <br>`Thursday`  <br>`Friday`  <br>`Saturday`                                                                                               |                                                                                                                                                                                                                                                                        |
| `num_hours_per_day`               | *integer*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `start_hour_of_day`               | *integer*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `timestamp_increments`            | *integer*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `cyclic_increments`               | *integer*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `cyclic_periods`                  | *list*                                                                                                                                                                                             |                                                                                                                                                                                                                                                                        |
| `output_interval`                 | `None`  <br>`Year`  <br>`Quarter`  <br>`Month`  <br>`Week`  <br>`Day`  <br>`Hour`  <br>`Minute`  <br>`Second`                                                                                      |                                                                                                                                                                                                                                                                        |
| `is_same_interval`                | `Same`  <br>`Notsame`                                                                                                                                                                              |                                                                                                                                                                                                                                                                        |
| `cross_hour`                      | *Boolean*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `aggregate_and_distribute`        | *list*                                                                                                                                                                                             |                                                                                                                                                                                                                                                                        |
| `aggregate_default`               | `Mean`  <br>`Sum`  <br>`Mode`  <br>`Min`  <br>`Max`                                                                                                                                                |                                                                                                                                                                                                                                                                        |
| `distribute_default`              | `Mean`  <br>`Sum`                                                                                                                                                                                  |                                                                                                                                                                                                                                                                        |
| `group_default`                   | `Mean`  <br>`Sum`  <br>`Mode`  <br>`Min`  <br>`Max`                                                                                                                                                |                                                                                                                                                                                                                                                                        |
| `missing_imput`                   | `Linear_interp`  <br>`Series_mean`  <br>`K_mean`  <br>`K_meridian`  <br>`Linear_trend`  <br>`None`                                                                                                 |                                                                                                                                                                                                                                                                        |
| `k_mean_param`                    | *integer*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `k_median_param`                  | *integer*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `missing_value_threshold`         | *integer*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `conf_level`                      | *integer*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `max_num_predictor`               | *integer*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `max_lag`                         | *integer*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `epsilon`                         | *number*                                                                                                                                                                                           |                                                                                                                                                                                                                                                                        |
| `threshold`                       | *integer*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `is_re_est`                       | *Boolean*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `num_targets`                     | *integer*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `percent_targets`                 | *integer*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `fields_display`                  | *list*                                                                                                                                                                                             |                                                                                                                                                                                                                                                                        |
| `series_dispaly`                  | *list*                                                                                                                                                                                             |                                                                                                                                                                                                                                                                        |
| `network_graph_for_target`        | *Boolean*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `sign_level_for_target`           | *number*                                                                                                                                                                                           |                                                                                                                                                                                                                                                                        |
| `fit_and_outlier_for_target`      | *Boolean*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `sum_and_para_for_target`         | *Boolean*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `impact_diag_for_target`          | *Boolean*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `impact_diag_type_for_target`     | `Effect`  <br>`Cause`  <br>`Both`                                                                                                                                                                  |                                                                                                                                                                                                                                                                        |
| `impact_diag_level_for_target`    | *integer*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `series_plot_for_target`          | *Boolean*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `res_plot_for_target`             | *Boolean*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `top_input_for_target`            | *Boolean*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `forecast_table_for_target`       | *Boolean*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `same_as_for_target`              | *Boolean*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `network_graph_for_series`        | *Boolean*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `sign_level_for_series`           | *number*                                                                                                                                                                                           |                                                                                                                                                                                                                                                                        |
| `fit_and_outlier_for_series`      | *Boolean*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `sum_and_para_for_series`         | *Boolean*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `impact_diagram_for_series`       | *Boolean*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `impact_diagram_type_for_series`  | `Effect`  <br>`Cause`  <br>`Both`                                                                                                                                                                  |                                                                                                                                                                                                                                                                        |
| `impact_diagram_level_for_series` | *integer*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `series_plot_for_series`          | *Boolean*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `residual_plot_for_series`        | *Boolean*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `forecast_table_for_series`       | *Boolean*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `outlier_root_cause_analysis`     | *Boolean*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `causal_levels`                   | *integer*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `outlier_table`                   | `Interactive`  <br>`Pivot`  <br>`Both`                                                                                                                                                             |                                                                                                                                                                                                                                                                        |
| `rmsp_error`                      | *Boolean*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `bic`                             | *Boolean*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `r_square`                        | *Boolean*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `outliers_over_time`              | *Boolean*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `series_transormation`            | *Boolean*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `use_estimation_period`           | *Boolean*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `estimation_period`               | `Times`  <br>`Observation`                                                                                                                                                                         |                                                                                                                                                                                                                                                                        |
| `observations`                    | *list*                                                                                                                                                                                             |                                                                                                                                                                                                                                                                        |
| `observations_type`               | `Latest`  <br>`Earliest`                                                                                                                                                                           |                                                                                                                                                                                                                                                                        |
| `observations_num`                | *integer*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `observations_exclude`            | *integer*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `extend_records_into_future`      | *Boolean*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `forecastperiods`                 | *integer*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `max_num_distinct_values`         | *integer*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `display_targets`                 | `FIXEDNUMBER`  <br>`PERCENTAGE`                                                                                                                                                                    |                                                                                                                                                                                                                                                                        |
| `goodness_fit_measure`            | `ROOTMEAN`  <br>`BIC`  <br>`RSQUARE`                                                                                                                                                               |                                                                                                                                                                                                                                                                        |
| `top_input_for_series`            | *Boolean*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `aic`                             | *Boolean*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `rmse`                            | *Boolean*                                                                                                                                                                                          |                                                                                                                                                                                                                                                                        |
| `date_time_field`                 | *field*                                                                                                                                                                                            | Time/Date field                                                                                                                                                                                                                                                        |
| `auto_detect_lag`                 | *Boolean*                                                                                                                                                                                          | This setting specifies the number of lag terms for each input in the model for each target\.                                                                                                                                                                           |
| `numoflags`                       | *Integer*                                                                                                                                                                                          | By default, the number of lag terms is automatically determined from the time interval that is used for the analysis\.                                                                                                                                                 |
| `re_estimate`                     | *Boolean*                                                                                                                                                                                          | If you already generated a temporal causal model, select this option to reuse the criteria settings that are specified for that model, rather than building a new model\.                                                                                              |
| `display_targets`                 | `"FIXEDNUMBER"`  <br>`"PERCENTAGE"`                                                                                                                                                                | By default, output is displayed for the targets that are associated with the 10 best\-fitting models, as determined by the R square value\. You can specify a different fixed number of best\-fitting models or you can specify a percentage of best\-fitting models\. |

<!-- </table "summary="tcmnode properties" class="defaultstyle" "> -->

<!-- </article "role="article" "> -->