Client App Registration

The Client Application page is used to register Sagitta for use with other applications that include InsurLink, SagittaConnect, WorkSmart, or some other API-based Sagitta integration.

Add this page in "Role Based Security" to whichever System Administrator’s role will include personalizing the Client Application. The program name is CLIENTS.APPS.REGISTRATION.

If this element is added via the Quick Entry section of the page, its path is Other > Personalization > System.

On the Client App Registration page, there are fields for Client Application ID, Client Application Name, and Enabled, as well as a "Generate Secret" button plus a "Scopes" grid.

Before registering Client Applications, Sagitta API Security Keys must be generated and in force (i.e., not expired) under Vertafore Services Personalization. See the Help article Web Service Import Personalization for more information.

To Use the Page:

  1. Enter the product ID in Client Application ID; the name will prefill to Client Application Name.

  2. The "Enabled" function has three options: blank, Yes and No. The default option is blank (which equals No).

  3. Set Enable to "Yes" to enable the integration product.

  4. Set Enable to "No" to prevent the integration.

  5. Select "Generate Secret" to generate a string of characters that will also need to be personalized within the integration product. Copy the Secret when it displays, since it will no longer be visible once the page has been saved. Treat the Secret as a password and do not write it down or store it in an insecure fashion.

  6. Paste the Secret into the appropriate field on the integration product application.

    Note: The client application will also need reference to the Client Application ID, the Sagitta Account Code (i.e., gemdata for the Live account), and the Connection Code to be properly configured.

  7. Scopes grid: The Scopes available for the integration product define what functions the integration product can perform within Sagitta. Select from among the Scopes available for the product being personalized to indicate the actions you wish the product to perform.

    1. To launch to a client or policy page, enter SAGITTAAPI.LAUNCH. The description prefills with, Allows launching Sagitta client or policy.

  8. If no scope is selected, the integration will be personalized; however, it will not be granted permission to do anything.

The Client Application Secret value expires one year after it is generated.

Beginning on the date 30 days before the "secret" expires, the users configured in the Sagitta API Keys Notifications field on the Vertafore Services personalization page will receive a DAILY memo notification. This notification reminds users to re-generate the Secret and configure it once again in the Client Application. Upon re-generation, the daily reminders will cease.