Skip to content

Commit e9799c4

Browse files
AdaOrdaceAdaOrdace
committed
update notes in 6.1
1 parent 979ef75 commit e9799c4

File tree

21 files changed

+332
-39
lines changed

21 files changed

+332
-39
lines changed

‎docs/identitymanager/6.1/installation-guide/quick-start/index.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,16 +40,22 @@ When extracting UsercubeBootstrap to the root of the computer, it looks like:
4040

4141
**Step 5 –** Create a Sources folder in UsercubeBootstrap.
4242

43-
_Remember,_ if you don't have the UsercubeBootstrap folder or if you don't create the Sources
43+
:::tip
44+
Remember, if you don't have the UsercubeBootstrap folder or if you don't create the Sources
4445
folder, the Path in the Directory connection in the Runtime/appsettings.agent.json must be adapted.
4546
Note that you don't need to have a Directory.xlsx file at the location described by this Path for
4647
now.
48+
:::
49+
4750

4851
**Step 6 –** Create a database named Usercube, using the default options.
4952

50-
**NOTE:** When using a database server other than Microsoft SQL Server or a different database name,
53+
:::note
54+
When using a database server other than Microsoft SQL Server or a different database name,
5155
remember to change the connection string accordingly, in the Runtime/appsettings.json file and in
5256
the future command lines.
57+
:::
58+
5359

5460
**Step 7 –** Execute the Runtime/identitymanager.sql file in the database.
5561

‎docs/identitymanager/6.1/installation-guide/requirements/database-requirements/index.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,10 @@ This section identifies hardware and software requirements for Usercube's databa
1313
The database disk storage requirements depend on multiple factors as the database lifespan and the
1414
number of entries, for example 100,000 users can take up appropriately 10 GB of storage
1515

16-
**NOTE:** The maximum SQL Express database is 10 GB.
16+
:::note
17+
The maximum SQL Express database is 10 GB.
18+
:::
19+
1720

1821
## Software
1922

‎docs/identitymanager/6.1/integration-guide/api/squery/index.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,10 @@ If select is not specified, API will just return queried elements' Ids.
7373

7474
Last 100 started job's instances' Ids.
7575

76-
_Remember,_ The `Top` in the API queries had been deprecated and `PageSize`should be used instead.
76+
:::tip
77+
Remember, The `Top` in the API queries had been deprecated and `PageSize`should be used instead.
78+
:::
79+
7780

7881
Code attributes enclosed with `<>` need to be replaced with a custom value before entering the
7982
script in the command line.

‎docs/identitymanager/6.1/integration-guide/connectors/references-connectors/csv/index.md‎

