Image

InBox CustomerPortal

Version 6.28.35

Creation date 2018/06/07

Resources

This module provides a custom interface for the customer view.

Prerequisites

Exporting services

Before installing the latest version, please export all service preferences in a csv.

And after installing the module, import this file so that the preferences are not lost!

Framework

The following OTRS framework versions are supported:

  • [6.x.x]

Modules

The following modules are required:

  • InBox Core 6.30.8 or superior

Operational system

The following operating systems are required:

  • [None]

Third Party Software

The following third party software is required:

  • [None]

Installation

bin/otrs.Console.pl Admin::Package::Install /path/to/InBox\ CustomerPortal-6.28.35.opm

Configuration

This module can be configured via "System Configuration" in the administrative interface. The following configuration options are available:


Layout

  • Change the layout of the Customer Portal

To change the layout of the Customer Portal, go to "Administration> Customer Portal Layout".

On this screen it is possible to have a preview of how the color settings will be in the Customer Portal.

Image

Set the image path (if the image is on the server, make sure it is located at: /opt/otrs/var/httpd/htdocs/ )

By clicking on the Preview in page button, the image will be loaded in the side mini browser.

Image

You can change the colors in the navigation bar. A gradient of up to two colors can be applied:

Image

It is also possible to customize the menu according to the image below:

Image

After finishing the customization, click save to apply the settings.

Image

When accessing the customer's environment, it is possible to view the customization already applied:

Image

  • Add default logo (Required)

To add a default logo for customers, navigate to system settings and search for "CustomerPortal::Core::CustomerLogoDefault".

Add the path to the logo image:

Image

Save and implement the settings. This done, for customers who are not set to "CustomerPortal::Core::CustomerLogo" will have this logo by default.

Remember: The image must be in the /opt/otrs/var/httpd/htdocs/ directory and the CustomerLogo setting must be active

  • Add default colors to side menu (Required)

To add default colors to the side menu, navigate to system settings and search for "CustomerPortal::Core::CustomerNavBarColorsDefault".

Image

Add the hexadecimal code of the 2 colors, as it is a gradient, it is possible to add 2 colors, separated by; . If you only want one, repeat with;

  • Add colors to side menu fonts (Required)

To add different colors to side menu fonts and icons, navigate to system settings and search for: "CustomerPortal::Core::CustomerNavBarFontColors":

Image

In the 'Menu' key enter the hexadecimal color code for the menus:

Image

In the 'SubMenu' key enter the hexadecimal color code for the sub menus:

Image

And in the 'UserName' key enter the hexadecimal color code for the username and the logout.

  • Add default colors and icon for the service (Required)

To add default colors and icon to the service card, navigate to system settings and search for "CustomerPortal::Core::ServiceColorsDefault".

Image

In the configuration there are 3 keys, which are responsible for:

  • ServiceColor: Add the hexadecimal pattern of the color to the service card.

  • ServiceIcon: Add the icon name to the service.

  • ServiceIconColor: Add the hexadecimal color pattern to the service icon.

Services that did not have settings for these parameters will receive these settings. Remembering child services without configuration, receive the parameters of the parent.

  • Add logo for each customer ( This functionality will soon be deprecated )

This setting is responsible for adding a specific logo for each customer. To do this, go to "Administration> System Configuration" search for 'CustomerPortal::Core::CustomerLogo':

Image

In the first key, add the desired customerID (CustomerID), and then enter the logo image path:

Image

Remember to add the image to the directory 'opt/otrs/var/httpd/htdocs/'

  • Add colors to the side navigation bar for each customer ( This functionality will soon be deprecated )

This setting is responsible for adding up to 2 colors (as a gradient) to the side navigation bar for each client. To do this, go to "Administration> System Configuration" search for 'CustomerPortal::Core::CustomerNavBarColors':

Image

In the first key, add the desired customerID (CustomerID), and then enter the hexadecimal code of the desired colors, separated by ';' (semicolon):

