November 2017: 5.10 Release
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.
- 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).
- 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.
- 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
- 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.
- 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.
Administration > Rules Engine > TIMELINE. When a rule is scheduled for a run or is running, the Abort icon is displayed beside the RULE DATE.
- Click the Abort icon. The Abort Rule dialog box is displayed with a warning ‘This results in abrupt ending of the rule’.
- 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:
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.
- 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:
- Partial Success
- Execution time of Bionic rules is set to a maximum limit of 8 hours, which if exceeded the system aborts the rule automatically.
- 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.
- 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.
- Select the required task from the list.
- 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.
- 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.
- 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.
- Click +TASK > Transformation.
- Click +Formula Field. The Formula Field dialog box is displayed.
- Select the Function option.
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.
An option to treat null values as zero is added in Expression formula type.
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
- 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.
- 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:
- 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.
- 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|
Timezone 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.
Advanced 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.
The following screen is displayed when you select Advanced as Schedule type:
Advanced scheduler uses cron expression to schedule a rule run. For more information about Cron Expressions, refer to Cron Expressions in Advanced Scheduler.
- Rules cannot run more than once in two hours.
- Historical period runs are not supported with Advanced scheduler.
- 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:
The following is the result of performing ‘Full Outer Join’ on these objects:
- 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.
- 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.
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.
Bionic 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:
- 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.
- 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
'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).
- 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.
May 2017: 5.6 Release
1. Support for Standard Objects in Bionic Rules Fetch Tasks: Previously when you selected Matrix Data, the Company, Relationship, or User objects were hidden as these objects were not supported in Bionic Rules.
Standard objects are now supported while creating CTA lifecycle from Company Object. You can start using MDA data sources such as SFDC Id, GSID, Picklist, Currency, Percentage etc. in rules without having to sync Account or Relationship data from SFDC through separate rules. Scorecard 2.0 related rules would also be easier. In short, you can incorporate Standard objects as sources and perform a wide variety of transformations, merge with SFDC objects, and perform actions.
a. Click +RULE from Administration > Rules Engine > RULES LIST tab.
b. Navigate to the Edit Rule screen where you provide the following information: the Rule Type (Bionic), Rule For (Account), Rule Name (new MDA Datatypes) and Description (optional). Click NEXT.
c. Navigate to Setup Rule > Source Standard object.
d. Select Company/User/Relationships as source standard object. All the data types which are now supported in Bionic Rules will be shown here. The following image shows the standard object (Company) and the datatypes available in it.
Note: MDA Joins (example, Company Objects has a User lookup) will not be visible in Bionic Rules. MDA Joins are not yet supported in Bionic Rules for both Custom and Standard objects.
2. Scorecard 2.0 fields are supported in Bionic Rules: You can now access the Scorecard Id, Current Score, Previous Score, and Trend fields in the standard objects such as Company and Relationship objects.
- Since MDA Join is not supported in a Bionic fetch task, you need to create two fetch tasks if you want to include both the scorecard fact and company, and merge the data in a third task.
- In Bionic Rules, you will not be able to set scores for scorecards created using Scorecard 2.0 option. The Set Score 2.0 option will not be available in the list of Actions. For this purpose, Gainsight recommends using Custom Rules to set the score for Scorecards 2.0.
3. Bionic Rule Config Preview available: Admins can now view the information about each Bionic Rule at a high-level. Perform the following steps to view the information.
a. In Rules Engine, click on any Bionic Rule name.
The Preview > RULE INFO tab is displayed. This tab displays summary information for that specific Bionic Rule.
b. Navigate to the RULE SETUP tab. High-level information is displayed:
- Task Description
- OutDataset Label (if any)
- Source Type and Source Datasets
- Export Enabled (True/False)
- Merge Details: includes the Merge Details if the Bionic Rule was merged while transforming the task
- Task Dependency Graph (Data Flow Diagram)
Note: Previously this was called ‘Tasks Execution Flow Diagram’ and appeared at the bottom of the window. Now it appears at the top.
Note: The RULE SETUP tab does not display all of the selected fields, filters, and Join conditions in the task.
RULE ACTIONS tab displays the list of actions as before. The EXECUTION HISTORY tab displays the basic details (existing feature) of tasks, including the link to download the final task output as csv.
4. Tasks dependency graph (DAG) in Bionic Rules > Setup Action: The Data Flow Diagram (DAG image) of every Bionic Rule was already available in the Rules Engine > [click on any Bionic Rule name] > Preview > RULE SETUP tab.
The same DAG image is also available at Rules Engine > [Click edit icon of any Bionic Rule] > Setup Rule screen as a task execution flow diagram.
5. Field Deletion option in Setup Rule screen: The fields that you use for setting up a Bionic Rule can now be deleted from the Gainsight Data Management page. Refreshing the specific Bionic Rule page will no longer show the particular datatype under the source object and will display a message as shown in the following image.
You can navigate to Administration > Data Management page > [add the deleted field] > Rules Engine > [re-edit the rule].
For more information about how you can delete fields that are used in Rules Engine > Bionic Rule, refer to the Field Deletion in Rules Engine article.
6. Alert appears while closing any Bionic Rules task with unsaved changes: Admins will no longer lose unsaved changes while creating or editing Bionic Rules. If you have any unsaved changes, you will now receive the following alert message if you click on CANCEL, BACK, or any other widget.
1. Formula Builder integration with Bionic Rules: The Formula fields in Bionic Rules are now supported, but the +Formula Builder button can be seen only when you perform the Transformation* (previously called Aggregation) tasks. This enhancement allows you to create different types of formulas so that you can avoid creating them on the Object directly in SFDC or MDA.
The following image shows the Transformation task as an output task where you can click the edit icon.
You can see the new +Formula Field button only when you aggregate the fetched data while transforming the task.
This feature is very similar to Calculated Fields in Custom Rule, but simpler. This will be shown as Number Field to add in the Show section while setting up a Bionic Rule. The following list describes each field available in Formula Builder > formula Field (refer the image below):
- Output Field Label: This name contains only alphanumeric and underscore characters. The label should always start with an alphabetical character.
- Output Header: This name is used as CSV Header to process action. This is view only and is generated based on the Output Field Label (but without space).
- Decimal Places: Number should be between 0 and 9
- Formula Type: When you add a Formula Field, you have the following Formula Types available:
- Expression: All arithmetic operators are considered as Expression.
- Function: Any predefined function (calculations already available in Engagement Rule) that Formula Builder supports. Bionic Rules now fills the gap of Engagement Rules as this will be deprecated soon after this release.
Note: When you select the Function check box, the following alert message appears stating that Date field is mandatory to use Trend Function type of formulas.
- You cannot create both Trend Functions and Expression in the same tasks. You can create two tasks in the same Bionic Rule - one with Trend Functions and another with Expression.
- When you create Trend Function, at least one field in GroupBy section is required.
- When you create Expression, the GroupBy section should not have any fields.
- For more information about Formula Builder and different formula types, refer to the Formula Builder in Bionic Rules article.
2. ‘Create CTA’ action enhancements in Rules Engine: Create CTA action is now more flexible. You can map/populate Custom fields and Associate Contact.
- Custom Fields: If you want to create a CTA with Custom Fields along with the Default Group of fields in Rules Engine > Setup Action, perform the following steps:
a. Ensure that you have configured the Default Group containing the Custom Fields first from Administration > Calls to Action > GLOBAL tab > Select the Default type > Detail view layout configuration section > CALL TO ACTION tab.
i. Standard fields are Read Only by default as shown in the following image. Custom fields that are marked as Read Only, will not be displayed in the Setup Action screen in Rules Engine.
ii. Custom fields that are marked as Mandatory, values must be provided in the Setup Action screen in Rules Engine.
b. In Administration > Rules Engine > + RULE (Bionic Rule - Custom Fields in Bionic Rules) > Setup Rule screen, click NEXT after adding the required datatypes in the Show and Filters sections and navigate to Setup Action screen.
c. Click +ACTION and from the Action Type drop-down list, select Call To Action.
d. Select the CTA Type. Depending upon CTA Type, it will show all the custom fields (under Additional Fields) that you Configured in Detail view layout configuration section > CALL TO ACTION tab. The following image shows an example of Additional fields section that contains custom fields configured from Calls to Action > GLOBAL tab > Select the Default type > Detail view layout configuration section > CALL TO ACTION tab.
- Associated Contact Field: For Custom Object, Standard object, and Gainsight Object, if there are any contact lookup fields available, the same can be added in the Setup Rule > Show section.
Once the lookup field is added in the Show section, it will be available in the Associated Contact field in Setup Action screen > Call to Action (Type) > Create CTA section (as shown in the following image).
3. Load to Company Action Type available in Bionic Rules: Whenever you want to update the action on Company standard object in a Bionic Rule, you can now update by selecting the Load to Company option from the Action Type drop-down list on Setup Action screen. Only Update operation will be supported.
4. Dropdown Lists support in Rules Engine > Bionic Rule and Custom Rule: With this release, ‘Dropdown Lists’ feature is introduced in Data Management.
This enables Admins to create their own Dropdown Lists by creating a new Category in MDA Account and adding new items to be available in the list.
a. Navigate to Administration > Data Management > Dropdown Lists where you have the Categories listed, or you can also add new categories by clicking +CATEGORY.
In the following example, Department is selected as Category. In this category,
b. Enter the name of the Object in the category. (here, Test for Standard Object) with in MDA Account.
c. Click +ITEM. (here, Marketing, Sales, and Business are some of the items added)
d. Navigate to Rules Engine > [click on any Bionic Rule (here, Dropdown Lists Usage)] > Setup Rule screen.
e. Select Matrix Data.
f. Select the source object (Test for Standard Objects) that was created in MDA Account in Data Management > Dropdown Lists page.
g. Drag and drop the Dropdown type in the Filters section. You can now see the same drop-down list that you created (as items) is available here. (refer the following image).
5. Aggregation Task in Bionic Rules is renamed as ‘Transformation’ Task: When you click +TASK in the Setup Rule screen, the ‘Transformation’ task option is now available in place of ‘Aggregation’.
February 2017: 5.5 Release
Rules Engine supports new data types in MDA: With this release, Gainsight Data Management (GDM) supports Currency, Percentage, Email, Picklist, SFDCID, and GSID data types. These new data types are also supported by the Rules Engine module. Earlier, the Percentages and Currency fields were defaulted to Number; the SFDCID and Email fields were defaulted to String; but now you can see the currency and percentage data type fields. You can also add these fields in the Show and Filters sections and map them in the Action stage. In a rule, you can also fetch fields from the standard objects like GS Company or GS User (shipped with this release).
The following image shows an example where Currency, Email, and SFDCID fields are selected.
Note: Standard objects will not be available to be used as Source in Rule setup. Admins can import the data from SFDC more frequently using Gainsight - Connect. Customers cannot load Standard objects using Rules Engine, but when an object in MDA is selected and that has a lookup on a standard object, the standard object will be accessible in rules. This is not supported in Bionic Rules, since MDA joins is not supported
- Create Milestones for Relationships: In Rules Engine, Admins can configure rules to automate milestone creation for Relationships. The list of the milestones are now displayed for both Account and Relationship types. Relationship tokens (based on the selected Relationship type) are available while adding comments. Refer Create Milestones for Relationships in Rules Engine.
- Bionic Rules in Rules Engine: A new rule type is available in Administration > Rules Engine > + RULE > Edit Rule > Rule Type which can perform multiple fetches and transformations in a single rule; including tasks to fetch data from multiple sources, merge, aggregate, pivot and then load to an object. Previously, multiple objects used to be joined and flattened by a series of Custom Rules, but now this can be accomplished with a single bionic rule.
Data is not required to be duplicated or loaded to temporary tables to get the Account Lookup and aggregate. For more information, refer to the Getting Started with Bionic Rules.
- Bionic Rules helps you reduce the rules created and all MDA custom objects (Redshift only) created by enabling Admins to work with multiple data sets from multiple data sources; as well as process the data and perform actions.
- Also see the following Tutorials:
- Enhanced Filter Component is integrated in Bionic Rules and Custom Rules. This new improvised Filter component honors the Custom Lookup options based on the Rule/Relationship Type options chosen and shows only those values in the Filters.
- Link the ‘Linked Objects’ to CTA through Rules Engine: Previously, CSMs used to manually search for a specific record and link it in the CTA Detail View, but now with this enhancement, all CTA relevant records can be linked through Rules Engine. All Linked Objects that are linked to the CTA type will be available in the drop-down. When a linked object is selected in the drop-down, Admins can choose the field to which it should be linked from the Show fields.
- Prevent the creation of repetitive CTAs: Admins can select the Create CTA once in check box in the Create CTA action to prevent the creation of CTAs based on the timeframe selected. A separate check box will be available for separate actions.
- Include CTA ID as Identifier: In the Close CTA action, Admins can now select the CTA ID > Include in identifiers check box to validate if the CTA ID should be included in identifiers while closing CTAs.
Note: When you select the Include in identifiers check box, the Type, Source, Reason, and Set CTA status to fields will become disabled and restricts the rule to mapping only with the CTA ID field. Only CTA ID will be used as an identifier while closing the CTA.
- Close Success Plan Objective CTAs: Admins can now select the Objective option from the CTA Type drop-down list to close Objective CTAs from the Rules Engine.
If the CTA type is Objective, the Objective Category field will be visible instead of Reason, and the Survey option is disabled in the Source drop-down as shown in the following image.
- ‘Close CTA’ action for Relationships in Rules Engine: CTA types associated with relationship types are available in the CTA type drop-down. CTA status associated with the Relationship type, CTA type, Global active All, and Private All are available. CTAs of the selected Relationship type can be closed.