Using additional schema types
Add your own schema types if you want to synchronize data, which does not have schema types in the connector schema. You can let your own schema types be added when setting up the initial synchronization project with the project wizard, However, you can also add them after saving the synchronization project. This method is described here.
You can obtain an overview of which schema types are defined in the connector schema in the Synchronization Editor target system browser.
IMPORTANT: Both used and unused schema types are displayed in the Target System Browser. If the synchronization project is set, unused system types are deleted from the schema. Then they are longer appear in the Target System Browser.
Check the schema type list before you enable the synchronization project.
To start the Target System Browser
-
Open the synchronization project in the Synchronization Editor.
-
Select the Configuration > Target system category.
-
Select the General view and click Browse.
This opens the Target System Browser. You will see all the schema types used in this synchronization project in the upper pane of the Schema types view. The lower pane contains the list of unused schema types
To extend the connector schema with your own schema types
-
Find which out schema types you require.
-
Create a schema extension file. Save this file and keep the file name and path at the ready.
For more information, see Creating a schema extension file.
-
Open the synchronization project in the Synchronization Editor.
-
Enable expert mode.
-
Select the Configuration > Target system category.
-
Click Edit connection.
This starts the system connection wizard.
-
Verify the data.
-
Enter the path to the schema extension file on the Schema extensions (manually) page.
-
To check the schema extensions file for logical errors, click Test file.
All defined schema types are listed.
-
Click Next.
-
Click Finish to end the system connection wizard.
-
Select the view General and click Update schema.
- Confirm the security prompt with Yes.
The schema types, including your new schema types, are loaded.
-
Open the Target System Browser and check whether the schema types have been added.
The schema types are displayed in the list of used schema types.
-
Select the Mapping category and create mappings for the your new schema types. Take note of whether these are read-only or whether read/write access is permitted.
For more information about setting up mapping and schema classes, see the One Identity Manager Target System Synchronization Reference Guide.
-
Select the Workflows category and edit the worklows. Create additional synchronization steps for the new mappings. Take note of whether the schema types are read-only or whether read/write access is permitted.
For detailed information about setting up synchronization steps, see the One Identity Manager Target System Synchronization Reference Guide.
-
Save the changes.
-
Run a consistency check.
-
Activate the synchronization project.
To remove the schema part of the schema extension file from the connector schema
-
Delete all mappings and synchronization steps that were created for the additional schema types.
-
Edit the target system connection using the system connection wizard.
- Update the schema.
- Save the changes.
-
Run a consistency check.
-
Activate the synchronization project.
Creating a schema extension file
Define all the schema types you want to use to extend the connector schema in the schema extension file. The schema extension file is an XML file with a structure identical to the connector schema. It describes the definitions for table queries for the new schema types. Schema types defined here are always added to the existing schema. If a new schema type has the same name as an already existing schema type, the extension is ignored.
You can only specify one schema extension file. This must contains all required extensions. If a schema extension file is added to a connection configuration that already contains a schema extension file, the previous definition is overwritten.
The schema extension file defines schema types as objects, and therefore corresponds to the basic structure of a list of object definitions. An object definition contains the definition of a schema type. A file can contain any number of object definitions.
Schema extension file structure
<?xml version="1.0" encoding="utf-8" ?>
<EBSF12>
<ObjectNames>
</ObjectNames>
</EBSF12>
Detailed information about this topic
Object definitions
The object definitions are used for the formal description of which sources, key values, and conditions are used for the selection of data objects of a schema type. This formal description is evaluated by the Oracle E-Business Suite connector, which uses them to generate SQL statements for the database query. Because data for an object of a schema type can be determined from multiple tables, always use table and column names in the full notation <schema name>.<table name>.<column name>.
Example: AK.AK_ATTRIBUTES_TL.ATTRIBUTE_CODE
Table 7: Attributes of an object definition
|
SchemaName |
Freely selected name of the schema type to be defined. The objects of this type are displayed in the extended schema under this name. |
|
ParentSchemaName |
Reference to an additional schema type on a higher hierarchy level.
Example: Application is ParentSchemaName of Attribute |
|
DisplayPattern |
Definition of a display pattern for displaying objects in the Synchronization Editor (for example, in the target system browser or when defining schema classes). |
|
IsReadOnly |
Specifies whether the objects of this schema type can be read-only. The default value is false. |
|
AddRootDN |
Specifies whether the unique name for the DN should be added to the defined name of all objects of this schema type. The default value is true. |
|
UseDistinct |
Specifies whether duplicate entries are prevented through the use of the Distinct function. The default value is false. |
Example
<Object SchemaName="ORA-Attribute" ParentSchemaName="ORA-Application" DisplayPattern="%AK.AK_ATTRIBUTES_TL.ATTRIBUTE_CODE%" IsReadOnly="true" UseDistinct="false" >
Object key definition
The object keys define all columns that are required to select only one object of the schema type. <Key> tags are used to define the key columns. The <ObjectKey> tag can contain any number of <Key> tags. This enables the components of the unique key to be declared for all elements of a schema type and the columns to be named that are required for the identification of an individual object of this schema type. The correct specification of all key columns is important both for the selection of the individual objects, and for possible Join operations.
Table 8: Attributes of an object key definition
|
Column |
Name of the column in full name notation. |
|
IsReferencedColumn |
Specifies whether the key column is required by other schema types for reference resolution The default value is false. |
|
IsDNColumn |
Specifies whether the value in this column is inserted as a component into the defined name of the object. The default value is false. |
|
X500Abbreviation |
Abbreviation that is added to the front of the value from this column when forming the defined name. Only required if IsDNColumn="true". |
Example
<Objectkey>
<Key Column="APPLSYS.FND_APPLICATION.APPLICATION_ID" IsDNColumn="true" X500Abbreviation="AP" />
</Objectkey>
