[DOCS-7529] Final UA review

federation-services/latest/admin/admin-properties.md

@@ -2,42 +2,36 @@
 title: Admin Properties
 ---
 
-## Admin Properties
-
-The Admin Properties section of Federation Services Admin allows a user to Configure the following Global, Analysis, and Internal Audits Properties. Once changes have been made to any of the properties use the **Update Configuration** button to save the changes to the properties file.
+The Admin Properties section of Federation Services Admin allows you to configure the following Global, Analysis, and Internal Audits properties. Once changes have been made to any of the properties use the **Update Configuration** button to save the changes to the properties file.
 
 ## Global Properties
 
-* Initialise Database on start-up. This will rebuild the database indexes as well as add or rename the connectors - this is the same as setting simflofy.initialize.mongo=true.
-* Import database items - this is the same as setting simflofy.initialize.bootstrap=true
-* Run various patches which will update the items in the database from 2.X to 3.X forms - this is the same as setting simflofy.initialize.update=true
-* Enter the Full Discovery UI URL where these changes are to take place. For example: `https://localhost:8080/Federation-Services-discovery`
+* Initialize Database on start-up. This will rebuild the database indexes as well as add or rename the connectors - this is the same as setting `simflofy.initialize.mongo=true`.
+* Import database items - this is the same as setting `simflofy.initialize.bootstrap=true`.
+* Run various patches which will update the items in the database from 2.X to 3.X forms - this is the same as setting `simflofy.initialize.update=true`.
+* Enter the Full Discovery UI URL where these changes are to take place. For example: `https://localhost:8080/Federation-Services-discovery`.
 
-Check the boxes and or set the intervals for the properties you want to update and use the update configuration button to push the changes to your Federation Services System.
+Check the boxes and or set the intervals for the properties you want to update and use the **Update Configuration** button to push the changes to your Federation Services system.
 
 ## Analysis
 
-The Analysis section of Federation Services Admin allows a user to set the following analysis tools for their Federation Services system.
+The Analysis section of Federation Services Admin allows you to set the following analysis tools for their Federation Services system:
 
-* Turn on the ability to Collect Data
-* Allow users to generate Scheduled Reports
-* Set time Interval between job check status
-* Set Time between Schedule Status checks
-* Set time of delay before the data collections service begins checking collection schedules
+* Turn on the ability to Collect Data.
+* Allow users to generate Scheduled Reports.
+* Set time Interval between job check status.
+* Set Time between Schedule Status checks.
+* Set time of delay before the data collections service begins checking collection schedules.
 
-Check the boxes for the properties you want to set and use the update configuration button to push the changes to your Federation Services System.
+Check the boxes for the properties you want to set and use the **Update Configuration** button to push the changes to your Federation Services system.
 
 ## Internal Audits
 
