Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameter

Description / Remarks

Server (mehrere getrennt mit ";")

Oracle server host name, can be multiple hosts delimited by the “;” character. All hosts use the same credentials and parameters as defined below

Usernamen

User name for the database

Passwort

Password for the database

Port

Numeric port value, default is 1521

SID / Servicenamen

SID or Service name of the Oracle DB instance

SQL parameters

...

Parameter

...

SQL command type

...

Description / Remarks

...

SQL CreateIdentity

...

Stored procedure

...

SQL GetIdentityParameters

...

Select query (function)

...

SQL CheckIdentityExists

...

Select query (function)

...

SQL FindObjectIdentifiersByAttributes

...

Select query (function)

...

SQL UpdateIdentity

...

Stored procedure

...

SQL DeleteIdentity

...

Stored procedure

...

SQL ValidateCredentials

...

Not implemented

...

SQL IsIdentityActivate

...

Select query (function)

...

SQL ActivateIdentity

...

Stored procedure

...

SQL DeactivateIdentity

...

Stored procedure

...

SQL SetIdentityPassword

...

Not implemented

...

SQL IsPropertyValueUnique

...

Select query (function)

...

SQL GetResourcesFromIdentity

...

Select query (function)

...

SQL GetIdentityMembersByResourceIdentifier

...

Select query (function)

...

SQL AddIdentityToResource

...

Stored procedure

...

SQL RemoveIdentityFromResource

...

Stored procedure

...

SQL GetIdentity

...

Select query (function)

...

SQL CreateResource

...

Stored procedure

...

SQL GetResourceParameters

...

Select query (function)

...

SQL CheckResourceExists

...

Select query (function)

...

SQL UpdateResource

...

Stored procedure

...

SQL DeleteResource

...

Stored procedure

...

SQL GetResources

...

Select query (function)

...

SQL IsResourcePropertyValueUnique

...

Select query (function)

...

SQL GetResource

...

Select query (function)

SQL command types

Select Query (function)

This can be a simple SELECT query from a table or a view. It’s also possible to call a function inside a SELECT query.

Examples:

SELECT * FROM t.users;
SELECT * FROM v.users;
SELECT * FROM get_users('all');

Stored procedure

If a stored procedure is needed for the SQL parameter, you have to specify the name of the stored procedure. The input and output parameters will be added in the system connector and are defined below.

Examples:

create_user
update_user

Source system Oracle database requirements

To execute the SQL statements defined in the target system, there are certain requirements needed on the database, so that they will be executed correctly.See below for an explanation of the different SQL command types

Identity methods

System connector method

SQL command type

Input parameters

Excepted return value

Description

SQL CreateIdentity

Stored procedure

  • Identity attributes, parameter names are taken from target_system_property_name in the system_identity_type_attribute table

  • IDENTITY_ID
    Unique identifier of the identity from the target system

Creates the user in the target system

SQL GetIdentityParameters

Select query (function)

  • SQL replacement for identity identifier: {IDENTITY_ID}

  • SQL replacements for identity attributes: {target_system_identity_typeproperty_attribute name}

  • All identity parameters from the SELECT query

Returns all the user parameters of a user

SQL CheckIdentityExists

Select query (function)

  • SQL replacement for identity identifier: {IDENTITY_ID}

  • Result row(s) or nothing

Checks if the user in the target system exists, if rows are returned → true, else false

SQL FindObjectIdentifiersByAttributes

Select query (function)

  • SQL replacement for system identity type: {SYSTEM_IDENTITY_TYPE_ID}

  • SQL replacements for attribute values: {target_system_identityproperty_type_attribute name}

  • Result rows with column name IDENTITY_ID

Finds object identifiers of users by their attribute values.

Returns all the object identifiers of users where the attributes values were found

SQL UpdateIdentity

Stored procedure

  • Identity identifier: IDENTITY_ID

  • Identity attributes, parameter names are taken from target_system_property_name in the system_identity_type_attribute table

-

Updates a user with the attribute values

SQL DeleteIdentity

Stored procedure

  • Identity identifier: IDENTITY_ID

-

Deletes a user by their identity identifier

SQL ValidateCredentials

Not implemented

-

-

-

SQL IsIdentityActivate

Select query (function)

  • SQL replacement for identity identifier: {IDENTITY_ID}

  • SQL replacements for identity attributes: {target_system_identity_typeproperty_attribute name}

  • Result row(s) or nothing

Checks if the user in the target system is active, if rows are returned → true, else false

SQL ActivateIdentity

Stored procedure

  • Identity identifier: IDENTITY_ID

-

Activates a user in the target system

SQL DeactivateIdentity

Stored procedure

  • Identity identifier: IDENTITY_ID

-

Deactivates a user in the target system

SQL SetIdentityPassword

Not implemented

-

-

-

SQL IsPropertyValueUnique

Select query (function)

  • SQL replacement for unique property: {UNIQUEPROPERTY}

  • SQL replacement for unique property value: {UNIQUEPROPERTYVALUE}

  • Result row(s) or nothing

Checks if a property value is unique in the target system.

There are 3 cases that gets checked to determine if the property value is unique:

  • Returing more than one row:

    • Not unique → false

  • Returing 1 row:

    • If property value is on the user with the given user object id → Is unique → true

    • If the property value is on another user → Is unique → false

  • Returning now rows:

    • Is unique → true

SQL GetIdentity

