Skip to main content
On the System Settings page, the Vault tab enables you to add and manage values for reuse throughout the CData Sync admin console. This feature saves time and helps prevent errors when you configure connectors that use the same data. Vault table showing vault items Sync supports external vault providers that let you reference secrets that are managed outside of Sync, and it also provides a built-in local vault. Both types of items appear in the vault table. In addition, you can filter the table by type and provider. After you set filters, you can clear all filter options by clicking the Reset link to the right of the filter menu. To set a filter:
  1. Click the filter icon.
  2. Choose filter options for Type, Provider, or both.
After you make your selections, the Vault table displays a list of items that meet the filter criteria. Filtered list of vault items

​
Managing Vault Providers

Vault providers determine where Sync resolves vault item values. The local vault is always present, and it is the only provider you can write to. External providers are read-only, and they allow you to reference secrets that already exist in your infrastructure without duplicating them in Sync. To open the provider list, click Vault Provider Config on the Vault tab. The Vault Provider Config dialog opens, listing each configured provider with its Name and Provider type. The Local provider is always the first row and it cannot be edited or removed. Vault Providers Config dialog To edit the Environment Variable external provider:
  1. Select … > Edit at the end of the row to open the Edit Environment Variable dialog. Edit Environment Variable dialog
    You can only edit the Included Patterns for the Environment Variable provider.
  2. Under Included Patterns, select the appropriate checkboxes and enter at least one pattern in Standard Patterns, Encrypted Patterns, or both. Each field accepts a comma-separated list of names or wildcard patterns using * and ?. Editing Standard and Encrypted patterns The pattern type controls how a matching variable is classified:
    • Standard Patterns: Matched variables are treated as Standard items and can be used in any non-sensitive field.
    • Encrypted Patterns: Matched variables are treated as Encrypted items and can only be used in sensitive fields.
    If a variable name matches both lists, an exact name match takes precedence over a wildcard match. If both matches are of the same kind (for example, two wildcards), Encrypted takes precedence over Standard.
    Variable names are matched case-insensitively on Windows and case-sensitively on all other platforms.
  3. Click Save to save your changes and close the dialog.

​
Managing Local Vault Items

You can add, edit, and remove vault items from the Vault table.

​
Adding Items to the Vault

To add an item to your vault:
  1. Add an item in either of two ways:
    • Click Add Vault Item at the top of the vault table.
    • Enter a value in a field elsewhere in Sync (for example, on a connector page), click the key symbol, and select Add to Vault. Add a vault item from a connector field using the key symbol Either option opens the Add Vault Item dialog. In this dialog, fill out the following fields:
      • Name: The name of the vault item as it appears when you use it.
      • Type: The classification for the vault item.
        • Standard: This type is for items that can be used in all non-sensitive fields (for example, URLs, usernames, and ports).
        • Encrypted: This type is for items that can be used only in sensitive fields (for example, passwords and authentication tokens).
      • Value: The actual value that the vault item contains (for example, the URL, username, or password that you want to use when this vault item is selected).
      • (Optional) Labels: Labels for the vault item that make it easier to manage and search through large vaults. Separate each label with a comma or a new-line character.
  2. Click Add Vault Item to save the item to your vault. Add Vault Item dialog

​
Editing Vault Items

To edit a vault item:
  1. Click the vault item’s name in the Vault table or hover over the row and select … > Edit at the end of the row. Either of these methods opens the Edit Vault Item dialog.
  2. Edit the name, value, and labels for the item, as necessary.
    • You cannot edit Vault ID values and types (standard or encrypted) after an item is created.
    • Items that are sourced from an external provider cannot be edited in Sync.
    • Hovering over an external item shows the tooltip: “This item is managed by an external vault provider and cannot be edited or removed.”
    • To change or remove an external item, update it in the originating system.

​
Removing Vault Items

To delete a vault item:
  1. Hover over an item row and select … > Remove to open the Remove Vault Item dialog.
  2. Verify that you want to delete the item. Then, click Remove. Remove a vault item
To remove multiple vault items, select the checkboxes next to each item that you want to delete and click Remove.
  • Hovering over an external item shows the tooltip: “This item is managed by an external vault provider and cannot be edited or removed.”
  • To remove an external item, update it in the originating system.

​
Using Vault Items

When an item is added to the vault, you can use it in fields that match the item type (Standard or Encrypted) and that display a key symbol in the Sync UI: Key symbol on a connector field To use a vault item:
  1. Click the key to open a list of matching vault values for a field. List of vault items available for a connector field
  2. Select one of the existing values (for example, the Schema value shown in the previous image) to populate the field. The list includes items from all configured providers. Each item shows the provider it comes from.
    If you already have a value in the field, you can click Add to Vault to open the Add Vault Item page as explained in Adding Items to the Vault.

​
Requalifying Vault References

When you move vault items to a different provider, you can update all existing job event and connection property references to point to a different vault provider. References that cannot be resolved in the target provider remain unchanged. To requalify vault references:
  1. Click Requalify References on the Vault tab to open the Requalify Vault References dialog. Requalifying Vault References dialog
  2. Select the source provider and target provider.
  3. Click Preview to see which references can be moved to the target provider.
  4. Click Apply Resolvable References to update the references that can be resolved. References to missing or incompatible items in the target provider are not changed.
Requalifying references does not copy item values between providers. Items must already exist in the target provider before you apply the requalification.

​
Scripting

You can use vault items in APIScript contexts. For more information, see Function Formatters.
Use caution when referring to encrypted vault items in scripting contexts to ensure that sensitive information is not included in the logs.