Creating OData Custom Composite Keys

Transcription

1 Creating OData Custom Composite Keys 1993, 2016 Informatica LLC. No part of this document may be reproduced or transmitted in any form, by any means (electronic, photocopying, recording or otherwise) without prior consent of Informatica LLC. All other company and product names may be trade names or trademarks of their respective owners and/or copyrighted materials of such owners.

2 Abstract This article describes how to create OData custom composite keys for use with a JDBC connector. Supported Versions Cloud Application Integration August 2016 Table of Contents Custom Composite Keys Viewing the Custom OData Entity Keys Section Creating OData Custom Composite Keys Editing OData Custom Composite Keys Adding and Removing Existing Fields... 4 Removing Fields That no Longer Exist Deleting OData Custom Composite Keys Publish Validation Custom Composite Keys When you use OData to access a JDBC connector, you can define and edit custom composite keys. You define a custom composite key when a database entity does not have a primary key. With this custom composite key that you create, you can perform read operations on the JDBC database. Primary Keys and Custom Composite Keys A primary key is an object field (a column in a database table or a database view) or a set of object fields (columns in a database) that can uniquely identify each record in a database table or database view. You use primary keys to query objects in the database. If an entity does not have a primary key, you can define a custom composite key for the entity. To create a custom composite key, manually select a field or multiple fields for that key. The custom composite key takes the place of the primary key, and you can use it to read data from a JDBC database. Example: You connect to a JDBC database of employee records and you see that the entity empaccount does not have a primary key. You can manually select the fields , ID, and name to define a custom composite key for empaccount. You can also edit custom composite keys that you created. If you defined a custom composite key that references an entity that no longer exists, you can remove the key. If a custom key contains fields that no longer exist, you can remove these fields. Viewing the Custom OData Entity Keys Section 1. Enable OData and publish a JDBC connection. 2. Click the Published Metadata tab. 2

3 You see a new section, Custom OData Entity Keys, with the following information: Error messages, if any, with information about entities without a primary key and custom keys assigned to entities that no longer exist. A list of entities and their corresponding key fields. 3. Click Edit Custom Keys. The Custom OData Entity Keys dialog box opens. The following image shows the Custom OData Entity Keys dialog box: On the left side, you see three types of entities: Entities that do not have a primary key. Entities that do not exist but still have a custom key mapped to them. Entities that have a primary key defined, and do not require a custom composite key. On the right side, you see a list of fields that you can map to create a custom composite key. Creating OData Custom Composite Keys To create OData custom composite keys, you select entities that you want to use as primary keys. 1. Click Edit Custom Keys. 2. Select an entity from the list of entities. 3. Select the fields that you want to use as a custom key. You can select multiple fields. Important: Ensure that you analyze the data and select fields that uniquely identify each record in the database table or view. For example, if you want to use the fields FirstName and LastName to create a custom composite key, you cannot have two employees with the same first and last names. 4. Click Apply. You see the custom composite key that you created in the list under Custom ODataEntity Keys. 3

4 Editing OData Custom Composite Keys You can edit an OData custom composite key to add and remove fields. Adding and Removing Existing Fields If you want to change a custom composite key, you can add or remove fields. 1. Select an entity from the list of entities. 2. If you want to remove fields, clear the fields that you do not want to use as a custom key. If you want to add fields, select the fields that you want to use as a custom key. 3. Click Apply. Removing Fields That no Longer Exist If you defined a custom composite key with fields that no longer exist, you can delete these fields. 1. Select an entity from the list of entities. You see that the fields that are a part of the custom composite key, but no longer exist, are marked with an x icon. 2. Click Delete at the upper-right of the dialog box. 3. Click Apply. You see that these fields not appear in the Custom ODataEntity Keys list. Deleting OData Custom Composite Keys If you created a custom composite key for an entity that no longer exists, you can delete the custom composite key. 1. Select the entity. You see that the entity is marked with an x icon. 2. On the right side, you see that all fields of entity are marked with an x icon. To remove these fields, click Delete at the top-right of the dialog box. Note: You can remove all custom keys defined for all missing entities in one step. To do this, click Delete at the top-left of the dialog box. When you apply changes, the entity no longer appears in the Custom ODataEntity Keys list. Publish Validation When you publish a connection, Informatica Process Designer checks the custom composite keys you created and displays a warning if it encounters any potential issues. The following image shows a sample warning message: 4

5 Author Sonia Abraham Senior Technical Writer 5