Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
automationrules [2021_06_08 13:26] – smeadmin | automationrules [2023_06_06 14:16] – [Data Automation Rules] eric | ||
---|---|---|---|
Line 1: | Line 1: | ||
# Data Automation Rules | # Data Automation Rules | ||
+ | |||
+ | ##### last updated on: Feb. 26, 2022 | ||
## Introduction | ## Introduction | ||
- | The Enterprise File Fabric' | + | The Enterprise File Fabric' |
- | Data Automation | + | Each Data Automation |
- | Data Automation Rules are configured a Organization Administrator. | ||
- | Applies to: | + | ## Applies to: |
- | * Enterprise File Fabric Appliance | + | * Enterprise File Fabric Appliance |
+ | * Enterprise File Fabric Appliance | ||
- | See Also: | + | ## See Also: |
- | * [[contentdiscovery]] | + | * [[contentdiscovery|Content Discovery]] |
- | * [[contentdiscoveryconfig]] | + | |
- | For data automation rules to be enabled the Content Discovery module must be enabled, and providers configured for content search. For more information see [[contentdiscoveryconfig]]. | + | |
+ | |||
+ | ## Administration | ||
+ | |||
+ | The Data Automation Rules configuration page is accessed from the Organization menu by the organization administrator and by users with the Administrator role. | ||
- | The Data Automation Rules configuration page is accessed from the Organization menu by users with the Administrator role. | ||
## Event Types | ## Event Types | ||
+ | This section outlines the available Event Types that the Enterprise File Fabric supports. | ||
- | ## Action Types | + | ### 1. File is uploaded through this platform |
+ | Description: | ||
+ | |||
+ | **Available since**: 2106.00 | ||
+ | ### 2. File is discovered on storage | ||
+ | Description: | ||
+ | **Available since**: 2106.00 | ||
- | ## Content Discovery | + | ### 3. File is discovered on storage or uploaded |
+ | Description: | ||
- | Automation rules work with [[contentdiscovery]] detectors and categories. Content Detectors trigger Content Detection Categories, which raise events that trigger rules which execute actions: | + | **Available since**: 2106.00 |
- | {{ :contentdiscovery: | + | ### 4. File contains matches against Content Discovery Rules |
+ | Description: This event is triggered when a file has been scanned using the Content Discovery rules, and the scan results contain one or more matches against the Content Discovery rules. Each rule applies to a single Content Detection Category which must be selected when setting up the rule. | ||
+ | **Available since**: 1906.00 | ||
- | ## Creating an Automation Rule | ||
- | An automation rule consists of an event, a condition and one or more actions. | ||
- | ### Event | + | ## Action Types |
- | Choose “Create Rule” to create an automation rule. | + | <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. | ||
+ | </ | ||
- | 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. | + | ### 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. | ||
- | You may create multiple automation rules with the same event type. Typically they will have different conditions but this is not required. | + | **Supported Events**: #1, #2, #3, #4 |
- | ### Condition | + | **Available since**: 1906.00 |
- | For a content detection | + | ### 2. Perform Content Intelligence |
+ | This action sends the file that triggered the event to the Content | ||
- | {{ :: | + | **Supported Events**: #1, #2, #3 |
- | Select | + | **Available since**: 2006.00 |
- | ### Action | + | ### 3. Transcode file |
+ | This action sends the file that triggered the event to be transcoded using the File Fabric' | ||
- | You may create many actions for each automation | + | To use the transcode file rule you will need to enable "Video transcoding" |
- | The following actions are supported: | + | **Supported Events**: #1, #2, #3 |
- | * Email members of a role | + | **Available since**: 2106.00 |
- | * Send an email to an email address | + | |
- | * Disable file url creation | + | |
- | * Move the file to another folder | + | |
- | ## Actions | + | ### 4. Send email to an email address |
- | ### Email Members of a Role | + | This action allows the event to notify |
- | This action immediately sends a notification by email to members of a role. | + | {{ : |
- | Configuration | + | **Supported Events**: #4 |
+ | |||
+ | **Available since**: 1906.00 | ||
- | * Choose one role (drop-down) | + | ### 5. Send email to members who have a role |
- | * Choose | + | 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 |
{{ : | {{ : | ||
Line 84: | Line 100: | ||
{{ : | {{ : | ||
- | ### 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 | ||
- | * A valid email address. | + | ### 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 existing shared links. | ||
- | {{ : | + | {{ : |
- | ### 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 disable shared links that have already been created. | + | |
- | + | ||
- | {{ : | + | |
- | ### Move the file to another folder | ||
- | This action moves the matched | + | ### 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 124: | Line 134: | ||
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 the File Fabric to invoke an HTTP callback when a qualifying event occurs. | ||
+ | |||
+ | {{ :: | ||
+ | |||
+ | The File Fabric 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 the File Fabric sending the HTTP request followed by the File Fabric 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 the File Fabric 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. | ||
- | Email notifications use the new generated file name and folder location. | + | At the discretion of the implementor, |
+ | {{ :: | ||
+ | **Supported Events**: #4 | ||
+ | **Available since**: 2106.00 |