Image


Display options in the sidebar

  • Hours Consumption Display

To view the company's hourly consumption, enable the CustomerPortal::Core::ToEnableConsumptionOfHours setting:

Image

Once this is done, the user will have access to the consumption of hours:

Image

  • Display FAQS in the navigation bar

If it is necessary to hide the FAQS option in the navigation bar, access the configuration CustomerPortal::Core::ToEnableShowFAQSideBar and change the setting to "No".

  • Display New Ticket in the navigation bar

If it is necessary to hide the New Ticket option in the navigation bar, access the configuration CustomerPortal::Core::ToEnableShowNewTicketSideBar and change the setting to "No".

To enable the 'Other' menu and be able to add submenus to it with links, navigate to system settings and search for 'CustomerPortal::Core::CustomerLinks':

Image

In the key, enter the display name and the value for the access link. That done the sidebar will have the 'Other' menu:

Image

  • Customize menu names in sidebar

You can change the names displayed in the side menu bar. To do this navigate to the configuration:

CustomerPortal::Core::CustomerNavBarText

Image

Keep the names present in the braces and change the values ​​as desired to display.


Module compatibility with Customer Portal

  • InBox CustomerTicketZoomSLA

Use of CustomerTicketZoomSLA

This implementation was based on the InBox CustomerTicketZoomSLA module, but it is not required.

Make sure you have run the script described in the documentation if you use this implementation:

Add the script_sla.sql file to a folder on the server and run the command:

mysql otrs <script_sla.sql

  • Enable the use of the solution

To enable this implementation, add the setting CustomerPortal::Core::ToEnableCustomerTicketZoomSLA as 'Yes':

Image

  • CustomerPortal::Core::CustomerTicketZoomSLA::TypeMapping

For REQUISITION type tickets, it displays the:

  • Solution timeout;

  • Solution time accomplished;

For INCIDENT type tickets, it displays the:

  • Solution timeout;

  • Solution time accomplished;

  • Service timeout;

  • Time of service performed

In the configuration it is possible to add the types of the system that are considered REQUISITION and the types that are INCIDENT, as in the image below:

Image

  • CustomerPortal::Core::CustomerTicketZoomSLA::CustomerMapping

Only displays the SLA for configured clients:

In the configuration it is possible to add the client id that will have the SLA view, as in the image below:

Image

  • InBox ServiceTemplate

Add InBox ServiceTemplate module

This configuration is responsible for adding the ServiceTemplate module to the opening ticket screen. To do this, go to "Administration> System Configuration" search for 'CustomerPortal::Core::ToEnableServiceTemplate'

Change its value to 'Yes', remembering that it is necessary to have the 'InBox ServiceTemplate' module installed in the environment.

  • InBox CustomServiceForm

Add custom service form (InBox CustomServiceForm module)

This setting is responsible for adding the custom service form module (InBox CustomServiceForm) to the ticket opening screen. To do this, go to "Administration> System Configuration" search for 'CustomerPortal::Core::ToEnableCustomServiceForm':

Image

Change its value to 'Yes', remembering that you must have the 'InBox CustomServiceForm' module installed in the environment.

  • InBox FileManager

Add InBox FileManager Module in CustomerPortal

To be able to use the InBox FileManager module, you must first have it installed in the environment from version '6.0.1'.

After that, you can add access to this module in the 'Other' menu:

Image

To do this navigate to the configuration: CustomerPortal::Core::CustomerLinks and add in the key the desired name to display and the value being: http:// yourHost/otrs/customer.pl?Action=CustomerPortalFileManager;Subaction=CustomerFileManager

Image

This done, the module will be available for access: Image


Settings for the Service

  • Add icons for services

To add icons to the interface service catalog, go to "Administration> Services", click on the desired service and in the 'Icon Name' field type the icon name for it:

Image

To view the list of icons and their names, you can access the Font Awesome

  • Add color to service icons

