Show TOC

Start ConditionLocate this document in the navigation structure

The start condition determines when the queue server triggers indexing of the documents collected in the queue.

The queue server regularly checks whether this start condition has been reached. If it has been reached, the queue server determines all documents that have the status To Be Indexed. It triggers indexing for these documents.

If more documents receive the status To Be Indexed in the meantime, the queue server only triggers indexing for them when the start condition is next met.

The following parameters denote the start condition:

  • Schedule Type
  • Schedule Time
  • Schedule Max Documents
Schedule Type Parameter

Defines the type of the start condition.

Type of Start Condition Meaning

Time

The indexing should be controlled by time. The queue server should trigger indexing at certain times or at certain time intervals.

You define the schedule using the parameter Schedule Time.

Count

The indexing should be controlled by quantity. The queue server should trigger indexing as soon as a particular number of documents are in the queue.

You define this number in the parameter Schedule Max Docs.

Both

The indexing should be controlled by time or quantity depending on which start condition is reached first.

Schedule Time Parameter

Only relevant for the start condition Time or Both.

Defines the schedule according to which the queue server triggers indexing. You have two options:

  • Variant 1: You define one or more times.

    For example: 'Each Monday at 8pm', 'Daily at 8am and 6pm'

  • Variant 2: You define one or more intervals.

    For example, 'Every 2 hours', 'Mondays, every 3 hours', 'Tuesdays, every 4 hours'.

You cannot combine these two variants. You define times or intervals.

Times

Use the following syntax to define times:

Specification Syntax Comment

<time>

<day>(<time_1>,<time_2>, ...)

You can define more than one time. Separate them with spaces.

<day>

Mon | Tue | Wed | Thu | Fri | Sat | Sun | All

If you use All, the definition is valid for every day of the week. If you also make specifications for individual days, TREX ignores them.

<time of day>

<hour> | <hour>:<minute>

  

<hour>

0-23

  

<minute>

0-59

  
Tip

All(12:00:00 AM)

Index documents daily at midnight.

All(0,6,20)

Index documents daily at midnight, 6am, and 8pm.

Mon(0,6:15,20) Tue(0,6:15,20) Wed(0,6:15,20) Thu(0,6:15,20) Fri(0,6:15,20)

Index documents Monday to Friday at 0:00, 6:15am, and 8pm.

Intervals

Use the following syntax to define intervals:

Specification Syntax Comment

<interval>

<day>-<time interval>

You can define multiple intervals. Separate them with spaces.

<day>

Mon | Tue | Wed | Thu | Fri | Sat | Sun | All

If you use All, the definition is valid for every day of the week. If you also make specifications for individual days TREX ignores them.

<time interval>

<hours> | <hours>:<minute>

  

<hours>

0-23

  

<minutes>

0-59

  

The queue server starts the calculation of the intervals at 0:00. As long as the intervals are not defined with All the calculation begins anew at 0:00 each day.

Tip

All-5

Index documents every five hours. On the first day, indexing takes place at 12am, 5am, 10am, 3pm, and 8pm. Because the interval is not interrupted, indexing takes place at 1am, 6am, 11am, 4pm, and 9pm on the second day.

All-0:30

Index documents every 30 minutes.

All-3:30

Index documents every three and a half hours.

Mon-5 Tue-6

Index documents every 5 hours on Mondays and every 6 hours on Tuesdays. On Mondays, indexing takes place at 12am, 5am, 10am, 3pm, and 8pm. On Tuesdays, indexing takes place at 12am, 6am, 12pm, and 6pm. On the other days, no indexing takes place.

Schedule Max Documents Parameter

Only relevant for the start condition Count or Both.

Defines the number of documents that the queue server collects before it triggers indexing.