From 92caafbe555c47c78fd8ccb8a588467a89f42d02 Mon Sep 17 00:00:00 2001 From: burgerni10 Date: Thu, 6 Feb 2025 10:36:09 +0100 Subject: [PATCH] doc: fix broken links and remove slims --- documentation/docs/guide/engine/ip-filters.md | 2 +- .../docs/guide/installation/migrate.mdx | 22 ++-- .../guide/north-connectors/oianalytics.md | 8 +- .../docs/guide/south-connectors/slims.mdx | 102 ------------------ .../docs/use-cases/_north_oianalytics.mdx | 4 +- .../docs/use-cases/use-case-advanced.mdx | 2 +- .../current/guide/south-connectors/slims.mdx | 96 ----------------- 7 files changed, 19 insertions(+), 217 deletions(-) delete mode 100644 documentation/docs/guide/south-connectors/slims.mdx delete mode 100644 documentation/i18n/zh/docusaurus-plugin-content-docs/current/guide/south-connectors/slims.mdx diff --git a/documentation/docs/guide/engine/ip-filters.md b/documentation/docs/guide/engine/ip-filters.md index cfb0cc6d43..4c8332b142 100644 --- a/documentation/docs/guide/engine/ip-filters.md +++ b/documentation/docs/guide/engine/ip-filters.md @@ -17,6 +17,6 @@ curl --location --request POST "http://localhost:2223/api/ip-filters" --header " ``` :::caution Allowing all with proxy server -Be careful when allowing all IP addresses and using the [proxy server](./engine-settings.mdx#proxy-server): since the +Be careful when allowing all IP addresses and using the [proxy server](./engine-settings.mdx#oibus-proxy-server-configuration): since the proxy simply forward without authenticating the request, it may be dangerous to accept all sources. ::: \ No newline at end of file diff --git a/documentation/docs/guide/installation/migrate.mdx b/documentation/docs/guide/installation/migrate.mdx index 8cd3bb760b..8794c69733 100644 --- a/documentation/docs/guide/installation/migrate.mdx +++ b/documentation/docs/guide/installation/migrate.mdx @@ -48,23 +48,23 @@ Migrate from OIBus v1 and v2 into the new OIBus v3 version with our migration to ## Download specific version :::caution OIBus version -The migration will work only with the 3.5.5 OIBus version. If you want to migrate to a later version, first install OIBus v3.5.5 -from one of the links below, and then update OIBus from v3.5.5 to a later version. +The migration will work only with the 3.5.10 OIBus version. If you want to migrate to a later version, first install OIBus v3.5.10 +from one of the links below, and then update OIBus from v3.5.10 to a later version. :::
+ link='https://github.com/OptimistikSAS/OIBus/releases/download/v3.5.10/oibus-setup-win_x64-v3.5.10.exe'>
-
{`OIBus v3.5.5 (installer)`}
+
{`OIBus v3.5.10 (installer)`}
Windows (x64)
 - +
-
{`OIBus v3.5.5 (zip)`}
+
{`OIBus v3.5.10 (zip)`}
Windows (x64)
 @@ -76,9 +76,9 @@ from one of the links below, and then update OIBus from v3.5.5 to a later versio
+ link={`https://github.com/OptimistikSAS/OIBus/releases/download/v3.5.10/oibus-linux_x64-v3.5.10.zip`}>
-
{`OIBus v3.5.5`}
+
{`OIBus v3.5.10`}
Linux (x64)
 @@ -90,9 +90,9 @@ from one of the links below, and then update OIBus from v3.5.5 to a later versio
