Onit Documentation

Creating a New App to Work with the Word Add-In

by Sigmarie Soto Updated on

Required Fields

Newly Created App

  • document (HasMany) field with the Target App property linked to the Document app and the Inverse Relation property
  • guid (Text)
  • num_docs (Integer) field with initial value of 0:
    • num_docs should be calculated by the number of related atoms in the HasMany document field

Document App

  • An inverse relation field of the type 'BelongsTo' that refers to the newly created app as the Target app
  • Ensure that the newly created 'BelongsTo' field is added to the launch form and hidden
  • Update "Fill in parent details" action's Shared Liquid with new elsif block for newly created app:
  • Update "Generate Document via DocGen Service" action's "scrAppId" request param with new "when" section
  • Create new Transaction Created BR and action to update num_docs on new app
  • The following OOTB buttons must all exist by those names: Check-out, Undo Check-out, and Check-in

Document Version App

  • Update "Add properties to doc" action's "srcAppId" request param with new "when" section

Word Add-In Configuration

A record must be created in the Word Add-In Configuration app to refer to the newly created app. This record has the following required fields:

  • App Name
  • App ID
  • Atom Dictionary ID
  • Inverse Relation Name which refers to the name of the 'BelongsTo' field
  • Action List

Word Add-In Key-Value Settings (KVS)

Word Add-In KVS can be added for the newly created app but are not required. For any missing KVS, default behavior will be observed. Refer to the list of KVS for information on defining desired behavior.

For additional information about environment requirements and user group permissions, click here.

Previous Article Clause Formatting Tips & Tricks for Consistent Styling
Next Article Word Add-In Environment Requirements

© 2025 Onit, Inc.

docs.onit.com contains proprietary and confidential information owned by Onit, Inc. that is subject to copyright. Onit presents it exclusively to you for your sole use in conjunction with using Onit products. No portion of the materials contained herein may be used for any other purpose. No portion of the materials contained herein may be shared with third parties or reproduced in any form.