Ribbons for Disclosure Management

Last modified on 2024-05-29

Overview

When working with MS Office documents, you can use functions in specific ribbons for MS Excel and MS Word. The functions provided in the ribbons are perfectly adapted for use in conjunction with Lucanet Disclosure Management:

  • The Excel ribbon helps you program an MS Excel file for Disclosure Management.
  • The Word ribbon helps you create result documents in MS Word.

Have you not installed the ribbons yet? Then go to the Toolbox of Disclosure Management and first install the Excel ribbon, the Word ribbon, and the Dispatcher. The Dispatcher is responsible for communication between Disclosure Management and the MS Office files, so installing it is a prerequisite.

This article contains the following sections:

General vs. Special Functions

For Disclosure Management, there are functions that are available in all ribbons and special functions for the MS Office product being used. The following figures highlight the general functions in the ribbons for MS Excel and MS Word:

Displays the Excel ribbon for Disclosure Management. The 'Server' and 'Files' areas and the 'Insert Document Variable' button are highlighted. Excel ribbon containing the general functions for Disclosure Management
Displays the Word ribbon for Disclosure Management. The 'Server' and 'Files' areas and the 'Insert Document Variable' button are highlighted. Word ribbon containing the general functions for Disclosure Management

The Word ribbon is also available for MS Office Online and Microsoft 365. However, the Word ribbon for MS Office Online doesn't yet contain all the functions that are available in the Word ribbon for the locally installed MS Word. We will gradually add the missing functions.

Ribbon for Disclosure Management in the online version of MS Word. Word ribbon in MS Office Online

If you want to switch between MS Office Online and the local MS Office installation, you must navigate to the Configure Document workspace and edit the MS Office variant option there.

All Functions at a Glance

The following functions are available in the Excel ribbon and Word ribbon:


Area

Description


Server

  • Check In: The current file will be saved in the database. Comments can be stored during the check-in process. Comments will be displayed in the document's history.
  • Update: By clicking Update, changes made in Excel or Word files can be viewed as a preview at any time without having to check in the file. The file view will be refreshed according to the current, changed settings.

    Examples:
    • You have created names and name extensions, but the corresponding cells of an Excel file have not yet been filled with content. By clicking Update in the Excel ribbon, the document's reference year will appear in the sn_year named range, for example.
    • Values in Excel files are to be updated if a new data import has been performed in the meantime.

Files

  • Event Reports: Disclosure Management has an internal error logging system that flags invalid references, etc. Show Log opens the results of the log.
  • Save File Locally saves the file in the local file directory.
  • Open Local File opens a file from the local file directory.
  • Recover Version opens or recovers a previous version of the document that is currently open.

Insert Document Variable

Insertion of a document variable; document variables are text building blocks that can be created in the document variable management tool and then easily inserted in every Excel and Word file of the current document.

More information on document variables can be found in Using Document Variables.


The following specific functions are available in the Excel ribbon:


Area

Description


Name Management

  • Name Manager opens MS Excel's standard Name Manager.
  • Delete Names deletes a selected name from the Excel file.
  • Delete All Names deletes all names from the Excel file.

Cells

  • Insert adds a new outarea.
  • Move shifts an outarea.
  • Insert Document Variable: Insertion of a document variable; document variables are text building blocks that can be created in the document variable management tool and then easily inserted in every Excel and Word file of the current document.

Columns

  • Name: button for creating a name column
  • Value: button for creating a value column
  • Prog: button for creating a programming column
  • Other: button for creating other columns

More information on inserting columns can be found in Defining Columns.


Settings

Edit Properties opens a dialog where the general properties of the Excel file can be configured.


Layout

Add Layout Area defines an area where a specific layout from the Layout Robot is to be applied (see Configuring Document). By doing so, you ensure that a table layout defined using the Layout Robot is implemented in the Word document.


The following specific functions are available in the Word ribbon:


Area

Description


File

Compare with Local Document opens the local directory structure where a file can be selected for comparison.


Integration

  • Insert Table opens a dialog where a table can be selected from an Excel file to carry it over to the Word document.

    More information on inserting tables can be found in Inserting Tables in a Word Document.
  • Insert text values opens a dialog where an existing variable or text value can be selected to carry it over to the Word document.

    More information on inserting text values can be found in Inserting Text Values of a Word Document.
  • Insert Document Variable opens a dialog where the available document variables can be selected to carry them over to the Word document.

    More information on inserting document variables can be found in Using Document Variables.
  • Layout Actions Assistant opens a dialog where you can define the layout of the tables from MS Excel.

    More information on the Layout Actions Assistant can be found in Applying Layouts in MS Word.
  • Highlight Text Values highlights all text values and variables in the Word document.
  • Highlight Tables highlights the tables in all Word documents. In the menu, you can choose between files defined in Disclosure Management and files not available in Disclosure Management.
  • Unlock Content Controls removes the lock on content controls.

Content controls can be found in the Controls group of the Developer tab in MS Word. You can lock content controls in the Word document via their Properties dialog. The Unlock Content Controls command removes the locks defined there.

Please note: Applying the lock will remove all the XBRL text block tags created in the Word document.


XBRL

  • Insert XBRL Text Block Tag opens a window in MS Word where you can assign an XBRL text block tag to a selected area in the Word document.
  • Insert XBRL Footnote Tag opens a window in MS Word where you can assign an XBRL footnote tag to a selected area in the Word document.
  • Highlight XBRL Text Blocks highlights all XBRL text blocks in the current Word file and displays a comment field for all highlighted text blocks.

    More information on inserting XBRL tags can be found in Inserting XBRL Tags.