To add colors to the interface service catalog icons, go to "Administration> Services", click on the desired service and in the 'Icon color' field type the hexadecimal icon color code for it:

Image

  • Add color to service card

To add colors to cards where services are listed in the interface, go to "Administration> Services", click on the desired service and in the 'Color' field type the hexadecimal color code of the card for it:

Image

  • Add description to service card

To add the description that will appear on the cards on which services are listed, go to "Administration> Services", click on the desired service and in the 'Description' field type the description for it:

Image

Descriptions longer than 85 characters will be 'broken' and replaced with '...'. But hovering over the service card you can see the full description.

  • Add queue, type, and / or SLA to service

To add queue, type, and SLA to tickets that will open in the service, you must enter data values ​​in the service preferences created by the module. As an example, let's use the queue.

Go to "Administration> System Configuration", search for: "ServicePreferences###ServiceTicketQueue". In the 'Data' key field, enter the name of existing queues in OTRS:

Image

Save and implement the settings.

For the SLA and Type fields, follow the same steps as the queue using the "ServicePreferences###ServiceTicketSLA" and "ServicePreferences###ServiceTicketType" settings.

Navigate to a service and add the desired data:

Image

Once this is done, the call to this service will have the attributes defined in it. If nothing is configured directly in the service, the module will use the SLA (* CustomerPortal::NewTicket::SLAID ) and queue ( CustomerPortal::NewTicket::QueueName *) settings.

So that when clicking on the service, the user is redirected to an external link, navigate to the desired service registration, and in the field 'External Link', add the link address:

Image

This done, clicking on the card of this service opens the added link.

Remember that the link only works for the last level of the service.

  • Add dynamic field in service

To add dynamic fields to the service, navigate to the system settings and search for '* ServiceDynamicField *'.

Enable each config in order of use:

Image

After enabling, change the tag value DFName and Label to the name of the dynamic field to be shown in the service.

By default it is possible to enable 40 dynamic fields already defined in the system configuration.

After enabling it, it is possible to enter a value in the field in the service register, which will be used to open a ticket.

Only fields of the called type and OTRS standards are accepted.

  • Add FAQ to the service

It is necessary to create 4 dynamic fields of the FAQ object and of the text type, with the names:

  • ButtonText1: Field responsible for the button name when the FAQ solved the problem
  • ButtonColor1: Field responsible for the hexadecimal color of the button where the FAQ solved the problem
  • ButtonText2: Field responsible for the name of the button when the FAQ did not solve the problem
  • ButtonColor2: Field responsible for the hexadecimal color of the button where the FAQ did not solved the problem

Image

After creating the dynamic fields, associate them with the FAQs and enter the desired values.

There is also a default setting for the text and color values ​​of the buttons on this screen. To do this, navigate to the configuration and enter the desired values:

Image

In the service registration, it is possible to define a FAQ so that before the user opens a ticket, it is presented.

Image

After the customer user clicks on the service card, the FAQ screen will be presented first, and he can choose whether the FAQ solved the problem, or if he will continue and open the ticket. The colors and text of the buttons can be the default of the configuration, or the dynamic fields present in the FAQ:

Image


Cards

  • Changing the Transition Effect of Cards in the Service Listing

To change the type of transition effect present on the service card listing screen, add the desired name to the setting:CustomerPortal::Core::CardTransitionEffect

Image

The names are present on the site: click here

By default no effect is added.

  • Modify Service Card Size and Format

To modify the size and shape of the service cards, navigate to the settings CustomerPortal::Core::CardSize (Size) and CustomerPortal::Core::CardFormat (Format):

Image

  • Whether or not to add description to service card

To add description to the service card or not, modify the CustomerPortal::Core::ToSetDescriptionInCard setting as desired.

If left without the description, the service card gets smaller.


Portal processes

In order to be able to open tickets via the process, it will be necessary to enable the configuration CustomerPortal::Core::EnableTicketProcess. After enabled, just create a process in which the customer has a vision in the creation.

