Create a Module

To create a module, follow the steps below:

  1. Select the grid icon, grid.png, in the top left corner and select Solutions Studio.

  2. Select the solution you want to create the module in.

    02f74f1-create_module_1.png
  3. In the desired solution, select + Add Module. A dropdown displays that provides two options:

    • Create New - Create a new, empty module.

    • Use Template - Create a new module using a template as a starting point.

    add_new_module.png
  4. Select either Create New to create a custom module or Use Template to create a module based on an existing template.

Create New Module

If you select Create New, the Create A New Ops Module window displays. Enter a descriptive name for your module and then select Create.

create_new_ops_module.png

Use a Module Template

If you select Use Template, the Ops Modules Templates screen displays.

  1. Browse the available templates by selecting the categories in the sidenav and select a template that fits your needs.

    ops_modules_template.png
  2. Select a solution from the dropdown to add your module to and select Create module.

    ops_module_template_name.png

Select a Data Source

To automate a process, your module needs access to the right data. To choose from available data sources, select the Input Source tile, labeled Start here, in the top left corner of the module builder screen.

Your admin must connect data sources to your Tonkean instance before you can use data from these sources in any of your modules.

create_module_select_data_source.png

In the Configure Input Source panel, you have several options:

  1. Manual List - These can be items such as a form, a business report where you may manually enter items in, or data that is coming from another Tonkean module. The most popular use case is with a form. The data from the user-submitted form, once submitted, will then be monitored by this module and the appropriate action will be taken.

  2. Scheduled List - Think of this as batch reporting, for a list of items you want to always be taken through a specific workflow. You can select the cadence (every X minutes, hours, days, weeks) for when this list should run.

  3. Data Sources - This is where all the 1,000+ software integrations Tonkean connects with come into play. If you've already connected some data sources to this module, you'll see them listed here. If a data source isn't connected, you can simply select the + Add Data Source button at the bottom and select from our list of integrations that pop up in the window. Selecting one of the existing or new integrations will give you the option to either:

    1. Bring in all the data for the specific data source.

    2. Filter the data, bringing in only a specific subset of data to monitor. In the example below, you can see that the module is pulling in only Salesforce accounts where the Customer Priority is High.

      create_module_data_source_options.png

You can have multiple conditions, where either all of them can be required or at least one needs to match in order for the data source to be configured. Select the plus icon to add more conditions to the criteria.

Select Preview Items to view a sample of the data that will be pulled from that data source. Ensure that the data being pulled in is correct and accurate. You can view the detailed data within Tonkean by selecting View or open the actual record with the integrated software in a new window by selecting Open.

create_module_data_source_view__open.png

Select Save to return to the module’s workflow and you'll now see an image of the data sources logo. You can now proceed with Setting Up TriggersSetting Up Actions, or bringing in more specific Update Fields from that data source.

Map Fields

Fields provide Tonkean with the power to pull and push specific data from multiple data sources. It's incredibly important that you select the necessary fields you want to be monitoring and tracking so that Tonkean can work properly.

There are two separate entity types in Tonkean, and many fields within these entities for each data source:

  • Root Entity - This is the data source that is being monitored by Tonkean. In the above example, these are Salesforce Accounts, filtered by High Customer Priority. However, there are 11 default Tonkean fields, all but one (Title) are optional to use in your modules.

    create_module_fields_root_entity.png
  • Matched Entity - This is the data that is mapped to another data source to "match" two fields together. Matched Entities are an advanced function in Tonkean. See Add Matched Entities for more information.

Some of these fields will be automatically used by the module for use in triggers, business reports, and other parts of the module workflow. You can use the above fields to help trigger certain actions, much like you could with custom data integrations.

If you're ever looking to change the example input data as you continue building out your module, selecting the Preview link will open up a new window showing you the data, and giving you the option to Change the example.

For more information about mapping fields, see Create and Manage Fields.