5.3 Keywords

Keywords represent a specific Property or Field in an item. For example, the keyword CREATE_DATE signals that this Filter will deal with the date an item was created.

For a list of available keywords, see

Keywords are separated by the following data types:

  • Unary

  • Date

  • Numeric

  • String

  • Enumerated

Several system-defined keywords exist within each of the five data types. These are listed in item (e) below. (For example, the CREATE_DATE keyword above is a system-defined keyword of the DATE data type.) In addition, users can create their own custom defined keywords (equivalent to custom field definitions for messages, address books, or documents).

User Defined Fields can be used as Keywords by enclosing the name and type within "<>" characters. For example, if a GroupWise system has a User Defined field named "Bowling Shoe Size", a numeric field, it can be given as the "<Bowling Shoe Size, NUMERIC>” keyword.

  • User Defined Field keywords must match the exact name given to the field.

  • All Fields within an Address Book search are considered User Defined Fields of type STRING. The keyword syntax for address books can be shortened to <MyField> rather than <MyField, STRING>.

Keywords are not case sensitive. "CREATE_DATE" is the same as "Create_Date".

The following is a list of system-defined keywords, sorted by type.

Data Type

Keywords

Date

  • ASSIGNED_DATE
  • CREATE_DATE
  • DELIVERED_DATE
  • DUEEND_DATE
  • MODIFY_DATE
  • RETRIEVED_DATE
  • START_DATE

Enumerated

  • PRIORITY
  • ATTACHMENT_TYPE
  • BOX_TYPE

Numeric

  • CURRENT_VERSION_NUMBER
  • DOCUMENT_NUMBER
  • NUMBER_ACCEPTED
  • NUMBER_COMPLETED
  • NUMBER_DELETED
  • NUMBER_OPENED
  • NUMBER_READ
  • NUMBER_REPLIED
  • OFFICIAL_VERSION_NUMBER
  • SIZE
  • TOTAL_RECIPIENTS
  • TASK_CATEGORY
  • TASK_PRIORITY
  • VERSION_NUMBER

String

  • ANY_FIELD
  • AUTHOR
  • ATTACHMENT_LIST
  • BC
  • CALLER_COMPANY
  • CALLER_NAME
  • CALLER_PHONE_NUMBER
  • CATEGORY
  • CC
  • CLASS_NAME
  • DOCUMENT_CREATOR
  • DOCUMENT_FILENAME
  • DOCUMENT_TYPE
  • LIBRARY
  • FROM
  • MESSAGE
  • PERSONAL_SUBJECT
  • PLACE
  • PRIMARY_CATEGORY
  • RETRIEVED_BY
  • SUBJECT
  • TO
  • VIEWNAME

Unary

  • ACCEPTED
  • APPOINTMENT
  • COMPLETED
  • DELEGATED
  • DELIVERED
  • DOCREFERENCE
  • DOCVERSION_ARCHIVED
  • DOCVERSION_CHECKED_OUT
  • DOCVERSION_IN_USE
  • DOCVERSION_CONNECTED_READ_WRITE
  • HIDDEN
  • MAIL
  • NOTE
  • OFFICIAL_DOCUMENT_VERSIONS_ONLY
  • ON_CALENDER
  • ON_CHECKLIST
  • OPENED
  • PHONE_MESSAGE
  • PRIVATE
  • READ
  • REPLY_REQUESTED
  • ROUTED
  • SEARCH_AS_LIBRARIAN
  • TASK

5.3.1 Available Keywords

The following keywords are available:

Keyword

Description

ACCEPTED

UNARY keyword. Finds all TASK, NOTE, or APPOINTMENT items that were accepted by their recipient(s).

ANY_FIELD

STRING keyword. Searches most text fields for the given value.

APPOINTMENT

UNARY keyword. Finds all APPOINTMENT Message items.

ASSIGNED_DATE

DATE keyword. The date and time a TASK item was assigned to this user. (Note: a task can be assigned by another person or by creating a Personal Task.)

ATTACHMENT_LIST

STRING keyword. Obsolete. Use the ATTACHMENT_TYPE keyword instead.

ATTACHMENT_TYPE

ENUMERATED keyword. The type of item attached to any MESSAGE. (APPOINTMENT, MAIL, NOTE, TASK, PHONE MESSAGE, DOCUMENT REFERENCE, or SHARED NOTIFICATION items.) The value to search for must come from this list of text constants: FILE, MESSAGE, SOUND, APPOINTMENT, TASK, NOTE, MAIL, MOVIE, PHONE_MESSAGE, OLE, or DOCREFERENCE.

AUTHOR

STRING keyword. Searches a LIBRARY for any DOCUMENT written by a given user.

BC

STRING keyword. Searches MESSAGE items for a Blind Copy recipient.

