Function Name:
Enrich Company
Purpose:
The Enrich Company function will retrieve Company data from your data enrichment provider. The enrichment provider will typically require a specific attribute to be used with finding a matching company. For example, Clearbit uses either the company IP Address or Domain to find a matching company record. Use this function in your Attribute Pipelines to enrich each attribute that requires enrichment. The first request for a given company will retrieve all available attributes from the enrichment provider and cache the information in Syncari for 30 days. This is done to help prevent excessive usage of your data enrichment service.
Configuration:
1. Enter a Display label for the node. This will be helpful with identifying the node when viewing your Entity Pipeline.
2. Enter a Description that will explain the criteria configured.
3. From the Enrichment Source dropdown, select the Enrichment Provider that will be used with the function.
4. The Enrich Using setting will display the attribute(s) that will be used to find a matching company record with the Enrichment Provider. For example, select Domain if you want to find a company record by the Domain.
5. Select the Source Entity that will be enriched.
6. Select Input Field on the Source Entity that will have the value for the option selected in Step 4. For example, if you selected Domain as the "Enrich Using" option, the Input attribute should hold the domain for the company.
7. The Enrichment Field option is used to select the attribute on the Company record that is returned by the Enrichment Provider. This will be the attribute value that is output by the Enrich Company Function.
8. Select the Attribute Value on the entity, it is the field that will be populated with the output returned by the enrichment provider. This field is only available when using this function in an Entity pipeline. It will not appear when configuring this function in an Attribute pipeline.