DayWeekPlanning Action Parameters
Supported dayweekplanning action parameters.
The DayWeekPlanning
action supports the following input arguments:
searchAndListName
Defines the info areas that are available for users to select and search in. Specify the info areas and (optional) the Search&List configurations separated by semicolon. This parameter is mandatory.
Defaults:
- BTB:
KP;FI
- FS:
PE;KP;FI
- OTC:
KP;FI;SB
Syntax:
infoAreaId:searchAndList;...
Example:
FI:FISearchAndList;KP:KPSearchAndList
The defined info areas are offered in a drop-down list in the top right corner of the page. The first entry is used as default when opening the page for the first time. The entries are sorted alphabetically.
If you defined info areas that are not children of FI and/or KP (e.g. AR), an error message is written to the client log.
maxRows
Defines the maximum number of results returned by the search.
defaultFieldValuesForMA
Allows you to define Activity Defaults displayed on the left below the calendar filters which are used when creating new activity records. The defaults can be changed by the user.
Syntax:
<field name or number>:"<value>";...
Example:
Contact:"#1";Duration:"30";Unit:"#2"
sets the Activity
Type to "Visit" and the default duration to 30 minutes
showSearch
If set to true
, the search mask is visible. If set to
false
, it is displayed collapsed and can be expanded by clicking
.
Default: true.
autoSearch
If set to true
, the search is immediately executed when the user opens
the page.
Auto-search does not happen when the user updates a filter in the search mask. If you
want auto-search to be activated when a filter is updated in the search mask, you have
to set autoApplyFilter to
true
.
Default: false
defaultFieldValues
Defines fields that have a default value within the search, which the user can change,
separated by semicolon. You can define default values for all info areas defined in
searchAndListName
.
Syntax:
<infoAreaId>.<field name or number>:"<value>";...
- To fill a field with the current rep, enter
fieldName:REP
- To fill a field with the current date, enter
fieldName:TODAY
Use operators (
<=
,=>
) to define date ranges and functionsSyntax:
fieldName:Value:Operator
- To set a value for a catalog field, enter
fieldName:"#catalog_ID"
Example:
KP.RepID:REP;PR.Date:TODAY-14;MA.Contact:"#3";MA.Date:TODAY-7:>=;MA.Date:TODAY+14:<=
This sets the search masks as follows:
- Person: Rep ID = the current rep
- Offer: Date = the current date minus 14 days
- Activity: Activity Type = Event, Date from = the current date minus seven days, Date to = the current date plus 14 days
fixedFieldValues
Defines fields that have a fixed value within the search which the user cannot change.
You can define fixed values for all info areas defined in
searchAndListName
. Use the syntax as described for defaultFieldValues.
disableFilter
Disables the filter selection and definition functionality for the user. Both the predefined filters and the More Filters entry are removed from the Add more drop-down list of the Search page.
Search.NoFilterDefinition
(type: Checkbox). This removes the
More Filters entry from the Add more
drop-down list on all Search pages. For further details, see Search.NoFilterDefinition. Users
may only select predefined filters and can no longer create or edit any filters in Aurea
CRM.Web.defaultFilterName
Allows you to specify a filter which is applied to the search by default. Users are
still able to select another filter unless disableFilter
=
true
.
<InfoAreaId>.<FilterName>
in the action (example -
"KP.Filter1"). In Aurea CRM.Web they are then displayed as
<FilterName>
(example - "Filter1").fixedFilterName
Allows you to specify a fixed filter which is applied to the search and cannot be changed by the user. The filter name is not visible for the user.
<InfoAreaId>.<FilterName>
in the action definition
(example - KP.Filter1
).listParams
Defines the behavior of the search results list. For further details, see ListParams.
selectionMode
is not supported in the DayWeekPlanning
action template.linkOfMAToSource
When creating activity records for info areas other than Company or Person, example - a Ticket, the link to the ticket record is not automatically added to the newly created activity. Records of these info areas are by default only used to determine the company and/or person record(s) for which the activity is created.
Use the linkOfMAToSource
parameter to add links from the activity
record to these info areas.
Syntax (JSON): {infoAreaId:linkId,infoAreaId:linkId,…}
Example: {KM:-1;IB:-1}
This creates links to ticket and installed base records using the default link. For further details, see Link IDs. The links are displayed under Parent Data in the activity record's Expand view.
contactTimeTypes
Defines the Type of Contact Time (CT) that is taken into account when displaying contact times.
If contactTimeTypes
is undefined, the contact times are only displayed
if CT records exists for exactly one Type. If contact times for
more than one type are configured, no contact times are displayed.
Syntax
<catalog value ID>
<info area ID>=<catalog value ID>
Separate multiple entries by comma.
Examples
2
The contact times of Type "Reachability" are displayed for companies and persons.
FI=1,KP=2
The contact times of Type "Visiting Times" are displayed for companies and of Type "Reachability" for persons.