Filters

The following formula script functions support the use of a primary filter as an optional argument:

• entity\countRelated()
• entity\sumRelated()
• record\count()
• record\findOne()
• record\findRelatedMany()
• record\findRelatedOne()

Only Primary Filters can be used for the optional FILTER argument.

The following lists all the primary filters that are currently available in the system.

Note

Primary Filter names are case sensitive and must be defined as shown.

Note

Primary filters are predefined by Mythradon. Currently, system administrators and developers do not have the capability to create additional primary filters.

---

Account

Account filters:

• customers - WHERE type = 'Customer'
• partners - WHERE type = 'Partner'
• recentlyCreated - WHERE createdAt within the last 7 days
• resellers - WHERE type = 'Reseller'

Customer Account Filter Example

$Id = record\findOne('Account', 'createdAt', 'desc', 'customers');
output\printLine($Id);

Partner Account Filter Example

$Id = record\findOne('Account', 'createdAt', 'desc', 'partners');
output\printLine($Id);

Recently Created Account Filter Example

$Id = record\findOne('Account', 'createdAt', 'desc', 'recentlyCreated');
output\printLine($Id);

Reseller Account Filter Example

$Id = record\findOne('Account', 'createdAt', 'desc', 'resellers');
output\printLine($Id);

---

Attachment

Attachment filters:

• orphan - WHERE the attachment record is condsidered an orphan and is not linked to any other records

Orphaned Attachment Filter Example

$Id = record\findOne('Attachment', 'createdAt', 'desc', 'orphan');
output\printLine($Id);

---

AuthLogRecord

Authentication Log Record filters:

• accepted - WHERE isDenied = false
• denied - WHERE isDenied = true

Successful Authentication Log Filter Example

$Id = record\findOne('AuthLogRecord', 'createdAt', 'desc', 'accepted');
output\printLine($Id);

Unsuccessful Authentication Log Filter Example

$Id = record\findOne('AuthLogRecord', 'createdAt', 'desc', 'denied');
output\printLine($Id);

---

AuthToken

Authentication Token filters:

• active - WHERE isActive = true
• inactive - WHERE isActive = false

Active Authentication Token Filter Example

$Id = record\findOne('AuthToken', 'createdAt', 'desc', 'active');
output\printLine($Id);

Inactive Authentication Token Filter Example

$Id = record\findOne('AuthToken', 'createdAt', 'desc', 'inactive');
output\printLine($Id);

---

Call

Call record filters:

• todays - WHERE dateStart = today() Uses the current user's timezone

Todays Calls Filter Example

$Id = record\findOne('Call', 'createdAt', 'desc', 'todays');
output\printLine($Id);

---

Campaign

Campaign filters:

• active - WHERE status = 'Active'

Active Campaign Filter

$Id = record\findOne('Campaign', 'createdAt', 'desc', 'active');
output\printLine($Id);

---

CampaignLogRecord

Campaign Log Record filters:

• bounced - WHERE action = 'Bounced'
• clicked - WHERE action = 'Clicked'
• leadCreated - WHERE action = 'Lead Created'
• opened - WHERE action = 'Opened'
• optedIn - WHERE action = 'Opted In'
• optedOut - WHERE action = 'Opted Out'
• sent - WHERE action = 'Sent'

Bounced Campaign Log Filter

$Id = record\findOne('CampaignLogRecord', 'createdAt', 'desc', 'bounced');
output\printLine($Id);

Clicked Campaign Log Filter

$Id = record\findOne('CampaignLogRecord', 'createdAt', 'desc', 'clicked');
output\printLine($Id);

Lead Created Campaign Log Filter

$Id = record\findOne('CampaignLogRecord', 'createdAt', 'desc', 'leadCreated');
output\printLine($Id);

Opened Campaign Log Filter

$Id = record\findOne('CampaignLogRecord', 'createdAt', 'desc', 'opened');
output\printLine($Id);

Opted-In Campaign Log Filter

$Id = record\findOne('CampaignLogRecord', 'createdAt', 'desc', 'optedIn');
output\printLine($Id);

Opted-Out Campaign Log Filter

$Id = record\findOne('CampaignLogRecord', 'createdAt', 'desc', 'optedOut');
output\printLine($Id);

Sent Campaign Log Filter

