Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
automationrules [2021_05_20 16:13] – smeadmin | automationrules [2024_03_04 17:45] (current) – [8. Call webhook] steven | ||
---|---|---|---|
Line 1: | Line 1: | ||
# Data Automation Rules | # Data Automation Rules | ||
+ | |||
+ | ##### last updated on: Feb. 26, 2022 | ||
## Introduction | ## Introduction | ||
- | The Enterprise File Fabric's Data Automation Rules functionality delivers ' | + | Access Anywhere's Data Automation Rules deliver if-this-then-that |
- | As an example: | + | Each Data Automation Rule configured in Access Anywhere consists of an //event trigger// (e.g. "File is uploaded" |
- | * Documents that contain personal data restricted under GDPR? - Don't allow them to be shared! | ||
- | * Sales contracts reference obsolete SKUs? - Notify the the legal team and move them to quarantine! | ||
- | * Files containing the name Ernie Madeoff? - Send email to the finance director! | ||
- | * High-res media assets require automatic transcoding? | ||
- | An administrator can pre-configure actions to be automatically performed when different types of content are detected. | ||
- | Applies to: | + | ## See Also: |
- | | + | * [[contentdiscovery|Content Discovery]] |
- | See Also: | + | * [[file_content_intelligence/ |
- | * [[contentdiscovery]] | + | ## Administration |
- | * [[contentdiscoveryconfig]] | + | |
- | For data automation rules to be enabled | + | The Data Automation Rules configuration page is accessed from the Organization menu by the organization administrator |
- | The Data Automation Rules configuration page is accessed from the Organization menu by users with the Administrator role. | ||
- | ## Content Discovery | + | ## Event Types |
- | Automation rules work with [[contentdiscovery]] detectors and categories. Content Detectors trigger Content Detection Categories, which raise events | + | This section outlines the available Event Types that Access Anywhere supports. |
- | {{ :contentdiscovery:data-automation-structure.png? | + | ### 1. File is uploaded through this platform |
+ | Description: This event is triggered when a file is uploaded by a user directly on Access Anywhere. The scope of this upload can be narrowed using the Folder selector. | ||
+ | |||
+ | **Available since**: 2106.00 | ||
+ | ### 2. File is discovered on storage | ||
+ | Description: | ||
- | ## Creating an Automation Rule | + | **Available since**: 2106.00 |
- | An automation rule consists of an event, a condition | + | ### 3. File is discovered on storage or uploaded |
+ | Description: | ||
- | ### Event | + | **Available since**: 2106.00 |
- | Choose “Create Rule” | + | ### 4. File contains matches against Content Discovery Rules |
+ | Description: | ||
- | The only event currently supported is “Content is detected in a file”. It’s triggered when content of interest is detected in a file that is uploaded or moved. | + | **Available since**: 1906.00 |
- | You may create multiple automation rules with the same event type. Typically they will have different conditions but this is not required. | ||
- | ### Condition | ||
- | For a content detection event the condition is a Content Detection Category. For example “GDPR” or “North America - National Identifiers”. | + | ## Action Types |
- | {{ :: | + | <WRAP center round tip 100%> |
+ | Each action type is available only for the event types listed at the end of the action type's description. | ||
+ | </ | ||
- | Select ***Create Rule*** | + | ### 1. Copy file to another folder |
+ | This action copies the file that triggered the event to a designated folder. The designated folder can be selected using the folder selector control. The Copy operation will be performed as a Background Task assigned to the Admin user. | ||
- | ### Action | + | **Supported Events**: |
- | You may create many actions for each automation rule. | + | **Available since**: 1906.00 |
- | The following actions | + | ### 2. Perform Content Intelligence |
+ | This action sends the file that triggered the event to the Content Intelligence module for analysis. | ||
- | * Email members of a role | + | **Supported Events**: #1, #2, #3 |
- | * Send an email to an email address | + | |
- | * Disable file url creation | + | |
- | * Move the file to another folder | + | |
- | ## Actions | + | **Available since**: 2006.00 |
- | ### Email Members of a Role | + | ### 3. Transcode file |
+ | This action sends the file that triggered the event to be transcoded using Access Anywhere' | ||
- | This action immediately sends a notification by email to members of a role. | + | To use the transcode file rule you will need to enable "Video transcoding" |
- | Configuration | + | **Supported Events**: #1, #2, #3 |
- | * Choose one role (drop-down) | + | **Available since**: 2106.00 |
- | * Choose to only send to members to have access to the file | + | |
- | {{ : | + | ### 4. Send email to an email address |
- | An email like the following will be sent when matching content | + | This action allows |
- | {{ : | + | {{ : |
- | ### Send an Email to an Email Address | + | **Supported Events**: |
- | This action allows the event to notify a single email address. | + | **Available since**: 1906.00 |
- | Configuration | + | ### 5. Send email to members who have a role |
+ | This action sends a notification of the triggering event by email to organization members who have the specified role. When configuring the action you must select the role from the dropdown, as well as whether the notification should only be sent to members of that role that have permissions to access the file that triggered the event, or to all members with the role regardless of their permissions. | ||
- | * A valid email address. | + | {{ : |
- | {{ :dataautomation: | + | An email like the following will be sent when matching content is detected: |
- | ### Disable file url creation | + | {{ : |
- | This action prevents the file being shared through the creation of shared links. | + | **Supported Events**: #4 |
- | Configuration | + | **Available since**: 1906.00 |
- | * Optionally | + | |
+ | ### 6. Disable file URL creation | ||
+ | This action prevents the file from being shared through the creation of secure shared links. This action can also be configured to disable | ||
{{ : | {{ : | ||
- | ### Move the file to another folder | ||
- | This action moves the matched | + | **Supported Events**: #4 |
+ | |||
+ | **Available since**: 1906.00 | ||
+ | |||
+ | |||
+ | ### 7. Move file to another folder | ||
+ | This action moves files matched | ||
Configuration | Configuration | ||
- | * Choose folder from dialog (folder must exist or can be created from dialog) | + | * Choose |
- | * Optionally disable shared links that have already been created. | + | |
{{ : | {{ : | ||
- | A suffix is added to the file as it is moved which includes the date and time. This prevents subsequent updates overwriting the quarantined version. An additional optional suffix may also be added. File extensions are preserved. | + | A suffix is added to the file as it is moved which includes the date and time. This prevents subsequent updates |
- | For example, with an provided suffix of " | + | For example, with a provided suffix of " |
CreditApplication.pdf | CreditApplication.pdf | ||
Line 122: | Line 130: | ||
CreditApplication_ContainsSSN_2018-08-20_22-08-24.pdf | CreditApplication_ContainsSSN_2018-08-20_22-08-24.pdf | ||
+ | | ||
+ | **Supported Events**: #4 | ||
+ | |||
+ | **Available since**: 1906.00 | ||
+ | ### 8. Call webhook | ||
+ | This action causes Access Anywhere to invoke an HTTP callback when a qualifying event occurs. | ||
+ | |||
+ | {{ :: | ||
+ | |||
+ | The Access Anywhere invokes the callback with the HTTP POST request method. The callback is invoked once per file for which a qualifying event is detected. | ||
+ | |||
+ | The HTTP request will contain a User-Agent header et to the site title of Access Anywhere sending the HTTP request followed by Access Anywhere version, | ||
+ | |||
+ | |||
+ | The request body is a JSON representation of information about the file in which the qualifying content was discovered and about the event that caused the webhook to be called. Here is an example: | ||
+ | |||
+ | ``` | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | ], | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | ], | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | }, | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | ``` | ||
+ | |||
+ | Webhook invocations by Access Anywhere will timeout if a connection cannot be established with the webhook host within 3 seconds, or if the first byte of the reply is not received within 30 seconds after the connection is established. | ||
+ | |||
+ | At the discretion of the implementor, | ||
- | Email notifications use the new generated file name and folder location. | + | {{ :: |
+ | **Supported Events**: #4 | ||