[DOCS-7358] Add HR Employee File Management solution to Alfresco Cont…

…ent Accelerator 3.5 docs (#1141) * [DOCS-7358] Add HR Employee File Management solution * [DOCS-7358][DOCS-7361] Add HREFM solution to Content Accelerator docs * [DOCS-7358] Revert step 3 in AMPs section and move plus minor fixes * [DOCS-7358] Update step 3 in Alfresco Tomcat section * [DOCS-7358] Rename file, update links, and add missing artefact * [DOCS-7358] Add renamed file * [DOCS-7358] Minor fixes * [DOCS-7358] Add corrections from self- review * Update content-accelerator/latest/configure/hr-management.md Co-authored-by: Oliver Stanley <[email protected]> --------- Co-authored-by: Oliver Stanley <[email protected]>
Alfresco · Oct 13, 2023 · cd1dea5 · cd1dea5
1 parent 5d7a90f
commit cd1dea5
Show file tree

Hide file tree

Showing 15 changed files with 179 additions and 28 deletions.
diff --git a/_data/toc/content-accelerator.yaml b/_data/toc/content-accelerator.yaml
@@ -59,3 +59,5 @@
         path: '/content-accelerator/latest/configure/activewizard/'
       - title: 'Supported Languages'
         path: '/content-accelerator/latest/configure/supported-languages/'
+      - title: 'HR Tier-2 Solution'
+        path: '/content-accelerator/latest/configure/hr-management/'
diff --git a/content-accelerator/images/hrefm-create-new-group.png b/content-accelerator/images/hrefm-create-new-group.png
diff --git a/content-accelerator/images/hrefm-create-new-hold.png b/content-accelerator/images/hrefm-create-new-hold.png
diff --git a/content-accelerator/images/hrefm-create-new-role.png b/content-accelerator/images/hrefm-create-new-role.png
diff --git a/content-accelerator/images/hrefm-create-new-rule.png b/content-accelerator/images/hrefm-create-new-rule.png
diff --git a/content-accelerator/images/hrefm-file-plan.png b/content-accelerator/images/hrefm-file-plan.png
diff --git a/content-accelerator/images/hrefm-import-action.png b/content-accelerator/images/hrefm-import-action.png
diff --git a/content-accelerator/images/hrefm-intro-dashboard1.png b/content-accelerator/images/hrefm-intro-dashboard1.png
diff --git a/content-accelerator/images/hrefm-intro-dashboard2.png b/content-accelerator/images/hrefm-intro-dashboard2.png
diff --git a/content-accelerator/images/hrefm-required-documents.png b/content-accelerator/images/hrefm-required-documents.png
diff --git a/content-accelerator/images/hrefm-sites-tab.png b/content-accelerator/images/hrefm-sites-tab.png
diff --git a/content-accelerator/images/hrefm-unfiled-records-manage-rules.png b/content-accelerator/images/hrefm-unfiled-records-manage-rules.png
diff --git a/content-accelerator/latest/configure/hr-management.md b/content-accelerator/latest/configure/hr-management.md
@@ -0,0 +1,69 @@
+---
+title: HR Tier-2 Configuration
+---
+
+Use this information to configure the HR Employee File Management solution (HREFM).
+
+## Prerequisites
+
+Make sure the HR Tier-2 solution is [installed]({% link content-accelerator/latest/install/install-guide.md %}) before implementing the configuration steps below.
+
+## Configuration
+
+1. Once Alfresco Content Services starts successfully, run the following `curl` command to create a Records Management (RM) site:
+
+    ```bash
+    curl -X POST "http://localhost:8080/alfresco/api/-default-/public/gs/versions/1/gs-sites?skipAddToFavorites=false" -H  "accept: application/json" -H  "authorization: Basic YWRtaW46YWRtaW4=" -H  "Content-Type: application/json" -d "{  \"title\": \"HREFM Records Management\",  \"description\": \"HREFM Records Management Description\",  \"compliance\": \"STANDARD\"}"
+    ```
+
+2. Navigate to the **HREFM Records Management** site from the **Sites** tab in Alfresco Share:
+
+   * ![Sites tab in Alfresco Share]({% link content-accelerator/images/hrefm-sites-tab.png %})
+
+3. Navigate to the **File Plan** from the site dashboard:
+
+   * ![File Plan in HREFM RM Site Dashboard]({% link content-accelerator/images/hrefm-file-plan.png %})
+
+4. Click on the **Import** action in the File Plan* folder, and select the file `HREFM_FilePlan.acp` to start the import:
+
+   * You'll find `HREFM_FilePlan.acp` in the `Alfresco Artifacts` folder of the `alfresco-content-accelerator-sehr-rm-accelerator` distribution zip.
+
+   ![Import action in File Plan]({% link content-accelerator/images/hrefm-import-action.png %})
+
+5. Upload the following scripts to the path **Repository > Data Dictionary > Records Management > Records Management Scripts**:
+
+   * `HREFM-RM_CutOff_Record.js`
+   * `HREFM-RM_Move_Record_to_Employee_Folder.js`
+
+    You'll find the JavaScript (`.js`) files in the `Alfresco Artifacts` folder of the `alfresco-content-accelerator-sehr-rm-accelerator` distribution zip.
+
+6. Navigate to `Unfiled Records` folder in File Plan section of RM Site. Select the `Manage Rules` action:
+
+    ![Unfiled Records - select Manage Rules]({% link content-accelerator/images/hrefm-unfiled-records-manage-rules.png %})
+
+7. Click the `Create Rules` link, and create a rule:
+
+    ![Select Create Rules to configure a new rule]({% link content-accelerator/images/hrefm-create-new-rule.png %})
+
+8. Navigate to `Holds` under `File Plan`, create a `New Hold` (as shown) and save it:
+
+    ![Create a New Hold]({% link content-accelerator/images/hrefm-create-new-hold.png %})
+
+9. Set the `Read and File` permission to `site_hr_SiteManager` and `site_hr_SiteCollaborator` Groups on Above created `HREFM` Hold.
+
+10. Provide the `HR Manager` group the correct permissions to create Legal Holds:
+
+    1. Navigate to `RM Admin Tools` from the top-right of the RM site.
+    2. Click **Define Roles** in the **Tools** section, and then click on the `New Role` button to the left of page.
+    3. Create a role with name `HREFM Hold Access` with the following capabilities:
+
+      * Add to Hold
+      * Remove from Hold
+
+    ![Set up Hold Access role]({% link content-accelerator/images/hrefm-create-new-role.png %})
+
+11. Navigate to the `Users and Groups` section of the **Tools** section.
+
+12. Select the `HREFM Hold Access` role, and then add the `site_hr_SiteManager` and `site_hr_SiteCollaborator` to the **Groups** section:
+
+    ![Add groups to Hold Access role ]({% link content-accelerator/images/hrefm-create-new-group.png %})
diff --git a/content-accelerator/latest/index.md b/content-accelerator/latest/index.md
@@ -12,6 +12,7 @@ These accelerators are:
 
 * [Claims Management]({% link content-accelerator/latest/index.md %}#claims-management)
 * [Policy and Procedure Management]({% link content-accelerator/latest/index.md %}#policy-management)
+* [HR Employee File Management]({% link content-accelerator/latest/index.md %}#hr-file-management)
 
 More information is included below for the available accelerators. ACA is available for on-premises customers as well as customers in the Alfresco Cloud PaaS.
 
@@ -76,7 +77,7 @@ Utilize Alfresco Enterprise Viewer to view, annotate, and redact documents witho
 
 ## Policy and Procedure Management {#policy-management}
 
-The Policy and Procedure Management accelerator helps regulated companies such as life sciences, energy, and manufacturers as well as HR departments **maintain quality processes of essential documents** that require strict control over **content lifecycle, reviews, and approvals**.
+The Policy and Procedure Management (PnP) accelerator helps regulated companies such as life sciences, energy, and manufacturers as well as HR departments **maintain quality processes of essential documents** that require strict control over **content lifecycle, reviews, and approvals**.
 
 The intuitive interface facilitates consistency, **collaboration**, electronic review and approval for knowledge workers and provides electronic signatures including **21 CFR Part 11 compliance for life science companies**. Document annotations are supported through using the built in Alfresco Enterprise Viewer to efficiently facilitate document review and approval.
 
@@ -118,3 +119,32 @@ A wizard-style form is utilized to capture change request information. The form
 ![ACA intro policy management4]({% link content-accelerator/images/aca-intro-policy-management-04.png %})
 
 > **Note:** AEV Edit and Redaction Modes are not supported with documents managed by the PnP Accelerator (Controlled Docs, Quality Docs, Wizard Forms)
+
+## HR Employee File Management {#hr-file-management}
+
+The HR Employee File Management (HR EFM) solution helps to keep track of all relevant documents for each employee at a company. The Alfresco Content Accelerator provides a platform which enables an organization to collect, store, manage, and delete documents within the Alfresco Content Services repository for their employees.
+
+Benefits of the HR Employee File Management solution:
+
+* **Faster & easier** to create, update, and retrieve employee data and documents.
+* **Restricted access** to employee folders and documents based on a user's role in the organization.
+* Easy to identify and maintain **incomplete & inaccurate** employee files.
+
+Key features:
+
+* **Custom Dashlets** - dashboard with visual representation of employee data to track and navigate easily.
+* **Employee Import** - autofill information from external systems to forms to create Employee folders in the repository.
+* **Alfresco Enterprise Viewer** - allows users to annotate and redact documents.
+* **Side by Side Viewing** - allows for side by side viewing of documents in a single interface.
+* **Records Management** - employee documents are filed as records in Alfresco Governance Services with a predefined Retention Schedule in case of employee separation.
+
+User Interface:
+
+Dashboards provide faster and easier access to employee information and visual reports representation:
+
+![ACA HREFM example dashboard 1]({% link content-accelerator/images/hrefm-intro-dashboard1.png %})
+![ACA HREFM example dashboard 2]({% link content-accelerator/images/hrefm-intro-dashboard2.png %})
+
+View all pending **Required Documents** in the employee folder. Fields highlighted with a red border need attention, i.e. employee documents that are yet to be uploaded.
+
+![ACA HREFM Required Documents]({% link content-accelerator/images/hrefm-required-documents.png %})