---
title: "Additional Documentation"
canonical: "https://help.agiloft.com/space/A2508SD/134054018/Additional+Documentation"
format: markdown
---
In addition to this reference, the <u>[Help Guide](https://agiloft-public.atlassian.net/wiki/spaces/HELP)</u> includes detailed instructions to help you and your end users complete basic and complex tasks, learn about new features, install add-ons, set up integrations, customize and extend the system, and perform maintenance and troubleshooting.

The sections included in this guide are detailed but not all-inclusive. The system provides additional documentation internally for some features. This content is in the form of table, field, rule, and permission descriptions and configuration settings. For information about exporting the internal system documentation, see <u>[Built-in System Documentation](#built_in_system_documentation)</u> below.

# > Macro (anchor)

Built-in System Documentation

Agiloft has built in functions that allow you to view summaries of different components in your system. These summaries are available to print and distribute. This section describes how to automatically generate documentation for tables, fields, rules, and permissions. Exporting this information is valuable when you're quickly trying to get a high-level idea of what your system comprises. The exported documentation can be shared to communicate the capabilities and structure of a specific KB.

## Export Tables and Fields Documentation

It's possible to export all table and field data from the system. Since this information changes frequently, this is a very useful option.

To generate an Excel workbook of the current field information for all the tables in the system, go to **Setup > Tables **and select Generate field documentation for all tables.

![Generate field documentation for all tables button](media://5a3dcf89-744f-49f1-9c6e-ab781e13cfc7)

In the window that opens, you can choose which field qualities to include, as well as how the sheet itself is formatted. Clicking Finish creates a workbook with a worksheet for each table and a column for each choice that was selected on the previous screen.

## Print Rules Documentation

You have the ability to create a summary of the rules from your system. This summary comes in the form of a file that provides most of the information about the rule criteria and actions, though it does not explain the purpose of the rule. Although there are a few ways to create these files, the recommended method is as follows:

1. Go to **Setup [Table Name]** and select the Rules tab.
2. Click either Rule ID, Priority, or Comment to sort the rules. This is also the order they appear in the file.
3. Select the rules you would like to include in the file. You can quickly select every rule by selecting the checkbox to the left of the Edit heading and choosing "Select all found records" from the drop-down list.
4. Click the printer icon in the action bar and select Print All Fields.

Print All Fields creates a single file with comprehensive details about a system's rules, which can be saved or printed. If you prefer a file that shows a snapshot of how rules appear in the Rules table, choose Print/Download Table View.

## > Macro (anchor)

Print Group Permissions Documentation

You also have the ability to view Group record permission configurations in detail, using a file that shows granular details down to the record level. Generate this file by following these steps:

1. Go to **Setup > Access > Manage Groups**.
2. Edit the group you want to document.
3. Click the Tables tab.
4. Select the tables you want to include in the file. Verify that the group you are editing has access to all the included tables. You can quickly select every table by selecting the checkbox to the left of the Edit heading and choosing "Select all found records" from the drop-down list.

> ℹ️ To quickly find specific fields in the list, click the column headers to change how the list is sorted.

5. Click the printer icon and select Permissions.

For full details on field level and other menu permissions for one or more groups:

1. Go to **Setup > Access > Manage Groups.**
2. Select one or more groups.
3. Click the printer icon and select one of the options. These reports take a long time to generate, and create long HTML documents that can be saved as documentation:
  - **All Current Permissions** generates a page that shows all permissions of the selected group, such as group permissions and field permissions for each table.
  - **All Permissions with History Log** generates a page similar to All Current Permissions that includes History field permissions as well as a History log. This same History log can be generated individually by selecting History Log only.
  - **History Log** shows permission changes tracked by the system. If the only item you need data for is history logs, always use this option instead of running All Permissions with History Log.
  - **Groups permissions comparison report** can be used after selecting two or more groups to compare their record and field level permissions. The Full Details section explicitly states record and field level permission comparisons for each group.

### Additional Options

From the same printer icon drop-down list, you can select additional options:

- **New HTML Template** opens a wizard that allows you to create an HTML Template. The wizard allows you to adjust the format of the template, as well as add certain variable fields to the template. This option is only recommended for users with intermediate knowledge of HTML.
- **New Word/PDF Template** opens a wizard that allows you to create either a PDF or Microsoft Word template from the selected data. This wizard allows you to adjust the format of the template or use an attached file field from the existing record or from a linked record as the document template.
- **Manage** opens a window that lists the document templates created using the two options above.