Resource wizard

Last modified 21 Jan 2025 16:00 +01:00

Since 4.6

This functionality is available since version 4.6. The functionality was further improved in versions 4.8, 4.9.

Table of Contents

Introduction
Resource creation
Basic configuration
Configuration of resource wizard panels
How to use Lifecycle state
Limitations

Introduction

Resource wizard allows to easily create and update resource configuration. No midPoint XML language is needed, the configuration is entirely UI-based.

The new UI takes form of panels with choices for specific parts of resource configuration. Specific parts of configuration are represented as steps in wizard.

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:

Resource Wizard Webinar Video

If you would like to see the resource wizard used as a part of First Steps Methodology webinar video, please watch our First Steps Methodology video:

First Steps Methodology Webinar Video

We recommend you to read about MidPoint Synchronization as resource wizard allows configuration which belongs to synchronization concepts.

Resource creation

To create resource, navigate to menu:Resources[New resource].

There are the following possibilities:

Inherit Template - the new resource will be based on a pre-existing resource template. The new resource will inherit the configuration.
From Scratch - you will need to configure all aspects of the resource
Copy From Template - the new resource will be based on a pre-existing resource template. The new resource will be created as a copy of that template.

A resource template is marked as such by setting the template property to true. See Resource and Object Type Inheritance for more information.

Figure 1. Type of resource

Selecting From Scratch option leads to a Resource catalog page:

Figure 2. Resource catalog

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 Connector Setup
For connector developers and engineers using custom connectors Using ConnId Connectors in midPoint might be important
List of Identity Connectors known to work with midPoint

Basic configuration

Enter basic configuration such as resource Name and Description here.

Lifecycle state is a new property since midPoint 4.8. It allows you to create preliminary resource configuration that will not be active, but can be used for Simulations. The default value is Proposed.

Figure 3. Basic configuration

Click btn:[Next] to continue the resource configuration.

If the connector supports discovery operation, resource wizard will ask you for mandatory configuration parameters to be able to detect the others, e.g. path to a CSV file for CSV file connector.

Figure 4. Partial configuration for discovery

See also the following pages for more information:

Familiarize yourself with the concept of Simulations
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, 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. 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.

Figure 5. Discovered configuration

Click btn:[Next] to continue the resource configuration.

If you are using CSV connector and wizard fails in this step with error "Connector initialization failed. Configuration error: Configuration error: Header in csv file doesn’t contain unique attribute name as defined in configuration.", it may be caused by presence of UTF-8 BOM characters in the file. See more here.
To resolve the issue, remove the leading UTF-8 BOM characters from the csv file and start the wizard again. This can be done e.g. by copying the file content to a new file in text editor.

Connector will return possible object types and their attributes (schema and its object classes). Confirm the detected configuration.

Figure 6. 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:

Preview Resource Data
Configure Object Types
Configure Association Types
Go To Resource

Figure 7. Resource created - next steps

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.

Figure 8. Resource Data preview

Clicking Configure Object Types allows you to configure the Object type(s).

Clicking Configure Association Types allows you to configure the Association type(s).

Clicking Go To Resource leads to the resource details page.

Configuration of resource wizard panels

Some wizard panels are configurable, for more information see Wizard panels.

How to use Lifecycle state

Resource, object type, attribute, mapping, synchronization situation and other aspects of resource configuration can be configured in different lifecycle states. As it was mentioned earlier, the Lifecycle state property can be used with Simulations. The resource is created in Proposed lifecycle state by default, it won’t work for normal deployment without switching to Active state.

By using the lifecycle state Proposed, you can test (simulate) the configuration without causing any damage to your target system data. When the simulation results are satisfactory, you can switch the lifecycle state to Active.

As the lifecycle state can be set on various configuration items, midPoint gives you a way of turning on specific parts of configuration incrementally. For example, after you switch your resource to Active lifecycle state, we recommend to add any new mappings first in Proposed lifecycle state. The new mapping can be simulated without causing any harm and switched to Active lifecycle state when ready.

Limitations

Resource wizard has several limitations as of midPoint 4.8, such as:

expression editor supports As is, Script, Literal and Generate expressions only
mapping ranges are not supported
mapping domains are not supported
correlation configuration currently supports only The items Correlator

midPoint resource wizard won’t be able to show or allow editing of these features but should tolerate them and keep them in the configuration.

Was this page helpful?

YES NO

Thanks for your feedback