Editing Time Series Data

Data contained in Scalar and Spatial time series data objects can be edited by the user in the Time Series Data window .

Which data is user editable depends on the dimensionality (scalar/spatial) and the type (observed/forecast) of the stream. Any fields that can be used in a user edit as described below, and only those fields, can be applied to the real data.

Tip: Editing time series data can be permissioned and therefore may not be available to users who have not been granted rights to perform this operation. If this is the case the time series data window will be read-only. Read-only time series data can be easily identified by a R/O caption in the window title bar. Alternatively, buttons (such as Apply Edits or Update Data buttons) may be disabled for such users.

Observed data

The fields of a time series point which can potentially be edited are value, flag, and whether the data point is to be excluded or protected.

In addition new time series data points can be added with a new timestamp, using the button, depending on the stream type and dimensionality:

• For scalar observed data, all of these fields can be used in a user edit. New time series data points can be inserted.
• For spatial observed data, all fields except for value can be used in a user edit. New time series data points cannot be inserted.

Forecast data

Only the forecast origins are editable (check box and Flag field can be modified), the forecast data itself cannot be edited.

This means used edits on forecasts are restricted to the following: flag, whether the forecast origin is to be excluded or protected.

If exclude is set on a time series data point for a forecast origin this means all of the forecast data for that origin would be ignored.

Working with user edits

This section describes how to create, save, edit and delete users edits using the Time Series Data window and the Live Data window. Note that user edits can also be created from the Regulate window, in the context of regulator control.

To create a new user edit

1. Open the Live Data window.
2. Ensure that the data time zone is correct.
3. Right-click on the data stream to create a new user edit for and select Add from the context menu. The Time Series Data window is opened.
4. Alternatively, if the Time Series Data window is already open, click New in the User Edit section.

   The New User Edit dialog is displayed.

5. Type in a name for the edit and click OK.
6. The user edit becomes current (the User Edit combo box is populated with its name) in the Time Series Data window.
7. Make the desired edits. See the sections below for details.
8. Click Save to save the changes to the user edit.
9. Click Apply Edits to commit the changes so that they are available to all users.

To save a user edit

1. Select the user edit in the User Edit combo box of the Time Series Data window.
2. Make the desired edits.
3. Click Save to save the changes to the user edit.

To edit an existing user edit

1. Open the Live Data window.
2. Right-click the data stream to edit a new user edit for and select View/Modify from the context menu. The Time Series Data window is opened.
3. Alternatively, if the Time Series Data window is already open, s elect the user edit in the User Edit combo box.
4. Make the desired edits. Usually, values (User Value column) and flags (User Flag column) can be edited, and data can be excluded from runs.
   To change a user value, you can either select the cell and type in the new value or you can right-click on one or more selected cell(s) and choose one of the following options from the context menu:

   • Set new value(s) for cell(s), which displays the New Cell Value dialog. Type a new value for the selected cells and click OK.
   • Adjust current value(s) for cell(s), which displays the Adjust Cell(s) Value dialog. Enter the values by which the selected cells are to be amended and click OK.
   • Insert timestep, which inserts a new timestep after the cell from which you selected this option.
   • Insert multiple timesteps, which displays the Add Multiple Timesteps (after) dialog. Use the arrow keys to specify the number of new timsteps you want to add, and then click OK. The specified number of timesteps will be added after the cell from which you selected this option.
5. Click Save to save the changes to the user edit.

Tip: Do not forget to click Apply Edits for the changes to be made available to all users.

To delete a user edit:

1. Open the Live Data window.
2. Right-click the user edit to delete and select Delete from the context menu.
3. Alternatively, if the Time Series Data window is open, s elect the user edit in the User Edit combo box and click Delete.

   The user edit is deleted.

Note: Use the Delete functionality with care as the deletion is immediate.

Excluding data points / forecast origins

To exclude data points:

1. Open the Live Data window.
2. Ensure that the data time zone is correct.
3. Right-click the user edit to make edits for and select View/Modify from the context menu. The Time Series Data window is opened.
4. Tick on the column for the desired rows (spatial time series data only) or delete the user values of interest in the User Value column (scalar time series data only).
5. Save the edit.
6. Click Apply Edits.

   The following message is displayed:

   

7. Click No to apply the edits in normal mode (such edits may be overridden by subsequent updates from external sources).

   A strike-through is used to indicate that the rows will not be used.

Protecting edits

Edits can be protected so they will never been overwritten by external source updates.

For this, follow the steps presented in the sections above for editing time series data.

When you click Apply Edits, select Yes on the Apply user edits read-only? message instead of No.

A padlock () appears to the left of the row(s), indicating that the data is protected.

Controlling regulators in ICMLive Operator Client

The Regulate window can be used to edit Time Series Data when controlling regulators:

1. Create a new run in the Runs window of the Operator.
2. Open the Regulate window. Click the Regulate tab in the Operator's left side or select Regulate from the Window menu. If required, click on one of the arrows of the following button which can be found at the bottom right corner of the window currently displayed in the rightmost pane to scroll to the correct tab.
3. Select the type of regulator to create a user edit for by selecting the relevant radio button.

   The list box gets populated with the regulators of the selected type, that are connected to a TVD connector.

4. Select one or more regulators in the list. If there is only one regulator meeting the criterion, it will be selected by default.
5. Specify the start and end date/time for the simulation in the From and Until controls.
6. Enter an overriding value in the Value box.
7. Click Apply.
8. The New User Edit dialog is displayed.
9. Edit the name of the edit as appropriate and click OK.
10. The user edit will appear in the Live Data window and will be automatically selected (ticked checkbox) if it has been set within the run start and end dates, indicating that it will be used in the run. Otherwise, it will not be shown on the Live Data window but will be available to select from the User Edit dropdown of the Time Series window.
11. If required repeat steps 3 to 10 to create more user edits for the same regulator or user edits for other regulators in the network.
12. Ensure that the desired user edits are included in the run about to be carried out (ticked checkboxes in the Live Data window).
13. Click the Simulate run hyperlink of the Runs window to start the run.

Time series data may also be manually (on demand update) or automatically (scheduled or triggered update) updated from data sources. See Updating Time Series Data for details.