Skip to content

List of Keywords

Some keywords are general and can be used for multiple scopes. They include the keywords id, name, owner, ownergroup and history.

The tables below give a summary of all possible keywords per scope, with a description of what exactly is being requested from the elements.

Keywords with Default Scopes§

In the general finder some keywords can be used without mentioning a scope in the query. In that case, Yesplan will apply the query to the default scopes for that keyword. For example, the query label:rental will search for the label “rental” with the scopes resource, contact and event. The list of results will display the resources, contacts and events with the label “rental”. This is the list of keywords with default scopes:

Keyword Default Scopes
activecontract resource
anylabel resource, person, organization, event
assignedby task
assignedto task
contact event
contract resource
date event
due task
group event, group, resource
id event, group, location, contact, resource, task, taskgroup, contactbooking, resourcebooking, team
label resource, contact, event
location event, group, location
name event, group, resource, contact, task
profile event
progress task
role resource
status event
statustype event
team task, resourcebooking
type resource
unpublished resourcebooking
zip person, organization

Keywords for Events, Event Groups and Productions§

Modified in v27

The table below gives a summary of information that can be requested with the scope event, group, event_or_group or production.

Keyword Valid Scopes Description
contact event, group, event_or_group, production The element’s contacts (excluding the contacts booked via custom data fields).
contactrole event, group, event_or_group, production The roles of the element’s contact bookings (excluding the contacts booked via custom data fields).
date event, group, event_or_group, production The date when the element takes place.
dateafter
New in v27
event, group, event_or_group, production All elements taking place on or after a given date.
defaultschedule event, event_or_group The description of the displayed start or end time of the element’s schedule.
document event, group, event_or_group, production The element’s attachments (documents and other things) (excluding the attachments added via custom data fields).
end event, group, event_or_group, production The element’s end date.
group event, group, event_or_group, production The event group that the element belongs to.
history event, group, event_or_group, production The items that were added manually to the element’s history. You search the description only, not the date or a period.
id event, group, event_or_group, production The element’s Yesplan ID.
inproduction event, event_or_group, group It is true if the element is in a production; otherwise it is false.
isproduction event, event_or_group, group It is true if the element is a production; otherwise it is false.
label event, group, event_or_group, production The element’s labels.
location event, group, event_or_group, production The locations where the element takes place.
name event, group, event_or_group, production The element’s name.
owner event, group, event_or_group, production The element’s owner.
ownergroup event, group, event_or_group, production The user group that owns the element.
production event, group, event_or_group The production that the element belongs to.
profile event, group,event_or_group, production The element’s profile; if an event group exists whose events have different profiles, this will return a n/a.
profiles event, group,event_or_group, production The element’s profile; for an event group this will yield a result if at least one event in the event group has this profile.
progress event, group, event_or_group, production The element’s status; if an event group exists whose events have different statuses, this will return a n/a. Identical to the keyword status.
schedule event, event_or_group The description of a schedule item of the element’s schedule.
start event, group, event_or_group, production The element’s start date.
status event, group, event_or_group, production The element’s status; if an event group exists whose events have different statuses, this will return a n/a.
statuses event, group, event_or_group, production The element’s status; for an event group this will yield a result if at least one event in the event group has this status.
statustype event, group, event_or_group, production The element’s status type; if an event group exists whose events have different statuses, this will not yield a result.
subevent group, event_or_group, production The name of the events that are part of the event group.

Keywords for Resources, Placeholders, Locations and Teams§

The table below gives a summary of information that can be requested with the scope resource, resourceplaceholder, location or team.

