Module Tool Parameters and Settings

Module Tool Parameters and Settings

This guide is about defining module tools’ parameters and other possible tool-specific settings. For more information about the module tools in general, see the guide Module Tools. There is also a separate guide for creating and using the Convert Lead tool, Convert Lead.

Parameters

You can set parameters for the module tool to for example fetch/supplement information from the source entity or fill in the field with certain information:

  • The formula for parameters when fetching information from another module: target field={$source field} (e.g. cf_1103={$cf_1499}).
  • The formula for parameters when fetching information from the same entity: target field=the wanted value/text (e.g. in a picklist: cf_1548=Approved   OR   in a text field: cf_5823=This is an example).

When writing the parameters, in some cases it is important to take into consideration the module, that the module tool is created into. E.g. if you are creating a tool for Accounts module, which creates a new contact for an account, the link between the account and contact is made with the parameter account_id={$ID}. Whereas when you are creating a tool for Contacts module, which creates a new potential for a contact, the link to the contact’s account is made with account_id={$account_id}.

There are examples of using the parameters below. For clarity, they all have been written for “Link to other module” module tools, but the parameters work the same way in any other module tool you can write parameters for.

Example 1: Creating a tool for Accounts module that creates a new Contact for the Account (by linking the Contact to the Account with a parameter account_id={$ID} , see the picture below).

 

Example 2: Creating a tool for Accounts module that creates a new Event for the customer (by adding an account relation to the event and determining the activity type with parameters activity_mode=Events&account_id={$ID} , see the picture below).

 

Example 3: Creating a tool for Contacts module that creates a new Potential for the contact (by adding an account relation and a contact relation to the potential with parameters contact_id={$ID}&account_id={$account_id} , see the picture below).

 

Example 4: Creating a tool for Potentials module that creates a new Event with subject, campaign, potential, contact and account relations to the potential with parameters activity_mode=Events&subject={$potentialname}&campaignid={$campaignid}&account_id={$accountid}&contact_id={$contactid}&parent_id={$ID} (see the picture below).

 

Example 5:  Creating a tool for Trouble tickets module that creates a new Event, whose subject is the ticket’s subject, status is Held and type is Meeting (by linking it to the trouble ticket with parameters activity_mode=Events&subject={$ticket_title}&eventstatus=Held&activitytype=Meeting , see the picture below.

 

Example 6: Creating a tool for Quotes module that creates a new Document (by linking it to the quote with parameters parent_id={$ID}&notes_title={$subject} , see the picture below).

 

Example 7: Creating a tool for Quotes module that creates a new Event (by linking it to the quote with parameters activity_mode=Events&subject={$subject}&campaignid={$campaignid}&account_id={$account_id}&contact_id={$contact_id}&quote_id={$ID} , see the picture below).

 

Convertmode

With the “Link to other module” module tool you can convert entities that have row level information into another entity with row level information with a specific convertmode parameter. For example with the following parameters, you can convert a quote to an invoice: record={$ID}&contact_id={$contact_id}&convertmode=quotetoinvoice

Other convertmode parameters are e.g. quotetoso (quote into salesorder) ja sotoinvoice (salesorder into invoice).

Other Tool-Specific Settings

Email tools

There are two types of module tools that you can send email with: in some cases, you must determine the content of the email with a separate email template (when using the tool, the system opens a pop-up for writing the email), while in other cases, like with the tools Email document template (Generic), Notify User (Generic) and Mail reminder (Invoice), there are specific fields for the email’s information (see also the picture below):

  • Target User – select the recipient for the email, the options depend on the module tool chosen. One option is always Custom, with which you can determine a fixed recipient in the field Custom Email Address.
  • Email Subject – the subject of the email.
  • Email Body – the email content. It is possible to use tags in this field, for more information see the guide Tags in Emails Sent by Module Tools.

With the module tools Email document template (Generic) and Mail PDF (Generic) you can email PDF templates by selecting the template from the picklist in Templates or Attachments section. With the Mail PDF tool, it’s also possible to add up to two other attachments from the user’s computer (see the picture below). You can also name the attachments with custom titles. The Remove attachments disables the use of the extra attachments.

With the Send email template (Contacts) module tool you can send an email template to a contact by selecting the template from the Email template picklist.

Tools that update entity information

A few module tools can be used for updating the information on the entity’s field, e.g. Update entity fields (Generic), Create new event or task with update (Accounts, Invitation Events), Link to other module with update (Accounts, Contacts) and Add contact to campaign with update (Contacts). In the Update section of these tools, you must select the updated fields from the picklists and write the value for the field in the text field on the same row (see the picture below).

Tools for creating projects

Projects can be created with the module tools Create project with static options (Generic) ja Create project (Quote). In both tools, you can copy information from the source entity with parameters and determine the project phases/jobs in Mainrow section and the sections below it. The other settings for the tools differ slightly: with the Create project tool, you can only decide the duration of the project. When the project is created with static options, the project can be linked with the source entity and you can add users to the project with certain roles (see the picture below).

Module Entity Numbering
Email Templates
Consolidated Invoicing Module Tool
Percent Steps Based Commission
Product Based Commission
Portal Settings
Combined Shape