Skip to content

Commit

Permalink
[DOCS-7123] Alfresco Content Accelerator 3.5 edits (Alfresco#958)
Browse files Browse the repository at this point in the history
* [DOCS-7123] Added commit 36323c0 with bolded edit

* [DOCS-7123] Edited deprecation to be a note

* [DOCS-7123] Add commit b77aa97

* [DOCS-7123] Small edits to the limitations page

* [DOCS-7123] Added commit 322e7ca

* [DOCS-7123] Added commit dab2fff

* [DOCS-7123] Added edits emphasis and numbering

* [DOCS-7123] Added commit 25442b7

* [DOCS-7123] Added commit fc305f4

* [DOCS-7123] Edited button to bold not code format

* [DOCS-7123] Added commit 9955df7

* [DOCS-7123] Resolved merge conflict that was not in build

* [DOCS-7123] Add commit b2cb318

* [DOCS-7123] Add commit c993f6a

* [DOCS-7123] Formatting edits

* [DOCS-7123] Formatting edits (ags to AGS)

* [DOCS-7123] Add commit f881bc4

* [DOCS-7123] Add commit e249d1c

* [DOCS-7123] Add commit 88de14a

* [DOCS-7123] Add commit 69273e1

* [DOCS-7123] Add a period

* [DOCS-7123] Fix internal & external links plus minor updates

* Update content-accelerator/latest/configure/actions.md

Co-authored-by: Adelaide Nxumalo <[email protected]>

* Update content-accelerator/latest/configure/integrations-and-addons.md

Co-authored-by: Adelaide Nxumalo <[email protected]>

* Update content-accelerator/latest/configure/actions.md

Co-authored-by: Adelaide Nxumalo <[email protected]>

* Update content-accelerator/latest/configure/admin-guide.md

Co-authored-by: Adelaide Nxumalo <[email protected]>

* Update content-accelerator/latest/configure/admin-guide.md

Co-authored-by: Adelaide Nxumalo <[email protected]>

* [DOCS-7123] Correct numbering and other edits

* [DOCS-7123] Correct numbering for Client ID

* [DOCS-7123] Change note text location

* [DOCS-7123] Edit notes and format

* [DOCS-7123] Fix note format in actions.md

---------

Co-authored-by: Adelaide Nxumalo <[email protected]>
  • Loading branch information
Amy-Hyland and anxumalo authored Apr 18, 2023
1 parent 44a9a02 commit e1b3be7
Show file tree
Hide file tree
Showing 31 changed files with 513 additions and 275 deletions.
Binary file added content-accelerator/images/aca-control-types.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content-accelerator/images/object-type-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
93 changes: 50 additions & 43 deletions content-accelerator/latest/configure/actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,26 +87,26 @@ The Bulk Upload action provides support for pulling in emails/threads and their

##### Enabling Gmail API

1. Go to [https://console.developers.google.com/](https://console.developers.google.com/)
1. Click the Create Project button
1. Give it whatever name you want and click the Create button
1. Once it has been created, you should be taken to the Project Overview page. In the lefthand column, click on Credentials, and then click the 'OAuth consent screen' tab
1. Fill out Product name. This will be shown to the user when they authenticate when importing docs from their gmail. You can fill out the other sections if you want, but it is not necessary.
1. Save your changes
1. Go to the Library by clicking the menu item on the left.
1. Under Google Apps APIs, click on Gmail API
1. Click the 'Enable' button at the top
1. Once the API has been enabled, an option will appear to create a new Client ID.
1. When creating the client ID:

* Make sure Web application is selected
* In the Authorized JavaScript origins section, put in the url for that is hosting ACA. For example, if ACA was accessed by `http://www.mysite.com/hpi`, you would use `http://www.mysite.com`. Note that multiple domains can be entered here if you have multiple HPIs that you would like to access the Gmail API.

1. Click Create Client ID
1. Copy the Client ID
1. In the bulk upload config, paste the Client ID from 14 into the 'Gmail Client Id' textbox

Note that you can always get back to your Client ID by going to the Credentials section.
1. Go to [https://console.developers.google.com/](https://console.developers.google.com/){:target="_blank"}.
2. Click the **Create Project** button.
3. Give it whatever name you want and click the **Create** button.
4. Once it has been created, you should be taken to the Project Overview page. In the lefthand column, click on **Credentials**, and then click the **OAuth consent screen** tab.
5. Fill out Product name. This will be shown to the user when they authenticate when importing docs from their gmail. You can fill out the other sections if you want, but it is not necessary.
6. Save your changes.
7. Go to the Library by clicking the menu item on the left.
8. Under Google Apps APIs, click on Gmail API.
9. Click the **Enable** button at the top.
10. Once the API has been enabled, an option will appear to create a new Client ID.
11. When creating the client ID:

* Make sure Web application is selected
* In the Authorized JavaScript origins section, put in the url for that is hosting ACA. For example, if ACA was accessed by `http://www.mysite.com/hpi`, you would use `http://www.mysite.com`. Note that multiple domains can be entered here if you have multiple HPIs that you would like to access the Gmail API.

12. Click **Create Client ID**.
13. Copy the Client ID.
14. In the bulk upload config, paste the Client ID into the 'Gmail Client Id' textbox.

>**Note:** You can always get back to your Client ID by going to the Credentials section.
##### Configuration Options for Ingest from Gmail

Expand All @@ -116,28 +116,33 @@ Note that you can always get back to your Client ID by going to the Credentials

##### Box Application

1. Create an application in Box or use an existing one
2. Go to [https://app.box.com/developers/console](https://app.box.com/developers/console) to view existing apps or create a new one
![Box Application]({% link content-accelerator/images/bulkupload-box-apps.png %})
3. When asked what type of app you are building, choose `Partner Integration`
4. Within an application, under the configuration tab, we can see the Client ID that we will need to use in the bulk upload admin (picture below)
1. Create an application in Box or use an existing one.
2. Go to [https://app.box.com/developers/console](https://app.box.com/developers/console){:target="_blank"} to view existing apps or create a new one.

![Box Application]({% link content-accelerator/images/bulkupload-box-apps.png %})

3. When asked what type of app you are building, choose `Partner Integration`.
4. Within an application, under the configuration tab, we can see the Client ID that we will need to use in the bulk upload admin (picture below).
5. Below the client ID will also be the redirect URI that will need to redirect back to ACA
(ex. `https://localhost:8080/hpi/dummy/path`)
![Bulk Client ID]({% link content-accelerator/images/bulkupload-box-clientid.png %})
(for example, `https://localhost:8080/hpi/dummy/path`):

![Bulk Client ID]({% link content-accelerator/images/bulkupload-box-clientid.png %})

##### Bulk Upload Config for Box

1. Select Bulk Upload Action
2. Set 'Enable Cloud Integration' slider to Yes
3. Choose 'Box' from dropdown selecting which application to integrate with (Box is the only one at the moment)
4. Set Client ID (Explained above)
5. Set Link Type to 'direct'
6. Choose whether to allow a user to select multiple documents to upload
![Box Upload]({% link content-accelerator/images/bulkupload-box-config.png %})
1. Select Bulk Upload Action.
2. Set 'Enable Cloud Integration' slider to Yes.
3. Choose 'Box' from dropdown selecting which application to integrate with (Box is the only one at the moment).
4. Set Client ID (Explained above).
5. Set Link Type to 'direct'.
6. Choose whether to allow a user to select multiple documents to upload:

![Box Upload]({% link content-accelerator/images/bulkupload-box-config.png %})

##### Separate Bulk Upload View for Box

1. When configured, Box upload will be a button next to the other upload buttons
When configured, Box upload will be a button next to the other upload buttons:

![Bulk Upload View]({% link content-accelerator/images/bulkupload-box-upload.png %})

#### Saved Sessions
Expand All @@ -164,15 +169,15 @@ The action can be configured to use a pattern for the downloaded file name based

Export folder must be configured as a folder action - it will throw an error if it is a document action.

The zip created will be the {_folder name_}.zip
The ZIP created will be the {_folder name_}.zip

If any child objects are subfolders or empty documents, they'll be omitted from the zip.
If any child objects are subfolders or empty documents, they'll be omitted from the ZIP.

#### Download With Tags

When enabled (defaults to false), a user can download a folder with folder tags enabled - creating individual folders for each tag and populating each folder with any child documents that share the same tag.

If a child document lacks a tag, or Download With Tags is disabled, all docs will be at the root of the zip.
If a child document lacks a tag, or Download With Tags is disabled, all docs will be at the root of the ZIP.

## Send Email

Expand All @@ -192,21 +197,21 @@ The subfolder of all correspondence sent from the parent folder. If left blank,

#### Email Object Type

This is the object type for Send Email. The default object type is _HPIEmailMessage_. It can be overridden with a custom object type.
This is the object type for Send Email. The default object type is `HPIEmailMessage`. It can be overridden with a custom object type.

#### Email Relationship

Is the relationship between an email and its attachments. For example, in a related objects view, it would show the attachments of an email and vice versa. THis should be set to "hpi:emailed (alfresco)".
Is the relationship between an email and its attachments. For example, in a related objects view, it would show the attachments of an email and vice versa. This should be set to `hpi:emailed (alfresco)`.

#### Folder Tags

You can optionally add a tag to the email object after it's created, typically set to 'Correspondence'. Usually, this is set when the folder is displayed using [Folder Tags](/content-accelerator/latest/configure/actions/#folder-tags). If this is the case, you will typically want to set the Email Storage Location to empty. This way, the email will be stored in the parent folder, but displayed in a 'Correspondence' tag in the folder.
You can optionally add a tag to the email object after it's created, typically set to 'Correspondence'. Usually, this is set when the folder is displayed using [Folder Tags]({% link content-accelerator/latest/configure/actions.md %}#folder-tags). If this is the case, you will typically want to set the Email Storage Location to empty. This way, the email will be stored in the parent folder, but displayed in a 'Correspondence' tag in the folder.

>**Note:** If you have both the folder and document action configured for send email, you will want to have the same tags in both configurations.
### Folder Notes Integration

Users can toggle attaching a folder note in addition to the rest of their email (default is Off). When a user turns on Folder Notes Integration, they must configure a chained action for Send Email to fire Folder Notes. Just like regular folder notes, a note requires a Note Object Type (defaults to _hpi_note_) and a Note Type (defaults to _Correspondence_). When Folder Notes Integration is enabled, a second editor will appear under the email body called Folder Note. If the note is sent without any content, the email's subject line will be substituted. The note that is created will be linked to the email being sent.
Users can toggle attaching a folder note in addition to the rest of their email (default is Off). When a user turns on Folder Notes Integration, they must configure a chained action for Send Email to fire Folder Notes. Just like regular folder notes, a note requires a Note Object Type (defaults to `hpi_note`) and a Note Type (defaults to `Correspondence`). When Folder Notes Integration is enabled, a second editor will appear under the email body called Folder Note. If the note is sent without any content, the email's subject line will be substituted. The note that is created will be linked to the email being sent.

## View All Documents Refined Search {#refined-search}

Expand All @@ -229,4 +234,6 @@ After searching, the pane will off the screen. The displayed results are those o

### Configuration for Refined Search

To enable this feature, go to Admin -> Stage -> (desired trac) -> Folder Actions -> View All Documents. Scroll to Additional Configurations and turn the "Enable Additional Searching" switch to "ON". Once active, this feature uses the View All Documents search configuration and the configured query type. This feature allows the user to select one document object type to perform the refined search on. The object types available are selected from the search config's attribute search. The displayed form for each object type can be set in the attribute search config. **Additional Searching is not supported for the getChildren query type and does not support searching on folder object types**
To enable this feature, go to Admin -> Stage -> (desired trac) -> Folder Actions -> View All Documents. Scroll to Additional Configurations and turn the "Enable Additional Searching" switch to "ON". Once active, this feature uses the View All Documents search configuration and the configured query type. This feature allows the user to select one document object type to perform the refined search on. The object types available are selected from the search config's attribute search. The displayed form for each object type can be set in the attribute search config.

>**Note:** Additional Searching is not supported for the getChildren query type and does not support searching on folder object types.
4 changes: 2 additions & 2 deletions content-accelerator/latest/configure/activewizard.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Active Wizard is ACA's tool for configuring workflows and is included in the Pol

It's possible to write Java code in Alfresco Content Accelerator to execute a query. Alfresco Content Accelerator queries all have a Parameters textbox that allows the administrator to pass information to the ACA query code. This parameter value can either be simple text typed into the admin or a query variable that is resolved at runtime before the query is executed.

**Note:** As of ACA 2.5, ACA queries can either generate answers, or execute special functionality to return data to the front end form.
> **Note:** As of ACA 2.5, ACA queries can either generate answers, or execute special functionality to return data to the front end form.
All parameters are formatted as: `${paramName}`.

Expand Down Expand Up @@ -41,7 +41,7 @@ It is possible to set up an Active Wizard query to use an ACA picklist. When ch

`${picklistName}`

**Note:** It is not recommended to hardcode the picklist name. It's more flexible to let the question configuration specify the picklist ID.
> **Note:** It is not recommended to hardcode the picklist name. It's more flexible to let the question configuration specify the picklist ID.
### Creating a new ACA Query

Expand Down
Loading

0 comments on commit e1b3be7

Please sign in to comment.