$Id = record\findOne('CampaignLogRecord', 'createdAt', 'desc', 'sent');
output\printLine($Id);

---

Case

Case filters:

• closed - WHERE status = 'Closed'
• open - WHERE status = 'Open'

Case Closed Filter

$Id = record\findOne('Case', 'createdAt', 'desc', 'closed');
output\printLine($Id);

Case Open Filter

$Id = record\findOne('Case', 'createdAt', 'desc', 'open');
output\printLine($Id);

---

Contact

Contact filters:

• notPortalUsers - WHERE portalUserFilter.id = null
• portalUsers - WHERE portalUserFilter.id != null

Contact Not Portal User Filter

$Id = record\findOne('Contact', 'createdAt', 'desc', 'notPortalUsers');
output\printLine($Id);

Contact Portal User Filter

$Id = record\findOne('Contact', 'createdAt', 'desc', 'portalUsers');
output\printLine($Id);

---

Document

Document filters:

• active - WHERE status = 'Active'
• draft - WHERE status = 'Draft'

Active Document Filter

$Id = record\findOne('Document', 'createdAt', 'desc', 'active');
output\printLine($Id);

Draft Document Filter

$Id = record\findOne('Document', 'createdAt', 'desc', 'draft');
output\printLine($Id);

---

EmailAddress

Email Address filters:

• orphan - WHERE record is considered orphaned - Not linked to any other records

Orphaned Email Address Filter Example

$Id = record\findOne('EmailAddress', 'name', 'desc', 'orphan');
output\printLine($Id);

Note

The EmailAddress entity does not have a cratedAt field. The sort order on this example uses the name field.

---

EmailQueueItem

Email Queue Item filters:

• failed - WHERE status = 'Failed'
• pending WHERE status = 'Pending'
• sent - WHERE status = 'Sent'

Failed Email Queue Item Filter Example

$Id = record\findOne('EmailQueueItem', 'createdAt', 'desc', 'failed');
output\printLine($Id);

Pending Email Queue Item Filter Example

$Id = record\findOne('EmailQueueItem', 'createdAt', 'desc', 'pending');
output\printLine($Id);

Sent Email Queue Item Filter Example

$Id = record\findOne('EmailQueueItem', 'createdAt', 'desc', 'sent');
output\printLine($Id);

---

EmailTemplate

Email Template filters:

• actual - WHERE oneOff = false

Actual Email Template Filter Example

$Id = record\findOne('EmailTemplate', 'createdAt', 'desc', 'actual');
output\printLine($Id);

---

KnowledgeBaseArticle

Knowledge Base Article filters:

• published - WHERE status = 'Published'

Published Knowledge Base Article Filter Example

$Id = record\findOne('KnowledgeBaseArticle', 'createdAt', 'desc', 'published');
output\printLine($Id);

---

Lead

• actual - WHERE status NOT IN ['Converted', 'Recycled', 'Dead']
• converted - WHERE status = 'Converted'

Unconverted Lead Filter Example

$Id = record\findOne('Lead', 'createdAt', 'desc', 'actual');
output\printLine($Id);

Converted Lead Filter Example

$Id = record\findOne('Lead', 'createdAt', 'desc', 'converted');
output\printLine($Id);

---

MassEmail

• actual - WHERE status IN ['Pending', 'Draft']
• complete - WHERE status = 'Complete'

Actual Mass Email Filter Example

$Id = record\findOne('MassEmail', 'createdAt', 'desc', 'actual');
output\printLine($Id);

Complete Mass Email Filter Example

$Id = record\findOne('MassEmail', 'createdAt', 'desc', 'complete');
output\printLine($Id);

---

Meeting

• held - WHERE status = 'Held'
• planned - WHERE status = 'Planned'
• todays - WHERE dateStart = Today() - Uses current User's timezone

Held Meeting Filter Example

$Id = record\findOne('Meeting', 'createdAt', 'desc', 'held');
output\printLine($Id);

Planned Meeting Filter Example

$Id = record\findOne('Meeting', 'createdAt', 'desc', 'planned');
output\printLine($Id);

Todays Meeting Filter Example

$Id = record\findOne('Meeting', 'createdAt', 'desc', 'todays');
output\printLine($Id);

---

Note

Note filters:

