Skip to content

Commit

Permalink
Removed all info on alternative data source for model simulation from…
Browse files Browse the repository at this point in the history
… 10.18 doc

(cherry picked from commit 14b3775)
  • Loading branch information
kailol-sag committed Sep 4, 2024
1 parent 0bad6dd commit 3da8981
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 94 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -53,94 +53,6 @@ For example, specify the following to set the value to 5:

See also [Configuration](/streaming-analytics/analytics-builder/#configuration).

### Configuring an alternative data source for simulation

By default, the platform database is used to retrieve the historical data for the simulation of an analytic model. You can configure an alternative data source for simulation, for example, if historical data is maintained separately. The data source must support HTTP `GET` operations for the required path and query parameters. The response to the `GET` operation must conform to the standard JSON format of {{< product-c8y-iot >}}. Refer to the {{< product-c8y-iot >}} documentation for the data and query parameter formats.

If you want to use an alternative data source for simulation, you need to define the tenant options listed below. That is, you need to send 3 separate `POST /tenant/options` requests. For detailed information, see the information on the [tenant options](https://{{< domain-c8y >}}/api/core/{{< c8y-current-version >}}/#tag/Options) in the {{< openapi >}}.

- `simulation.dataSource.url` - The base HTTP URL of the data source.
- `simulation.dataSource.username` - The username to be used for the HTTP basic authentication.
- `simulation.dataSource.password` - The password to be used for the HTTP basic authentication.

For example:

```
{
"category": "analytics.builder",
"key": "simulation.dataSource.url",
"value": "http://192.168.1.1/"
}
```

```
{
"category": "analytics.builder",
"key": "simulation.dataSource.username",
"value": "myname"
}
```

```
{
"category": "analytics.builder",
"key": "simulation.dataSource.password",
"value": "secret"
}
```

See also [Configuration](/streaming-analytics/analytics-builder/#configuration).

The sections below list the path and query parameters that need to be supported by the alternative data source.

#### Alarms

Path: `alarm/alarms`

Query parameters:

- `source` - Source ManagedObject identifier of the alarms.
- `dateFrom` - Start date or date and time of the alarm occurrence.
- `dateTo` - End date or date and time of the alarm occurrence.
- `pageSize` - Maximum number of records to return.
- `currentPage` - The current returned page within the full result set, starting at page 1.

#### Events

Path: `event/events`

Query parameters:

- `source` - Source ManagedObject identifier of the events.
- `dateFrom` - Start date or date and time of the events.
- `dateTo` - End date or date and time of the events.
- `pageSize` - Maximum number of records to return.
- `currentPage` - The current returned page within the full result set, starting at page 1.

#### Measurements

Path: `measurement/measurements`

Query parameters:

- `source` - Source ManagedObject identifier of the measurements.
- `dateFrom` - Start date or date and time of the measurements.
- `dateTo` - End date or date and time of the measurements.
- `pageSize` - Maximum number of records to return.
- `currentPage` - The current returned page within the full result set, starting at page 1.

#### Operations

Path: `devicecontrol/operations`

Query parameters:

- `deviceId` - Source device identifier of the operations.
- `createdFrom` - Start creation time of the operations.
- `createdTo` - End creation time of the operations.
- `pageSize` - Maximum number of records to return.
- `currentPage` - The current returned page within the full result set, starting at page 1.

### Monitoring dropped inputs

The simulated model may drop delayed input events in exceptional cases. The number of input events dropped across all the models is exposed as a user-defined status with the name `user-analytics-oldEventsDropped`. See also [Monitoring dropped events](/streaming-analytics/analytics-builder/#monitoring-dropped-events).
Original file line number Diff line number Diff line change
Expand Up @@ -463,12 +463,6 @@ After you have changed a tenant option using a REST request, the correlator will
<td><code>simulation.maxInstances</code></td>
<td>The maximum number of simulation models to be deployed at a time. The default value is 3 models. See also <a href="/streaming-analytics/analytics-builder/#configuring-the-maximum-number-of-simulation-models">Configuring the maximum number of simulation models</a>.</td>
</tr>
<tr>
<td><code>simulation.dataSource.url</code><br>
<code>simulation.dataSource.username</code><br>
<code>simulation.dataSource.password</code></td>
<td>The URL of an alternative data source for simulation. This also requires a user name and password for HTTP basic authentication. See also <a href="/streaming-analytics/analytics-builder/#configuring-an-alternative-data-source-for-simulation">Configuring an alternative data source for simulation</a>.</td>
</tr>
</tbody>
</table>

Expand Down

0 comments on commit 3da8981

Please sign in to comment.