Skip to main content
Gainsight Inc.

Catch-up on Rules Engine Enhancements

February 2018: 5.11 Release

Automatic Updates

  1. Ability to see the Description of a Bionic Rule Action in the Action Header: Admins can now see the description of the Actions in all of the Action headers in a Bionic Rule. To see this enhancement, navigate to Administration > Rules Engine (Bionic) > Setup Action. If you have created an Action in a Bionic Rule, you can see the description of an Action in the Action header without having to expand it. This helps Admins to identify a specific Action in a Bionic Rule and change the configurations when there are multiple Actions.

Action_Header_Field.png

Incremental Improvements

  1. S3 Dataset Task configuration in Bionic Rules: You can now use files in the Gainsight S3 bucket and create a dataset task in Bionic Rules. A new type of task called S3 Dataset is introduced to create a dataset from a CSV/TSV file in the S3 bucket. This option allows you to create fields in the new dataset from the CSV/TSV columns. You can apply other tasks and create setup actions on this dataset. For more information, refer S3 Dataset Task in Bionic Rules.

S3 Dataset.png

  1. Send emails using Marketo in Bionic Rules: You can send emails using Marketo from Bionic Rules with the new action type Send Email using Marketo.
    1. Navigate to Administration > Rules Engine.
    2. Create or open an existing bionic rule.
    3. Select an object with Contact ID or Email Address fields. This is a mandatory step to use the Send email using Marketo option.

Marketo.png

  1. Click + ACTION and select the dataset task. This task needs to have an Account or Contact as the source object.
  2. Select Send Email using Marketo as the Action.
  3. Provide a description (optional).
  4. Select a campaign from the Send Campaign list. The list of campaigns are fetched from Marketo directly. For more information, see Marketo Documentation.
  5. Select a field from the To list. The To list specifies to which contacts the email must be sent. This can be either an ID field or Contact fields or a field having lookup to Account or Contact object.
  6. (optional) Add a criteria.
  7. Click SAVE to save the email action.

 

  1. Support for Multi-select dropdown list data type fields on MDA objects in Bionic Rules: Multi-select dropdown list data type fields in the MDA objects are now supported in configuring the Bionic Rules. While configuring a Rule, Admins can now add these types of fields in the Show fields section and even apply filters on these fields. Once a dataset is created in the Setup Rule section, Admins can load data into the MDA and SFDC objects from this dataset.

    While loading data into the MDA and SFDC objects, Admins can map multi select dropdown list fields in an MDA object to dropdown or multi select dropdown list data type fields in the MDA and SFDC objects.

    To see this enhancement:
    1. Navigate to Administration > Rules Engine > Setup Rule.
    2. Admins can add multi select dropdown list data type fields in an MDA object to the Show fields section and filters can be applied on these fields as shown in the image below:

Multipicklist.gif

  1. String operators in Formula Builder: With this release, more String operators are added to Formula Builder (only in the transformation task). Using these string operators you can perform string manipulation and transform your data. 
    1. LEFT(field, substring) - extracts the left part of the string from the appearance of string character. For example, LEFT(johndoe@gainsight.com, @) will return “johndoe” as the output.

String 1.png

  1. RIGHT(field, substring) - extracts the right part of the string with the appearance of a string character. For example, RIGHT(johndoe@gainsight.com, @) will return “gainsight.com” as the output.
  2. POSITION(field, substring) - provides the position of the substring in a string. For example, POSITION(“doe” in “johndoe”) returns 5. Counting of the position starts with an index 1.
  3. LENGTH(field) - provides the length of the string. For example, LENGTH(“string”) returns 6. 
  4. SUBSTRING(field, position, length) - finds the substring based on the position and length. For example, Substring(“johndoe”, 2, 3) returns “ohn”.