Select query (function)

  • SQL replacement for identity identifier: {IDENTITY_ID}

  • A user with their attribute values

Gets a single user with the attribute values

Resource methods

System connector method

SQL command type

Input parameters

Excepted return value

Description

SQL CreateResource

Not implemented

GetResourceParameters

Not implemented

CheckResourceExists

  • Unique resource identifier

Single row with single column

Stored procedure

  • Resource attributes, parameter names are taken from target_system_property_name in the system_resource_type_attribute table

  • RESOURCE_ID
    Unique identifier of the resource from the target system

Creates the resource in the target system

SQL GetResourceParameters

Select query (function)

  • SQL replacement for resource identifier: {RESOURCE_ID}

  • SQL replacements for resource attributes: {target_system_property_name}

  • All resource parameters from the SELECT query

Returns all the resource parameters of a resource

SQL CheckResourceExists

Select query (function)

  • SQL replacement for resource identifier: {RESOURCE_ID}

  • SQL replacements for resource attributes: {target_system_property_name}

  • Result row(s) or nothing

Checks if the resource exists. Return nothing if it doesn’t.

UpdateResource

Not implemented

DeleteResource

Not implemented

GetResources

Not implemented

IsPropertyValueUnique

Not implemented

GetResourceMembersByResource

Not implemented

AddResourceToResource

Not implemented

RemoveResourceFromResource

Not implemented

FindObjectIdentifiersByAttributes

Not implementedin the target system exists, if rows are returned → true, else false

SQL UpdateResource

Stored procedure

  • Resource identifier: RESOURCE_ID

  • Resource attributes, parameter names are taken from target_system_property_name in the system_resource_type_attribute table

-

Updates a resource with the attribute values

SQL DeleteResource

Stored procedure

  • Resource identifier: RESOURCE_ID

-

Deletes a resource in the target system

SQL GetResources

Select query (function)

  • SQL replacement for system resource type: {SYSTEM_RESOURCE_TYPE_ID}

  • SQL replacements for the search value: {textPattern}

  • SQL replacements for maximun amount of results returned: {maxResults}

  • Result row with the resource identifiers that were found with the column name RESOURCE_ID

Returns resources of a specific system resource type, filtered by the text pattern and limited by the max results value

SQL IsResourcePropertyValueUnique

Select query (function)

  • SQL replacement for unique property: {UNIQUEPROPERTY}

  • SQL replacement for unique property value: {UNIQUEPROPERTYVALUE}

  • SQL replacement for system resource type: {SYSTEM_RESOURCE_TYPE_ID}

  • Result row(s) or nothing

Checks if a property value is unique in the target system.

There are 3 cases that gets checked to determine if the property value is unique:

  • Returing more than one row:

    • Not unique → false

  • Returing 1 row:

    • If property value is on the user with the given user object id → Is unique → true

    • If the property value is on another user → Is unique → false

  • Returning now rows:

    • Is unique → true

SQL GetResource

Select query (function)

  • SQL replacement for resource identifier: {RESOURCE_ID}

  • Result row with the resource identifier that was found

Gets a single resource

Identity-resource membership methods

System connector method

SQL command type

Input parameters

Excepted return value

Description

SQL AddIdentityToResource

  • Unique user object id

  • Unique resource object id

    Stored procedure

    • Identity identifier: IDENTITY_ID

    • Resource identifier: RESOURCE_ID

    -

    Adds the user to the resource

    SQL RemoveIdentityFromResource

  • Unique user object id

  • Unique resource object id

    Stored procedure

    • Identity identifier: IDENTITY_ID

    • Resource identifier: RESOURCE_ID

    -

    Removes the user identity from the resource

    AddResourceToIdentity

    • Unique user object id

    • Unique resource object id

    -

    Adds the resource to the user

    RemoveResourceFromIdentity

    • Unique user object id

    • Unique resource object id

    -

    Removes the user from the resource

    GetResourcesFromIdentity

    • Unique user object id

    • List of resource identifiers

    Adds the user identity to the resource

    GetIdentityMembersByResourceIdentifier

    • Unique resource object id

    List of user identity identifiers

    SQL GetResourcesFromIdentity

    Select query (function)

    • SQL replacement for identity identifier: {IDENTITY_ID}

    • SQL replacement for the system resource type: {SYSTEM_RESOURCE_TYPE_ID}

    • Result rows with the resources from the identity, column names to return:
      RESOURCE_ID → unique identifier of the resource
      RESOURCE_DISPLAY_NAME → display name of the resource

    Gets all the resources from the identity

    SQL GetIdentityMembersByResourceIdentifier

    Select query (function)

    • SQL replacement for resource identifier: {RESOURCE_ID}

    • Result rows with the identities from the resource, column names to return:
      IDENTITY_ID → unique identifier of the identity

    Gets all the user identities from the resource

    SQL command types

    Select Query (function)

    This can be a simple SELECT query from a table or a view. It’s also possible to call a function inside a SELECT query.

    Examples:

    SELECT * FROM t.users;
    SELECT * FROM v.users;
    SELECT * FROM get_users('all');

    Stored procedure

    If a stored procedure is needed for the SQL parameter, you have to specify the name of the stored procedure. The input and output parameters will be added in the system connector and are defined below.

    Examples:

    create_user
    update_user

    How-to Artikel

    Filter by label (Content by label)
    cqllabel in ( "systemkonnektor" , "how-to" ) and type = "page" and space = "IKB"

    ...