+ link={`https://github.com/OptimistikSAS/OIBus/releases/download/v3.5.10/oibus-macos_x64-v3.5.10.zip`}>
-
{`OIBus v3.5.5`}
+
{`OIBus v3.5.10`}
MacOS (Intel chip)
 @@ -109,7 +109,7 @@ from one of the links below, and then update OIBus from v3.5.5 to a later versio You can zip the data folder, or at least the configuration file `oibus.json` and its `keys` as a backup. ::: -2. Install [OIBus v3.5.5](#download-specific-version). Be careful to specify the **same data folder**. Check +2. Install [OIBus v3.5.10](#download-specific-version). Be careful to specify the **same data folder**. Check that OIBus v3 run properly by login on `http://localhost:2223` with admin / pass. If everything works, go on with the next step. 3. Stop OIBus v3. diff --git a/documentation/docs/guide/north-connectors/oianalytics.md b/documentation/docs/guide/north-connectors/oianalytics.md index 2f6cb5a782..33fc2271fa 100644 --- a/documentation/docs/guide/north-connectors/oianalytics.md +++ b/documentation/docs/guide/north-connectors/oianalytics.md @@ -20,13 +20,13 @@ unfolds within the SaaS application, courtesy of its easily configurable setting Here are the important parameters for configuring connectivity with the OIAnalytics SaaS application: -- **Use OIAnalytics Module**: Use the connection settings of the OIAnalytics module +- **Use OIAnalytics registration**: Use the connection settings of the [OIAnalytics registration](../advanced/oianalytics-registration.mdx). - **Timeout**: The duration before a connection failure is reported in HTTP requests. - **Compress data**: Compress the data if not already compressed. Compressed files will be detected with the .gz file extension, and JSON payload will be compressed and sent to a specific OIAnalytics endpoint. -If OIAnalytics module is not used, the following fields will be used: +If OIAnalytics registration is not used, the following fields will be used: - **Host**: The hostname of the SaaS application (e.g., `https://optimistik.oianalytics.com`). - **Accept unauthorized certificate**: This option is useful when HTTP queries traverse a firewall that strips the @@ -54,8 +54,8 @@ If OIAnalytics module is not used, the following fields will be used: To securely connect OIBus to OIAnalytics, follow these steps: 1. Register OIBus on OIAnalytics: - This ensures seamless integration and secure communication between OIBus and OIAnalytics. -2. Enable the Use OIAnalytics Module Option: - - In the North connector settings, enable the Use OIAnalytics Module option to establish the connection. +2. Enable the **Use OIAnalytics registration** option: + - In the North connector settings, enable the **Use OIAnalytics registration** option to establish the connection. - By doing this, you eliminate the need to manually transfer API keys, simplifying the process and enhancing security. :::tip Proxy client diff --git a/documentation/docs/guide/south-connectors/slims.mdx b/documentation/docs/guide/south-connectors/slims.mdx deleted file mode 100644 index 5be1c21e88..0000000000 --- a/documentation/docs/guide/south-connectors/slims.mdx +++ /dev/null @@ -1,102 +0,0 @@ ---- -sidebar_position: 12 ---- - -import SerializationSettings from './_south-rest-serialization-settings.mdx'; -import ThrottlingSettings from './_throttling-settings.mdx'; - -# SLIMS™ -Query time values from an [Agilent SLIMS™](https://www.agilent.com/en/product/software-informatics/lab-workflow-management-software/slims) -application, which serves as a comprehensive laboratory management solution. - -## Specific settings -Here are the details for configuring your connection: -- **URL**: This is the address of the SLIMS application. -- **Port**: Specify the port that the application is listening on. -- **Accept unauthorized certificate**: Decide whether to accept certificates even if they are outdated or self-signed. -- **Timeout**: The duration before a connection failure is reported in HTTP requests. -- **Username**: Provide the username used for authentication. -- **Password**: Enter the password used for authentication. -- **Use proxy**: Choose whether to route the request through a proxy. - - **Proxy URL**: The URL of the proxy server to pass through. - - **Proxy username**: The username associated with the proxy. - - **Proxy password**: The password linked to the proxy. - - - -## Item settings -In the South connector, each item can be configured to be queried according to the chosen scan mode. Multiple queries to -the same database can be configured within the same South connector. OIBus will execute the queries one after another, -prepare the output file, and then send it to North connectors. - -### Endpoint -The endpoint where to send the HTTP request, for instance `/slimsrest/rest/Result/advanced`. - -### Body and query params -The **Body** field supports JSON syntax and can utilize internal variables. These variables serve two primary purposes: -ensuring data stream resilience in case of connection failures and breaking down large intervals into smaller chunks, -thus reducing the load on both the server and the network (as explained in the [big queries section](#splitting-large-queries)). - -The **Query params** field is structured as a key/value array and can also make use of the same interval variables. - -#### Query variables -In OIBus, you can utilize the following internal variables that will be interpreted by the system: - -- **@StartTime**: Initially, the @StartTime variable is set to the date of the first execution of the query. When results -are retrieved from the application, the @StartTime value is updated to the most recent timestamp among those results in the -field used as a reference (refer to [the datetime fields section](#datetime-fields)). -- **@EndTime**: The @EndTime variable is set to either the current time (_now()_) or the end of the sub-interval if a -query is split. - -```json title="Body example with variables" -{ - "criteria": { - "operator": "and", - "criteria": [ - { - "fieldName": "rslt_fk_status", - "operator": "equals", - "value": 14 - }, - { - "fieldName": "rslt_cf_pid", - "operator": "notNull" - }, - { - "fieldName": "rslt_cf_samplingDateAndTime", - "operator": "notNull" - }, - { - "fieldName": "rslt_modifiedOn", - "operator": "between", - "start": @StartTime, - "end": @EndTime - } - ] - }, - "sortBy": [ - "rslt_modifiedOn" - ] -} -``` - -### Datetime fields -You can specify in this array which fields are a datetime type, and which format to use. -- **Field name**: The field name in the HTTP payload result. -- **Reference field**: Use this field as reference for the next @StartTime value (see [query variables](#query-variables)). -- **Type**: The type of the data in the result. -- **Timezone** (for string only): The timezone of the datetime stored in the -database. -- **Format** (for string only): The string format of the datetime retrieved. -- **Locale** (for string only): The locale to use when the format contains locale specific string (such as MMM format for -months). - -For SLIMS, two datetime fields must be specified: -- **rslt_modifiedOn** (used as reference): this field will be stored in the internal variable @StartTime for the next HTTP request -- **rslt_cf_samplingDateAndTime**: this field is not used as reference but must be specified to be correctly parsed. It will be used -as the timestamp of the value retrieved. - -OIBus will internally use these dates in ISO UTC format. The output datetime format can be set in the -[serialization section](#csv-serialization). - - \ No newline at end of file diff --git a/documentation/docs/use-cases/_north_oianalytics.mdx b/documentation/docs/use-cases/_north_oianalytics.mdx index e7161e1719..62d535f373 100644 --- a/documentation/docs/use-cases/_north_oianalytics.mdx +++ b/documentation/docs/use-cases/_north_oianalytics.mdx @@ -9,7 +9,7 @@ your IT team to add a rule allowing communication. A best practice for sending values into OIAnalytics is to [register OIBus first](../guide/advanced/oianalytics-registration.mdx). Create the OIAnalytics North connector and populate the relevant fields. If OIBus has been registered into OIAnalytics, -check the `Use OIAnalytics Module` toggle. +check the `Use OIAnalytics registration` toggle. You can test the settings by clicking the `Test settings` button to verify the connection. @@ -24,7 +24,7 @@ to add a rule permitting communication. For optimal functionality, it is recommended to [register OIBus](../guide/advanced/oianalytics-registration.mdx) before sending values to OIAnalytics. -If OIBus has been registered with OIAnalytics, activate the `Use OIAnalytics Module` toggle. +If OIBus has been registered with OIAnalytics, activate the `Use OIAnalytics registration` toggle.
diff --git a/documentation/docs/use-cases/use-case-advanced.mdx b/documentation/docs/use-cases/use-case-advanced.mdx index 10e3b9577c..a2f48464c6 100644 --- a/documentation/docs/use-cases/use-case-advanced.mdx +++ b/documentation/docs/use-cases/use-case-advanced.mdx @@ -53,7 +53,7 @@ It is strongly suggested to first [register OIBus into OIAnalytics](../guide/adv registration inside the [North OIAnalytics connector](../guide/north-connectors/oianalytics). ### Proxy server -Enable the [proxy server](../guide/engine/engine-settings#proxy-server) and be sure the selected port is not used and is allowed on the firewall for inbound connections. +Enable the [proxy server](../guide/engine/engine-settings#oibus-proxy-server-configuration) and be sure the selected port is not used and is allowed on the firewall for inbound connections. ## OIBus OT This OIBus can be used to access PLCs located in the industrial network. diff --git a/documentation/i18n/zh/docusaurus-plugin-content-docs/current/guide/south-connectors/slims.mdx b/documentation/i18n/zh/docusaurus-plugin-content-docs/current/guide/south-connectors/slims.mdx deleted file mode 100644 index cec6f2d205..0000000000 --- a/documentation/i18n/zh/docusaurus-plugin-content-docs/current/guide/south-connectors/slims.mdx +++ /dev/null @@ -1,96 +0,0 @@ ---- -sidebar_position: 12 ---- - -import SerializationSettings from './_south-rest-serialization-settings.mdx'; - - -# SLIM (Rest API) -Retrieve data from the [Agilent SLIMS](https://www.agilent.com/en/product/software-informatics/lab-workflow-management-software/slims) -application, which serves as a comprehensive laboratory management solution. - -## Specific settings -Here are the details for configuring your connection: -- **URL**: This is the address of the SLIMS application. -- **Port**: Specify the port that the application is listening on. -- **Username**: Provide the username used for authentication. -- **Password**: Enter the password used for authentication. -- **Use proxy**: Choose whether to route the request through a proxy. -- **Accept unauthorized certificate**: Decide whether to accept certificates even if they are outdated or self-signed. - -## Item settings -In the South connector, each item can be configured to be queried according to the chosen scan mode. Multiple queries to -the same database can be configured within the same South connector. OIBus will execute the queries one after another, -prepare the output file, and then send it to North connectors. - -### Endpoint -The endpoint where to send the HTTP request, for instance `/slimsrest/rest/Result/advanced`. - -### Body and query params -The **Body** field supports JSON syntax and can utilize internal variables. These variables serve two primary purposes: -ensuring data stream resilience in case of connection failures and breaking down large intervals into smaller chunks, -thus reducing the load on both the server and the network (as explained in the [big queries section](#拆分大型查询)). - -The **Query params** field is structured as a key/value array and can also make use of the same interval variables. - -#### 查询变量 -In OIBus, you can utilize the following internal variables that will be interpreted by the system: - -- **@StartTime**: Initially, the @StartTime variable is set to the date of the first execution of the query. When results -are retrieved from the application, the @StartTime value is updated to the most recent timestamp among those results in the -field used as a reference. -- **@EndTime**: The @EndTime variable is set to either the current time (_now()_) or the end of the sub-interval if a -query is split. - -```json title="Body example with variables" -{ - "criteria": { - "operator": "and", - "criteria": [ - { - "fieldName": "rslt_fk_status", - "operator": "equals", - "value": 14 - }, - { - "fieldName": "rslt_cf_pid", - "operator": "notNull" - }, - { - "fieldName": "rslt_cf_samplingDateAndTime", - "operator": "notNull" - }, - { - "fieldName": "rslt_modifiedOn", - "operator": "between", - "start": @StartTime, - "end": @EndTime - } - ] - }, - "sortBy": [ - "rslt_modifiedOn" - ] -} -``` - -### 日期时间字段 -You can specify in this array which fields are a datetime type, and which format to use. -- **Field name**: The field name in the HTTP payload result. -- **Reference field**: Use this field as reference for the next @StartTime value (see [query variables](#查询变量)). -- **Type**: The type of the data in the result. -- **Timezone** (for string only): The timezone of the datetime stored in the -database. -- **Format** (for string only): The string format of the datetime retrieved. -- **Locale** (for string only): The locale to use when the format contains locale specific string (such as MMM format for -months). - -For SLIMS, two datetime fields must be specified: -- **rslt_modifiedOn** (used as reference): this field will be stored in the internal variable @StartTime for the next HTTP request -- **rslt_cf_samplingDateAndTime**: this field is not used as reference but must be specified to be correctly parsed. It will be used -as the timestamp of the value retrieved. - -OIBus will internally use these dates in ISO UTC format. The output datetime format can be set in the -[serialization section](#csv序列化). - - \ No newline at end of file