BOX_TYPE

ENUMERATED keyword. The type of any MESSAGE item in the users mailbox. The constant value INCOMING signifies a group item that was delivered to this user. The value OUTGOING identifies a message sent to others. The value PERSONAL defines an item that was created in and exists only in this users mailbox. Finally, the value DRAFT identifies a MESSAGE item that is in progress, and may become an OUTGOING item at a later date.

CALLER_COMPANY

STRING keyword. Searches a PHONE MESSAGE item for the company name of the caller. Searches an ADDRESS BOOK ENTRIES collection for the company name of each Contact.

CALLER_NAME

STRING keyword. Searches a PHONE MESSAGE item for the name of the caller.

CALLER_PHONE_ NUMBER

STRING keyword. Searches a PHONE MESSAGE item for the phone number of the caller.

CATEGORY

STRING keyword. Searches a MESSAGE item for a CATEGORY. The CATEGORY text value must be defined in the CATEGORY DEFINITIONS collection. Even though the CATEGORY keyword is a string, it can be used only with the Matches operator. It cannot be used with the Contains, BeginsWith, or DoesNotContain operators.

CC

STRING keyword. Searches a MESSAGE item for a recipient name inside the Carbon Copy list.

CLASS_NAME

STRING keyword. Searches a MESSAGE item for a specific sub-type of message. The Class Name for normal mail messages is "GW.MESSAGE.MAIL". A sub-type of message may add to that Class Name string more text. For example, "GW.MESSAGE.MAIL.CRITICAL" would add the sub-type "CRITICAL" to the MESSAGE item.

COMPLETED

UNARY keyword. Returns all TASK items that have been marked Completed.

CREATE_DATE

DATE keyword. The date and time an item was created in the users mailbox.

CURRENT_VERSION_NUMBER

NUMERIC keyword. The latest version number for a DOCUMENT in a LIBRARY.

DELEGATED

UNARY keyword. Returns all MESSAGE items that were Delegated to another user by the original recipient(s).

DELIVERED

UNARY keyword. Searches for all MESSAGE items that were Delivered to their recipient(s).

DELIVERED_DATE

DATE keyword. The date and time a group item was delivered to the users mailbox.

DOCUMENT_ CREATOR

STRING keyword. Searches a DOCUMENT for the name of the user that created this document.

DOCUMENT_ FILENAME

STRING keyword. Searches a DOCUMENT item for the specific file name that this document is known by in the Operating System. This file name will only be present if this document has been checked out or saved to the local computer.

DOCUMENT_NUMBER

NUMERIC keyword. A number assigned to a DOCUMENT in a LIBRARY.

DOCUMENT_TYPE

STRING keyword. Searches a DOCUMENT item for a DOCUMENT TYPE. The DOCUMENT TYPE text must be defined as part of the DOCUMENT TYPES collection.

DOCREFERENCE

UNARY keyword. Returns all MESSAGE items that are references to DOCUMENT objects.

DOCVERSION_ ARCHIVED

UNARY keyword. Searches for all DOCUMENT items that have a Version archived.

DOCVERSION_ CHECKED_OUT

UNARY keyword. Searches for any DOCUMENT items that have a status of Checked Out.

DOCVERSION_IN_USE

UNARY keyword. Searches for any DOCUMENT items that have a status of In Use.

DOCVERSION_ CONNECTED_READ_ WRITE

UNARY keyword. Returns any DOCUMENT item that are marked as Connected Read Write.

DUEEND_DATE

DATE keyword. The date and time a TASK item must be completed by. The date and time an APPOINTMENT or NOTE item ends.

FROM

STRING keyword. Searches a MESSAGE item for a recipient name in the FROM field.

HIDDEN

UNARY keyword. Returns any MESSAGE item that has been marked as hidden.

LIBRARY

STRING keyword. Searches for DOCUMENT items that belong to a specific LIBRARY.

MAIL

UNARY keyword. Returns any MESSAGE item of type Mail.

MESSAGE

STRING keyword. Searches the Message Body of a MESSAGE item for the given text.

MODIFY_DATE

DATE keyword. The date and time an item in the user’s mailbox was last modified.

NOTE

STRING keyword. Returns any MESSAGE item of type NOTE (a.k.a. Reminder Note).

NUMBER_ACCEPTED

NUMERIC keyword. The number of users who have accepted a TASK, NOTE, or APPOINTMENT item

NUMBER_COMPLETED

NUMERIC keyword. The number of users who have completed a TASK.

NUMBER_DELETED

NUMERIC keyword. The number of users who have deleted a MESSAGE.

NUMBER_OPENDED

NUMERIC keyword. The number of users who have opened a MESSAGE.

NUMBER_READ

