Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/docs/cleanup-4.8' into support-4.8
Browse files Browse the repository at this point in the history
  • Loading branch information
dejavix committed Jan 12, 2024
2 parents 663478c + c878f62 commit d2c0b3e
Showing 1 changed file with 86 additions and 24 deletions.
110 changes: 86 additions & 24 deletions docs/admin-gui/resource-wizard/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,14 @@ Specific parts of configuration are represented as steps in wizard.
//It was further enhanced in midPoint 4.8.
Screenshots below corresponding with midPoint version 4.8.

If you would like to see the resource wizard in action, please watch our Resource Wizard webinar video:

video::-JUXHMGrFyI[youtube,title="Resource Wizard Webinar Video"]

If you would like to see the resource wizard used as a part of xref:/midpoint/methodology/first-steps/[First Steps Methodology] webinar video, please watch our First Steps Methodology video:

video::suo775ym_PE[youtube,title="First Steps Methodology Webinar Video"]

== Resource creation

To create resource, navigate to menu:Resources[New resource].
Expand All @@ -32,7 +40,12 @@ Selecting *From Scratch* option leads to a Resource catalog page:

image::step-1-resource-catalog.png[link=step-1-connector-conf-discovery.png,100%, title=Resource catalog]

Click the connector you want to use to start the resource creation wizard.
Click the connector tile you want to use to start the resource creation wizard.

.See also the following pages for more information:
* For general advice on using stock connectors in midPoint, please see xref:/midpoint/reference/resources/connector-setup/[Connector Setup]
* For connector developers and engineers using custom connectors xref:/midpoint/reference/resources/connid/[Using ConnId Connectors in midPoint] might be important
* xref:/connectors/connectors/[List of Identity Connectors] known to work with midPoint

== Basic configuration

Expand All @@ -50,11 +63,15 @@ If the connector supports _discovery_ operation, resource wizard will ask you fo

image::step-1-connector-conf-discovery.png[link=step-1-connector-conf-discovery.png,100%, title=Partial configuration for discovery]

.See also the following pages for more information:
* Familiarize yourself with the concept of xref:/midpoint/reference/admin-gui/simulations/[Simulations]
* xref:https://docs.evolveum.com/midpoint/reference/concepts/object-lifecycle/[Object Lifecycle] (at least to understand the basics of lifecycle states)

Click btn:[Next] to start discovery process and continue the resource configuration.

All other resource configuration properties can be configured now.
All other resource configuration properties can be configured now, e.g. CSV file field delimiter or a CSV file unique identifier column.
Some of the properties are already preconfigured by the connector.
Some of them allow suggestions of appropriate values using an autocompletion, e.g. CSV file columns as detected by the connector in the discovery step.
Some of them allow suggestions of appropriate values using an autocompletion, e.g. when selecting which column should be used as a unique identifier of the row, the wizard suggests the CSV file columns as detected by the connector in the discovery step.

image::step-1-discovered-config.png[link=step-1-discovered-config.png, 100%, title=Discovered configuration]

Expand All @@ -67,40 +84,85 @@ image::step-1-schema.png[link=step-1-schema.png, 100%, title=Schema]

Click btn:[Create resource] to create the resource and store it in midPoint repository.
Further configuration is required.
You can choose your next step:

// XXX ENDED HERE
* Preview Resource Data
* Configure Object Types
* Go To Resource

After basic configuration of resource we see three tiles for next path.
image::choice-part-resource.png[link=choice-part-resource.png,title=Resource created - next steps,100%]

.Parts of resource configuration
image::choice-part-resource.png[Parts of resource configuration,100%]
Clicking *Preview Resource Data* tile will display the data (e.g. accounts) in the source/target system configured as resource.
You can display the data even before providing configuration for its processing.

* First tile shows data on resource.
image::data-preview-resource.png[link=data-preview-resource.png,100%,title=Resource Data preview]

.Data preview
image::data-preview-resource.png[Data preview,100%]
Clicking *Configure Object Types* allows you to <<Object type configuration,configure the Object type(s)>>.

* Second tile leads to the object type configuration.
* After clicking on last tile you will be redirected to resource details page.
Clicking *Go To Resource* leads to the resource details page.

== Object type configuration