String 2.png

  1. Statistical functions in Bionic Rules: With this release, five Statistical functions are introduced in Bionic Rules. Statistical functions provide the ability to work with datasets and obtain insightful statistics and take decisions. The following statistical functions are introduced (only in the transformation task): 
     
    1. Correlation: Looks at the strength of a relationship between two variables (in the case of Bionic Rules, two datasets). This function returns an output between -1 and +1.
      1. If the output is between 0 and +1, then the two variables are positively correlated. 
      2. If the output value is between -1 and 0, then the variables are negatively correlated.
      3. If the value is 0, then the variables are not correlated. 


        Statistical 1.png
    2. Covariance: Covariance is also a type of correlation. This function indicates whether the two datasets are positively or negatively correlated. This function does not indicate the strength of correlation between two variables.

      Statistical 2.png
    3. Standard Deviation and Variance: Standard deviation and Variance measure how disperse your dataset is. A high value indicates that the dataset is widespread and a low value indicates that the variability in data is minimal.

Statistical 3.png

  1. Median: Using the Median function you can find where the middle of a dataset is. Median is better than average if the dataset has high and low values.

Statistical 4.png

  1. Ability to add more Derived Mappings in Load to Company/Relationship Person action types: Admins can now add more derived mappings along with the standard derived mappings shipped by Gainsight in the following action types:
    • Load to Company Person
    • Load to Relationship Person

To see this enhancement in the Load to Company Person and Load to Relationship Person action type in Bionic Rules:

  1. Navigate to Administration > Rules Engine. Create a dataset to load into either Company Person or Relationship Person objects in the Setup Rule page.
  2. In the Setup Action page for the Load to Company Person action type, in the Derived field mappings section, click +Derived Mapping for Person to add more derived mappings for loading data into the GSID data type fields of Person object.
  3. Click +Derived Mapping for Company Person to add more derived mappings for loading data into the GSID data type fields of Company Person object.

    Load to Company Person.png
  4. Similarly, In the Setup Action page for the Load to Relationship Person action type, in the Derived field mappings section, click +Derived Mapping for Person and +Derived Mapping for Relationship Person to add more derived mappings for loading data into the GSID type fields of Person and Relationship Person objects respectively.

Load to Relationship Person.png

For more information on the derived mappings, refer Data Import Lookup.

For more information on the Load to Company Person and Load to Relationship Person action types, refer Setup Rule Action Types.

November 2017: 5.10 Release

Automatic Updates:
  1. Preview and Download Task Results options in Execution History of Bionic Rules: Navigate to Administration > Rules Engine > RULES LIST > [Select any Bionic Rule] > EXECUTION HISTORY. You can now preview and download the results of all the tasks in a Bionic Rule after the rule run. In the EXECUTION HISTORY tab, select any task to view the respective task details:

  • Task Type: Task type as defined while creating the Bionic Rule
  • Status: Status of rule run
  • Records: No. of records fetched for the task defined
  • Duration: Duration of the rule run
  • Results: You can -
    • Preview Results: Click this icon to preview the task results in a new window. A maximum of only 100 records are displayed in this page.

  • Download Results: Click this icon to download the results of the selected task.

        Notes:

  • Seven days after the rule run date, the preview and download options expire and an error message is displayed if you click these icons.
  • These icons are disabled when the rule run is aborted.
  • By default, all the task results are retrieved from S3 (Even if the Export to S3 option in the Setup Rule screen is disabled).
  1. Advanced Logic is introduced in the Setup Action - Criteria section of Bionic Rules: Navigate to Administration > Rules Engine > +RULE > Setup Action. The Criteria section now provides Advanced Logic that allows you to apply logical operators AND or OR on the selected fields. Previously, Rules Engine (internally) applied AND operator on the selected fields, by default. Now, you can view the logic in the screen and modify the operator to update the logic as required.

Note: Advanced Logic is case-sensitive in Action criteria.

  1. Support for all data sources in Bionic Rules for relationships: In Bionic Rules for relationships, all data sources (SFDC, MDA) are now supported. Navigate to Administration > Rules Engine > +RULE > Setup Rule. In this screen, when you select the source object from the left panel, the following categories are now available:
  • Relationship related objects
  • All other objects                        

  1. Abort a Rule and Rule Chain runs: The ability to abort any rule run (manual, test, scheduled) is now added to Rules and Rule Chain executions. You can use abort option when the rule run is initiated unintentionally or if the rule is not configured as required. Rule runs can be aborted from the Execution History tab of rule details or the Timeline view.  
    1. Navigate to: 

