Skip to main content

Create a Module

Each solution is made of modules. Modules house all the custom workflows, connect all of your data sources together, and give you the power to take actions based on the criteria you set up. Within each module, Tonkean provides you the ability to say "when" an event happens and the actions to take.

Modules are typically built and organized as distinct, operational workflows or automations that orchestrate business processes between people, systems, applications, and data. This organization allows modules to remain simple to understand as they are iterated on and enhanced over time.

To create a module, follow the steps below:

  1. Select the main nav icon, grid.png, in the upper left 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 module template from the Component Library 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 a module 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

Your new module opens in the module builder.

new_custom_module.png

Select an Input 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. Using a create form is the most common use case. The data from the user-submitted form, once submitted, is monitored by this module and the appropriate workflow logic runs.

  2. Scheduled List - This is similar to 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 - Choose from the 1,000+ software integrations Tonkean supports. If you've already connected data sources to this solution, those data sources display here.

    If a data source isn't connected, you can simply select the + Add Data Source button at the bottom and select from the list of data sources that display. Selecting one of the existing or new integrations offers one of the following options:

    1. Bring in all the data source records of the available entity (for example, all Emails from an email inbox or all Messages from a Slack instance).

      config_input_source_all_items.png
    2. Filter the data, bringing in only a specific subset of data to monitor. In the example below, the module is pulling in only Slack messages from the "Welcome to the Team" channel.

      config_input_source_custom_filter.png

You can have multiple conditions where either all of them can be required or at least one must match for the data source to be configured. Select the + AND to add more conditions to the criteria.

Select Preview Items & Save to view a sample of the data that will be pulled from that data source, if available. Ensure that the data being pulled in is correct and accurate on the Input source items preview window.

input_source_items_preview.png

To view the fields for each data source record, select Inspect.

When finished, select Save. The module builder screen displays. Notice there's now an image of the data source logo on the Input Source tile. You can now proceed with Setting Up TriggersSetting Up Actions, or bringing in more specific Fields from that data source.

Use a Module Template

If you select Use Template, the Component Library screen displays.

The Component Library is a popular way to get started building in Tonkean. It contains ready-to-go components you can import into your board and begin customizing to suit your particular needs and business process.

  1. In the side panel, select Module Templates. The Module Templates screen displays.

    select_modules_templates.png
  2. Select the template you want to import. The template detail screen displays.

    select_template_tile.png
  3. Browse the template detail screen to confirm this is the template you want to import, then select Import. The Download Module window displays, featuring a list of boards you have access to.

    select_import_template.png
  4. Select the board you want to import the template into. A list of solutions you have access to on the chosen board displays.

    Use the search field to quickly locate a specific board.

    select_board_for_module_template.png
  5. Select the solution you want to import the template into. A list of sections you have access to in the chosen solution displays.

    select_solution_for_template.png
  6. Select the section you want to add the template to. A list of data sources the module contains displays.

    choose_solution_section.png
  7. For each data source the module uses, there is a placeholder in the template. You must select an existing instance of that data source from your solution or create a new connection to make the relevant part of the module functional.

    1. To select a connector for each data source in the module template, select Select Connector and choose from an existing instance of that data source in your solution, or choose to create a new connection.

      select_connector_dropdown.png
    2. If you choose to connect an existing data source, the data source automatically connects.

      If you choose to create a new data source connection, the Set Up Data Source window displays. Enter the relevant information and select OK.

      set_up_new_data_source.png
    3. Repeat this process for each data source or select Finish setup later to configure these data sources after the module is added to your solution.

      finish_setup_later.png
  8. Ensure you've chosen the right board, solution, and section, then select Confirm. The module template is imported into your solution.

    confirm_template_import.png

The module templates open in the module builder in your chosen solution. From this point, you can explore and customize the module workflow. Select an action or trigger block to see the configuration details.

The module features a complete workflow, but you must connect all relevant data sources and customize each action and trigger to reflect your unique data to build a functional module. The template is designed as a starting point and in most cases is not plug-and-play.

module_imported.png