Keyword Valid Scopes Description
account resource, resourceplaceholder, location, team The ‘accounting number’ in the element’s default price definition.
activecontract resource The active contract; only applicable for resources of the type human.
active resource, resourceplaceholder, location, team It is true if the element is active; otherwise it is false.
contact resource, resourceplaceholder, location, team The element’s contacts (excluding the contacts booked via custom data fields).
contract resource The contracts that are applicable on the resource; only applicable for resources of the type human.
costprofile resource, resourceplaceholder, location, team The event profile associated with the element’s default price definition.
costprofiles resource, resourceplaceholder, location, team The event profiles associated with an element’s price definition.
date resource, location The (purchase) date of the resource; not applicable on resource sets.
description resource, location, team A description of the element.
document resource, resourceplaceholder, location, team The element’s attachments (documents and other things) (excluding the attachments added via custom data fields); not applicable on resource sets.
external resource, resourceplaceholder, location, team It is true if the element is external; otherwise it is false.
group resource, resourceplaceholder, location, team The resource group that the element belongs to.
history resource, resourceplaceholder, location, team The items that were added manually to the element’s history. You search the description only, not the date or a period.
id resource, resourceplaceholder, location, team The element’s Yesplan ID.
invoice resource, resourceplaceholder, location, team It is true if the default price definition is to be billed; otherwise it is false (refers to the field “To Be Billed”).
label resource, resourceplaceholder, location The element’s roles; identical to keyword role.
member team The human resources that are part of the team.
name resource, resourceplaceholder, location, team The element’s name.
owner resource, location, team The element’s owner.
ownergroup resource, location, team The user group that owns the element.
productcode resource, location The element’s product code; not applicable on resource sets.
resourcespecies resource, resourceplaceholder, location, team The type of resource; possible values are set, adhoc, bulk, placeholder and instantiatable.
rented resource, resourceplaceholder, location, team It is true if the element is rented; otherwise it is false.
role resource, resourceplaceholder, location The element’s roles.
serialnumber resource, location The element’s serial number; not applicable on resource sets.
team resource, team The element’s team; only applicable for resources of the type human.
type resource, resourceplaceholder, location The element’s type; possible values are human, material, service or financial.

Keywords for Resource Bookings§

The table below gives a summary of information that can be requested with the scope resourcebooking.

Keyword Valid Scopes Description
account resourcebooking The ‘accounting number’ in the booking’s price definition.
accountableto resourcebooking The contact to which the booking was awarded for the price calculation (refers to the field “Billable to”).
actualstart resourcebooking The actual start date of the booking; only applicable for bookings on events with an “allow actuals” status type.
actualend resourcebooking The actual end date of the booking; only applicable for bookings on events with an “allow actuals” status type.
comment resourcebooking The value of the booking’s comment field.
contact resourcebooking The resource’s contacts (excluding the contacts booked via custom data fields).
date resourcebooking The date when the booking takes place.
description resourcebooking A description of the resource of the booking; not applicable for bookings of placeholders.
end resourcebooking The end date of the booking.
event resourcebooking The event of the booking.
external resourcebooking It is true if the resource of the booking is external; otherwise it is false.
group resourcebooking The group of the booked resource.
history resourcebooking The items that were added manually to the element’s history (the booking does not have its own history). You search the description only, not the date or a period.
id resourcebooking The element’s Yesplan ID.
invoice resourcebooking It is true if the booking is to be billed; otherwise it is false (refers to the field “To Be Billed”).
label resourcebooking The labels of the resource; identical to the keyword role.
location resourcebooking The location where the event of the booking takes places.
name resourcebooking The element’s name.
owner resourcebooking The element’s owner.
ownergroup resourcebooking The user group that owns the element.
productcode resourcebooking The product code of the booked resource.
resourcespecies resourcebooking The type of booked resource; possible values are set, adhoc, bulk, placeholder and instantiatable.
rented resourcebooking It is true if the booked resource is rented; otherwise it is false.
role resourcebooking All roles of the booked resource.
serialnumber resourcebooking The serial number of the booked resource.
start resourcebooking The start date of the booking.
team resourcebooking The bookings of the people who belong to a certain team; only applicable for resource bookings of the type human.
type resourcebooking The type of the booked resource.
unpublished resourcebooking Has the value true if the booking hasn’t been published (i.e. when the start of the booking takes place after the date rosters published up until). Has the value false if this is not the case. The keyword is only valid for bookings of resources of the type person (human) if roster publication has been activated in “System Settings” > “Teamplanner” > “Roster Publication”.
usedrole resourcebooking The role used for the booking; only applicable for resource bookings of the type human.

Keywords for Contacts§

The table below gives a summary of information that can be requested with the scope contact, person, organization, person_or_organization or contactlink.