-By default, internal auditing is turned off. To turn auditing on check the box for Internal audits. Here you can choose to **Track All Internal Audits** by checking the Track all Audits box, or you can **Track Internal Audits by Type** by checking the box next to each action type you would like to audit.
-
-List of available Audit types:
-
-mappings, repository, job, job group, license, output, authentication, view, user, search, content search, widget, template, configuration, license
+By default, internal auditing is turned off. See the [configuration](#configuration) section for more details.
 
 ### Overview
 
-The internal audit table displays internal audits, each with a name, type, action, user, org, date, and a description. By default, the audits are sorted by descending order on the date column (most recent audits show at the top). All the other columns except the Date column can be sorted alphabetically if you click on the header. The Date column is sorted by date and time. An up arrow indicates that the column is sorted in ascending order while a down arrow indicates that the column is sorted in descending order.
+The internal audit table displays internal audits, each with a name, type, action, user, org, date, and a description. By default, the audits are sorted in descending order on the date column (most recent audits show at the top). All the other columns except the Date column can be sorted alphabetically if you click on the header. The Date column is sorted by date and time. An up arrow indicates that the column is sorted in ascending order while a down arrow indicates that the column is sorted in descending order.
 
 A system admin will be able to see audits from all orgs while org admins will be able to see only their orgs audits.
 
@@ -49,9 +43,9 @@ Below the table you will find search bars and select inputs. These allow you to
 
 By default all audits are selected. You can use multiple column filters to get more precise results.
 
-The input does not have to be an exact match, for example if I want to get all audits that contain the word Filesystem then you could just enter File into the search bar.
+The input does not have to be an exact match, for example if you want to get all audits that contain the word `Filesystem` then enter `File` into the search bar.
 
-An example of filtering by column is shown below. Here we are filtering on the first three columns, Name, Type, and Action.
+<!--An example of filtering by column is shown below. Here we are filtering on the first three columns, Name, Type, and Action.-->
 
 ### Pagination
 
@@ -63,13 +57,13 @@ The date range picker allows you to look at audits from within a certain time pe
 
 Clicking on the calendar icon will bring up the current dates month and year. You can select a day on this month, or you can go to a different month by using the back arrow which goes to the previous month, or the forward arrow which goes to the next month.
 
-Alternatively, you can just enter the date manually by selecting in the text field and entering a date and time that follows the format dd/mm/YYYY h:mm.
+Alternatively, you can just enter the date manually by selecting in the text field and entering a date and time that follows the format `dd/mm/YYYY h:mm`.
 
-For example, 12/23/2011 12:03 PM would be a valid date and time
+For example, `12/23/2011 12:03 PM` would be a valid date and time
 
 ### Displayed Number of Entries
 
-You can change the amount of audit are displayed using the number of entries selector. By default, the number of entries is set to 10. You can change the number of entries per page by clicking on the selector and selecting a different value. The options are 10, 25, 50, and 100.
+You can change the number of audit entries displayed using the number of entries selector. By default, the number of entries is set to `10`. You can change the number of entries per page by clicking on the selector and selecting a different value. The options are `10`, `25`, `50`, and `100`.
 
 ### Configuration
 
@@ -104,6 +98,6 @@ List of available Audit types:
 
 ### My Internal Audit
 
-This page is available under the **Audit Reports** menu and will display a version of this page with information limited to the current user.
+This page is available under the **Audit Reports** menu and displays a version of this page with information limited to the current user.
 
-By default, the audits are sorted by descending order on the date column (most recent audits show at the top). All the other columns except the Date column can be sorted alphabetically if you click on the header. The Date column is sorted by date and time. An up arrow indicates that the column is sorted in ascending order while a down arrow indicates that the column is sorted in descending order.
+By default, the audits are sorted in descending order on the date column (most recent audits show at the top). All the other columns except the Date column can be sorted alphabetically if you click on the header. The Date column is sorted by date and time. An up arrow indicates that the column is sorted in ascending order while a down arrow indicates that the column is sorted in descending order.

federation-services/latest/admin/index.md

@@ -4,63 +4,47 @@ title: Administer Federation Services
 
 The following diagram shows the architecture of Alfresco Federation Services:
 
-![Architecture Diagram]({% link federation-services/images/architecture-diagram.png %})
+![Architecture Diagram]({% link federation-services/images/architecture-diagram.png %}){:height="395px" width="384px"}
 
 ## Configuration Tools
 
 Federation Services's configuration tool allows for easy import/export of all configurations in Federation Services. This is great for backups or for bootstrapping Federation Services with common configurations.
 
-**Export Configurations**
-
-Through the User Interface on the left-hand menu under the Admin section select Configuration Tools.
-
-Click on the Export button.
-
-Select all the configuration you wish to export from the list.
-
-Select Export Configuration. This will trigger the download of a JSON file that contains all the selected configuration.
-
-**Import Configuration**
-
-Access the Configuration Tools menu from the Admin panel on the left-hand menu. Click on the Import button.
-
-Click Choose File and select the exported JSON file from
-
-Click Import.
-
 ### Admin Tools
 
-In the Admin Tools (Configuration Tools) Page users can import configurations, export configurations, export configs by job, manage patches and reset configurations.
+In the **Admin Tools > Configuration Tools** page, users can import configurations, export configurations, export configs by job, manage patches and reset configurations.
 
 #### Export Configuration
 
-Through the User Interface on the left-hand menu under the **Admin** section select **Admin Tools**.
-
-Click on the **Export** button.
+Using the left-hand menu in the UI:
 
-Select all the configuration you wish to export from the list.
+1. Select **Admin Tools** under the **Admin** section.
+2. Click on the **Export** button.
+3. Select all the configuration you wish to export from the list.
+4. Hit **Export Configuration**.
 
-Hit **Export Configuration**. This will trigger the download of a JSON file that contains all the selected configuration.
+   This will trigger the download of a JSON file that contains all the selected configuration.
 
 #### Import Configuration
 
-Access the **Configuration Tools** menu from the Admin panel on the left-hand menu. Click on the **Import** button.
+Using the left-hand menu in the UI:
 
-Click **Choose File** and select the exported JSON file from
-
-Click **Import**.
+1. Access the **Configuration Tools** menu from the Admin panel on the left-hand menu.
+2. Click on the **Import** button.
+3. Click **Choose File** and select the exported JSON file from.
+4. Click **Import**.
 
 ## Licenses
 
 The **Licenses** page allows for management of your License Keys. You can add a new License key, or reactivate previously entered keys. The details of each key are listed, including the associated MAC Address, Documents Allowed, Documents Used, End Date and which key is in use.
 
-**Add a License Key**
+### Add a License Key
 
 To add a license key simply paste the key into the text box labelled License Key and click Add License Key. You can only have one active license at a time.
 
-**Reactivate a License Key**
+### Reactivate a License Key
 
-To reactivate a license key or adding a new license key copy the key and put it into the License Key text box, then click Add License Key. If the key already exists then it will be activated and the old key will be set to inactive.
+To reactivate a license key or add a new license key, copy the key and put it into the `License Key` text box, then click **Add License Key**. If the key already exists then it will be activated and the old key will be set to inactive.
 
 ## Users
 
@@ -70,9 +54,9 @@ Users can be created within Federation Services for user authentication and auth
 * Create, edit, delete or disable users.
 * View users by organization.
 * Manage active sessions to see who is currently logged in. From here you can end all sessions as well. For example, if you need to make updates to the system.
-* And you can use the search field to narrow down the list of users displayed by name, email, login, or role
+* You can use the search field to narrow down the list of users displayed by name, email, login, or role.
 
-**Creating New Users**
+### Creating New Users
 
 To create new users click on the **Create New User** button. On the **Edit User** page fill in the following details for the user you are creating:
 
@@ -85,7 +69,7 @@ To create new users click on the **Create New User** button. On the **Edit User*
 
 ### List of User Role Definitions
 
-**Federation Services Admin**
+#### Federation Services Admin
 
 * **Discovery Only**: This user does not have access to the Federation Services Admin UI, and can only log in to Discovery
 * **Monitor**: Can **monitor** the execution of jobs, run reports, view job details. This is a READ ONLY user.
@@ -94,25 +78,25 @@ To create new users click on the **Create New User** button. On the **Edit User*
 * **Org Admin**: Can **create, update, execute and delete** jobs, users and reports for a given Tenant.
 * **Federation Services Admin**: This user is the Federation Services Root user, with all capabilities on the system, for all tenants.
 
-**Discovery**
+#### Discovery
 
-* **Discovery User**: Can log in to Discovery but cannot edit or delete views or alter configuration
+* **Discovery User**: Can log in to Discovery but cannot edit or delete views or alter configuration.
 * **Discovery Admin**: Full access to basic federation features.
 
 ## User Groups
 
 User groups are collections of users. They can be used as part of View Level Permissions.
 
 * While adding users you will be able to see their first name, last name, login and role.
-* Federation Services Admins will be able to see all users
+* Federation Services Admins will be able to see all users.
 * Organization Admins will only be able to see users from their organization.
-* Includes the ability to search all users
+* Includes the ability to search all users.
 
 ## Themes
 
 Theming gives an admin the ability to customise the Logo and Top bar colour as well as customise Lead Text sections throughout the application. Each organization may have a separate theme that can be set up by that organisations' admin. This is done in two parts. First, the Logo and Top bar colour, through the themes' page under the applications' admin section. Second, the Lead Text Sections, through the editing of a messages.properties file.
 
-**Theme Fields**
+### Theme Fields
 
 * **Browser Title**: The title that's displayed in the header
 * **Reset Browser Title**: Check to reset the browser title
@@ -126,7 +110,7 @@ After selections, click Save. After page reloads, the changes will have taken ef
 
 The Active Jobs page shows the jobs that are currently running. Sometimes jobs can get stuck in the RUNNING state.
 
-**Fixing Stuck Jobs**
+### Fixing Stuck Jobs
 
 If a job is running and the **Abort** does not stop the job in an appropriate amount of time, the job can be killed manually through an Admin page.
 
@@ -138,19 +122,15 @@ Once the job is killed, you will need to fully restart the job to run it again.
 
 The **Connectors** page shows the available Connector types with the option to Activate or Deactivate any given connector. Custom Connectors will be listed here as well.
 
-## Organisation
-
-The Organization page shows the different Organisation used within the Federation Services platform for multi-tenancy. It will display the Organization name, short name, the status (Active/Inactive) which notes whether an organization is enabled, and also provide a link to search their users. 
-
-###  Overview
+## Organization
 
-The Organization page shows the different Organisation used within the Federation Services platform for multi-tenancy. It will display the Organization name, short name, the status (Active/Inactive) which notes whether an organization is enabled, and also provide a link to search their users.
+The Organization page shows the different Organisations used within the Federation Services platform for multi-tenancy. It will display the Organization name, short name, the status (Active/Inactive) which notes whether an organization is enabled, and also provide a link to search their users.
 
 By default, Federation Services has one organization, based on configuration in the global properties.
 
-**Tip:** This page assumes **simflofy.multi.tenant** is set to true in your global properties
+> **Tip:** This page assumes `simflofy.multi.tenant` is set to `true` in your global properties.
 
-In multi-tenant mode, a user with the Federation Services Admin role will have access to the **Organisation** page under the **Admin** menu. This page will display all the current tenants in your Federation Services. It will display whether an organization is enabled, and also provide a link to search their users.
+In multi-tenant mode, a user with the Federation Services Admin role will have access to the **Organisation** page under the **Admin** menu. This page displays all the current tenants in your Federation Services. It will display whether an organization is enabled, and also provide a link to search their users.
 
 #### Creating an Organization
 
@@ -160,18 +140,22 @@ When clicking on **Create New Organization** a pop-up will appear with the follo
 * **Organizational Key**: The org key that will follow the @ after users names. This cannot be changed after the organization has been creation.
 * **Organization Database**: This will be created and populated on submission. It cannot be changed after the organization has been creation.
 
-The Key and Database fields cannot contain spaces or of the following characters
+The Key and Database fields cannot contain spaces or of the following characters:
 
-`!@#$%^&*()+=-[]\';,./{}|":<>?`
+```text
+!@#$%^&*()+=-[]\';,./{}|":<>?
+```
 
 Clicking **Continue** will take you to the org edit screen, but the org will not be created yet. You will be presented with a list of products available on your license, which you can activate for the new organization. This can be changed at any time to remove access to certain connectors and features.
 
 Upon clicking **Save** in this page, the organization will be added to the database and a standard initialisation will be performed (generation of Mongo indexes, adding the enabled connectors, and loading the bootstrap).
 
-Users under non-global organisations will need to log in with
+Users under non-global organisations will need to log in with:
 
-`usersname@orgkey`
+```text
+usersname@orgkey
+```
 
 ## About Federation Services
 
-On the About page users can find the version and build information for the installed version of Federation Services.
+On the **About** page users can find the version and build information for the installed version of Federation Services.