Purpose
The purpose of this technical bulletin is to provide users with an overview of the Actions Panel, and how the Actions Panel can be used in conjunction with third party software, and the TDF Item Launcher. The Actions Panel is a URL shortcut used to display a window, which allows users to perform specific actions based on the item or record the URL is referencing. Setting up the Actions Panel is typically performed by Tour de Force.
This technical bulletin contains the following sections:
- Overview of the Actions Panel
- Email Details Example
- Using the TDF Protocol
Note: Read the documentation completely before using the Actions Panel.
- Overview of the Actions Panel
There are many applications for the Actions Panel functionality and this section references the Email Details functionality. By default the Actions Panel is only available through the Email Details and Item Forwarding functions, but can be applied in several areas that can be customized to a company’s needs.
How the Actions Panel is used, and where the Actions Panel is used is going to solely depend on the needs of the users and the company, and the capabilities of the third party software. However, before the Actions Panel can be used and applied, there are a few requirements that need to be met.
Requirements to use the Actions Panel:
- Tour de Force must be installed
- Outlook must be installed
- The third party software must be able to call the TDF Protocol, and “hook” into Tour de Force
- The third party software must be able to call an executable file and pass arguments when using the TDF Item Launcher to execute command lines
- Tour de Force Core is installed
Note that the Actions Panel is only available while Online, and not through Offline mode or Tour de Force Mobile.
- Email Details Example
The Actions Panel is a versatile feature that can either use the TDF Item Launcher or a URL using the TDF Protocol to launch the Actions Panel window. This feature has many applications, and can even be used in conjunction with the Phone Logging system. However, for the purpose of this technical bulletin, the only example shown is the Email Details function.
After forwarding an email by using the link only option, or the details option a new link is going to display directly below the hyperlink to open the item.
Clicking the Show Actions/Views link displays a new dialog window called the Actions Panel.
The Actions tab contains all of the options that generally appear in the Actions menu from either the Quick Events, or the Actions menu on a Tour de Force form. In this example, the Actions that display are the Actions that can be used for the Account record. This is because the record that was forwarded to the user is the Account record.
The Views tab contains all of the linked item views that the user can view in relation to record or item that was forwarded in the email.
The Templates tab contains all of the templates assigned to the record or item being forwarded. In this example the Account record is the record forwarded and only the templates created for the Account record display in the Templates tab.
The Actions Panel is not available by default in the Email Details function, however, the function can be enabled by Tour de Force if necessary.
- Using the TDF Protocol and Command Line
For companies with a developer on staff, or an employee who understands how the company’s third party software works, can use the TDF Protocol to create the “hook” into the third party software. In most cases the integration into the third party software would be performed by Tour de Force. This section of the technical bulletin provides the list of item type IDs for the Tour de Force records and items. This section also provides the protocol required to launch the Actions Panel.
List of TDF Item IDs
typeid |
typename |
1 |
Account |
2 |
Activity |
3 |
Appointment |
4 |
Document |
5 |
Contact |
6 |
|
7 |
Note |
8 |
Opportunity |
9 |
Support |
10 |
Task |
11 |
Folder |
12 |
Expense |
13 |
Quote |
14 |
Product |
15 |
Forecast |
16 |
Mailing |
17 |
Affiliate |
18 |
ConTRact |
19 |
Event |
20 |
EmailArchive |
21 |
ProductRegistration |
22 |
Asset |
23 |
QuoteLine |
24 |
Ticket |
27 |
Literature |
28 |
KnowledgeBase |
Actions Panel TDF Protocol
In order for the TDF Protocol to be used, the third party software must be able to display a hyperlink, or be able to open a URL.
The following protocol is needed to call the TDF Actions Panel:
tdf://action=panel&parentid=____________&parenttype=#
In the example above, if calling the Account record for the protocol, the TDF Protocol would look as follows:
tdf://action=panel&parentid=Account&parenttype=1
In a lot of cases, the Actions Panel is going to be used in conjunction with a Phone Logging system, or some type of screen pop. In this case, the Phone Number field would be used to tie the incoming call, with a Contact record in Tour de Force.
For a Contact record, the TDF Protocol would look as follows:
tdf://action=panel&parentid=Contact&parenttype=5
This would allow users to click the Actions Panel hyperlink to quickly create a new Note item, or new Activity item that is then linked to the Contact record that is related to the incoming call.
Actions Panel Command Line
In order for the Actions Panel to be used with an executable command line, the third party software must be able to call an executable and pass arguments.
The following command line is needed to call the TDF Actions Panel:
TDF.Item.Launcher.exe
"action=panel&parentid=_____________&parenttype=#"
In the example above, if calling the Account record from the Item Launcher, the command line would look as follows:
"action=panel&parentid=Account&parenttype=1"
Version: 6.5 Technical Bulletin 6010
©2014 Tour de Force CRM
Comments
0 comments
Article is closed for comments.