Administration > Rules Engine > RULES LIST > [Select the required Rule] > EXECUTION HISTORY. When the selected rule run is in progress, the Abort icon is displayed beside the In Progress status.

OR

Administration > Rules Engine > TIMELINE. When a rule is scheduled for a run or is running, the Abort icon is displayed beside the RULE DATE.

  1. Click the Abort icon. The Abort Rule dialog box is displayed with a warning ‘This results in abrupt ending of the rule’.
  2. Click ABORT to abort the rule or CANCEL. A success message is displayed when the rule abort process starts successfully.

    EXECUTION HISTORY tab of Rule Details:

TIMELINE view:

    

When a rule that is used in a Rule Chain is aborted, you are prompted with an option to abort the rule chain in the Abort Rule dialog box.

  

Abort rule chain:

  • Select this option to abort the Rule Chain(s) which the rule is a part of.
  • Deselect this option to abort only the selected rule and the dependent rules in the respective Rule Chain(s). The independent rules in the Rule Chain are executed as scheduled.
  1. New ‘Sort by’ option is available in Rules Engine List View: A new Sort by option, Last run status is now added in Rules Engine List View. The Last run status option allows you to sort rules by the following status:
  • Failure
  • Partial Success
  • Success

  1. Execution time of Bionic rules is set to a maximum limit of 8 hours, which if exceeded the system aborts the rule automatically.

Incremental Improvements:

  1. Support for setting up actions on outputs of multiple tasks in Bionic Rules: Navigate to Administration > Rules Engine > +RULES > Setup Action. In Bionic Rules, actions now support using multiple tasks’ outputs as source. This allows you to set up actions for intermediate tasks’ outputs apart from the final output task from Setup Rule. This ability to consume the outputs of intermediate tasks enables the admin to model a business process more efficiently, provides the flexibility to achieve multiple actions on similar datasets in one rule, and thus reduces the number of rules created for a similar criteria.
    1. Click +ACTION to view the Select Task dialog box. All the tasks defined in the Setup Rule screen are available in the drop-down list.
    2. Select the required task from the list.

      Rules Engine 1.gif
       
    3. Click SAVE to set up an action for the selected task.

Note: You can now find SAVE and RUN NOW in the top right corner of the page.

  1. New action types are available in Bionic Rules: Navigate to Administration > +RULE > Setup Action > Action Type. The following new action types are now available in Bionic Rules:
  • Load to Relationship Person: Supports loading data to the Person and Relationship Person standard objects at the same time.
  • Load to Scorecard History: Supports loading data to the Scorecard History object. This action type is helpful during onboarding, for example, when you’re integrating historical customer health score data.

Also, the action type Load to Person is now renamed to Load to Company Person. This action type supports loading data to the Person and Company Person standard objects at the same time.

For more information on the Gainsight Person object model, refer to Gainsight Person Object Model, and for details on different Action types in Rules Engine, refer to Setup Rule Action Types.

  1. GainsightCommunity_Icon_20x20 (1).png New functions are available in Formula Builder of Transformation task in Bionic Rules: Navigate to Administration > Rules Engine > +RULE > Setup Rule.

    To provide more flexibility, the new String and Date functions are now supported in the Transformation task.
     
    1. Click +TASK > Transformation.
    2. Click +Formula Field. The Formula Field dialog box is displayed.
    3. Select the Function option.

      Rules Engine 2.png
       

The following is the list of new functions:

Function Description Valid input Data types
Concat Concatenates the selected arguments String, Picklist, Multi-picklist
To Lower Case Converts the selected argument values to Lowercase
To Upper Case Converts the selected argument values to Uppercase
Date Converts Date-time argument to Date Datetime
Date Diff Returns difference of the two selected dates in the selected unit
First Day of Calendar Quarter Returns the first day of Calendar Quarter Date, Datetime
First Day of Current Month Returns the first day of Current Month
First Day of Current Week Returns the first day of Current Week
Last Day of Calendar Quarter Returns the last day of Calendar Quarter
Last Day of Current Month Returns the last day of Current Month
Last Day of Current Week Returns the last day of Current Week

