Skip to end of metadata
Go to start of metadata

Version Warning

The content below is for Apache Syncope <= 1.2 - for later versions the Reference Guide is available.

 

Warning

The DB Connector does not support synchronization of roles. If you also require role synchronization you should use a scripted SQL resource instead.

Introduction

This wiki page shows all the steps needed to configure an external Database Table resource identified by the following connection parameters:

Host: localhost
Port: 3306
User: root
User Password: password
JDBC Connection URL: jdbc:mysql://localhost:3306/demo
Database: demo
Table: test

In order to link an external Database Table resource there are pre-requisites and configuration steps to be satisfied.

Pre-Requisites

  1. Download JDBC driver (MySQL JDBC driver in this case) and include it into your JEE container classpath.
  2. Install ConnId Database Table connector bundle.

Configuration steps

  1. Configure Database Table connector instance.
  2. Configure Database Table resource.

Configure Database Table connector instance

Please, take a look at all configurable parameters at Database Table Connector Configuration and use this page as reference to provide your configuration.

  1. Open your browser and access to the Syncope administration console (http://host:port/syncope-console).
  2. Log into the interface by providing the following credentials:
    1. Login: admin
    2. Password: password
  3. Click on the Resources tab.
  4. Click on the Connectors sub-tab.
  5. Click on Create new Connector button (configuration modal page appears).
  6. Click on tab General.
    1. Provide Display name (e.g. 'Db Table Demo') and the correct Bundle name (org.connid.bundles.db.${version}).
  7. Click on tab Configurations and provide connector instance configuration.
    User: root
    Password: password
    Host: localhost
    TCP Port: 3306
    JDBC Connection URL: jdbc:mysql://localhost:3306/demo
    JDBC Driver: com.mysql.jdbc.Driver
    Database: demo
    Table: test
    Key Column: id
  8. Click on tab Capabilities.
  9. Check needed capabilities as shown at Connector instance configuration.
  10. Click on Save button.

Configure Database Table resource

  1. Click on the Resources tab.
  2. Click on the Resources sub-tab.
  3. Click on Create new Resource button (configuration modal page appears).
  4. Click on Resource Details tab.
  5. Choose from the list the correct Connector instance name.
  6. Provide the following information
    1. Name: DbTable-Demo
    2. Connector: Demo Db Table
  7. Click on Schema Mappings tab.
  8. Click on Add button to insert attributes mapping.
  9. Click on Save button.
Schema mapping

Internal mapping types

Internal mapping

External Attributes

Mandatory condition

Account Id

Password

Username

 

 

true

X

 

Password

 

 

true

 

X

UserSchema

surname

surname

true

 

 

UserSchema

firstname

firstname

false

 

 

UserSchema

email

email

false