Merge pull request #381 from ritza-co/docs-19.03.05

Docs 19.03.05 release (Week 44, 2024)

docs/administration/active-directory-and-openldap-support.md

@@ -3,15 +3,15 @@ title: "Active Directory and OpenLDAP Support"
 sidebar_position: 1
 ---
 
-## Multi-domain Active Directory & OpenLDAP Support
+## Multi-domain Active Directory and OpenLDAP Support
 
 Device42 can now be configured to work with multiple Active Directory (AD) servers. AD servers can be used for both Active Directory based logins, as well as AD synchronization.
 
-AD settings can be found and configured in _Tools > Settings > Active Directory Settings_, but are only accessible to D42 **super users**. Multiple Active Directory settings and/or up to one OpenLDAP server setting can be configured at a time to properly describe your environment. Each Active Directory setting can also specify multiple domains.
+AD settings can be found and configured in *Tools > Settings > Active Directory Settings*, but are only accessible to D42 **super users**. Multiple Active Directory settings and/or up to one OpenLDAP server setting can be configured at a time to properly describe your environment. Each Active Directory setting can also specify multiple domains.
 
 ![Select Active Directory/LDAP Settings to view](/assets/images/Active_directory_settings_menu_button.png) ![Change Active Directory Settings](/assets/images/Change_Active_directory_settings-HL.png)
 
-After entering Active Directory or LDAP settings, you can test your configuration with the _'Test Connection'_ button on the view page. You will be prompted for credentials to initiate the test.
+After entering Active Directory or LDAP settings, you can test your configuration with the *'Test Connection'* button on the view page. You will be prompted for credentials to initiate the test.
 
 ![Test Active Directory Credentials](/assets/images/Test_AD_Connection_button.png)
 
@@ -21,7 +21,7 @@ If you have selected to utilize “DomainUsername” Username Login Style, then
 
 ## Manually Add Single user from Active Directory
 
-To add a single new Administrator user manually from Active Directory, simply visit the main menu, _"Tools -> Admins & Permissions -> Administrators"_. ![Add Admin User Active Directory](/assets/images/manually_add_d42_admin_user_from_AD-1.png)
+To add a single new Administrator user manually from Active Directory, simply visit the main menu, *"Tools -> Admins & Permissions -> Administrators"*. ![Add Admin User Active Directory](/assets/images/manually_add_d42_admin_user_from_AD-1.png)
 
 You are able to review the domain found for the user found prior to adding them, and **the new user will be added according to the currently configured "Username Login Style option"**: (previous section). ![Add Active Directory user as Admin](/assets/images/Add_AD_user_as_Admin.png)
 

docs/reports/reports/object-history-aka-audit-log.mdx

@@ -0,0 +1,99 @@
+---
+title: "Object History (Audit Logs)"
+sidebar_position: 11
+---
+
+import ThemedImage from '@theme/ThemedImage'
+import useBaseUrl from '@docusaurus/useBaseUrl'
+
+Every change made to Device42 Configuration Items (CIs), via the user interface, autodiscovery jobs, RESTful API calls, or imports, is recorded as history. 
+
+This section discusses how to view and filter audit logs and exclude object categories (models) from being logged. 
+
+## The Audit Log List Page
+
+Go to **Analytics > Audit Logs > History** to view the audit history. Use the search bar on the right to find changes made by a specific user or source. 
+
+<ThemedImage
+  alt="History (audit log) list page"
+  sources={{
+    light: useBaseUrl('/assets/images/object-history-aka-audit-log/history-list-page-light.png'),
+    dark: useBaseUrl('/assets/images/object-history-aka-audit-log/history-list-page-dark.png'),
+  }}
+/>
+
+The **History (Audit Logs)** table includes the following sortable columns :
+
+- **Type**: Indicates the category of the object that was changed (for example, Device, Global Settings, Affinity Group, Contract, and so on).
+- **Object**: Displays the specific object that was changed. Click an object to filter the table by that object.
+- **Changed**: Shows what was added and what was changed. For database objects, the database ID of the object is shown.
+- **Action**: Displays the type of action that was logged (for example, Insert, Delete, Update, View, Login, API).
+- **Origin**: Shows the source of the change (for example, UI, API, Task, and Internal). 
+
+### Dropdown Filters
+
+Apply filters to narrow down the results displayed in the table. Use the **Action Date/Time** dropdown to limit results to a specific duration. 
+
+The **User**, **Type**, **Action**, and **Origin** dropdown menus are included in the UI by default. To add additional filters, click the **+ More** button.
+
+Use the **Advanced** button to query the audit logs by properties such as `object_id` and `action_id`. 
+
+Click on the **gear icon** to save the filters you've applied for quick access later or to save the view as the default view. 
+
+<ThemedImage
+  alt="Dropdown filters"
+  sources={{
+    light: useBaseUrl('/assets/images/object-history-aka-audit-log/time-filter-light.png'),
+    dark: useBaseUrl('/assets/images/object-history-aka-audit-log/time-filter-dark.png'),
+  }}
+/>
+
+
+### Export as CSV
+
+Under the **Action** menu is the option to **Export Selected Columns as CSV**. Click the **hammer icon** to execute the action. 
+
+<ThemedImage
+  alt="Action dropdown"
+  sources={{
+    light: useBaseUrl('/assets/images/object-history-aka-audit-log/action-light.png'),
+    dark: useBaseUrl('/assets/images/object-history-aka-audit-log/action-dark.png'),
+  }}
+  style={{ width: '50%' }} 
+/>
+
+## View History for Individual Objects
+
+In addition to this centralized audit log, you can access the history of an individual object from its view or edit page. 
+
+<ThemedImage
+  alt="Object history button"
+  sources={{
+    light: useBaseUrl('/assets/images/object-history-aka-audit-log/history-button-light.png'),
+    dark: useBaseUrl('/assets/images/object-history-aka-audit-log/history-button-dark.png'),
+  }}
+/>
+
+The default view is **Direct Only**. To see changes made to related data, such as the IPs of a device, change the filter option to **All** or **Related Only**.
+
+<ThemedImage
+  alt="Object history filter"
+  sources={{
+    light: useBaseUrl('/assets/images/object-history-aka-audit-log/history-filter-light.png'),
+    dark: useBaseUrl('/assets/images/object-history-aka-audit-log/history-filter-dark.png'),
+  }}
+/>
+
+## Audit Log Exclusions
+
+You can turn off history tracking for object categories. Navigate to **Tools > Settings > History (Audit Log) Exclusions** and click **Edit**. 
+
+Select one or more object categories from the **Available Models** and use the arrow button to add them to the **Excluded Models** box. 
+
+<ThemedImage
+  alt="Select exclusions interface"
+  sources={{
+    light: useBaseUrl('/assets/images/object-history-aka-audit-log/exclusions-light.png'),
+    dark: useBaseUrl('/assets/images/object-history-aka-audit-log/exclusions-dark.png'),
+  }}
+/>