Keyword Valid Scopes Description
address contact, person, organization, person_or_organization The full default address of the element.
{address type}_address contact, person, organization, person_or_organization The full address of the element’s {address type} type.
anycomment
Deprecated
contact, person, organization, person_or_organization, contactlink The value of the element’s comment field; for person, organization and person_or_organization the comment of their contact links is also taken into account.
anycontactinfo
Deprecated
contact, person, organization, person_or_organization, contactlink The element’s contact information; for person, organization and person_or_organization the contact information of their contact links is also taken into account.
anylabel
Deprecated
contact, person, organization, person_or_organization, contactlink The element’s labels; for person, organization and person_or_organization the labels of their contact links are also taken into account.
city contact, person, organization, person_or_organization The city of the element’s default address.
{address type}_city contact, person, organization, person_or_organization The city of the address with the element’s {address type} type.
comment contact, person, organization, person_or_organization, contactlink The value of the element’s comment field.
contactinfo contact, person, organization, person_or_organization, contactlink The element’s contact information.
country contact, person, organization, person_or_organization The country of the element’s default address.
{address type}_country contact, person, organization, person_or_organization The country of the address with the element’s {address type} type.
countrycode contact, person, organization, person_or_organization The country code of the element’s default address.
{address type}_countrycode contact, person, organization, person_or_organization The country code of the address with the element’s {address type} type.
department contact, person, organization, person_or_organization The department of one of the links of a person or organization.
document contact, person, organization, person_or_organization, contactlink The element’s attachments (documents and other things) (excluding the attachments added via custom data fields).
duplicate contact, person, organization, person_or_organization The name of the contacts that are a possible double of this contact.
firstname person The first name of a person.
history contact, person, organization, person_or_organization, contactlink The items that were added manually to the element’s history. You search the description only, not the date or a period.
id contact, person, organization, person_or_organization, contactlink The element’s Yesplan ID.
jobtitle contact, person, organization, person_or_organization The job title of one of the links of a person or organization.
label contact, person, organization, person_or_organization, contactlink The element’s labels.
language contact, person, organization, person_or_organization The element’s language.
languagecode contact, person, organization, contact, person_or_organization The language code of the element confer the ISO 639.2 list.
lastname person The last name of a person.
link contact, person, organization, person_or_organization The name of the element’s link.
name contact, person, organization, person_or_organization, contactlink The element’s name.
owner contact, person, organization, person_or_organization, contactlink The element’s owner.
ownergroup contact, person, organization, person_or_organization, contactlink The user group that owns the element.
street contact, person, organization, person_or_organization The street name and street number (the two lines with the label ‘Street’) of the element’s default address.
{address type}_street contact, person, organization, person_or_organization The street name and street number (the two lines with the label ‘Street’) of the address with the element’s {address type} type.
title person The title of a person.
type organization The business entity of an organization.
zip contact, person, organization, person_or_organization The ZIP code of the element’s default address.
{address type}_zip contact, person, organization, person_or_organization The ZIP code of the address with the element’s {address type} type.

Keywords for Contact Bookings§

The table below gives a summary of information that can be requested with the scope contactbooking.

Keyword Valid Scopes Description
contact contactbooking A contact booking for a certain contact – notice the difference with the keyword ofcontact.
contactrole contactbooking The roles of the booked contacts (including the contacts booked via custom data fields).
event contactbooking A contact booking for a certain event (including the contacts booked via custom data fields).
eventdate contactbooking A contact booking for an event that takes place on a certain date.
history contactbooking The items that were added manually to the element’s history (the booking does not have its own history). You search the description only, not the date or a period.
id contactbooking The element’s Yesplan ID.
label contactbooking The contact’s labels. Identical to the keyword role.
name contactbooking The element’s name.
ofcontact contactbooking The booked contact – notice the difference with the keyword contact.
owner contactbooking The element’s owner.
ownergroup contactbooking The user group that owns the element.
resource contactbooking A contact booking for a certain resource.
role contactbooking The contact’s labels.
type contactbooking The business entity of the booked organization.

Keywords for Tasks and Task Groups§

The table below gives a summary of information that can be requested with the scope task en taskgroup.

Keyword Valid Scopes Description
assignedby task, taskgroup The person by whom the task is assigned.
assignedto task, taskgroup The person to whom the task is assigned.
date task, taskgroup The due date of the task. Identical to the keyword due.
description task A description of the task.
document task, taskgroup The element’s attachments (documents and other things).
due task, taskgroup The due date of the task.
event task, taskgroup The event to which the element is linked.
history task, taskgroup The items that were added manually to the element’s history. You search the description only, not the date or a period.
id task, taskgroup The element’s Yesplan ID.
name task, taskgroup The element’s name.
owner task, taskgroup The element’s owner.
ownergroup task, taskgroup The user group that owns the element.
progress task, taskgroup The value for the element in the “Progress” column of the task finder.
start task, taskgroup The start date of the element.
status task, taskgroup The element’s status; possible values are new, started, done on hold and obsolete.
team task, taskgroup The team to which the task is awarded.