When we choose the configuration for the object type, we can see a table.
In this part of resource configuration, you can configure the object types for xref:/midpoint/reference/resources/resource-configuration/schema-handling/[Schema handling], essentially defining the behavior of midPoint with respect to the resource.
One or multiple object types can be defined, based on the source/target system characteristics.
For example, CSV resource contains typically a single object type (e.g. accounts) while LDAP resource can contain more than one object type (e.g. accounts and groups).

.Table of object type
image::step-2-object-type-table.png[Table of object type,100%]
image::step-2-object-type-table.png[link=step-2-object-type-table.png,100%,title=Table of object types]

{empty} +
Detail for configuration of object type:
Click btn:[Add object type] to create a new object type definition using Object type configuration wizard.

[%autowidth, cols="a,a", frame=none, grid=none, role=center]
|===
| image::step-2-object-type-basic-config.png[link=step-2-object-type-basic-config.png, 100%, title=Basic configuration of object type]
| image::step-2-object-type-resource-data.png[link=step-2-object-type-resource-data.png, 100%,title=Resource data]
Define the basic information about the object type:

| image::step-2-object-type-midpoint-data.png[link=step-2-object-type-midpoint-data.png, 100%, title=Midpoint data]
|
|===
* *Display name* will be displayed in midPoint as a reference to this object type configuration
* *Kind* is either `Account`, `Entitlement` or `Generic`. For accounts, please select `Account`.
* *Intent* is used when you would like to use more than one different object _types_, e.g. standard and administrative accounts. Keep the default (empty) value if you want to work with just one type of accounts.
* *Default* specifies if the intent provided in the previous value should be used as the default value in case you define multiple intents. Select `True` if you are using only a single intent / one type of accounts.


image::step-2-object-type-basic-config.png[link=step-2-object-type-basic-config.png, 100%, title=Basic configuration of object type]

.See also the following pages for more information:
* xref:/midpoint/reference/resources/shadow/kind-intent-objectclass/[Kind, Intent and ObjectClass]

Click btn:[Next: Resource data] to continue the object type configuration.

Define the resource-specific configuration for this object type:

* *Object class* is one of the object classes (types) supported by the connector for the source/target system represented as this resource. For resources supporting only a single object class (e.g. CSV) this will be displayed as `AccountObjectClass` and set as default by the wizard.
* *Filter* allows to define a classification via midPoint xref:/midpoint/reference/concepts/query/midpoint-query-language/[query language]
* *Classification condition* allows to define a classification condition (midPoint expression, not query)

TIP: Classification allows to limit which resource data (e.g. accounts) are considered part of this object type definition.
An example of *Filter* usage: CSV file entries matching query `attributes/contractType != "Incognito"` should be considered as accounts, all other should be ignored.

NOTE: You do not need to use the classification at all. If unsure, do not use it.

.See also the following pages for more information:
* xref:/midpoint/reference/resources/resource-configuration/schema-handling/changes-in-4.6/#resource-object-type-delineation[Resource Object Type Delineation]

// TODO TODO we do not have better Delination example! I have created https://jira.evolveum.com/browse/MID-9404 to track this

image::step-2-object-type-resource-data.png[link=step-2-object-type-resource-data.png, 100%,title=Resource data]

Click btn:[Next: MidPoint Data] to continue the object type configuration.

Define the midPoint-specific configuration for this object type:

* *Type* defines type of midPoint object that will correspond to the resource object (e.g. `User`). midPoint will respect this setting when creating a new midPoint object from this object type data on the resource.
* *Archetype* allows selection of archetype that will be automatically assigned for all midPoint objects created from this object type data on the resource. The same archetype will be also used as a part of correlation, i.e. enforced.
+
If unsure, keep Archetype empty.

.See also the following pages for more information:
* overview of xref:/midpoint/reference/schema/archetypes/[Archetypes]
* built-in xref:/midpoint/reference/schema/archetypes/person/[Person archetype] ready to be used

image::step-2-object-type-midpoint-data.png[link=step-2-object-type-midpoint-data.png, 100%, title=Midpoint data]

Click btn:[Save settings] to save the object type configuration.
Further configuration is required.

// TODO TODO finished here 12.1.2024 11:47

After we configure object type, we can see the button for previewing the data and titles for configuring of the containers for the selected object type.

Expand Down

0 comments on commit d2c0b3e

Please sign in to comment.