Also check that in the configuration CustomerPortal::Core::CustomerNavBarText there are the values:

NewTicketProcess -> Novo Chamado Via Processo

Image

Hide reply button according to the activity window when viewing the ticket on the Portal

To hide the reply button, simply access the CustomerPortal::Core::HideButtonResponseActivity configuration and insert the process ID in the key and the activity ID in the value.


Macro in service registration

To be able to add a macro, it is necessary that this JS file is loaded in the service admission screen. Check that the file is already defined, otherwise add.

Access the configuration:

Loader::Module::AdminService###002-Ticket

And add the JS file:

Core.Agent.Admin.CustomerPortalService.js

Image


Other settings

  • Enable graphics on the home page

Access the configuration CustomerPortal::Core::EnableChartOfDashBoard. The options to enable or disable the available graphics will be displayed.

  • Fields displayed on the "My Data" screen of the Customer Portal

Image

The settings CustomerPortal::Core::UserFieldsMyData and CustomerPortal::Core::UserFieldsMyCompany are responsible for defining the display of the fields.

The key value is the field to be displayed and the value can vary between 0, 1 and 2.

0 - Hides the field 1 - Displays and allows changes 2 - Only displays, no changes

The mandatory field will be in accordance with the default settings of the fields in the OTRS Default.pm file.

Image

If the client user database is through LDAP, automatically all fields will be displayed only, without being able to make any changes.

Image

The client user will be able to download a report with all the information related to it. Just click on "Download my personal data".

Image

The settings CustomerPortal::Core::GenerateCustomerUserTemplate, CustomerPortal::Core::GenerateCompanyDataTemplate and CustomerPortal::Core::GenerateTicketDataTemplate are responsible for the layout of the client user's personal data report. By default it is already configured. Change if necessary.

  • Add screen after user login (Required)

Old configuration: "CustomerPortal::Core::CustomerDefaultSubaction". It is obsolete!

The module now works with the standard OTRS configuration:

"CustomerFrontend::CommonParam###Action"

Add the 'HomePage' action, for example:

Image

If you want to go back to the old interface, change this setting to 'CustomerTicketOverview'

  • Add customizable cards on the main screen

First, it is necessary to activate the configuration below, so that the cards appear in the interface:

CustomerPortal::Core::EnableCustomizedCards

Then, the attendant must navigate to the administrative interface and go to the '' Customer Portal Cards "menu:

Image

In the list choose the card to customize, and in the text field click on 'Source code' to be able to add the desired HTML:

Image

After that, the cards will be displayed at the top of the main screen.

  • Add priority on ticket opening screen

To enable the priority field to be enabled on the new interface ticket opening screen, go to 'Administration> System Configuration', look for 'Ticket::Frontend::CustomerTicketMessage###Priority' and leave the setting enabled.

Image

If the setting is not enabled, the priority for tickets created in the interface will be the one that was added in the 'Ticket::Frontend::CustomerTicketMessage###PriorityDefault' setting

  • Add 'News' to Statistics Screen

To add the news card to the statistics screen, navigate to system settings and search for "CustomerPortal::Core::CustomerNews":

Image

In this configuration, enter in the key the title and in the value the referring text.

This done the card below will be presented:

Image

  • Settings that must be active

For the module to function correctly, some OTRS settings must be active in the environment, such as:

  • Ticket::Frontend::CustomerTicketMessage###SenderType

  • Ticket::Frontend::CustomerTicketMessage###StateDefault

  • CustomerPanelUserID

  • CustomerLogo

  • Ticket::Frontend::CustomerTicketMessage###HistoryComment

  • Ticket::Frontend::CustomerTicketMessage###HistoryType

  • Ticket::Frontend::CustomerTicketMessage###TicketTypeDefault

  • Enable SLA Field

To enable the SLA field on ticket open, just enable the Ticket::Frontend::CustomerTicketMessage###SLA setting and Ticket::Frontend::CustomerTicketMessage###QueueDefault setting.