• posts
• updates

$Id = record\findOne('Note', 'createdAt', 'desc', 'posts');
output\printLine($Id);

$Id = record\findOne('Note', 'createdAt', 'desc', 'updates');
output\printLine($Id);

---

Opportunity

• lost - WHERE stage = 'Lost'
• open - WHERE stage = 'Open'
• won - WHERE stage = 'Won'

Lost Opportunity Filter Example

$Id = record\findOne('Opportunity', 'name', 'desc', 'lost');
output\printLine($Id);

Open Opportunity Filter Example

$Id = record\findOne('Opportunity', 'name', 'desc', 'open');
output\printLine($Id);

Won Opportunity Filter Example

$Id = record\findOne('Opportunity', 'name', 'desc', 'won');
output\printLine($Id);

---

PhoneNumber

Phone number filters:

• orphan - WHERE record is considered an orphan

Orphaned Phone Number Filter Example

$Id = record\findOne('PhoneNumber', 'name', 'desc', 'orphan');
output\printLine($Id);

---

Task

Task filters:

• actual - WHERE status NOT IN ['Completed', 'Canceled', 'Deferred']
• actualStartingNotInFuture - WHERE (status NOT IN ['Completed', 'Canceled', 'Deferred']) OR (dateStart = NULL) using the current User's timezone
• completed - WHERE status = 'Completed'
• deferred - WHERE status = 'Deferred'
• overdue - WHERE (status NOT IN ['Completed', 'Canceled', 'Deferred']) AND (dateEnd < Now()) using the current User's timezone
• todays - WHERE dateEnd = Today() using the current User's timezone

Task Actual Filter Example

$Id = record\findOne('Task', 'name', 'desc', 'actual');
output\printLine($Id);

Task Actual Starting Not in Future Filter Example

$Id = record\findOne('Task', 'name', 'desc', 'actualStartingNotInFuture');
output\printLine($Id);

Completed Task Filter Example

$Id = record\findOne('Task', 'name', 'desc', 'completed');
output\printLine($Id);

Deferred Task Filter Example

$Id = record\findOne('Task', 'name', 'desc', 'deferred');
output\printLine($Id);

Overdue Task Filter Example

$Id = record\findOne('Task', 'name', 'desc', 'overdue');
output\printLine($Id);

Todays Task Filter Example

$Id = record\findOne('Task', 'name', 'desc', 'todays');
output\printLine($Id);

---

User

User filters:

• active - WHERE isActive = true AND type IN ['regular', 'admin']
• activeapi - WHERE isActive = true AND type = 'api'
• activeportal - WHERE isActive = true AND type = 'portal'
• api - WHERE type = 'api'
• internal - WHERE type NOT IN ['portal', 'api', 'system']
• portal - WHERE type = 'portal'

Active User Filter Example

$Id = record\findOne('User', 'name', 'desc', 'active');
output\printLine($Id);

Active API User Filter Example

$Id = record\findOne('User', 'name', 'desc', 'activeapi');
output\printLine($Id);

Active Portal User Filter Example

$Id = record\findOne('User', 'name', 'desc', 'activeportal');
output\printLine($Id);

API User Filter Example

$Id = record\findOne('User', 'name', 'desc', 'api');
output\printLine($Id);

Internal User Filter Example

$Id = record\findOne('User', 'name', 'desc', 'internal');
output\printLine($Id);

Portal User Filter Example

$Id = record\findOne('User', 'name', 'desc', 'portal');
output\printLine($Id);

---

WorkingTimeRange

Working Time Range filters:

• actual - WHERE endDate >= Today()

WorkingTimeRange Actual Filter Example

$Id = record\findOne('WorkingTimeRange', 'name', 'desc', 'actual');
output\printLine($Id);

---

See Also

• Array Functions
• Datetime Functions
• Entity Functions
• Env Functions
• Ext Functions
• JSON Functions
• Language Functions
• Number Functions
• Object Functions
• Output Functions
• Password Functions
• Record Functions
• String Functions

• Util Functions

• Formula Examples

• Formula Sandbox

• Mythradon Bookshelf Home

• Mythradon Basics

• Mythradon Marketing
• Mythradon Sales
• Mythradon Service
• Mythradon System Administration
• Mythradon Tools

---