This article covers the information in the old version of Author Studio. If you are using the most current version of Author Studio released in the fall of 2023, see our Author Studio Documentation here.
Browser Compatibility
For the most secure and best experience using Author Studio™, the latest version of the below preferred browser is recommended.
Author Studio supports the following browsers:
Accessing Author Studio
Within Author Studio™, there are multiple ways to log in, including Single Sign-On (SSO).
Login with Single Sign-On (SSO)
Author Studio allows for SSO through both Azure® AD and Okta.
Login with Email
Login to Author Studio using an email address and password.
Reset Password
- To reset the password, log out of the application and return to the login screen.
- Enter email address and select Forgot Password.
- Check email account and follow the steps to reset password.
-
If the reset email failed to be received:
- Check Spam and Bulk Mail folders.
- Add no-reply@InRule.com to the address book.
Author Studio and the InRule Decision Platform
At InRule Technology®, we make automation accessible. We do it faster, with more accuracy and transparency than anyone else. The InRule Decision Platform solves organization's challenges by:
Architecture Overview
From server-based REST deployments to serverless environments that take advantage of the flexibility and scalability of the cloud, the InRule Decision Platform has a deployment option to meet your organization’s goals and requirements.
Because our decision platform is so flexible, it can be leveraged in almost any application either in process or through a service-based architecture so that the same decision logic can be defined once, saved to the catalog, and executed wherever and whenever it is needed. The catalog database acts as your organization’s single source of truth.
Author Studio™ complements the family of products, empowering authors with the flexibility to edit rules from anywhere.
Author Studio Experience
The layout of Author Studio™ is built with a user-friendly interface. The simplicity of the layout makes it easy for you to load assets, make changes, and create intuitively.
Author Studio Workspace Explained
The overall layout consists of Navigation Pane, Workspace, and Properties Panel.
| Navigation Pane |
The primary navigation of the page allows you to jump to your desired spot quickly. Items selected will load in the workspace. The core sections are Model, Author, Test, and Publish.
You can select the collapse arrow to minimize the Navigation Pane for maximum workspace capabilities.
| Workspace |
Workspace is the primary functional area of Author Studio. Here is where most activities and selections will occur.
|
Properties Panel |
The Properties Panel displays metadata for the item selected in the workspace. If no item is selected, then the Properties Panel displays the metadata for the parent item.
You can select the collapse arrow to minimize the Navigation Pane for maximum workspace capabilities.
Navigation in Author Studio
Breadcrumbs
Breadcrumbs allow you to see where you are. The hierarchy uses a Component Naming convention. When editing a rule, the breadcrumb will end with the rule type. You can quickly jump around within the workspace by clicking the location within the Breadcrumbs.
Managing a Rule Application from the Navigation Pane
The Navigation Pane operates within a selection hierarchy. When a rule application is selected, then Decisions, Rule sets, and Validate load the data in the Workspace for the selected rule application.
Support Options
- You can review the Author Studio Documentation for detailed explanations and answers to the most common questions.
- If you are on a trial and have questions, please email your questions to info@inrule.com.
Additional details on how InRule Support may be able to help you can be found in the article, Get Help.
Rule Sets
A rule set is a container for a group of logically related rules and actions. Rule sets are functionally significant because they establish when and how the underlying rules are executed. This is accomplished by setting the Fire and Run Modes for the rule set. Rule sets may also be activated and deactivated individually or by category to further control the flow and behavior of rule execution.
Rule sets can be created in both irAuthor® and Author Studio™. Read more about creating rules in Author Studio in the article, Creating a New Rule Set
Three Types of Rule Sets in Author Studio
Entity Rule Sets
Entity Rule Sets are based on an entity context and apply to all instances of the entity. They are the most commonly used of the three rule set types. The associated entity establishes the authoring and execution context for the rule set to operate against, essentially defining which fields are available to the rule set.
One goal when authoring rules is to keep the logic in a rule set as atomic as possible without having to reach across contexts; an Entity Rule Set lends itself to this approach as it defines a limited and relevant logical context for the rules. Entity Rule Sets are typically the recommended authoring model for new users.
Decision Rule Sets
A decision always begins with a DecisionStart rule set and contains a set of inputs that can be different from its outputs. The rules within a Decision execute against the inputs and then the outputs reflect the results. Decisions allow authors to only pass in the data that is needed to make a decision. Decision Rule Sets always use explicit fire mode.
Independent Rule Sets
Independent Rule Sets do not have an inherent associated entity context like Entity Rule Sets or Decision Rule Sets. They are currently disabled and will be available in future releases of Author Studio.
Rule Set Workspace
| Name |
Rule set name. Click the rule set name to load the rules page. The rules page will show all the rules within the selected rule set.
| Context |
Identifies the context for the rule set.
| Fire Mode |
Identifies the selected Fire Mode for the rule set. Make modifications to the Fire Mode by selecting the rule set to load the properties panel.
| Description |
Identifies the description for the rule set. Make modifications to the description by selecting the rule set to load the properties panel.
| Modified By |
The user that last made a modification to the rule set.
| Date Modified |
The time the rule set was last modified.
| New Rule Set |
Create a new Decision Rule Set or Entity Rule Set.
| Delete Rule Set |
Delete a Decision Rule Set or Entity Rule Set by hovering over the rule set to see the Delete icon on the far right of the row. The items under the rule set will also be deleted.
Properties Panel
Within the workspace, when a rule set is selected, the properties panel will appear.
| Name |
The title of the rule set is saved here.
| Description |
The description of the rule set is saved here.
|
Enabled |
The user can enable or disable the selected rule set. The disabled rule set will not run when the rule application is executed. Enabled slider is available for both decision rule set and entity rule set
Fire Mode Settings
Rule sets are functionally significant because they establish when and how the underlying rules are executed. The Fire Mode allows the user to select when the rule set will fire.
Decision Rule Sets always use explicit fire mode. Therefore, the Decision Rule Set properties panel will not show the fire mode settings.
| Auto Sequential |
Auto Sequential specifies that the rule set and its associated rules are always "on.” Unlike Auto Optimized rule sets, Auto Sequential rule sets execute in the order they appear in the list. These rule sets will fire any time a dependency for a top-level rule condition changes as the result of running a subsequent rule set.
| Auto Optimized |
The engine will automatically recalculate a condition within the rule set any time any of its dependent values change. These rule sets do not fire in the order they are authored—the engine decides the sequence based on a proprietary optimization algorithm. These rule sets will continue to fire until all of its conditions are satisfied. Only a limited set of actions are available in an optimized rule set.
| Auto Single Pass |
Auto Single Pass rule sets execute in the order they appear in the list, and execute only once, even if a dependency for a top-level rule condition changes during the execution of a subsequent rule set.
| Explicit |
An Explicit Rule Set will be executed only when explicitly instructed to do so by action or calling application. An Explicit Rule Set is appropriate for procedural operations and will not get re-fired automatically by the engine.
The user can enable or disable the selected rule set. The disabled rule set will not run when the rule application is executed. Enabled slider is available for both decision rule set and entity rule set.
Decisions
A decision is a method of executing rules with clear inputs and outputs, and a specific starting point. A decision always begins with a DecisionStart rule set. It has a set of inputs that can be different from its outputs. The rules within a decision execute against the inputs and then the outputs reflect the results. Decisions allow authors to only pass in the data that is needed to make a decision.
Decisions Workspace
| Name |
Decision name. Click the decision name to load the rule set page. The rule set page will show all the rule sets within the selected decision. Name modifications are made in the properties panel.
| Description |
Decision description. Description modifications are made in the properties panel.
| Modified By |
The user that last made a modification to the decision.
| Date Modified |
The time the decision was last modified.
Properties Panel
Within the workspace, when a decision set is selected, the properties panel will appear.
| Name |
The title of the decision is saved here.
| Description |
Allows users to enter a description for the decision.
Working with Decision Tables
Decision tables are a powerful way to represent a set of related business rules in matrix form. They are exceptionally useful in modeling and maintaining large sets of complex business decisions in a compact format.
A decision table is made up of conditions and resulting actions. The resulting matrix of conditions and actions is displayed in a precise yet compact tabular manner, as rows of rules, which can be easily managed by business users.
The decision table evaluates from the top down until it finds a path where all conditions resolve to True. Business experts can easily check the logic represented in a decision table for consistency, completeness, and correctness.
Decision Table Workspace
| Filter |
The Filter checks the input within all columns and rows. If there is a match, the complete row will show for the match. The filter allows for large data sets to be easily searched.
| Condition |
Selecting Condition will add a new column to the decision table.
Each defined Condition Set creates a corresponding column in the decision table. Specific instances of named Expressions are defined for each Condition in a Condition set, which will populate the selections for each row in the Condition's column within the decision table.
There are many options for defining Conditions: Simple field comparison, Syntax Expression, Business Language Expression, or building the conditions from a value list.
| Action |
Selecting Action will add a new column to the decision table.
The end result of the logic path through a decision table is determined by a set of defined Actions. Multiple Action Sets can be defined (each being a column in the decision table) with many Actions for each set. These Actions will then be available to associate with a row of conditions in the body of the decision table.
| Row |
Selecting Row will add a new row to the decision table.
| Save |
Saves any of the changes made to the decision table.
Column Editor
Manage the content of the columns by selecting the column header and selecting desired options.
Pencil Icon
Evaluate for this Entity Field
- Links an action or a condition to a specific entity field from the list of entities that are available in the dropdown.
Condition Display Name (optional)
- Specifies the name of the Condition Set that appears in the decision table column header.
Value List (under Advanced Options)
- If the Condition is linked to a Field, a value list may be selected to automatically populate the Condition Set.
Add Column Icon
When clicked, the editor adds the same column type as an active column.
Trash Icon
Deletes the column.
Row Editor
Manage the content of the rows by selecting the row ID and selecting desired options.
Add Row Icon
Adds a new row.
Copy Row Icon
Copies and pastes the selected row below.
Trash Icon
Deletes the selected row.
Cell Selection for Condition
Select a Value
When a cell is selected, there is an option to select from the connected Value List. A data selection can be made by selecting a value.
The Any option provides for a catch-all that essentially triggers the Condition to True.
Enable -Any- Option
Check or uncheck the -Any- option for the condition column by clicking on the edit icon on the condition heading. The -Any- option will appear in the values dropdown when the -Any- option is turned on.
Edit a Value
An existing value can be edited by clicking on the Edit icon that appears to the left of the Trash icon. Editing the value will update all cells with that value.
Delete a Value
Data from the Value List can also be removed from the decision table, by clicking on the Trash icon.
Select + New Value
In the current release of Author Studio™, Field is the only active Condition Type that can be selected. In future releases, Expression and business language will become active fields.
- Select an Expression and enter the appropriate Value(s) for the desired condition.
- Under Condition Display Name (optional), enter a name desired to be shown when the value is set to True.
Cell Selection for Action
Select a Value
When a cell is selected, there is an option to select from the connected Value List. A data selection can be made by selecting a value.
The Ignore option means the cell will be ignored as if it did not exist.
Delete a Value
Data from the Value List can also be removed from the decision table by clicking on the Trash icon.
Select +New Value
Enter a Value to be placed in the cell.
Action Display (optional) enter a name desired to be shown in the value dropdown list and in the cell when selected.
Drag and Drop Functionality
Columns and rows are designed to be dragged and dropped for easy ordering. Click and drag the decision table rows to change the execution order.
Properties Panel
| Name |
The title of the decision table is saved here.
| Description |
The description is saved here.
| Enabled |
The user can enable or disable the selected decision table. Disabled decision tables will not run when the rule set is executed.
| Runtime |
Compatibility Mode
- When checked, the identity of conditions that evaluate and actions that execute will include the row identifier (e.g. Row3). Turning this feature on will result in slower compilation and execution performance.
- Note: If the Run Mode of the parent rule set is Auto-Optimized, Compatibility mode is the only option and must be used.
| Exit At First True |
When checked, the decision table will stop evaluating rows after a row matches its conditions and executes its actions. If unchecked, execution continues to evaluate the remaining rows in the table and executes actions for any row whose conditions match.
Deleting a Decision Table
1. On a rules page hover over a decision to see the Delete icon on the far right of the row.
2. Click on Delete and confirm.
3. A toast notification confirms that the decision is deleted.
Deleting a Language Rule
1. On a rules page, hover over a language rule to see the Delete icon on the far right of the row.
2. Click on the Delete icon and confirm.
3. A toast notification confirms that the language rule is deleted.
Business Language Template Reference
Please see the most recent version of the article, as this information is relevant to all versions.
Business Language Tutorials
Please see the most recent version of the article, as this information is relevant to all versions.
Working with the Language Rules Editor
The Author Studio™ business language rule editor is designed to make working with and authoring rules in business language as easy as possible. InRule®’s business language authoring offers a highly intuitive medium to author rules using English-like syntax with menu-driven, point-and-click interface. These simple-to-use features further extend InRule's unique ability to efficiently manage sophisticated rules and complex calculations.
Click here to view the Business Language Template Reference.
Activating the Editor
To activate the editor, the rule application must be checked out. If the rule application is not checked out, the user will be prompted to check the rule application out. To learn how to check a rule application out, read the article Rule Application Check-Out and Check-In. Once you have checked the rule application out, you can start editing by double-clicking on the editing workspace and letting it load.
The Editor Bar
Shortcut Keys
When there is a keyboard shortcut key, the shortcut is identified by hovering over the widget within the Toolbar.
Undo
The Undo feature allows you to step backward in the order of the changes the user has made. There are a total of five historical steps that can be remembered. Once the changes have been saved or discarded, the undo feature clears its history and starts over. Shortcut keys can be used for this function by pressing Ctrl+Z for PC or Cmd+Z for Mac users.
Redo
The Redo icon allows you to revert an Undo. Once the changes have been saved or discarded, the undo feature clears its history and starts over. Shortcut keys can be used for this function by pressing Ctrl-Y for PC or Cmd-Y for Mac users.
Insert
The Insert icon allows you to add another action. This action will be added above the selected action.
Move Up
Use the Move Up icon to move an action’s location upward within the hierarchy. When an action is selected, that action will move up one spot per click. If the action cannot be moved, the Move Up arrow will not be clickable.
Move Down
Move an action’s location downward within the hierarchy by using the Move Down button. When an action is selected, that action will move down one spot per click. If the action cannot be moved, the Move Down arrow will not show as a clickable feature in the toolbar.
Expand Selection
The Expand Selection feature allows you to select an action and then expand the selection through the hierarchy. As a result, the user can quickly select an action(s) and then the parent actions. Shortcut keys can be used for this function by pressing Ctrl-Up arrow for PC or Cmd-Up for Mac users.
Contract Selection
Clicking the Contract Selection icon enables you to select an action and then contract the selection through the hierarchy. As a result, the user can quickly select an action(s) and then the child's actions. Shortcut keys can be used for this function by pressing Ctrl-Down arrow for PC or Cmd-Down for Mac users.
Copy Selection
Copy Selection allows you to highlight actions and copy them to the clipboard, making them pasteable. In the cases where a highlighted action is not copyable, the Copy Selection icon will not show as a clickable feature in the toolbar. Shortcut keys can be used for this function by pressing Ctrl-C for PC or Cmd-C for Mac users.
Cut Selection
The Cut Selection tool allows you to highlight actions and cut them from the editor. This places the cut actions onto the clipboard, making them pasteable. In cases where a highlighted action is not cuttable, Cut Selection will not show as a clickable feature in the toolbar. Unlike the Copy Selection, the Cut Selection removes the selected section highlighted. Shortcut keys can be used for this function by pressing Ctrl-X for PC or Cmd-X for Mac users.
Paste Selection
The Paste Selection icon becomes active when an item is copied or cut and put onto the clipboard. When selected, the section copied or cut will then be pasted above where the cursor is in the editor. Pasted items will paste with the same hierarchy as they had when copied or cut. Shortcut keys can be used for this function by pressing Ctrl-V for PC or Cmd-V for Mac users.
Delete Selection
Delete Selection becomes active when an action item(s) are selected. The shortcut key for this function is pressing Delete.
Adding a Decision Table
On a rules page, click New and select Decision Table. Author Studio™ will create a new decision table that is ready to populate.
In the workspace, you have the ability to create and combine multiple conditions with resulting actions. Read the article, Working with Decision Tables to learn more about decision tables.
Properties Panel
| Name |
The title of the decision table is saved here.
| Description |
The description is saved here.
| Enabled |
You can enable or disable the selected decision table. Disabled decision tables will not run when the rule set is executed.
| Runtime |
Compatibility Mode
- When checked, the identity of conditions that evaluate and actions that execute will include the row identifier (e.g. Row3). Turning this feature on will result in slower compilation and execution performance.
If the Run Mode of the parent rule set is Auto-Optimized, Compatibility mode is the only option and must be used.
| Exit At First True |
When checked, the decision table will stop evaluating rows after a row matches its conditions and executes its actions. If unchecked, execution continues to evaluate the remaining rows in the table and executes actions for any row whose conditions match.
Adding a Language Rule
InRule’s Business Language Authoring offers a highly intuitive medium to author rules using English-like syntax and point-and-click authoring. These simple-to-use features further extend InRule's unique ability to efficiently manage sophisticated rules and complex calculations.
- On a rule page, click New and select Language Rule. This creates a business language rule.
- In the workspace, you have the ability to add a language rule using your keyboard and toolbar-driven interaction that is easy to follow with available tooltips. Context-aware choices in the language editor will help in selecting the relevant conditions and associated actions.
Properties Panel
| Name |
The title of the decision table is saved here.
| Description |
The description is saved here.
| Enabled |
You can enable or disable the selected rule. Disabled rules will not run when the rule set is executed.
Rules
Please see the most recent version of the article, as this information is relevant to all versions.
Creating a New Rule Set
In the Rule Sets workspace, there is a New Rule Set button. When you click on this button, you are presented with three options:
- Entity Rule Set
- Independent Rule Set
- and Decision Rule Set.
Independent Rule Set is disabled and will be functional in a later release of Author Studio™
Decision Rule Set
- When you select Decision Rule Set, a prompt will ask you to select the parent decision name of the rule set.
- Once selected, a new rule set will be created and nested below the selected decision. You will have the ability to modify the rule set properties in the properties panel window.
Entity Rule Set
- By selecting Entity Rule Set, a prompt will ask you to select the context of the rule set.
- Once selected, a new rule set will be created and you will have the ability to modify the rule set properties in the properties panel window.
Properties Panel
| Name |
The title of the rule set is saved here.
| Description |
The description of the rule set is saved here.
Fire Mode Settings
Rule sets are functionally significant because they establish when and how the underlying rules are executed. The Fire Mode allows you to select when the rule set will fire.
Decision Rule Sets always use explicit fire mode. Therefore, the Decision Rule Set properties panel will not show the fire mode settings.
| Auto Sequential |
Auto Sequential specifies that the rule set and its associated rules are always "on.” Unlike Auto Optimized rule sets, Auto Sequential rule sets execute in the order they appear in the list. These rule sets will fire any time a dependency for a top-level rule condition changes as the result of running a subsequent rule set.
| Auto Optimized |
The engine will automatically recalculate a condition within the rule set any time any of its dependent values change. These rule sets do not fire in the order they are authored—the engine decides the sequence based on a proprietary optimization algorithm. These rule sets will continue to fire until all of its conditions are satisfied. Only a limited set of actions are available in an optimized rule set.
| Auto Single Pass |
Auto Single Pass rule sets execute in the order they appear in the list, and execute only once, even if a dependency for a top-level rule condition changes during execution of a subsequent rule set.
| Explicit |
An Explicit Rule Set will be executed only when explicitly instructed to do so by an action or calling application. An Explicit Rule Set is appropriate for procedural operations and will not get re-fired automatically by the engine.
Rule Application Check-Out and Check-In
To begin modifying a rule application, it must first be checked out.
Workflow and Rules
- When a user checks out a rule application in Author Studio™, all logged-in users can edit that checked-out rule application in Author Studio. Users will not be able to edit in irAuthor® when the rule application is checked out in Author Studio.
- When a user checks out a rule application in irAuthor, only that user can edit that rule application in irAuthor. Editing that application will not be possible in Author Studio while it remains checked out in irAuthor.
- The rule application will remain checked out until check-in or undo check-out occurs.
- Pending changes can be viewed on the rule application page in the Activities section.
- The user initiating the check-out is the only user who can check in or undo check-out in the rule application.
- The process, once initiated in Author Studio, must be completed in Author Studio.
Check-In
The check-in process saves all changes made in a new revision of the rule application. Add a comment while checking in to describe and track what changed in this version. Currently, check-in comments can be seen in irAuthor and Web Catalog Manager.
Undo Check-Out
Undo Check-Out discards any changes made within the rule application. This includes the changes made to any decisions or any rule sets by any user.
This process cannot be undone.
Once Undo Check-Out is activated, the rule application would need to be checked out again if the user wants to make further modifications.
Rule Application List
The rule application list contains all the rule applications in the associated catalog. Click on Rule Application List in the navigation pane to see the list of rule applications.
Rule Application List Workspace
| Name |
Rule application name. Click on the name to navigate to the rule application page.
| Status |
Identifies the current status of the rule application.
-
Ready to check out
The rule application is available to check out in Author Studio™. To edit the rule application, navigate to the rule application page by clicking on the rule application name and then clicking on the Check Out button. -
Continue editing
The rule application is checked out currently and can be edited by all users who can access this rule application via Author Studio. -
Locked by
The rule application cannot be checked-out in Author Studio right now because another user has checked it out in irAuthor®. -
Need to pull updates from
There are changes that a user from irAuthor has checked in. Navigate to the rule application page by clicking on the rule application name and check out the rule application in Author Studio to pull in those latest changes.
| Modified By |
The user that last checked in or made a modification to the rule application.
| Date Modified |
The time the rule application was checked in or last modified.
| Revision |
The latest revision number of the rule application.
| Reset to Latest |
The Reset to Latest button appears on the right-hand side when hovering over a rule application row. Clicking on this button will revert the rule application to the latest checked-in revision. All edits from the current session will be undone.
Rule Application
A rule application is a collection of rules grouped as Decisions or Rule Sets. Click on a row in the rule application list to navigate to a rule application page. Here the user can check out and check in the rule application as well as see activity data.
Rule Application Workspace
Activities Section
While a rule application is checked out, all activity for the underlying rule application will be listed. Once check in occurs, all activity will be purged.
| Activity Type |
Identifies the activity that occurred. Options include:
- Added Rule Set – A new rule set was added.
- Updated Rule Set - A rule set was updated.
- Deleted Rule Set - A rule set was deleted.
- Updated Rule Application - A Rule application was updated.
- Updated Decision - A decision was updated.
- Updated Language Rule – A language rule was added or updated.
- Deleted Language Rule – A language rule was deleted.
- Updated Decision Table– A decision table was added or updated.
- Deleted Decision Table– A decision table was deleted.
| Name |
Identifies the rule application element.
| Context |
Identifies the entity context and the rule set name.
| Modified By |
Identifies the user that made the modification.
Properties Panel
The properties panel can be edited only when the rule application is checked out.
| Name |
The title of the rule application is saved here.
| Description |
Allows users to enter a description for rule application.
| Check In and Check Out |
Allows a rule application to be checked out and checked in. Click here to learn how to use this feature.
Comments
0 comments
Please sign in to leave a comment.