Lines changed: 84 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,90 @@ The identifier of the connection and thus the name of the subsection must:
8181
| Path Required if PathIncremental is not defined. | **Type** String **Description** Path of the input file to be used for complete synchronization. |
8282
| PathIncremental Required if Path is not defined. | **Type** String **Description** Path of the input file to be used for incremental synchronization. |
8383
| IsFileNameRegex optional | **Type** Boolean **Description** `True` to enter a regex instead of a normal string for `Path` and `PathIncremental`. **Note:** if several files correspond to the regex, then the export will use the last created file. **Info:** useful when the filename is only partially known, for example when using a generated file. |
84-
| ValuesToTrim optional | **Type** String List **Description** Ordered list of the characters to trim at the beginning and at the end of the headers and values of the input file. **Note:** the second value will be trimmed after the first, the order is important. **Example** When writing `$` first and then `%` in `ValuesToTrim`, then "$%I am an example$%" becomes "I am an example$". |
84+
| ValuesToTrim optional | **Type** String List **Description** Ordered list of the characters to trim at the beginning and at the end of the headers and values of the input file. **Note:** the second value will be trimmed after the first, the order is important. **Example** When writing `---
85+
title: "CSV"
86+
description: "CSV"
87+
sidebar_position: 40
88+
---
89+
90+
# CSV
91+
92+
This connector exports data from a [CSV file](https://en.wikipedia.org/wiki/Comma-separated_values).
93+
94+
This page is about
95+
[File/CSV](/docs/identitymanager/6.1/integration-guide/connectors/references-packages/csv/index.md).
96+
97+
![Package: File/CSV](/img/product_docs/identitymanager/6.1/integration-guide/connectors/references-connectors/csv/packages_csv_v603.webp)
98+
99+
## Overview
100+
101+
Files in CSV format are commonly used to store information.
102+
103+
## Prerequisites
104+
105+
Implementing this connector requires the source file to be in CSV format.
106+
107+
## Export
108+
109+
This export copies the information found in a CSV file and transforms it into a new CSV file in the
110+
Usercube's format.
111+
112+
### Configuration
113+
114+
This process is configured through a
115+
[connection](/docs/identitymanager/6.1/integration-guide/toolkit/xml-configuration/connectors/connection/index.md)
116+
in the UI and/or the XML configuration, and in the `appsettings.agent.json > Connections` section:
117+
118+
```
119+
appsettings.agent.json
120+
{
121+
...
122+
"Connections": {
123+
...
124+
"<ConnectionIdentifier>": {
125+
...
126+
}
127+
}
128+
}
129+
```
130+
131+
The identifier of the connection and thus the name of the subsection must:
132+
133+
- be unique.
134+
- not begin with a digit.
135+
- not contain `<`, `>`, `:`, `"`, `/`, `\`, `|`, `?`, `*` and `_`.
136+
137+
> For example:
138+
>
139+
> ```
140+
> appsettings.agent.json
141+
> {
142+
> ...
143+
> "Connections": {
144+
> ...
145+
> "HRContoso": {
146+
> "Path": "C:/identitymanagerContoso/Contoso/hr_conto(.*?).csv",
147+
> "PathIncremental": "C:/identitymanagerContoso/Contoso/hr_delta_conto(.*?).csv",
148+
> "Encoding": "UTF-16",
149+
> "Separator": ";",
150+
> "IsFileNameRegex": true,
151+
> "NumberOfLinesToSkip": 1,
152+
> "ValuesToTrim": [> "*",
153+
> "%"
154+
>]
155+
> }
156+
> }
157+
> }
158+
> ```
159+
160+
#### Setting attributes
161+
162+
| Name | Details |
163+
| ------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
164+
| Path Required if PathIncremental is not defined. | **Type** String **Description** Path of the input file to be used for complete synchronization. |
165+
| PathIncremental Required if Path is not defined. | **Type** String **Description** Path of the input file to be used for incremental synchronization. |
166+
| IsFileNameRegex optional | **Type** Boolean **Description** `True` to enter a regex instead of a normal string for `Path` and `PathIncremental`. **Note:** if several files correspond to the regex, then the export will use the last created file. **Info:** useful when the filename is only partially known, for example when using a generated file. |
167+
first and then `%` in `ValuesToTrim`, then "$%I am an example$%" becomes "I am an example$". |
85168
| | |
86169
| --- | --- |
87170
| Encoding default value: UTF-8 | **Type** String **Description** Encoding of the input file. [See the list of available encodings](https://learn.microsoft.com/en-us/dotnet/api/system.text.encoding#see-the-list-of-available-encodings). |

‎docs/identitymanager/6.1/integration-guide/connectors/references-connectors/excel/index.md‎

Lines changed: 90 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,96 @@ The identifier of the connection and thus the name of the subsection must:
8787
| Path Required if PathIncremental is not defined. | **Type** String **Description** Path of the input file to be used for complete synchronization. |
8888
| PathIncremental Required if Path is not defined. | **Type** String **Description** Path of the input file to be used for incremental synchronization. |
8989
| IsFileNameRegex optional | **Type** Boolean **Description** `True` to enter a regex instead of a normal string for `Path` and `PathIncremental`. **Note:** if several files correspond to the regex, then the export will use the last created file. **Info:** useful when the filename is only partially known, for example when using a generated file. |
90-
| ValuesToTrim optional | **Type** String List **Description** Ordered list of the characters to trim at the beginning and at the end of the headers and values of the input file. **Note:** the second value will be trimmed after the first, the order is important. **Example** When writing `$` first and then `%` in `ValuesToTrim`, then "$%I am an example$%" becomes "I am an example$". |
90+
| ValuesToTrim optional | **Type** String List **Description** Ordered list of the characters to trim at the beginning and at the end of the headers and values of the input file. **Note:** the second value will be trimmed after the first, the order is important. **Example** When writing `---
91+
title: "Microsoft Excel"
92+
description: "Microsoft Excel"
93+
sidebar_position: 140
94+
---
95+
96+
# Microsoft Excel
97+
98+
This connector exports datasheets from a
99+
[Microsoft Excel](https://www.microsoft.com/en-us/microsoft-365/excel) (XLSX) file.
100+
101+
This page is about
102+
[File/Microsoft Excel](/docs/identitymanager/6.1/integration-guide/connectors/references-packages/excel/index.md).
103+
104+
![Package: File/Microsoft Excel](/img/product_docs/identitymanager/6.1/integration-guide/connectors/references-connectors/excel/packages_excel_v603.webp)
105+
106+
## Overview
107+
108+
Microsoft Excel files using the XLSX file format are commonly used to store information.
109+
110+
## Prerequisites
111+
112+
Implementing this connector requires the input file to be in the XLSX format.
113+
114+
## Export
115+
116+
This connector copies the information from an XLSX file into CSV files, one per spreadsheet, while
117+
filtering out spreadsheets and trimming values if needed.
118+
119+
### Configuration
120+
121+
This process is configured through a
122+
[connection](/docs/identitymanager/6.1/integration-guide/toolkit/xml-configuration/connectors/connection/index.md)
123+
in the UI and/or the XML configuration, and in the `appsettings.agent.json > Connections` section:
124+
125+
```
126+
appsettings.agent.json
127+
{
128+
...
129+
"Connections": {
130+
...
131+
"<ConnectionIdentifier>": {
132+
...
133+
}
134+
}
135+
}
136+
```
137+
138+
The identifier of the connection and thus the name of the subsection must:
139+
140+
- be unique.
141+
- not begin with a digit.
142+
- not contain `<`, `>`, `:`, `"`, `/`, `\`, `|`, `?`, `*` and `_`.
143+
144+
> For example:
145+
>
146+
> ```
147+
> appsettings.agent.json
148+
> {
149+
> ...
150+
> "Connections": {
151+
> ...
152+
> "HRContoso": {
153+
> "Path": "C:/identitymanagerContoso/Contoso/hr_conto(.*?).xlsx",
154+
> "PathIncremental": "C:/identitymanagerContoso/Contoso/hr_delta_conto(.*?).xlsx",
155+
> "IsFileNameRegex": "true",
156+
> "SheetOptions": [> {
157+
> "SheetIgnored": "false",
158+
> "NumberOfLinesToSkip": 1
159+
> },
160+
> {
161+
> "SheetIgnored": "true"
162+
> }
163+
>],
164+
> "ValuesToTrim": [> "$",
165+
> "%"
166+
>]
167+
> }
168+
> }
169+
> }
170+
> ```
171+
172+
#### Setting attributes
173+
174+
| Name | Details |
175+
| ------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
176+
| Path Required if PathIncremental is not defined. | **Type** String **Description** Path of the input file to be used for complete synchronization. |
177+
| PathIncremental Required if Path is not defined. | **Type** String **Description** Path of the input file to be used for incremental synchronization. |
178+
| IsFileNameRegex optional | **Type** Boolean **Description** `True` to enter a regex instead of a normal string for `Path` and `PathIncremental`. **Note:** if several files correspond to the regex, then the export will use the last created file. **Info:** useful when the filename is only partially known, for example when using a generated file. |
179+
first and then `%` in `ValuesToTrim`, then "$%I am an example$%" becomes "I am an example$". |
91180
| | |
92181
| --- | --- |
93182
| SheetOptions optional | **Type** SheetOption List **Description** List of options for each sheet of the input file. The first element of the list sets the options for the first sheet, the second element for the second sheet, etc. |

‎docs/identitymanager/6.1/integration-guide/connectors/references-connectors/googleworkspace/index.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,11 @@ Implementing this connector requires:
3333

3434
[See Google's documentation to create the service account with the right impersonation](https://developers.google.com/workspace/guides/create-credentials#see-googles-documentation-to-create-the-service-account-with-the-right-impersonation).
3535

36-
**Caution:** Google's documentation describes this procedure as optional, while the Google
36+
:::warning
37+
Google's documentation describes this procedure as optional, while the Google
3738
Workspace connector requires it.
39+
:::
40+
3841

3942
## Export
4043

‎docs/identitymanager/6.1/integration-guide/connectors/references-connectors/internalworkflow/index.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,10 @@ appsettings.agent.json
6666
}
6767
```
6868

69-
**NOTE:** The identifier of the connection and thus the name of the subsection must:
69+
:::note
70+
The identifier of the connection and thus the name of the subsection must:
71+
:::
72+
7073

7174
- be unique
7275
- not begin with a digit
@@ -155,8 +158,11 @@ FulfillInternalWorkflow.json
155158
156159
```
157160

158-
_Remember,_ as workflows' aspects are computed during the fulfill process, all the required
161+
:::tip
162+
Remember, as workflows' aspects are computed during the fulfill process, all the required
159163
properties must be present in the provisioning order and in this JSON file.
164+
:::
165+
160166

161167
Setting attributes
162168

‎docs/identitymanager/6.1/integration-guide/connectors/references-connectors/okta/index.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,11 @@ To configure the Okta connector it is necessary to:
3737
In order to do so you must connect to the Okta administration console
3838
`https://myexample-admin.okta.com` and create a new Netwrix Usercube user.
3939

40-
**NOTE:** For some Okta deployments it is possible to create a service account or to Manage an Okta
40+
:::note
41+
For some Okta deployments it is possible to create a service account or to Manage an Okta
4142
user account as a service account.
43+
:::
44+
4245

4346
**Step 2 –** Assign administrator role and permissions to the Netwrix Usercube user.
4447

‎docs/identitymanager/6.1/integration-guide/connectors/references-connectors/saperp6/index.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,10 @@ variables.
107107

108108
Set up the prerequisites for writing
109109

110-
**NOTE:** Make sure the Read prerequisites are configured first.
110+
:::note
111+
Make sure the Read prerequisites are configured first.
112+
:::
113+
111114

112115
**Step 1 –** Copy the provided DLL `sapnwrfc.dl` into the Runtime of Usercube.
113116

@@ -152,7 +155,10 @@ appsettings.agent.json
152155
}
153156
```
154157

155-
_Remember,_ the identifier of the connection and thus the name of the subsection must:
158+
:::tip
159+
Remember, the identifier of the connection and thus the name of the subsection must:
160+
:::
161+
156162

157163
- Be unique
158164
- Not begin with a digit.

0 commit comments

Comments
 (0)