search-index-docs.md

@@ -4,32 +4,27 @@ Algolia runs a Docsearch free program, where they manage and host and update the
 
 That program is by application only and takes at least two weeks. In the mean time, they have a (legacy) option to run your own scraper, as documented [here](https://docsearch.algolia.com/docs/legacy/run-your-own).
 
-In either case, Algolia hosts the index on their servers. The (frontend-only) docs site can then fetch search data from Algolia's servers and return relevant search results to the user. The difference is that if accepted into the programme
-then Algolia also takes care of regularly scraping the site (once a week) and updating the index. Without acceptance, this can be done manually by using their open source (no longer maintained) Docker container as described below.
+In either case, Algolia hosts the index on their servers. The (frontend-only) docs site can then fetch search data from Algolia's servers and return relevant search results to the user. The difference is that if accepted into the programme then Algolia also takes care of regularly scraping the site (once a week) and updating the index. Without acceptance, this can be done manually by using their open source (no longer maintained) Docker container as described below.
 
-## Pre-requisites 
+## Pre-requisites
 
-* Docker
+- Docker
 
 ## Creating the search index
 
-* Sign up for the Aloglia free plan
-* Create a new index and make a note of the **index name**
+- Sign up for the Aloglia free plan
+- Create a new index and make a note of the **index name**
 
 ![image](https://github.com/device42/device42-docs/assets/2641205/7bcc0aee-3e7a-47d7-acab-66c391bc7888)
 
-* * Visit API Keys under settings:
-
 ![image](https://github.com/device42/device42-docs/assets/2641205/2a82587a-95b9-475a-a780-9ebcaea92c21)
 
-* * Make note of the application id and the two api keys (one to update the index, one as a read-only token that will be included in the frontend to access the index and perform searches).
-
 ![image](https://github.com/device42/device42-docs/assets/2641205/4d2eac2b-9b23-4f6f-abfd-6b856c232695)
 
-* Create a .env file with the application ID and the Admin API key, as described in [the docs](https://docsearch.algolia.com/docs/legacy/run-your-own).
-* Create a `config.json` file with the contents copied from the [Indexer configuration](#config) below.
-* If necessary, change the `start_urls` and `sitemap_urls` to the correct domain (dev, prod, etc)
-* Run the Docker command
+- Create a .env file with the application ID and the Admin API key, as described in [the docs](https://docsearch.algolia.com/docs/legacy/run-your-own).
+- Create a `config.json` file with the contents copied from the [Indexer configuration](#config) below.
+- If necessary, change the `start_urls` and `sitemap_urls` to the correct domain (dev, prod, etc)
+- Run the Docker command
 
 This should update the index in your aloglia account, which you can see in the portal.