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 [2018_08_28 01:21] – ↷ Page name changed from dataautomation to automationrules steven | automationrules [2021_09_27 17:55] – external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
# Data Automation Rules | # Data Automation Rules | ||
+ | ##### last updated on: July 16, 2021 | ||
+ | ## Introduction | ||
- | An administrator can pre-configure actions to be automatically | + | The Enterprise File Fabric' |
- | For data automation rules to be enabled the Content Discovery module must be enabled, and providers | + | Each Data Automation Rule configured |
- | The Data Automation Rules configuration page is accessed from the Organization menu by users with the Administrator role. | ||
- | ## Creating an Automation Rule | + | ## Applies to: |
- | An automation rule consists of an event, a condition | + | * Enterprise File Fabric Appliance v2106 and above (all licenses; functionality varies according to licensed features) |
+ | * Enterprise File Fabric Appliance [[cloudappliance/ | ||
- | ### Event | + | ## See Also: |
- | Choose “Create Rule” to create an automation rule. | + | * [[contentdiscovery|Content Discovery]] |
- | The only event currently supported is “Content | + | * [[file_content_intelligence/ |
- | You may create multiple automation rules with the same event type. Typically they will have different conditions but this is not required. | + | ## Administration |
- | ### Condition | + | The Data Automation Rules configuration page is accessed from the Organization menu by the organization administrator and by users with the Administrator role. |
- | For a content detection event the condition is a Content Detection Category. For example “GDPR” or “North America - National Identifiers”. | ||
- | {{ :: | + | ## Event Types |
- | Select ***Create Rule*** to begin adding actions. | + | This section outlines the available Event Types that the Enterprise File Fabric supports. |
- | ### Action | + | ### 1. File is uploaded through this platform |
+ | Description: | ||
+ | |||
+ | **Available since**: 2106.00 | ||
- | You may create many actions for each automation rule. | + | ### 2. File is discovered on storage |
+ | Description: | ||
- | The following actions are supported: | + | **Available since**: 2106.00 |
- | * Email members of a role | + | ### 3. File is discovered on storage or uploaded |
- | * Send an email to an email address | + | Description: |
- | * Disable file url creation | + | |
- | * Move the file to another folder | + | |
- | ## Actions | + | **Available since**: 2106.00 |
- | ### Email Members of a Role | + | ### 4. File contains matches against Content Discovery Rules |
+ | Description: | ||
- | This action immediately sends a notification by email to members of a role. | + | **Available since**: 1906.00 |
- | Configuration | ||
- | * Choose one role (drop-down) | ||
- | * Choose to only send to members to have access to the file | ||
- | {{ : | + | ## Action Types |
- | An email like the following will be sent when matching content is detected: | + | ### 1. Copy file to another folder |
+ | This action copies | ||
- | {{ :dataautomation: | + | **Supported Events**: #1, #2, #3, #4 |
- | ### Send an Email to an Email Address | + | **Available since**: 1906.00 |
- | This action | + | ### 2. Perform Content Intelligence |
+ | This action | ||
- | Configuration | + | **Supported Events**: #1, #2, #3 |
+ | |||
+ | **Available since**: 2006.00 | ||
+ | |||
+ | ### 3. Transcode file | ||
+ | This action sends the file that triggered the the event to be transcoded using the File Fabric' | ||
+ | |||
+ | **Supported Events**: #1, #2, #3 | ||
+ | |||
+ | **Available since**: 2106.00 | ||
+ | |||
+ | ### 4. Send email to an email address | ||
- | * A valid email address. | + | This action allows the event to notify a single |
{{ : | {{ : | ||
- | ### Disable file url creation | + | **Supported Events**: |
- | This action prevents the file being shared through the creation of shared links. | + | **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. | ||
- | * Optionally | + | {{ : |
+ | |||
+ | An email like the following will be sent when matching content is detected: | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | **Supported Events**: #4 | ||
+ | |||
+ | **Available since**: 1906.00 | ||
+ | |||
+ | |||
+ | ### 6. Disable file URL creation | ||
+ | This action prevents the file 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 folder from dialog (folder must exist or can be created from dialog) | ||
- | * Optionally disable shared links that have already been created. | ||
{{ : | {{ : | ||
Line 95: | Line 126: | ||
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 |