diff --git a/_data/toc/content-accelerator.yaml b/_data/toc/content-accelerator.yaml index 833d10d999..07d6351bc7 100644 --- 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 new file mode 100644 index 0000000000..caa630be38 Binary files /dev/null and b/content-accelerator/images/hrefm-create-new-group.png differ diff --git a/content-accelerator/images/hrefm-create-new-hold.png b/content-accelerator/images/hrefm-create-new-hold.png new file mode 100644 index 0000000000..ff8489ab85 Binary files /dev/null and b/content-accelerator/images/hrefm-create-new-hold.png differ diff --git a/content-accelerator/images/hrefm-create-new-role.png b/content-accelerator/images/hrefm-create-new-role.png new file mode 100644 index 0000000000..be7eb87c5a Binary files /dev/null and b/content-accelerator/images/hrefm-create-new-role.png differ diff --git a/content-accelerator/images/hrefm-create-new-rule.png b/content-accelerator/images/hrefm-create-new-rule.png new file mode 100644 index 0000000000..eb610e7a45 Binary files /dev/null and b/content-accelerator/images/hrefm-create-new-rule.png differ diff --git a/content-accelerator/images/hrefm-file-plan.png b/content-accelerator/images/hrefm-file-plan.png new file mode 100644 index 0000000000..1f405612b1 Binary files /dev/null and b/content-accelerator/images/hrefm-file-plan.png differ diff --git a/content-accelerator/images/hrefm-import-action.png b/content-accelerator/images/hrefm-import-action.png new file mode 100644 index 0000000000..fd03e264aa Binary files /dev/null and b/content-accelerator/images/hrefm-import-action.png differ diff --git a/content-accelerator/images/hrefm-intro-dashboard1.png b/content-accelerator/images/hrefm-intro-dashboard1.png new file mode 100644 index 0000000000..e72ce8ab9c Binary files /dev/null and b/content-accelerator/images/hrefm-intro-dashboard1.png differ diff --git a/content-accelerator/images/hrefm-intro-dashboard2.png b/content-accelerator/images/hrefm-intro-dashboard2.png new file mode 100644 index 0000000000..9be5fcd32e Binary files /dev/null and b/content-accelerator/images/hrefm-intro-dashboard2.png differ diff --git a/content-accelerator/images/hrefm-required-documents.png b/content-accelerator/images/hrefm-required-documents.png new file mode 100644 index 0000000000..44aeb2f40a Binary files /dev/null and b/content-accelerator/images/hrefm-required-documents.png differ diff --git a/content-accelerator/images/hrefm-sites-tab.png b/content-accelerator/images/hrefm-sites-tab.png new file mode 100644 index 0000000000..5c6b4fcae7 Binary files /dev/null and b/content-accelerator/images/hrefm-sites-tab.png differ diff --git a/content-accelerator/images/hrefm-unfiled-records-manage-rules.png b/content-accelerator/images/hrefm-unfiled-records-manage-rules.png new file mode 100644 index 0000000000..7d07c04620 Binary files /dev/null and b/content-accelerator/images/hrefm-unfiled-records-manage-rules.png differ diff --git a/content-accelerator/latest/configure/hr-management.md b/content-accelerator/latest/configure/hr-management.md new file mode 100644 index 0000000000..0597cfa1e5 --- /dev/null +++ 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 index 0e5e5371b4..637d459b6c 100644 --- 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 %}) diff --git a/content-accelerator/latest/install/install-guide.md b/content-accelerator/latest/install/install-guide.md index d52b3f3038..421f92c42a 100644 --- a/content-accelerator/latest/install/install-guide.md +++ b/content-accelerator/latest/install/install-guide.md @@ -2,6 +2,8 @@ title: Install Content Accelerator --- +Use this information to install the Content Accelerator base package and pre-configured accelerators on top of ACA. + ## Prerequisites There are a number of software requirements for installing the Content Accelerator: @@ -14,7 +16,11 @@ You will need to download the following distribution zips in order to install AC * alfresco-content-accelerator-base-package-3.5.x.zip * (Claims Only) alfresco-content-accelerator-claims-accelerator-3.5.x.zip -* (Pnp Only) alfresco-content-accelerator-policy-and-procedure-accelerator-3.5.x.zip +* (PnP Only) alfresco-content-accelerator-policy-and-procedure-accelerator-3.5.x.zip +* (HR Only) alfresco-content-accelerator-sehr-accelerator-3.5.x.zip +* (HR Tier-2 Only) alfresco-content-accelerator-sehr-rm-accelerator-3.5.x.zip + +> **Note:** If you're installing the HR Employee File Management (HR EFM) solution, you will need to get the HR EFM pre-release artifacts from [Hyland Confluence](https://hyland.atlassian.net/wiki/spaces/SESS/pages/687540729/Alfresco+HR+Employee+File+Management){:target="blank"} rather than using the distribution zips in Hyland Community. ### Java @@ -296,21 +302,24 @@ In this section we ensure that all components of the Content Accelerator are ins 2. Copy the AMPs to the Alfresco Content Services installation: - Navigate to the `ALFRESCO_HOME/amps` directory and copy the following amps to this directory (these are amps that should be applied to the repository aka [alfresco.war]): + Navigate to the `ALFRESCO_HOME/amps` directory and copy the following amps to this directory (these are amps that should be applied to the repository a.k.a `alfresco.war`): + * `tsgrp-opencontent-{version_info}.amp` * `tsgrp-autofile.amp` These amps can be found in the alfresco-content-accelerator-base-package distribution zip under `Alfresco Artifacts` folder. - >**Note:** make sure you are using the correct `tsgrp-opencontent.amp` for your version of Alfresco. + >**Note:** Make sure you are using the correct `tsgrp-opencontent.amp` for your version of Alfresco. - * If using Alfresco Content Services 7.1.x, use the `tsgrp-opencontent-3.5-for-acs7.1.amp`. - * If using Alfresco Content Services 7.2.x, use the `tsgrp-opencontent-3.5-for-acs7.2.amp`. - * If using Alfresco Content Services 7.3.x, use the `tsgrp-opencontent-3.5-for-acs7.3.amp`. + * If using Alfresco Content Services 7.1.x, use the `tsgrp-opencontent-3.5.x-for-acs7.1.amp`. + * If using Alfresco Content Services 7.2.x, use the `tsgrp-opencontent-3.5.x-for-acs7.2.amp`. + * If using Alfresco Content Services 7.3.x, use the `tsgrp-opencontent-3.5.x-for-acs7.3.amp`. + * If using Alfresco Content Services 7.4.x, use the `tsgrp-opencontent-3.5.x-for-acs7.4.amp`. -3. (Pnp ONLY) This step is only required if installing the Policy and Procedure Content Accelerator solution: +3. (PnP ONLY) This step is only required if installing the Policy and Procedure Content Accelerator solution: Navigate to the `ALFRESCO_HOME/amps` directory and copy the following amps there: + * `tsgrp-alfresco-chain-versioning.amp` * `pnp-platform-3.5.amp` @@ -321,9 +330,36 @@ In this section we ensure that all components of the Content Accelerator are ins Navigate to the `ALFRESCO_HOME/amps` directory and copy the following amps there: `claims-platform-3.5.amp` - This amps can be found in the alfresco-content-accelerator-claims-accelerator distribution zip under `Alfresco Artifacts` folder. + This amp can be found in the `alfresco-content-accelerator-claims-accelerator` distribution zip under `Alfresco Artifacts` folder. + +5. (HR ONLY) This step is only required if installing the HR Content Accelerator solution: + + Navigate to the `ALFRESCO_HOME/amps` directory and copy the following amps there: + + * `sehr-platform-1.0-SNAPSHOT.amp` + * `tsgrp-cascading-value-assistance.amp` + * `tsgrp-alfresco-chain-versioning.amp` + + Navigate to `ALFRESCO_HOME/amps_share` directory and copy the following amp there: + + * `tsgrp-cascading-value-assistance-share.amp` + + This amp can be found in the `alfresco-content-accelerator-sehr-accelerator` distribution zip under the `Alfresco Artifacts` folder. + +6. (HR Tier-2 ONLY) This step is only required if installing the HR Tier-2 Content Accelerator solution: -5. Apply the AMPs + Navigate to the `ALFRESCO_HOME/amps` directory and copy the following amps there: + + * `sehr-rm-platform-1.0-SNAPSHOT.amp` + * `alfresco-governance-services-enterprise-repo-12.21.amp` + + Navigate to `ALFRESCO_HOME/amps_share` directory and copy the following amp there: + + * `alfresco-governance-services-enterprise-share-12.19.amp` + + This amp can be found in the `alfresco-content-accelerator-sehr-rm-accelerator` distribution zip under the `Alfresco Artifacts` folder. + +7. Apply the AMPs From the directory where your alfresco tomcat lives, run this command for each Repository AMP required (replace `{myAmp}` with the correct AMP name and `{ALFRESCO_HOME}` with the location of your alfresco): @@ -335,20 +371,20 @@ In this section we ensure that all components of the Content Accelerator are ins `java\{javaVersion}\bin\java -jar {ALFRESCO_HOME}\bin\alfresco-mmt.jar install {ALFRESCO_HOME}\amps\{myAmp}.amp tomcat\webapps\alfresco.war -force` -6. Delete current Alfresco deployed WAR files +8. Delete current Alfresco deployed WAR files Navigate to the `ALFRESCO_HOME/tomcat/webapps` directory and delete the following [folders] (if they exist) to ensure old versions of the `alfresco.war` and `share.war` are not run: * `alfresco` * `share` -7. Install license file for OpenConnect +9. Install license file for OpenConnect Create the `module/com.tsgrp.opencontent/license` folder structure on the /alfresco classpath, for example, at `ALFRESCO_HOME/tomcat/shared/classes/alfresco` Place a `TextLicense.l4j` file in the `license` directory. -8. Deploy the OpenConnect configuration: +10. Deploy the OpenConnect configuration: Deploy/Copy the following files onto the /alfresco classpath, for example, `ALFRESCO_HOME/tomcat/shared/classes/alfresco/module/com.tsgrp.opencontent/` folder: @@ -358,7 +394,7 @@ In this section we ensure that all components of the Content Accelerator are ins These files can be found in the `Alfresco Artifacts` folder of the alfresco-content-accelerator-base-package zip. -9. Configure OpenConnect +11. Configure OpenConnect In the `opencontent-override-placeholders.properties` file deployed in the last step, update the following environment variables: @@ -370,7 +406,7 @@ In this section we ensure that all components of the Content Accelerator are ins * `oc.email.smtp.host={SMTP host}` * `imageMagick.path=IMAGEMAGICK_HOME` (if installed, get IMAGEMAGICK_HOME value from [ImageMagick Installation]({% link content-accelerator/latest/install/install-guide.md %}#im)) -10. Update Tomcat server configuration: +12. Update Tomcat server configuration: By default, Apache Tomcat doesn't support UTF-8 characters for languages other than English. To enable support, the web.xml and server.xml files need to be modified in the deployed Tomcat. @@ -429,7 +465,7 @@ In this section we ensure that all components of the Content Accelerator are ins >**Note:** that in a typical Alfresco installation, the 8080 connector can be modified for HTTP communications and >the 443 connector can be modified for HTTPS connections. -11. (OPTIONAL) This step is only required if using Alfresco Search Services 2.0 or greater: +13. (OPTIONAL) This step is only required if using Alfresco Search Services 2.0 or greater: a. Navigate to the `SOLR_HOME/solrhome/conf` folder. @@ -450,9 +486,9 @@ In this section we ensure that all components of the Content Accelerator are ins Start Solr process. -12. Start up Alfresco server. +14. Start up Alfresco server. -13. Confirm OpenContent has been installed correctly by accessing `http://{server}/alfresco/OpenContent`. +15. Confirm OpenContent has been installed correctly by accessing `http://{server}/alfresco/OpenContent`. ## Install webapps @@ -471,11 +507,11 @@ This section walks through how to install the web applications on a separate Tom This war can be found in the `Web Applications` folder of the alfresco-content-accelerator-base-package zip. -3. (Pnp ONLY) This step is only required if using the Policy and Procedure Content Accelerator solution: +3. (PnP and HR ONLY) This step is only required if using the Policy and Procedure Content Accelerator or HR Content Accelerator solution: - Copy the `WizardAdmin.war` file into the `TOMCAT_HOME/webapps` directory. + Copy the `WizardAdmin.war` file into the `ALFRESCO_HOME/tomcat/webapps` directory. - This war can be found in the `Web Applications` folder of the alfresco-content-accelerator-policy-and-procedure-accelerator zip. + You'll find this WAR file in the `Web Applications` folder of the `alfresco-content-accelerator-policy-and-procedure-accelerator` zip or `alfresco-content-accelerator-sehr-accelerator` zip. 4. Configure Tomcat for shared classpath loader as well as encoded slashes: @@ -547,11 +583,11 @@ This section walks through how to install the web applications on Alfresco Tomca This war can be found in the `Web Applications` folder of the alfresco-content-accelerator-base-package zip. -3. (Pnp ONLY) This step is only required if using the Policy and Procedure Content Accelerator solution: +3. (PnP and HR ONLY) This step is only required if using the Policy and Procedure Content Accelerator or HR Content Accelerator solution: Copy the `WizardAdmin.war` file into the `ALFRESCO_HOME/tomcat/webapps` directory. - This war can be found in the `Web Applications` folder of the alfresco-content-accelerator-policy-and-procedure-accelerator zip. + You'll find this WAR file in the `Web Applications` folder of the `alfresco-content-accelerator-policy-and-procedure-accelerator` zip or `alfresco-content-accelerator-sehr-accelerator` zip. 4. Configure Tomcat for shared classpath loader as well as encoded slashes: @@ -618,7 +654,7 @@ This section walks through how to install the web applications on Alfresco Tomca This will create the base groups and folder for the application. -2. (Pnp ONLY) This step is only required if using the Policy and Procedure Content Accelerator solution: +2. (PnP ONLY) This step is only required if using the Policy and Procedure Content Accelerator solution: Create Policy and Procedure specific groups and folders: @@ -626,14 +662,24 @@ This section walks through how to install the web applications on Alfresco Tomca This will create the base groups and folder for the Policy and Procedure solution. -3. Locate the `default-{accelerator}.zip` configurations and rename it. +3. (HR ONLY) This step is only required if using the HR Content Accelerator solution: - * For Pnp, the file will be named `default-pnp.zip` and can be found in the `Configuration` folder of the alfresco-content-accelerator-policy-and-procedure-accelerator zip. + Create HR specific groups and folders: + + Open a browser window and navigate to the following URL: `{Alfresco Base URL}/alfresco/s/sehr/setup` + + This will create the base groups and folder for the HR solution. + +4. Locate the `default-{accelerator}.zip` configurations and rename it. + + * For PnP, the file will be named `default-pnp.zip` and can be found in the `Configuration` folder of the alfresco-content-accelerator-policy-and-procedure-accelerator zip. * For Claims, the file will be named `default-claims.zip` and can be found in the `Configuration` folder of the alfresco-content-accelerator-claims-accelerator zip. + * For HR, the file will be named `default-sehr.zip` and can be found in the `Configuration` folder of the alfresco-content-accelerator-sehr-accelerator zip. + * For HR Tier-2, the file will be named `default-sehr-rm.zip` and can be found in the `Configuration` folder of the alfresco-content-accelerator-sehr-rm-accelerator zip. Obtain the `default-{accelerator}.zip` for your accelerator and rename the zip to `default.zip`. -4. Import default configuration. There are two ways you can do this. +5. Import default configuration. There are two ways you can do this. OPTION 1 - use the config import tool (This may not be available on initial install): @@ -653,10 +699,14 @@ This section walks through how to install the web applications on Alfresco Tomca * Click on the `default.zip` and choose the "unzip to" action, select the `repository> hpi> default` folder -5. (OPTIONAL) This step is only required if **NOT** using the Alfresco Enterprise Viewer: +6. (OPTIONAL) This step is only required if **NOT** using the Alfresco Enterprise Viewer: Navigate to the *Stage Config*. For each stage config: 1. Navigate to the *docviewer* 2. Turn off *Alfresco Enterprise Viewer* and *Alfresco Enterprise Video Viewer* 3. Turn on `PDF.js` and `Video.js` 4. Click **Save Config** + +7. (HR Tier-2 ONLY) This step is only required if you are installing the HR Tier-2 solution: + + Follow the installation steps to configure Alfresco Governance Services for the [HR Tier-2 solution]({% link content-accelerator/latest/configure/hr-management.md %}).