> For the complete documentation index, see [llms.txt](https://docs.novacura.com/marketplace-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.novacura.com/marketplace-documentation/components/explore-components/anomaly-detector/documentation/anomaly-detector.md).

# Anomaly Detector

## Overview

This flow is used to notify a user when an anomaly is detected allowing to review the report and send a work order if needed.

![](https://3218748546-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MiW42YxFsGXIDjQJKNR%2Fuploads%2Fdpw91YrQ3TPfJ6AgQwqU%2FPicture24.png?alt=media\&token=8a26c6ce-8632-48f2-940f-241db3e4bcc7)

## Description

This flow collects all the measurement readings from the IoT device and saves them in the IFS serial object and notifies the flow user when there is an Anomaly detected.

This flow can handle:

{% hint style="info" %}
This application is capable of:

* Review the prior measurements in a tabular and a graphical view
* View previously created work orders
* Create a new work order
  {% endhint %}

## Steps

### 1. IFS IoT Device Map

Use this basic data window to create or edit the mapping of a device to an IFS Applications object. It's also possible to navigate to the observations received for the device. IFS Applications objects that are possible to map against devices need to be IoT aware.

<div align="left"><img src="https://3218748546-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MiW42YxFsGXIDjQJKNR%2Fuploads%2FJtOq6CK0j9crk3m0YoGG%2F1.png?alt=media&amp;token=4f9d28b9-3fda-4878-885d-e2f42962fbea" alt=""></div>

### 2. Generate Weblink&#x20;

Create a web link that can be scheduled to initiate a call to the Novacura endpoint to read the measurements readings and to trigger the workflow. &#x20;

| <img src="https://3218748546-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MiW42YxFsGXIDjQJKNR%2Fuploads%2FrpNecO51Ti0snMLOvmfA%2F3.png?alt=media&amp;token=b30e8ad6-f6dd-4bca-b18e-4438b8659770" alt="" data-size="original"> |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

| Parameter Id     | Description                                                                                                                                                                                                            |
| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| DeviceId         | Device id used for the mapping of a device to an IFS Applications object.                                                                                                                                              |
| TestPointId      | The identity of the test point of the serial object.                                                                                                                                                                   |
| ParameterCode    | The parameter identity that connects to the test point of the serial object. This field is connected to the Parameters table in the Test points /Parameters tab in Functional Object, Serial Object or Tool/Equipment. |
| Spike (optional) | <p>Should be only used for testing.</p><p>-Set as '1' when a manual anomaly is needed to be triggered for testing. </p><p>-Default set it as 0</p>                                                                     |

**Example :**&#x20;

Use the generated web link(URL) to test the machine workflow that will run without user interaction using the Postman, which is a comprehensive set of tools that helps accelerate the API Lifecycle - from design, testing, documentation, and mocking to discovery. To test the process create a post request with the generated link and use the above-defined JSON payload.

![](https://3218748546-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MiW42YxFsGXIDjQJKNR%2Fuploads%2FBScfH1t0TDBYBgsN8KSL%2F4.png?alt=media\&token=5c2b687f-06fc-4245-b973-c9516c50076e)

### 3. View Anomaly Alert

Check the handover inbox for a new alert notification which is triggered when there is an anomaly detected from the readings of the device.

| <img src="https://3218748546-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MiW42YxFsGXIDjQJKNR%2Fuploads%2Fm2bHA0nMkGQXF9GW8GFj%2F1.png?alt=media&amp;token=5c6f9b90-0e38-47bb-ab47-10fa1936f66e" alt="" data-size="original"> | ![](https://3218748546-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MiW42YxFsGXIDjQJKNR%2Fuploads%2FJIpCAcW8L0G6fG2lmHgJ%2F2.jpg?alt=media\&token=76a21515-325b-4445-ab55-afdc3dd963b7) |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

### 4. Review the Anomaly report&#x20;

View the anomaly report which is depicted in a graph with prior measurements and has all the serial object details of the connected IoT device.

Select the required serial object node if there are any anomalies detected and create a Fault report (Work order in IFS).

| ![](https://3218748546-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MiW42YxFsGXIDjQJKNR%2Fuploads%2F3Jp2mT1QKYDogh8CTWBD%2F3.png?alt=media\&token=eb9ab0d2-f2b3-4ff5-98cb-9ff6527d87f6) | ![](https://3218748546-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MiW42YxFsGXIDjQJKNR%2Fuploads%2Fv8U3WQVIrcUBnCfatv5d%2F4.png?alt=media\&token=d6a9b7af-4ce8-40da-abd3-6df0475ce8ff) |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ![](https://3218748546-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MiW42YxFsGXIDjQJKNR%2Fuploads%2FcWB1P1i0ZGQjf4PjQEpI%2F5.png?alt=media\&token=611876de-a2f4-47f2-99d3-5e7095c636e1) | ![](https://3218748546-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MiW42YxFsGXIDjQJKNR%2Fuploads%2FxqE5DXjGe81v1eGEuokv%2F6.png?alt=media\&token=26a50eb9-c681-4ae4-bd78-8ea63598a35e) |
| ![](https://3218748546-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MiW42YxFsGXIDjQJKNR%2Fuploads%2FxnXqqn7yBKissVfwlaBj%2F7.png?alt=media\&token=d7fb9002-0743-41da-8641-b06483c35ce9) |                                                                                                                                                                                                                 |

### 5. Report a fault

This window is used to create a  new work order for the detected anomaly, where the user fills in set of fields and has the option to review the prior measurements and historical works orders created against the same serial object using the below pin steps.

| ![](https://3218748546-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MiW42YxFsGXIDjQJKNR%2Fuploads%2F8C4vcmXBPvObXpsjEeRO%2F12.png?alt=media\&token=f91dc2d3-e969-47fc-9665-6f5ddc273ca4) | ![](https://3218748546-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MiW42YxFsGXIDjQJKNR%2Fuploads%2FepnNHlUrliucEKN0Epju%2F11.png?alt=media\&token=8e15ab7a-c4ac-4ef7-91f0-22d7b1e4adcc) |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ![](https://3218748546-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MiW42YxFsGXIDjQJKNR%2Fuploads%2FvouFo5KCLcFF9o7xvwiH%2F10.png?alt=media\&token=9e08ae94-52d0-4f56-89ed-1f99cca04fd5) | ![](https://3218748546-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MiW42YxFsGXIDjQJKNR%2Fuploads%2Fiwhz2emRAUUiTIKoLuOi%2F8.png?alt=media\&token=dff6a074-54c8-49ab-a748-e2e6cf734df8)  |
| ![](https://3218748546-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MiW42YxFsGXIDjQJKNR%2Fuploads%2FMXGS7sElmCECbzezoEHm%2F9.png?alt=media\&token=14558f49-b39d-47a9-8ed9-27bfbd0c618b)  | ![](https://3218748546-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MiW42YxFsGXIDjQJKNR%2Fuploads%2FIldt2aLr9zXA7N1opbAH%2F15.jpg?alt=media\&token=c6dc4ada-b8eb-4d56-8e75-b2d25633ec95) |

• Enter Fault Description (Mandatory)

• Enter Long Fault Description&#x20;

• Select Maintenance Organization (Mandatory)

• Select Customer&#x20;

• Select Work Type&#x20;

• Select Work Stage&#x20;

• Select Priority&#x20;

• Select Discovery&#x20;

• Select Item Class&#x20;

• Select Fault Type&#x20;

• Select Attach Documents or Media Items&#x20;

• Press \[Save] to proceed.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.novacura.com/marketplace-documentation/components/explore-components/anomaly-detector/documentation/anomaly-detector.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
