Developer Features in 20R1

We are pleased to bring you the following additions and enhancements to Developer Portal features in 20R1. REST API features added in 20R1 only affect API v20.1, unless otherwise noted. For issues fixed in this release, view the “Developer Features” category of the fixed issues list in Vault Help.

REST API v20.1

In this release, we’ve released the new beta version of the API: v20.1.

Record Migration Mode for Configuration Migration Packages

Record Migration Mode allows configuration specialists to use outbound packages with dataset items to create object records in non-initial state.

This feature introduces a new field, Record Migration Mode (record_migration_mode__sys) to the Inbound Package Data (vault_data_package__v) and Dataset Item (dataset_item__sys) objects.

Record Migration Mode for Loader REST API

Record Migration Mode now allows integration specialists to use Loader REST API to create object records in non-initial state.

Learn more about Loader REST API

idParam for Loader REST API

This feature allows integration specialists to specify the idParam that can be used with an upsert, update, and delete action to identify the field that will be used to identify the record.

Learn more about Loader REST API

Vault Safety: Import Narrative REST API

Release Date: December 19, 2019

This feature introduces a publicly accessible API for importing a Vault Safety Case narrative. This will assist with non-E2B database migrations to Vault Safety.

Learn more about Import Narrative REST API.

Vault Java SDK

Document Type Support for Reference Lookups

This feature is geared towards developers building Spark integrations. It is common to have vaults with document types that are the same but with different names, especially across Vault families. With document-type reference lookups, Spark-integration developers can now map source document types to target document types, avoiding the need to hard code the mappings.

Learn more about Reference Lookups.

Spark Message Delivery Event Handler SDK Interface

The MessageDeliveryEventHandler interface allows developers to handle undeliverable Spark messages. Any classes implemented using this interface can be assigned to an Outbound Queue. The class assigned to the queue will be run anytime a Spark message can’t be delivered to its destination.

A Message Delivery Event Handler User is required to ensure auditable events triggered by MessageDeliveryEventHandler run on behalf of a named user. By default, handler code executes with System-level access, identified in audit logs as System on behalf of {originatingUser}, where {originatingUser} is the Spark Message Delivery Event Handler User.

Learn more about Message Delivery Event Handlers.

Integration Rule Service with Custom Error Reporting

Previously, it was not possible for custom Spark Integrations to access the error details returned by IntegrationRuleService. In this release, we have created a new set of Integration Rule Services that provide custom error reporting.

Periods Supported for client_id

Every Vault REST API call can accept an optional client ID to represent an external integration client. You can provide this data via a query parameter called client_id or HTTP Header called X-VaultAPI-ClientID.

Previously, underscores and hyphens were the only special characters allowed in a valid client ID. With this release, a valid client ID may also contain periods.

Learn more about client_id.

MDL

Spark Message Delivery Event Handler SDK Interface

The MessageDeliveryEventHandler interface allows developers to handle undeliverable Spark messages. Any classes implemented using this interface can be assigned to an Outbound Queue. The class assigned to the queue will be run anytime a Spark message can’t be delivered to its destination.

The feature introduces two new attributes, message_delivery_event_handler and message_delivery_event_handler_user, to the Queue component. These attributes can be set on an outbound queue once the handler code has been deployed to vault. The new Messagedeliveryeventhandler component is referenced by the message_delivery_event_handler attribute.

Document Type Support for Reference Lookups

With document-type reference lookups, Spark-integration developers can now map source document types to target document types, avoiding the need to hard code the mappings.

To support the new reference lookup type, the Fieldrule component’s reference_lookup_type attribute now includes a documenttype value.

Add single_instance_states attribute to Jobmetadata Component

SDK Jobs can now be configured to only allow one instance of that job to be in a given state at any time. The Jobmetadata component’s single_instance_states attribute accepts a value of scheduled, queued, or running, depending on which states of the job need to be restricted to one instance at a time. SDK Jobs that attempt to enter into a state that only allows a single instance will be blocked.