And for this field to be required, also enable this setting: Ticket::Frontend::CustomerTicketMessage###SLAMandatory.

  • Enable Type Field

To enable the Type field on ticket open, simply enable the setting: Ticket::Frontend::CustomerTicketMessage###TicketType.

  • Add custom columns to the Company Tickets menu

For the 'Company Calls' menu to appear, you must disable OTRS configuration: CustomerDisableCompanyTicketAccess. Once this is done you can define which columns will be displayed in the company ticket table.

To do this navigate to the module configuration: CustomerPortal::CompanyTickets::Settings , keep the primary key 'VisibleColumns' and in the secondary keys add any of the values ​​between:

  • "Age"

  • "PriorityID",

  • "ServiceID",

  • "Service",

  • "Type",

  • "Responsible",

  • "StateID",

  • "ResponsibleID",

  • "ChangeBy",

  • "EscalationTime",

  • "OwnerID",

  • "Changed",

  • "RealTillTimeNotUsed",

  • "GroupID",

  • "Owner",

  • "CustomerID",

  • "TypeID",

  • "Created",

  • "Priority",

  • "UntilTime",

  • "EscalationUpdateTime",

  • "QueueID",

  • "Queue",

  • "State",

  • "Title",

  • "CreateBy",

  • "TicketID",

  • "StateType",

  • "EscalationResponseTime",

  • "UnlockTimeout",

  • "EscalationSolutionTime",

  • "LockID",

  • "ArchiveFlag",

  • "TicketNumber",

  • "Lock",

  • "SLAID",

  • "CustomerUserID"

Save and implement the settings. Remember that the column '** State **' is required in the display.

  • Set up state filters on the 'My Tickets' and 'Company Tickets' screen

Navigate to module configuration 'CustomerPortal::Core::StateFilter'

Fill in the main keys according to the desired states in it.

After that, also fill in the 'CustomerPortal::Core::StateFilterName' setting with the desired display names.

  • Enable service parameters on the attendant call opening screens.

So that in the call opening screens via phone and via e-mail in the attendant interface, only the SLA, type and queue that were selected in the service register are shown, enable the setting

CustomerPortal::Core::ToEnableServiceParams to 'yes':

Image

Done this by choosing a service on the screens shown:

Image

Only the registration fields will be shown:

Image

  • Add service name as subject when opening tickets

To be able to add the service name in the subject field and leave 'readonly', enable the setting:

CustomerPortal::Core::ToEnableServiceNameAsSubject to 'yes':

Image

After that the subject of the call becomes the name of the service:

Image

  • Add column data to ticket listing screen (Required)

This setting is responsible for adding which ticket attributes will be displayed in the created ticket listing table. To do so, go to 'Administration> System Configuration' look for 'CustomerPortal::MyTickets::Settings':

Image

In the first key, keep the name 'VisibleColumns', and then enter the desired ticket data for display:

Image

  • Add queue for tickets created via CustomerPortal (Required)

This setting is responsible for adding the default queue to which tickets created via CustomerPortal will be created. To do this, go to "Administration> System Configuration" search for "CustomerPortal::NewTicket::QueueName", and add the desired queue name:

Image

  • Add state filter

This setting is responsible for adding which filters can be made on the 'MyTickes' screen.

To do this, go to "Administration> System Configuration" search for "CustomerPortal::Core::StateFilter", and add a key and the desired states for that key:

Image

  • Add names in state filters

This setting is responsible for adding which names can be displayed on the 'MyTickes' screen.

To do this, go to "Administration> System Configuration" search for "CustomerPortal::Core::StateFilterName", and add the key (same key added in configuration) and the desired states for that key:

Image

This configuration that allows you to choose whether the links configured in CustomerPortal::Core::CustomerLinks when selected will

open in the current tab in a new tab.

For that, leave the setting CustomerPortal::Core::ToOpenLinkInANewTab as 'Yes':

Image

  • Add notifications to CustomerPortal