Trend and Trend % functions are renamed to Period Over Period Comparison and Period Over Period Comparison in % respectively.

Rules Engine 3.png

An option to treat null values as zero is added in Expression formula type.

Rules Engine 4.png

Treat null value as zero check box:

  • Select this to replace any null field values with zero while performing calculations using the expression provided.
  • Deselect this to use any null value as is in the calculations.

September 2017: 5.9 Release

Automatic Updates:

  1. Handling % (Percentage) Data type in Bionic Rules: % data type is now handled differently to avoid data discrepancies. The % field value stored in the source is displayed as is, in the respective consumption area.
  2. Inactive Bionic Rules: When a Bionic Rule fails, the rule is marked inactive automatically. This happens only for the following query fail exception or error scenarios in Bionic Rules:
  • MALFORMED_QUERY
  • INVALID_QUERY_FILTER_OPERATOR
  • INVALID_FIELD
  • INVALID_TYPE
  1. Support for parallel Rule runs: Rules or Rule Chains can now run in parallel. Any two Rules or Rule Chains scheduled at the same time can run in parallel, if:
  • Both are mutually exclusive
  • Both are not writing to the same object
  • One is reading from and other is not writing to the same object

This ensures rules are executed faster by reducing the wait-time in queue. Also, the manual rule runs are prioritized over scheduled rule runs.

Note: Multiple reads to the same object are allowed while running rules in parallel.

Incremental Improvements:

  1. Rule results can be stored in the Gainsight file repository instead of Email attachments: Previously, while mailing both custom and bionic rule results to customers, an excel sheet with the results was attached to the mail. Now, a toggle to disable the mail attachment is added in the Application settings page. Refer to the following image:

If this toggle is:

  • Enabled - The rule results are stored in the Gainsight repository automatically and a button to download these results is provided in the Administration > Rules Engine > RULE LIST > Rule Details > EXECUTION HISTORY tab. Refer to the following image:

  • Disabled - An attachment with the rule results is sent to the customer through Execution Results Email (Earlier behaviour). The button to download the results is disabled in the Rule Details - Execution History tab.

Refer to the following table for rule results settings:

Application settings page - Storage Email attachment Execution History - Download Button
Enabled Disabled Enabled
Disabled Enabled Disabled
  1. GainsightCommunity_Icon_20x20 (1).pngTimezone standardization: Navigate to Administration > Application Settings > Timezone. Admins can now configure Gainsight and SFDC timezones from this pane. The Gainsight timezone selected in this pane is honoured across Gainsight.
    Note: Reports created on SFDC objects honour SFDC Timezone settings.

Navigate to Administration > Rules Engine. Click the Settings (gear) icon in the top right corner and select Timezone to view the Timezone dialog box. The timezone selected in the Application Settings page is honored and is read-only from now.

Note: Once the Timezone is set by the Admin, Timezone cannot be edited and it is available as a read-only field in the respective consumption areas.

CAUTION: Do not change your timezone settings, after setting them up. It will result in serious data discrepancy issues.

For more information, refer to Timezone Standardization in Gainsight.

  1. GainsightCommunity_Icon_20x20 (1).pngAdvanced scheduler for Bionic Rules: The new Advanced scheduler in Rules Engine enables you to run Bionic Rules more frequently. Rule run can be as frequent as once in two hours, allowing multiple rule runs in a day (maximum 12). As a part of this enhancement, Schedule type drop-down with Advanced and Basic options is added in the Administration > +RULE > Schedule screen.

    Schedule_type.png

The following screen is displayed when you select Advanced as Schedule type:

Advanced_Cron.png

