job where

Available for: Content Management Server, Template Engine

Task: Searches for jobs that meet all the conditions that have been specified as parameter-value-pairs.

Syntax:

job where {parameter value}

Function parameters:

• parameter is one of the following identifiers:
  • maxResults specifies that value is a number that limits the number of hits. If number is less than or equals zero, the number of hits is unlimited.
  • category: The jobs whose category parameter equals the value value will be returned.
  • comment: Returns the jobs whose comment parameter contains the value value.
  • execLogin: Returns the jobs whose script will be executed under the login specified as value.
  • isActive: Returns the jobs whose isActive parameter equals value.
  • isQueued: If value is not 0 then all jobs will be returned whose queuePos value is greater than or equal to zero. Otherwise, all jobs with a queuePos value less than zero are returned.
  • name: The jobs whose name parameter equals the value value will be returned.
  • title: The jobs whose title parameter contains the value value will be returned.
• value contains the value for the respective parameter.

Return value if successful: the list of the names of the matching job entries (stringlist).

Necessary permissions (CM only): no restrictions

Example:

CM>job where isActive 1 execLogin root
rootJob1 rootJob2