It is possible to add personalized notifications to be counted and presented in a specific menu for CustomerPortal.

For this, in the desired notification, check the option below:

Image

It is also necessary to define the maximum number of notifications that will be presented in the configuration: CustomerPortal::Core::NotificationTableSize, by default there will be 100.

Therefore, when the user receives a notification with this flag active, it will be counted and he can access it through the menu below:

Image

Image

  • Add SLA for tickets created via CustomerPortal

This setting is responsible for adding an SLA for which tickets created via CustomerPortal will be created. To do this, go to "Administration> System Configuration" search for "CustomerPortal::NewTicket::SLAID", and add the desired SLA id:

Image

  • View archived tickets on the Portal

To also display tickets archived in CustomerPortal, enable the setting:

CustomerPortal::Core::ToEnableArchivedTickets

  • Filter the queues in the consumption of hours

To define the queues that will not be filtered in 'Time Consumption', navigate to the configuration:

CustomerPortal::Core::QueueToNotFilter:

And define the names of the queues that should NOT appear in the filter

  • Perform date filter for tickets

To define a date filter for tickets that are displayed in CustomerPortal, enable the setting:

CustomerPortal::Core::ToEnableSearchByDate.

After that, a time in standard days must be defined through the configuration:

CustomerPortal::Core::SearchByDateDefaultDays. By default it will be 30 days

It is also possible to define a time per customer, to do this navigate to the configuration:

CustomerPortal::Core::SearchByDateCustomerDays, enter the customer's name on the first key and the time in days on the second.

  • Setting service values for open calls via the attendant interface

It is possible to define that the calls opened via the attendant interface receive the values defined in the service. To do this, activate the event by configuring Ticket::EventModulePost###9000-TicketSetServicesPreferences.

It is possible to define which values will be set in the ticket by changing the values of the keys from 1 to 0.

Image


Use

Viewing user preferences

By clicking on the arrow next to the username, you can see the 'Preferences' menu. By clicking on it the user can change some preferences such as password, time zone and language.

Viewing charts

In this interface 4 types of charts are created. Each can be enabled or disabled through configuration CustomerPortal::Core::EnableChartOfDashBoard.

To view them, navigate to the 'Statistics' menu in the side menu bar:

Image

The graphs shown are:

  • Open vs. Closed Tickets:

Image

This graph shows the number of open and closed calls in the last 7 days.

  • Total by state:

Image

This graph shows the number of tickets according to the state of the ticket.

  • Tickets by service:

Image

This graph shows the number of calls by service, grouping the number of child services in the parent.

  • Tickets by type:

Image

This chart shows the number of calls by type.

Open a new ticket

In this interface it is possible for the client to open tickets. To do this, navigate to the 'Calls -> New Call' menu in the side menu bar:

Image

This screen will display all services that the user has permission. To open a ticket, click on the desired service.

Image

To perform a search among FAQs, services or tickets, type the text in the search field:

Image

The services, FAQ and calls related to the text will be presented. Clicking on a FAQ, the user is redirected to the FAQ, clicking on a service is redirected to the opening screen of the service's ticket, already clicking on a ticket is redirected to its zoom.

You can also enter after entering the search text, and the same actions can be performed:

Image

After choosing the service, the ticket opening screen will be displayed:

Image

Remembering that the calls are only open to the last level of the chosen service.

Here you can add standard OTRS-type dynamic fields, which must be added to the 'CustomerTicketMessage' action to be there as well.

User Ticket Listing

In this interface you can view all user-created tickets. To do this, navigate to the 'Tickets-> My Tickets' menu in the side menu bar:

Image

Clicking on a table item will show the referent call and its interactions:

Image

In this screen you can also check some filters, such as the priority.

When you click the color for the priority, only those called with that priority are filtered in the table:

Image

To see all tickets again, click 'All tickets'.

Another possible filter is for open and closed calls. You can filter by clicking on the drop down field:

Image

To see all calls again, click 'All'.

