all docs but endpointpolicymanager building—must fix broken links

Author: jtviolet

brokenlinks.json

@@ -0,0 +1,148 @@
+# History in GroupID
+
+In GroupID, history is tracked for:
+
+- **Admin Center -** Actions performed in Admin Center, such as creating identity stores, SMS
+  gateway accounts, changes to notification templates, and more.
+- **Helpdesk -** Helpdesk-specific actions, such as account unlock and enrollment.
+- **Identity store configurations -** Changes made to identity store configurations, including
+  changes to security roles and workflows.
+- **Identity store objects -** Modifications made to objects in an identity store, such as creating
+  objects, updating attributes for an object, etc. It includes modifications made through:
+
+  - GroupID portal (whether manually, through Synchronize jobs. or changes to object entitlements)
+  - GroupID Management Shell cmdlets
+  - GroupID mobile app
+  - GroupID Admin Center (actions performed by schedules only)
+  - GroupID APIs
+
+Enabling history tracking
+
+History for Admin Center and helpdesk is tracked by default and you cannot disable it.
+
+However, history for identity store configurations and objects is disabled by default. You can
+enable it for an identity store as well as choose to track all or specific actions. See the
+[Configure History Tracking](/docs/directorymanager/11.0/configuration/identity-stores/active-directory.md)
+topic.
+
+Where is history displayed?
+
+- History for Admin Center, helpdeak, and identity store configurations is displayed in Admin
+  Center, each displayed on separate pages.
+- History for identity store objects is displayed in the GroupID portal.
+
+History Retention
+
+The _history retention_ setting for an identity store enables you to choose whether you want to keep
+history data forever or for a specific period. See the
+[Retain Complete History Data](/docs/directorymanager/11.0/configuration/identity-stores/active-directory.md#retain-complete-history-data)
+and
+[Retain History for a Specific Period](/docs/directorymanager/11.0/configuration/identity-stores/active-directory.md#retain-history-for-a-specific-period)
+topics. Your desired setting applies to all history tracked for the respective identity store,
+including that tracked for helpdesk and Admin Center.
+
+NOTE: Actions tracked under Admin Center history are independent of an identity store. In this case,
+history retention settings apply to a history item in the context of the identity store selected by
+the user to log into Admin Center to perform that action.  
+**Example:** UserA selects IdentityStoreA to sign into Admin Center and creates an SMS gateway
+account. This user then selects IdentityStoreB to sign into Admin Center and creates a GroupID
+portal. Both actions are logged in Admin Center history. However, history retention setting of
+IdentityStoreA will apply to the SMS gateway account creation action and that of IdentityStoreB will
+apply to the GroupID portal creation action.
+
+Event Logging
+
+In addition to history tracking, GroupID provides event logging, which includes file logging and
+Windows logging for GroupID clients and services. See the
+[Event Logging](/docs/directorymanager/11.0/configuration/identity-stores/active-directory.md)
+topic.
+
+**See Also**
+
+- [Admin Center History](/docs/directorymanager/11.0/administration/admin-center/index.md)
+- [History in Helpdesk](/docs/directorymanager/11.0/administration/help-desk/index.md)
+- [Identity Store History](/docs/directorymanager/11.0/configuration/identity-stores/active-directory.md)
+  (for identity store configurations, workflows, and security roles)
+- [History](/docs/directorymanager/11.0/user-guide/portal/index.md) (for directory objects)
+
+# History Retention Schedule
+
+While configuring history tracking for an identity store, you can choose to keep history records
+forever in the GroupID database or retain history for a specific period (see the
+[Configure History Tracking](/docs/directorymanager/11.0/configuration/identity-stores/active-directory.md)
+topic). In case you select the latter option, the History Retention schedule is auto created for the
+identity store. This schedule runs on a specified frequency to check if the retention period is over
+for any history records, and if so, move them from the GroupID database to the following .csv files:
+
+- **History** - contains history data of the GroupID portal, Synchronize, GroupID Management Shell,
+  scheduled jobs, and the GroupID mobile app. It also contains history data for the identity store,
+  security roles, and workflow configurations.
+- **AuditingHistory** - contains history data of all authentication actions performed in GroupID, as
+  logged in Helpdesk history. See the
+  [History in Helpdesk](/docs/directorymanager/11.0/administration/help-desk/index.md) topic.
+- **PasswordCenterHistory** - contains history data of all actions tracked in Helpdesk, except the
+  authentication action. See the
+  [History in Helpdesk](/docs/directorymanager/11.0/administration/help-desk/index.md) topic.
+- **AdminCenterHistory** - contains Admin Center history data. See the
+  [Admin Center History](/docs/directorymanager/11.0/administration/admin-center/index.md) topic.
+
+These files are available at the following location on the GroupID server:  
+X:\Program Files\Imanami\GroupID
+11.0\GroupIDDataService\Inetpub\GroupIDDataService\Web\HistoryBin\  
+(X is the GroupID installation drive)
+
+History data moved to these files is not longer displayed in GroupID.
+
+NOTE: Admin Center history does not fall in a specific identity store, so its retention mechanism is
+different. GroupID checks the identity store of the user who performed an action logged in Admin
+Center history, and archives that record according to the history retention setting of the identity
+store that user belongs to.
+
+After the History Retention schedule runs, the following information is displayed on the **History**
+page in identity store configurations:
+
+![historyretention](/img/versioned_docs/directorymanager_11.0/directorymanager/admincenter/schedule/historyretention.webp)
+
+You cannot create or delete a History Retention schedule; only update the existing one.
+
+What do you want to do?
+
+- [Update the History Retention Schedule](#update-the-history-retention-schedule)
+
+## Update the History Retention Schedule
+
+1. In Admin Center, click **Identity Stores** in the left pane.
+2. On the **Identity Stores** page, click the ellipsis button for an identity store and select
+   **Edit**.
+3. Click **Schedules** under **Settings** in the left pane.
+4. On the **Schedules** page, click the plus sign next to **History Retention**. Then click the
+   ellipsis button for the schedule and select **Edit**.
+5. On the **Edit Schedule** page, the schedule name is displayed in the **Schedule Name** box as
+   read-only.  
+   The default name format is: _HistoryRetention_`<identity store ID>`_`<identity store name>`_.
+6. The **Name Preview** box displays the schedule name as HistoryRetention; the schedule is
+   displayed with this name in email notifications.
+7. In the **Scheduler Service Name** drop-down list, select a Scheduler service that would be
+   responsible for triggering this schedule. The number of services displayed in the list depend on
+   the number of Elasticsearch clusters in the environment, as each cluster has its own Scheduler
+   service. See the
+   [Scheduler Service](/docs/directorymanager/11.0/configuration/services/index.md)
+   topic.
+8. The **Triggers** area displays the default triggering frequency for the schedule.
+
+   - To change a trigger, click **Edit** for it.
+   - To add a new trigger, click **Add Trigger**.
+
+   Follow step 11 in the
+   [Create a Group Usage Service Schedule](/docs/directorymanager/11.0/administration/admin-center/system-settings.md#create-a-group-usage-service-schedule)
+   topic to manage triggers.
+
+9. Click **Update Schedule**.
+10. On the **Schedules** page, click **Save**.  
+    For general schedule info, see the
+    [View the Schedules in an Identity Store ](/docs/directorymanager/11.0/administration/admin-center/system-settings.md#view-the-schedules-in-an-identity-store)
+    topic.
+
+See Also
+
+- [Schedules](/docs/directorymanager/11.0/administration/admin-center/system-settings.md)

build_output.txt

@@ -0,0 +1,239 @@
+# History in Helpdesk
+
+GroupID tracks the following actions performed by end-users and helpdesk users in an identity store
+and displays them as history to helpdesk users:
+
+- Unenroll account
+- Sending of secure link for password reset by helpdesk
+- Change Password
+- Reset Password
+- Unlock Account
+- Link Account
+- Unlink Account
+- Enroll account
+- Authenticate with password, authentication types, or any other medium
+
+History can be used for audit and analysis, such as how many users changed their passwords in the
+last x days, reset their passwords using secure link, and more. It can also be used to verify the
+identity of a user through the last action he or she performed.
+
+What do you want to do?
+
+- [View History in Helpdesk](#view-history-in-helpdesk)
+  - [Switch History Layouts](#switch-history-layouts)
+- [Search History](#search-history)
+- [Export History to a File](#export-history-to-a-file)
+
+## View History in Helpdesk
+
+1. In Admin Center, click **Helpdesk** in the left pane.
+2. On the **Helpdesk** page, click the **History** tab.  
+   This tab displays the tracked history actions for all identity stores in GroupID. Use the
+   pagination options at the bottom of the listing to navigate through records.
+
+   To search for specific records, see the [Search History](#search-history) topic.
+
+### Switch History Layouts
+
+You can view history in two layouts:
+
+- **Basic view:** displays history in a friendly, descriptive manner.
+- **Administrative view:** displays history in tabular form.
+
+In both layouts, click **Details** for an item to view more details.
+
+You can also export history to MS Excel, CSV, and XML formats.
+
+To Switch Layouts:
+
+- In the Basic view, click the **Switch to Administrative View** button to view history in
+  Administrative layout.
+- In the Administrative view, the button changes to **Switch to Basic View**. Click it to view
+  history in Basic layout.
+
+#### View History in Basic Layout
+
+By default, the **History** tab of the **Helpdesk** page displays history in the Basic view, that
+lists the tracked actions in meaningful sentences.
+
+Click **Details** for a history item to launch the **History Details** dialog box that displays the
+following:
+
+- **Display name:** the user on whom the action was performed.
+- **Identity store:** the identity store the action was performed in.
+- **Action:** the action performed.
+- **Authentication type:** the authentication type(s) used by the user to authenticate in order to
+  perform the action. For some actions performed by helpdesk, such as sending a secure link for
+  password reset, no authentication type is displayed. For other actions such as _unenroll_, the
+  authentication type for which the end user is unenrolled will be displayed.
+- **Status:** whether the action was performed successfully or not.
+- **Date/Time:** the date and time the action was performed.
+- **Performed by:** the user who performed the action.
+- **Client name:** the name of the GroupID client the action was performed from.
+- **Helpdesk action:** whether the action was performed through helpdesk or not.
+- **Machine name:** the name of the machine the action was performed from.
+- **IP:** the IP address of the machine the action was performed from.
+- **Browser:** the name of the browser used to perform the action.
+- **Device type:** the device type used to perform the action, such as PC/laptop or mobile.
+
+Click **Close** to close the dialog box.
+
+#### View History in Administrative Layout
+
+The Administrative layout displays history in a table. On the **History** tab of the **Helpdesk**
+page, click **Switch to Administrative View**.
+
+The following information is displayed for a record:
+
+- **Name:** The name of the user the action was performed on
+- **Client Name:** the name of the GroupID client the action was performed from.
+- **Identity Store:** The identity store the action was performed in
+- **Action:** The action performed
+- **Date:** The date and time the action was performed on
+
+Click **Details** for a history item to view its details on the **History Details** dialog box. See
+the [View History in Helpdesk](#view-history-in-helpdesk) topic for a discussion of the dialog box.
+
+Use the pagination options at the bottom of the listing to navigate through records.
+
+Sort the Listing
+
+History records on the **History** tab of the **Helpdesk** page are sorted in chronological order,
+with the latest action at the top.
+
+You can sort the listing in the Administrative view by any column name in the header row. Click a
+column name to sort the listing by that attribute. An arrow appears next to the column name.
+
+- The upward arrow head indicates that the list is sorted in ascending order.
+- The downward arrow head indicates that the list is sorted in descending order.
+
+Click the arrow to change the order from ascending to descending and vice versa.
+
+## Search History
+
+You can search for history records in all the identity stores or specific identity stores. Simply
+enter the name of a user to view all actions performed for it, be it by that same user or another
+user, such as helpdesk. You can also create a filter based on multiple attributes to search for
+specific records.
+
+To perform a search:
+
+1. In Admin Center, click **Helpdesk** in the left pane.
+2. On the **Helpdesk** page, click the **History** tab.
+3. On the **History** tab, the following search options are available:
+
+   - **Identity Store list** - To get the history records for one or specific identity stores,
+     click in the **Identity Store** box and select the check boxes for the identity stores you
+     want to view the history for.
+   - **Search box to search for records specific to a user** - In the _Search_ box, enter a user’s
+     full name or part of a name and press _Enter_. GroupID displays all history actions that are
+     performed by or performed on the user.
+   - **Search filter** - Click **Filter**. On the **Filter(s)** dialog box, you can search the
+     history data using the available filters individually or in combination.
+
+     - **Date Logged:** Specify a time period to view history data for. Click in the box and use
+       the calendar for selecting a date range.
+     - **Performed By:** Specify whether you want to view the actions performed by end users,
+       helpdesk users, or both.
+     - **Device Type:** Specify a device type (PC/laptop, mobile, or both) to view actions that
+       have been performed using that device type.
+     - **Status:** Specify whether you want to view successful actions, failed actions, or both
+       successful and failed actions
+     - **Action Type:** Select an action to view the history records for it. On selecting
+       _Enrollment_ or _Authenticate_, another drop-down list is displayed that lists the
+       authentication types. Select an option to view the enrollment or authentication actions
+       performed using that specific type.
+
+   Click **Apply**. History records matching the given criteria are displayed.
+
+## Export History to a File
+
+1. In Admin Center, click **Helpdesk** in the left pane.
+2. On the **Helpdesk** page, click the **History** tab.
+3. On the **History** tab, you can export all history records in all identity stores to a file or
+   filter the listing to export specific records only. To narrow down records, see the
+   [Search History](#search-history) topic.
+4. Click **Export History** and select a file format in the list to export history data to.  
+   The file is saved to the download location specified in your browser settings.
+
+**See Also**
+
+- [Dashboard](/docs/directorymanager/11.0/administration/admin-center/index.md)
+- [Search Users](/docs/directorymanager/11.0/administration/help-desk/operations.md)
+- [History in GroupID](/docs/directorymanager/11.0/administration/audit-history/index.md)
+
+# Helpdesk
+
+The Admin Center Helpdesk section enables administrators and helpdesk users to perform
+helpdesk-specific tasks, such as:
+
+- Unlock user accounts and reset passwords on behalf of users in an identity store.
+- Notify users to enroll their accounts.
+- Unenroll user accounts from identity stores.
+- View users' activities, such as enrollment, authentication, account unlock, and password-related
+  functions. Toast notifications and history tracking are also enabled for these actions.
+
+## Helpdesk Permissions
+
+A security role must have the following permissions in an identity store to perform
+helpdesk-specific functions:
+
+- Reset Any Password
+- Unlock Any Account
+- Unenroll
+
+See
+[Password Management](/docs/directorymanager/11.0/administration/admin-center/security-roles.md#password-management)
+in the
+[Security Role – Permissions](/docs/directorymanager/11.0/administration/admin-center/security-roles.md)
+topic.
+
+## Helpdesk Policy
+
+The administrator can define a Helpdesk policy for a user role in an identity store. This policy
+mainly defines whether helpdesk role members should operate under the restricted or unrestricted
+mode to perform the account unlock and reset password functions.
+
+NOTE: In unrestricted mode, helpdesk can unlock accounts and reset passwords of both enrolled and
+unenrolled users. In restricted mode, helpdesk can perform these functions for enrolled users only.
+
+See the
+[Helpdesk Policy](/docs/directorymanager/11.0/administration/admin-center/policies.md)
+topic.
+
+## Helpdesk Analytics
+
+The dashboard in Admin Center offers insightful information to the administrator and helpdesk on
+users' activities (such as enrollment, account unlock, and password reset) in an identity store.
+
+The dashboard displays the following helpdesk-specific cards:
+
+- [Enrollment Summary](/docs/directorymanager/11.0/administration/admin-center/index.md#enrollment-summary):
+  displays the number of enrolled users in an identity store.
+- [Auth Summary](/docs/directorymanager/11.0/administration/admin-center/index.md#auth-summary):
+  displays information about failed and successful authentication attempts for each authentication
+  type.
+- [Activity Summary](/docs/directorymanager/11.0/administration/admin-center/index.md#activity-summary):
+  displays a summary of users' activities related to password change, password reset, account
+  unlock, and enrollment.
+
+## Desktop Notifications
+
+You can enable desktop notification for GroupID in browser settings. In this way, a user signed into
+Admin Center on the respective machine will receive desktop notifications when an end-user performs
+any of the following actions in the GroupID portal:
+
+- Resets account password
+- Changes account Password
+- Unlocks Account
+- Links Account
+- Unlinks Account
+- Enrolls account
+- Authenticates with password, authentication types, or any other medium
+
+These actions are also logged in helpdesk history.
+
+**See Also**
+
+- [Helpdesk Operations](/docs/directorymanager/11.0/administration/help-desk/operations.md)
+- [History in Helpdesk](/docs/directorymanager/11.0/administration/help-desk/index.md)