Skip to content

Commit

Permalink
[DOCS-7374] Add maintenance fixes for Alfresco Content Accelerator 3.…
Browse files Browse the repository at this point in the history
…6/4.0 (#1513)

* [DOCS-7374] Add maintenance fixes

* [DOCS-7374] Update the naming of HR EFM Solution in Introduction ACA 3.6/4.0
  • Loading branch information
monikamichalska authored Jun 19, 2024
1 parent 6040492 commit 8b3629a
Show file tree
Hide file tree
Showing 14 changed files with 33 additions and 33 deletions.
2 changes: 1 addition & 1 deletion content-accelerator/3.6/configure/hr-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Make sure the HR Tier-2 solution is [installed]({% link content-accelerator/3.6/

* ![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:
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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,5 +68,5 @@ To do this, create the file `opencontent-override-placeholders.properties`. It w

Two things to note with this:

1. This file will win out on any other property files, even ones in the custom amp. For this reason, if you are using a custom amp, it is better to override the properties in the amp than this file.
1. This file will win out on any other property files, even ones in the custom amp. For this reason, if you are using a custom amp, it is better to override the properties in the AMP than this file.
2. You will likely need to create the `module/com.tsgrp.opencontent/` folders.
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ For the three steps above, see the below for example configuration:

The default Quality Document object type is the out-of-the-box available controlled document type. If you wish to add additional properties or aspects to your Policy and Procedure solution, you can extend the quality document type using the following steps.

In a [custom Alfresco AMP]({% link content-accelerator/3.6/develop/extension-content-accelerator.md %}) (see what is expected of a custom ACA amp and how to set it up properly), define your custom Alfresco object model, then do the following:
In a [custom Alfresco AMP]({% link content-accelerator/3.6/develop/extension-content-accelerator.md %}) (see what is expected of a custom ACA AMP and how to set it up properly), define your custom Alfresco object model, then do the following:

1. Extend the `aw:qualityDocument` type in your object model.

Expand Down Expand Up @@ -201,7 +201,7 @@ For the three steps above, see the below for example configuration:

The default Page Set Instance object type is the out-of-the-box available type for documents created via wizard form. If you wish to add additional properties or aspects to the ootb PSI for the Policy and Procedure solution, you can extend the aw:psi type using the following steps.

In a custom Alfresco AMP ( [See]({% link content-accelerator/3.6/develop/extension-content-accelerator.md %}) on what is expected of a custom ACA amp and how to set it up properly), setup a custom Alfresco object model, then do the following:
In a custom Alfresco AMP ( [See]({% link content-accelerator/3.6/develop/extension-content-accelerator.md %}) on what is expected of a custom ACA AMP and how to set it up properly), setup a custom Alfresco object model, then do the following:

1. Extend the `aw:psi` type in your object model. Example:

Expand Down Expand Up @@ -287,7 +287,7 @@ In a custom Alfresco AMP ( [See]({% link content-accelerator/3.6/develop/extensi

```

5. Once the updates to the custom amp have been deployed, you can now add your custom type to the Object Type Config in the ACA admin. Locate the Object Type Config in the ACA Admin interface, click **Add Type**, and select your new object type from the list (ex: `hy_psi`). Once selected, change the `container` to `Wizard`. Save the config.
5. Once the updates to the custom AMP have been deployed, you can now add your custom type to the Object Type Config in the ACA admin. Locate the Object Type Config in the ACA Admin interface, click **Add Type**, and select your new object type from the list (ex: `hy_psi`). Once selected, change the `container` to `Wizard`. Save the config.

6. You can now use this type as the Instance type for a wizard form. Login to the Wizard Admin interface. Create a new form. You will be prompted for an Instance Type. Select your new type.

Expand Down Expand Up @@ -668,10 +668,10 @@ Once a custom permissionSet is defined and enabled via your custom AMP, it can b

### Modify Only Properties

In some cases, you may only want to override some of the default properties of the pnp accelerator. You do not need an entire custom amp to do this. Instead you can create the file `opencontent-override-placeholders.properties` on the /alfresco classpath, for example, `tomcat/shared/classes/alfresco/module/com.tsgrp.opencontent` and put the overridden properties in this file.
In some cases, you may only want to override some of the default properties of the pnp accelerator. You do not need an entire custom AMP to do this. Instead you can create the file `opencontent-override-placeholders.properties` on the /alfresco classpath, for example, `tomcat/shared/classes/alfresco/module/com.tsgrp.opencontent` and put the overridden properties in this file.

Two things to note with this:

1. This file will win out on any other property files, even ones in the custom amp. For this reason, if you are using a custom amp, it is better to override the properties in the amp than this file
1. This file will win out on any other property files, even ones in the custom amp. For this reason, if you are using a custom amp, it is better to override the properties in the AMP than this file

2. You will likely need to create the `module/com.tsgrp.opencontent/` folders
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ The Extension Content Accelerator is a generic content accelerator for adding cu

## How to add the Extension Content Accelerator onto existing Accelerators

There are a few requirements that your custom amp must meet to work with the existing accelerators.
There are a few requirements that your custom AMP must meet to work with the existing accelerators.

1. The amp configuration and code must reside under `alfresco/module/com.alfresco.aca.accelerator.extension` to be properly picked up
1. The AMP configuration and code must reside under `alfresco/module/com.alfresco.aca.accelerator.extension` to be properly picked up
2. Any overrides for ACA properties must reside in a file named `opencontent-extension-override-placeholders.properties`
3. Any overrides or additions to the ACA bean configurations need to reside in a file named `opencontent-extension-override-config.xml`. **Note:** This file can reference other xml config files but ACA will only specifically look for this file.
4. Name the module context file for the extension `opencontent-extension-override-module-ctx.xml`
Expand Down
2 changes: 1 addition & 1 deletion content-accelerator/3.6/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ A wizard-style form is utilized to capture change request information. The form
## 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.
The HR Employee File Management (HR EFM or HR Tier-2) 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:

Expand Down
10 changes: 5 additions & 5 deletions content-accelerator/3.6/install/install-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,7 @@ 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 amp 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:

Expand All @@ -340,11 +340,11 @@ In this section we ensure that all components of the Content Accelerator are ins
* `tsgrp-cascading-value-assistance.amp`
* `tsgrp-alfresco-chain-versioning.amp`

Navigate to `ALFRESCO_HOME/amps_share` directory and copy the following amp there:
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.
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:

Expand All @@ -353,11 +353,11 @@ In this section we ensure that all components of the Content Accelerator are ins
* `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:
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.
This AMP can be found in the `alfresco-content-accelerator-sehr-rm-accelerator` distribution zip under the `Alfresco Artifacts` folder.

7. Apply the AMPs

Expand Down
2 changes: 1 addition & 1 deletion content-accelerator/3.6/using/user-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -663,7 +663,7 @@ Annotations are a very powerful collaboration tool that is integrated within thi

The annotation tool can be used whenever a form or document is viewed (this viewer is configured by default).

The advantage of using AEV is that it provides additional opportunities to provide feedback on a document. In addition, there are an abundance of use cases that AEV can tackle. During this section, only the particular use cases associated with the Pnp scenario will be highlighted.
The advantage of using AEV is that it provides additional opportunities to provide feedback on a document. In addition, there are an abundance of use cases that AEV can tackle. During this section, only the particular use cases associated with the PnP scenario will be highlighted.

To understand more of the use cases of AEV please refer to AEV's user guide or relevant documentation.

Expand Down
2 changes: 1 addition & 1 deletion content-accelerator/latest/configure/hr-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Make sure the HR Tier-2 solution is [installed]({% link content-accelerator/late

* ![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:
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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,5 +68,5 @@ To do this, create the file `opencontent-override-placeholders.properties`. It w

Two things to note with this:

1. This file will win out on any other property files, even ones in the custom amp. For this reason, if you are using a custom amp, it is better to override the properties in the amp than this file.
1. This file will win out on any other property files, even ones in the custom amp. For this reason, if you are using a custom amp, it is better to override the properties in the AMP than this file.
2. You will likely need to create the `module/com.tsgrp.opencontent/` folders.
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ For the three steps above, see the below for example configuration:

The default Quality Document object type is the out-of-the-box available controlled document type. If you wish to add additional properties or aspects to your Policy and Procedure solution, you can extend the quality document type using the following steps.

In a [custom Alfresco AMP]({% link content-accelerator/latest/develop/extension-content-accelerator.md %}) (see what is expected of a custom ACA amp and how to set it up properly), define your custom Alfresco object model, then do the following:
In a [custom Alfresco AMP]({% link content-accelerator/latest/develop/extension-content-accelerator.md %}) (see what is expected of a custom ACA AMP and how to set it up properly), define your custom Alfresco object model, then do the following:

1. Extend the `aw:qualityDocument` type in your object model.

Expand Down Expand Up @@ -201,7 +201,7 @@ For the three steps above, see the below for example configuration:

The default Page Set Instance object type is the out-of-the-box available type for documents created via wizard form. If you wish to add additional properties or aspects to the ootb PSI for the Policy and Procedure solution, you can extend the aw:psi type using the following steps.

In a custom Alfresco AMP ( [See]({% link content-accelerator/latest/develop/extension-content-accelerator.md %}) on what is expected of a custom ACA amp and how to set it up properly), setup a custom Alfresco object model, then do the following:
In a custom Alfresco AMP ( [See]({% link content-accelerator/latest/develop/extension-content-accelerator.md %}) on what is expected of a custom ACA AMP and how to set it up properly), setup a custom Alfresco object model, then do the following:

1. Extend the `aw:psi` type in your object model. Example:

Expand Down Expand Up @@ -287,7 +287,7 @@ In a custom Alfresco AMP ( [See]({% link content-accelerator/latest/develop/exte

```

5. Once the updates to the custom amp have been deployed, you can now add your custom type to the Object Type Config in the ACA admin. Locate the Object Type Config in the ACA Admin interface, click **Add Type**, and select your new object type from the list (ex: `hy_psi`). Once selected, change the `container` to `Wizard`. Save the config.
5. Once the updates to the custom AMP have been deployed, you can now add your custom type to the Object Type Config in the ACA admin. Locate the Object Type Config in the ACA Admin interface, click **Add Type**, and select your new object type from the list (ex: `hy_psi`). Once selected, change the `container` to `Wizard`. Save the config.

6. You can now use this type as the Instance type for a wizard form. Login to the Wizard Admin interface. Create a new form. You will be prompted for an Instance Type. Select your new type.

Expand Down Expand Up @@ -668,10 +668,10 @@ Once a custom permissionSet is defined and enabled via your custom AMP, it can b

### Modify Only Properties

In some cases, you may only want to override some of the default properties of the pnp accelerator. You do not need an entire custom amp to do this. Instead you can create the file `opencontent-override-placeholders.properties` on the /alfresco classpath, for example, `tomcat/shared/classes/alfresco/module/com.tsgrp.opencontent` and put the overridden properties in this file.
In some cases, you may only want to override some of the default properties of the pnp accelerator. You do not need an entire custom AMP to do this. Instead you can create the file `opencontent-override-placeholders.properties` on the /alfresco classpath, for example, `tomcat/shared/classes/alfresco/module/com.tsgrp.opencontent` and put the overridden properties in this file.

Two things to note with this:

1. This file will win out on any other property files, even ones in the custom amp. For this reason, if you are using a custom amp, it is better to override the properties in the amp than this file
1. This file will win out on any other property files, even ones in the custom amp. For this reason, if you are using a custom amp, it is better to override the properties in the AMP than this file

2. You will likely need to create the `module/com.tsgrp.opencontent/` folders
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ The Extension Content Accelerator is a generic content accelerator for adding cu

## How to add the Extension Content Accelerator onto existing Accelerators

There are a few requirements that your custom amp must meet to work with the existing accelerators.
There are a few requirements that your custom AMP must meet to work with the existing accelerators.

1. The amp configuration and code must reside under `alfresco/module/com.alfresco.aca.accelerator.extension` to be properly picked up
1. The AMP configuration and code must reside under `alfresco/module/com.alfresco.aca.accelerator.extension` to be properly picked up
2. Any overrides for ACA properties must reside in a file named `opencontent-extension-override-placeholders.properties`
3. Any overrides or additions to the ACA bean configurations need to reside in a file named `opencontent-extension-override-config.xml`. **Note:** This file can reference other xml config files but ACA will only specifically look for this file.
4. Name the module context file for the extension `opencontent-extension-override-module-ctx.xml`

### How to add custom Alfresco models into the custom amp
### How to add custom Alfresco models into the custom AMP

To add custom alfresco models you will need to define a bean that has a parent of `dictionaryModelBootstrap` and depends-on `dictionaryBootstrap,com.tsgrp.openContent.dictionaryBootstrap` in the aca extension accelerators module context file. This bean will need to extend any models that other accelerators would need. For instance, this is what it might look like to add onto the claims or pnp accelerators:

Expand Down
2 changes: 1 addition & 1 deletion content-accelerator/latest/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ A wizard-style form is utilized to capture change request information. The form
## 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.
The HR Employee File Management (HR EFM or HR Tier-2) 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:

Expand Down
Loading

0 comments on commit 8b3629a

Please sign in to comment.