Table row coloration refers to the priority color of the ticket

User Profile Picture

The user profile photo is added after their email has been registered with Gravatar.

Add service as favorite

To bookmark a service, simply click the star on each service card:

Image

This done, the service is saved in user preferences and is displayed in the 'Favorite Services' menu:

Image

By clicking on the service name in this menu, the user is redirected to the referral service call opening screen, or to the service level tree.

To opt out of the favorites service, click the trash can icon next to the service name:

Image

View FAQs

Clicking on the 'FAQs' menu, you can view the interface and FAQ list:

Image

Image

Using the process on the portal

NOTE: To use ACL with the InBox ShowHide module, it will be necessary to have installed at least the InBox ShowHide-6.5.10.opm or higher version.

In the sidebar click on "New Call Via Process".

Image

The processes will be listed according to the level that will be determined by their name.

Exemplo: Process 1::Process 1.1::Process 1.1.1

in this example, the first selection box will show the option Process 1, then in the second box the option Process 1.1. If you have another process with the name Process 1::Process 1.2::Process 1.2.2, the second box will show the option Process 1.2.

Image

Image

When selecting the last checkbox, the process will be loaded on the screen with all fields configured in the process. Just fill in according to the displayed fields and click on "Send".

Image

Image

In the ticket view, if the ticket is in any process activity in which the client user has to participate, a new card will be presented.

Image

Just fill in what was requested and send.

Image

Macro Registration

Access the Admin menu and select the Macro option

Image

Accessing this area it is possible to create, view, edit and delete macros:

Image

To add a new macro, this screen is displayed, and the fields can be filled:

Image

The Macro Name field is the only mandatory field for registering the macro.

The fields below will be the values defined in the ticket if the macro is executed:

Image

The macro is executed, based on the settings defined in the Service, and when executed it will define the attributes that are configured here.

OBS: check if this config is defined Load JS Macro.

Macro configuration in Services

In the registration of services it is possible to define macros, according to a dynamic field value (only dynamic fields of the Dropdown type are accepted).

Upon updating the dynamic fields configured in a ticket that has the service in question, the macro will be executed.

To configure a macro in the service, access the Admin-> Services menu and select the service you want to add the macro to:

Image

In the selected service, the field above is available, and it is possible to select the dynamic fields (Dropdown) to associate their value to a Macro.

By selecting a field, the following options will be displayed:

Image

In this first field it is possible to select one of the values available in the selected dynamic field.

In the second field ahead, it is possible to select a macro that is available:

Image

In this way, when updating FieldX to the defined value, the selected macro will be executed.

Call opening using Contract-Service association

To use the features described below, it will be necessary to have the module installed in the environment InBox-ContractManagement.

When making the necessary associations described in the module's documentation InBox-ContractManagement you will need to enable the setting CustomerPortal::Core::OpenTicketByContract.

When accessing the ticket opening screen, the contracts available to the logged in user will be displayed.

Image

When you click on a contract, the services available for the contract will be displayed.

Image

When you click on the service, the opening screen will be displayed.

Image

Configuring contract cards

You can add some information to be displayed on contract cards.

Image

To do this, use the settings below to make the changes.

CustomerPortal::CardContract::StandardFields: Contract data on the card.

CustomerPortal::CardContract::DynamicFields: Dynamic field data of the contract on the card.

Attention! Configure the fields to appear on the cards according to the configured size of the cards. Avoid setting too many fields to be displayed to avoid layout problems. If you want more information about the contract on the screen, insert the fields in the Tooltip settings below:

CustomerPortal::CardContract::StandardFieldsTooltip: Contract data on icon i.

CustomerPortal::CardContract::DynamicFieldsTooltip: Contract dynamic field data on icon i.

Image

CustomerPortal::CardContract::MessageNoContract

If the client user has no associated contract, a message will be displayed. This message can be changed at CustomerPortal::CardContract::MessageNoContract

API

This module does not build any APIs.