Skip to main content

Version: 19.05 (EOL)

User Save

The User Save command type performs a user-initiated save operation.

Support​

User Save was introduced in Transact Manager 17.10, and continues to be available in later Transact Manager and Journey Manager releases.

Options​

All options are optional unless otherwise indicated.

OptionDescription
sendEmailSavedFormboolean

Whether to send a Form Saved email message to the user specified by the emailAddress parameter.

sendEmailShareFormboolean

Whether to send a Form Shared email message to the user specified by the emailAddress parameter.

emailAddressstring

The email address of the email recipient.

milestonestring (Maximum length 100 characters)

A transaction milestone event to record with the transaction. For example, "IDV:Completed".

Milestones are used to store transaction analytics information only. Do not store sensitive or PII data in milestones.

These milestones are recorded in the transaction history table for business reporting, and are also published to the Transact licensing service to support custom licensing agreements.

Example​

{
   "type": "userSave",
   "requestKey": "96b45311175fc320d875483950b2847c",
   "options": {
      "sendEmailSavedForm": true,
      "emailAddress": "[email protected]",
      "milestone": "User:Save"
   }
}

Response​

The response to this command is based on the standard Open UX API HTTP response. For more information, see HTTP Response.

200 OK​

On a successful response, the form should display the Save Success modal page. The resumeUrl attribute provides a link URL for the user to reopen their saved form.

{
   "formStatus": "Saved",
   "resumeUrl": "https://www.mycorp.com/forms/servlet/SmartForm.html?submitKey=bb9c87a62c83f2b642240d97edda50a9"
}

Generally, the form will not be required to perform any further operations; however, the server may instruct the form to redirect the user to another location.

{
   "formStatus": "Saved",
   "redirectUrl": "https://www.mycorp.com/accounts/tasks"
}

400 Bad Request​

On an invalid response, the server sends a JSON error message.

The error message may contain validation error messages to be displayed in the form.