Key Scraping

When a record is created inside of a system, the Central engine can retrieve the new key generated for that record. Central will then save that key inside its database to be used for any subsequent call to update that record. This is referred to as indexing the record. Keys that have been scraped and stored inside of an index can also be used as a cross-reference on Foreign Key Maps. See Maintain Index for information on managing indexed records.

Endpoints with key replication configured display a icon on their endpoint card in the Data Hub.

Key Scraping Action

Input	Description
Key Scraping	Title: A freeform label you give to the Action.
	Key Name: The name that the key is given inside of the index. The default value is ID; however, you are able to give the Key a more specific name.
	Key Source: Connectors (directing it to look in the save response for the key) and Response Headers (directing it to look in the response headers for the key).
	Connector Property: If the source is a Connector, it will be a path to the property of the key, e.g. "ID." If the source is Response Headers, it will be a path to the specific header that holds the key, e.g. ..Location[0]
	Transforms: Allows you to transform the response data the key in Central is returned to Central.
	Other Key Sources: Allows you to instruct Central where to find the key in a response if there is an atypical response body after a save.

Edit or Delete the Primary Key Action

1. Select Build > Data Hubs from the main menu.

2. Select the appropriate Data Hub; then, select an Endpoint to edit.

3. Ensure the Data Source tab is selected.

4. Select the On Save tab from the Events column.

5. Then, use the below table to determine next steps:

Edit the Primary Key Action

1. Select menu > Edit in the ObtainPrimaryKey card.

2. Enter a Title.

3. Select a Source.

4. As needed, toggle Requires Load.

   TIP

   The Requires Load toggle allows Central to query the system to find the record's key that was created if it is not in the response.

5. Enter a Connector Property.

6. As needed, select the arrow to add Transforms.

Delete the Primary Key Action

1. Select menu > Delete in the ObtainPrimaryKey card.
2. Select OK to confirm.

See Also

• Endpoint Configuration — Configure endpoint actions and parameterization
• Action Mapping — Map endpoint actions to Common Model properties
• Maintain Index — Manage the entity index where scraped keys are stored
• Endpoint Settings — Configure Override Key Source and other key-related settings