NUMERIC keyword. The number of users who have read a MESSAGE.

NUMBER_REPLIED

NUMERIC keyword. The number of users who have replied to a MESSAGE.

OFFICIAL_DOCUMENT_VERSIONS_ONLY

UNARY keyword. While searching LIBRARIES for a DOCUMENT, return only Document References to the "official" version of this document.

OFFICIAL_VERSION_ NUMBER

NUMERIC keyword. The version number of a DOCUMENT that is considered to be the "official" version.

ON_CALENDAR

UNARY keyword. Searches for any APPOINTMENT, NOTE, or TASK item. (FYI: Only Appointments, Notes, or Tasks are considered to be "On the calendar".)

ON_CHECKLIST

UNARY keyword. Returns any MESSAGE item that has been placed on the "Checklist".

OPENED

UNARY keyword. Searches for all MESSAGE items that have been opened by the recipient. Note: Personal or Draft items are considered "opened" when they are created.

PERSONAL_SUBJECT

STRING keyword. Searches any MESSAGE item for the Subject assigned by the recipient.

PHONE_MESSAGE

UNARY keyword. Returns all MESSAGE items of type Phone Message.

PLACE

STRING keyword. Searches an APPOINTMENT item for the location of this appointment.

PRIMARY_CATEGORY

STRING keyword. Searches any MESSAGE item for the CATEGORY assigned as the Primary Category. The CATEGORY text value must come from the CATEGORIES collection.

PRIORITY

ENUMERATED keyword. The Priority placed on a message item. Values to search for must be on of these text strings: HIGH, LOW, or NORMAL.

PRIVATE

UNARY keyword. Returns all MESSAGE items that are marked as Private.

READ

UNARY keyword. Returns all MESSAGE items that have been Read by the recipient. Note: Draft and Personal items are considered to have been Read at all times.

REPLY_REQUESTED

UNARY keyword. Searches for all MESSAGE items that the Sender asked for all Recipients to Reply to.

RETRIEVED_BY

STRING keyword. Searches DOCUMENT items for the name of the last person to Check Out or Save the document.

RETRIEVED_DATE

DATE keyword. The most recent date and time a DOCUMENT item was retrieved from a library.

ROUTED

UNARY keyword. Returns any MESSAGE item that are marked as part of a Work Flow.

SEARCH_AS_ LIBRARIAN

UNARY keyword. Users may be granted LIBRARIAN rights to any DOCUMENT LIBRARY. Setting this keyword allows the current user to use those rights to search all DOCUMENTS in the LIBRARY. Without this keyword, the returned list of DOCUMENT REFERENCES will only contain DOCUMENTS that the user may see using normal LIBRARY security.

SIZE

NUMERIC keyword. The size of an item in the mailbox.

START_DATE

DATE keyword. The date and time a TASK, REMINDER NOTE, or APPOINTMENT item begins.

SUBJECT

STRING keyword. Searches a MESSAGE items Subject field.

TASK

UNARY keyword. Returns all MESSAGE items of type TASK.

TASK_CATEGORY

NUMERIC keyword. This is listed as a NUMERIC keyword, and uses the NUMERIC data operators for all searches. But all values to search for must be a single text character from A-Z. For example, a TASK may be assigned a Category of "A" and a Priority of "4". The GroupWise Windows client will display this as the string "A4" in the Priority window. To find all TASKS assigned with a Category of "A", construct a filter expression similar to this: "(TASK_CATEGORY = "A")".

TASK_PRIORITY

NUMERIC keyword. The numeric priority given to a TASK. For example, a TASK item may be given a priority of "B" and a Priority of 2. If this TASK is displayed in the GroupWise Windows client, the Priority window will display the value "B2".

TO

STRING keyword. Searches a MESSAGE item for a recipient in the TO field.

TOTAL_RECIPIENTS

NUMERIC keyword. The number of users that this MESSAGE was sent to.

VERSION_NUMBER

NUMERIC keyword. A revision number of a DOCUMENT within a LIBRARY.

VIEW

STRING keyword. Obsolete. Searches a MESSAGE item for a name that displays a specific View in the GroupWise Windows Client. (Remember the old View Designer? The name used inside that product was stored in each MESSAGE item that should be displayed using that form.)

5.3.2 AddressBook Keywords

The keywords for the GroupWise System Address Book are

  • Name

  • First Name

  • Last Name

  • E-Mail Address

  • Department

For example, you can use filters similar to the following:

  • (Name CONTAINS ‘Smi*’)
  • (<First Name> MATCHES "John")
  • (<Last Name> CONTAINS ‘Smi*’)
  • (<E-Mail Address> CONTAINS "*novell.com")
  • (Department CONTAINS "System Test")

NOTE:Field names that contain spaces must be wrapped between brackets (< >).