This guide explains how Key Value Settings (KVS) in the OnitX CLM Word Add-In should be configured for contracts and templates in the Inactive app Word Addin KVS.
Scroll to the right side of the table to see the full configuration values for each key.
| Key | Usage Explanation | Standard Configuration Value |
|---|---|---|
| allow_insert_segments | If true, Set Segment button is available on Document Details screen for a user to highlight and define a SEGMENT content control in the document. If true, the Segments tab in the Control Panel is also provided. If false, button and Control Panel tab are unavailable. | CLM: false Template Library: true |
| document_name_editable_on_launch_form | If true, enable editable document name on launch form. NOTE: This feature requires additional configuration to support. The KVS is used to inform the Word Add-In that the feature is enabled/expected. | CLM: false Template Library: false |
| display_control_panel | If true, provide Control Panel access from Document Details screen. If false, remove button access. The Control Panel allows for users to view existing fields, clauses, tables, and segments in the document and provide conditions and other properties to each. Only intended for use with placeholder/liquid references. | CLM: false Template Library: true |
| allow_new_obligation | If true, Add Obligation is available to user on Document Details screen. If false, ability to add obligation is unavailable. | CLM: true Template Library: false |
| allow_document_comparison | If true, Document Compare action available on Document Details screen when the record has more than one document/document version to compare. If false, Document Compare action is unavailable. | CLM: true Template Library: false |
| docgen_url | URL for doc-gen service instance to be used by add-in. | Not provided by default; contact your System Administrator. |
| auto_checkout | If true, documents are automatically checked out to the user opening the document as they are opened (if not otherwise already checked out to another user). If false, documents are only checked out when manually done so by a user. | CLM: false Template Library: false |
| clause_library_config | show_insert_clause - If true, Clause Library icon is available on the navigation sidebar and the Document Details screen. use_resolved_clause - If true, clause document is evaluated by the doc-gen service against the parent record and inserted into the document. If false, clause placeholder reference is inserted into the document. clause_library - Value of “precedent” or “onit”. allow_duplicate_clauses - If true, multiple instances of the same clause can be inserted into the document. If false, only one instance can be inserted. Only applies to Onit clauses. navigation_after_clause_insert - Value of “control panel”, “checkout view” or “clause library”. Value refers to the screen the user will be directed to after inserting a clause. Only applies to Onit clause library. override_contract_type_filtering - If true, clauses in the Onit clause library will not be filtered by contract type. If false, clauses will be filtered based on their contract type as it matches the open document record. use_active_version - If true, the active version (p_active_version) of a clause will be used for resolving clauses to insert into a document. If false, the latest version (p_attachment) of a clause will be used. | CLM: {"show_insert_clause”: true, “clause_library”: “onit”, “use_resolved_clause”: true, “allow_duplicate_clauses”: false, “override_contract_type_filtering”: true, “navigation_after_clause_insert”: “checkout view”, “use_active_version”: true} Template Library: {“show_insert_clause”: true, “clause_library”: “onit”, “use_resolved”clause”: false, “allow_duplicate_clauses”: false, “override_contract_type_filtering”: false, “navigation_after_clause_insert”: “control_panel”, “use_active_version”: false} |
| preview_template_config | allow_preview_template - If true, Preview Template icon is avialable on the Document Details screen. If false, Preview Template feature is not available. preview_template_version - List of attachment field display name to field name options from where to pull clauses from during generation. If not provided, p_attachment/“Latest Version” will be used by default. preview_template_doc_settings - Document protection setting options for resulting preview document. docxProtectionLevel - Document protection options = -1: Full Access 0: Insert Comments & Track Changes 1: Insert Comments Only 2: Fill in Form Fields Only 3: Read Only includeWatermark - watermarkText - watermarkOrientation - password - NOTE: Preview Template feature is only available to System Administrators. | CLM: {allow_preview_template”: false} Template Library: {“allow_preview_template”: true, “preview_template_version”:{“options”:{“Latest Version”:"p_attachment”, “Active Version”:"p_active_version”}, “default”:"Active Version”}, “preview_template_doc_settings”:{“docxProtectionLevel”:3, “includeWatermark”: true, “watermarkText”: “PREVIEW”, watermarkOrientation”:”Diagonal”}} |
| reconciliation_settings | allow_reconciliation - If true, field/clause reconciliation is available for the document check-in process. A toggle will be present on the Document Check-in screen. If false, reconciliation is not available. reconcile_by_default: If true, reconciliation toggle is on by default when the screen is reached. If false, reconciliation toggle is off by default when the screen is reached. allow_reconcile_overried - If true, the user is able to change the toggle. If false, the toggle is disabled and the user is unable to change the value from the reconcile_by_default proprty. | CLM: {allow_reconciliation”: true, “reconcile_by_default”: false, “allow_reconcile_override”: true} Template Library: {“allow_reconciliation”: false, “reconcile_by_default”: false, “allow_reconcile_override”: false} |
| workflow_config | phase_to_allowed_workflow - List of atom phases mapped to which review/approval workflows should be available at document check-in. Any phase can be provided as it will be compared against the phase of the document; however, workflow options are limited to “Send for Internal Review,” “Send for External Review,” “Send for Approval.” send_for_internal_review_list_provider_id - List provider ID for list of options to which the document can be sent for internal review. send_for_external_review_list_provide_id - List provider ID for list of options to which the document can be sent for external review. send_for_approval_review_list_provider_id - List provider ID for list of options to which the document can be sent for approval. bypass_checkin - allow_bypass_checkin_screen - If true, document will automatically be checked in when the user clicks on the save icon in the side nav bar. The user will not be prompted to select version, workflow actions, or reconciliation. If false, user will be navigated to the check-in screens on nav bar to make selections before document is checked in. version_increment (options: “minor” or “major”) - If allow_by_checkin_screen is true, document version will have a minor or major increment per KVS value (i.e., if “major,” 1.0 will increase to 2.0; if “minor,” 1.0 will increase to 1.1). | CLM: {“bypass_checkin”:{allow_bypass_checkin_screen”: false, “version_increment”: “minor”}, “send_for_approval_list_provider_id”:”623cbb1b5684da11990002ce”, “send_for_external_review_list_provider_id”:”5d14c5c2d8a1be75d300124d”,“send_for_internal_review_list_provider_id: “623cbb1b5684da11990002ce”, “phase_to_allowed_workflow”:{Author Contract:[“Send for External Review”, “Send for Internal Review”, “Send for Approval”], “Language Approved”:[“Send for Internal Review”, “Send for External Review”, “Send for Approval”], “Language Review”:[“Send for Internal Review”, “Send for Approval], “Language Approval”:[“Send for Internal Approval”], “Internal Review”:[“Send for Internal Review”, “Send for Approval”]}} Template Library: {“bypass_checkin”:{allow_bypass_checkin_screen”: false, “version_increment”: “minor”}, “send_for_approval_list_provider_id”:”623cbb1b5684da11990002ce”, “send_for_external_review_list_provider_id”:”5d14c5c2d8a1be75d300124d”,“send_for_internal_review_list_provider_id: “623cbb1b5684da11990002ce”, “phase_to_allowed_workflow”:{Author Template:[“Send for Internal Review”, “Send for Approval”], “Template Review”:[“Send for Internal Review”, “Send for Approval”], “Template Approval”:[“Send for Internal Review”, “Send for Approval], “Template Approved”:[“Send for Internal Review”, “Send for Approval”]}} |
| catalyst_config | allow_checklists - If false, Catalyst checklists will be hidden. If true or null, Catalyst checklists will be available. allow_highlights - If false, Catalyst highlights will be hidden. If true or null, Catalyst highlights will be available. allow_catalyst_chat - If false, Catalyst contract chat will be hidden. If true or null, Catalyst contract chat will be available. NOTE: Both properties defer to the use_precedent_integration corp1 setting. If that setting is false, Catalyst features will be hidden regardless of KVS value. | CLM: {“allow_checklists”: true, “allow_highlights”: true, “allow_catalyst_chat”: true} Template Library: {“allow_checklists”: false, “allow_highlights”: false, “allow_catalyst_chat”: false} |
| record_search_config | show_search_record_filters - If true, additional search filters will be available on the record search screen. record_search_filters - List of fields available for filtering records on the record search screen. Name field will always be included for filtering whether or not provided by KVS. display_name - Display field name to see in Word Add-In; does not need to match display value for the field in AppBuilder. field_name - Name of the field for the record search. The value to be used in actual filtering; mustmatch AppBuilder field name. field_type - Field data type for filtering. default_record_filter - Default filter for landing on the record search screen. | CLM: {“show_search_record_filters”: false} Template Library: {“show_search_record_filters”: false} |
| activity_config | disable_activity_feed - If true, comments/activity feed for all records will be hidden and new comments cannot be added. show_record_level_comments - If true, the activity feed items/comments displayed will be from the parent record (i.e., CLLM or Template Library atoms). If false, the activity feed items/comments will be from the Document record. NOTE: Comments do not display attachments in the Word Add-In. | CLM: {“show_insert_table”: false} Template Library: {“show_insert_table”: true} |
| table_config | show_insert_table - If true, Insert Table feature is enabled on the Document Details screen. Intended for template records, the table can include any number of fields from an app as the columns. When generated, each row will be populated with the values from the related atoms. table_ui_app_config - app_context - Source of the app relationship; the app with the “HasMany” end of the relationship. field_apps - List of related apps that have the “BelongsTo” end of the relationship to the “app_context”. app_name - Name of related app. related_field - Name of the relationship field. join_related_field - Name of the relationship field from the app serving as the join table to the data app. If value is null or property is missing, it is assumed it is not needed and is left out of the field liquid. (<related_field>.<index>.<join_related_field>.<field_name> i.e., contract_to_other_parties.[1].other_party.name) | CLM: {“show_insert_table”: false} Template Library: {“show_insert_table”: true} |
| field_config | allow_liquid_field - If true, liquid field placeholders can be added via the “Add Field” feature on the Document Details screen. Also enables the “Fields” tab on the Control Panel. app_fields_config - app_context - Source of the app relationship; the app with the “HasMany” end of the relationship. field_apps - List of related apps that have the “BelongsTo” end of the relationship to the “app_context”. app_name - Name of related app. related_field - Name of the relationship field. join_related_field - Name of the relationship field from the app serving as the join table to the data app. If value is null or property is missing, it is assumed it is not needed and is left out of the field liquid. (<related_field>.<index>.<join_related_field>.<field_name> i.e., contract_to_other_parties.[1].other_party.name) field_index_array - List of indices available for related app fields. label - Display value for the index in the Word Add-In value - Index value. enable_field_tracking - If true, enables the marking of text as tracked fields in an already generated document for future tracking and reconciliation. | CLM: {“enable_field_tracking”: true} Template Library: {“allow_liquid_fields”: true, “field_index_array”: [{“label”:”first”,"value”:"first”},{“label”:"second”,"value”:"[1]”},{“label”:”third”,"value”:"[2]”},{“label”:"fourth”,”value”:"[3]”},{“label”:”fifth”,"value”:"[4]”},{“label”:”last”,"value”:”last”}], “app_fields_config”: [{“app_context”: “Contract Lifecycle Management”, “field_apps”: [{“app_name”: “Contract Lifecycle Management”, “related_field”: null}, {“app_name”: “Other Parties”, “related_field”: “contract_to_other_parties”, “join_related_field”:”other_party”}, {“app_name”: “Legal Entities”, “related_field”: “contracts_to_legal_entity”, “join_related_field”: “legal_entity”}]}], “enable_field_tracking”: false} |
| create_record_config | allow_record_config - If true, creation of records on the app will be supported. If false, users cannot create new records on the app. limit_number_of_docs - The limit of documents the add-in will allow to be added to a record. If no limit is provided, the add-in will treat it as any number of documents can be added to the record. NOTE: Only one document should be allowed on Template Library. | CLM: {“allow_record_creation”: true} Template Library: {“allow_record_creation”: true, “limit_number_of_docs”: 1} |
| condition_library_config (Deprecated) | enable_condition_library - If true, Condition Library is available for create/update conditions in the Condition Library app as well as for use on conditional content control elements. | Template Library: {“app_list”: [“Contract Lifecycle Management”] “enable_condition_library”: true} |
| condition_builder_config | enable_condition_library - If true, Condition Library is available for create/update conditions in the Condition Library app as well as for use on conditional content control elements. app_list - The list of apps to be included in the Condition Builder for field selection. NOTE: The following data types will not be visible in the Condition Builder select: Attachment, BelongsTo, DisplayField, DisplayText, DocumentFolder, HasMany, HtmlField, ManyToMany, Multicurrency, Multiselect, Password | Template Library: {“app_list”: [“Contract Lifecycle Management”] “enable_condition_library”: true} |