Skip to content

Commit

Permalink
fix(oia): adapt OIAnalytics North connector help with the latest API …
Browse files Browse the repository at this point in the history
…key gen feature #1820
  • Loading branch information
burgerni10 committed Aug 22, 2022
1 parent 15e80b2 commit 993c56f
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 8 deletions.
26 changes: 18 additions & 8 deletions src/north/OIAnalytics/OIAnalytics.schema.jsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import React from 'react'
import { notEmpty, startsWith, combinedValidations } from '../../services/validation.service'
import screenshot from './screenshot.png'
import userpass from './userpass.png'
import oiaApiKeyGen from './oia-api-key-gen.png'

const schema = { name: 'OIAnalytics' }
schema.form = {
Expand All @@ -14,15 +14,25 @@ schema.form = {
<p>
OIAnalytics sends the received values/file to OIAnalytics.
</p>
<p>To fill the user and password :</p>
<p>To fill the username and password:</p>
<ul>
<li>Connect to OIAnalytics using your account</li>
<li>Go to &apos;User Management&apos;</li>
<li>Select the user &apos;Api&apos;</li>
<li>Click on the key icon in the top left corner</li>
<img src={screenshot} alt="OIanalytics screenshot" style={{ width: '600px' }} />
<li>This will download a text file containing an encoded string</li>
<li>The string contain the user name and the password like this : username:password</li>
<li>Go to Configuration -&gt; Users</li>
<li>
Click on the key icon for the user you want to create an API key to.
The user must have API access. We suggest a dedicated user with API access only.
</li>
<li>
Create an API key. It will generate an API key. It is the only time you can download and copy the password.
Be sure to store it securely somewhere.
</li>
<img src={oiaApiKeyGen} alt="OIanalytics KeyGen" style={{ width: '600px' }} />
<li>
If you downloaded the key and its password, the string contain the username (key) and the password like
this:
{' '}
<i>username:password</i>
</li>
<img src={userpass} alt="user password" style={{ width: '300px' }} />
<li>Fill the encoded user and password in OIBus</li>
</ul>
Expand Down
Binary file added src/north/OIAnalytics/oia-api-key-gen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed src/north/OIAnalytics/screenshot.png
Binary file not shown.

0 comments on commit 993c56f

Please sign in to comment.