Skip to content

Commit

Permalink
Reorganize "Create a schema" and remove the strikethroughs on "Gettin…
Browse files Browse the repository at this point in the history
…g the token"
  • Loading branch information
aitormurgu committed Jun 26, 2024
1 parent 8d7bf61 commit 978cbc9
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 13 deletions.
4 changes: 2 additions & 2 deletions docs/Examples/POSTMAN/Getting the token.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ The token you will need to the authorization, is the id_token.
- Navigate to the "Body" tab within the request settings.
- Select "form-data" as the body type.
- Add the following key-value parameters:
- `username`: ~HTTP USER FROM CSV~
- `password`: ~PASSWORD FROM CSV~
- `username`: HTTP USER FROM CSV
- `password`: PASSWORD FROM CSV
- `grant_type`: password
- `client_id`: biotz-platform-devices
- `scope`: openid
Expand Down
21 changes: 10 additions & 11 deletions docs/How-to guides/How to create a schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,31 +70,26 @@ Timestamp ones, the same as the rest with an extra one:
![Payload Timestamp](img/payload-timestamp.png)
</div>

Once the schema is totally represented the ‘save’ button will register the schema. This will create the necessary machinery for the data validation and ingestion, it will also create the needed database structure for the data to be stored.


## Data tranformation


The data transformation functionality allows users to apply scaling and offsetting during data ingestion.
Data transformation includes advanced options such as the application of scaling and offsetting. This feature allows users to adjust their data more precisely during the ingestion process, this will be applicable to the following item types.
To the following item types, **data transformation** is applicable:

- Integer
- Integer, as text
- Integer, as hexadecimal text
- Decimal
- Decimal, as text

The data transformation functionality allows users to apply scaling and offsetting during data ingestion.
Data transformation includes advanced options such as the application of scaling and offsetting. This feature allows users to adjust their data more precisely during the ingestion process.

#### How to use the Functionality

**Step 1: Access the Ingestion Configuration**

To access the data ingestion flows on the Biotz platform and select the "Data Transformation" option, first, navigate to the left-hand side of the main menu on the Biotz platform and select "Setup". From there, choose "Data Ingestion Flows", then, select the appropriate device type, followed by the corresponding message type, and then click on "New Schema" to start defining a new data schema.


Once on the schema definition screen, select the item type you want to transform, ensuring it is one of the following: integer, integer as text, integer as hexadecimal text, decimal, or decimal as text. After selecting the item type, the "fx" icon will appear next to the item name. Click on this icon to access the data transformation options.


<div class="tutorial-image-container">
![Creating panels](img/click-to-tranform1.png)
</div>
Expand Down Expand Up @@ -123,7 +118,9 @@ For example:
</div>

Scale: 1.5

Offset: -2

This means that each data value will be multiplied by 1.5 and then 2 will be subtracted.

To add more transformations click on the "add tranformation" button, once the setup is done, click on "save". Once the configuration is saved the "fx" button will show a yellow circle to show that the data transformation formulas are stored.
Expand All @@ -132,9 +129,11 @@ To add more transformations click on the "add tranformation" button, once the se
![Creating panels](img/click-to-tranform.png)
</div>

**Step 3: Apply Transformations**
<br>
</br>

Once the schema is totally represented the ‘save’ button will register the schema. This will create the necessary machinery for the data validation and ingestion, it will also create the needed database structure for the data to be stored.

Associate the defined transformation rules with the data ingestion flow.


## Create a schema using the text editor
Expand Down

0 comments on commit 978cbc9

Please sign in to comment.