Advanced scheduler uses cron expression to schedule a rule run. For more information about Cron Expressions, refer to Cron Expressions in Advanced Scheduler.
Notes:

  • Rules cannot run more than once in two hours.
  • Historical period runs are not supported with Advanced scheduler.
  1. Full outer join support in Bionic Rules: Navigate to Administration > Rule Engine > +RULE > Setup Rule > +TASK > Merge. In Bionic Rules, you can now perform ‘full outer join’ to merge any two pre-defined data sets (in tasks). This enables you to fetch all the records from both data sets. As a part of this enhancement, a new join type - Retain all records from both datasets, is added to the Criteria section in Merge task. Refer to the following image:

For example, consider the following two objects:

Account_Example

Account_ID Page_Views
1 100
2 250
3 130
4 50

Account_Type

Account_Type_ID Account_ID Type_Name
Type_1 1 Admin
Type_2 9 IT
Type_3 12 Support

The following is the result of performing ‘Full Outer Join’ on these objects:

Account_ID Type_Name Page_Views
1 Admin 100
2 null 250
3 null 130
4 null 50
9 IT null
12 Support null
  1. MDA joins support in Bionic Rules: MDA joins are now supported in Bionic Rules for both Account and Relationship. Navigate to Administration > Rules Engine > +Rule > Setup Rule. MDA joins enable you to use lookup objects related to MDA Data objects to setup a Bionic Rule. You can use lookup objects up to the third sub-level.

  1. New action types available in Bionic Rules: Navigate to Administration > +RULE > Setup Action > Action Type. The following new action types are now available in Bionic Rules:
  • Load to Milestone (Both for Account and Relationships)
  • Load to User (Only for Account)
  • Load to Person (Only for Account)
  • Set Score 2.0 (Both for Account and Relationships)

For more information about different types of Actions in Rules Engine, refer to Setup Rule Action Types.

  1. Create Success Plans using Bionic Rules for relationships: You can now configure Bionic rules to create Success Plans. Navigate to Administration > Rules Engine > +Rule > Setup Action. The Success Plans action type is available in Bionic Rules for both accounts and relationships.

The associated field values that can be configured in this screen are similar to Custom rules - Success Plan action type. For more information about how to create Success Plans for Accounts using Rules Engine (Custom Rule Type), refer to the Creating Success Plans Using Rules Engine article.

  1. GainsightCommunity_Icon_20x20 (1).pngBionic Rules available in Rule Chain: Rule chain now supports Bionic Rules. This enables scheduling Bionic rule chain runs similar to Custom rule chain runs. Navigate to Administration > Rules Engine > Rule Chain > +RULE CHAIN. When you select rules while creating a new rule chain, you can now view both Bionic and Custom rules in drop-down. Refer to the following image:

Rule_Chain.png

  1. Support for all data sources in Bionic Rules: You can now use objects from all data sources (SFDC, All MDA sources) for creating a Bionic Rule in Rules Engine.
  2. Support for ‘Rich Text Area’ data type: A new data type ‘Rich Text Area’ is now supported in Rules Engine. The data type is defined as ‘Text Area’ in the source and this supports Rich Text Area type formatting. Navigate to Administration > Rules Engine > +RULE > Setup Rule. The fields with ‘Text Area’ data types can now be used to set up rules. Refer to ‘Comments’ in the following image:

These fields can further be used to set up an action.

Note: ‘Rich Text Area’ field is not supported in:

  • Setup Rule screen - Filters section
  • Setup Action screen - Criteria section
  • Setup Rule > +TASK > Transformation task - GroupBy section
  • Setup Rule > +TASK > Dataset task - Filters section
  1. GainsightCommunity_Icon_20x20 (1).png'Replace Comments' option added in the Load to Feature action: A new option Replace Comments is added to the Comments field for Load to Feature action type. Select this option to replace the comments (both entered manually and added by tokens selected). If this option is not selected, comments are concatenated (earlier behavior).

 Action Type.png

  1. Custom Rules deprecation: The Custom rule type will be removed in the next 6 - 12 months. Gainsight recommends that you use Bionic Rules to leverage more of the Rules Engine capabilities. A Bionic Rules training course is in development to help support customers in this transition. Additionally, we are planning a migration utility to help convert custom rules to bionic rules. To learn more about Bionic Rules, refer to Configure Bionic Rules path.
  • Was this article helpful?