Documentation

This is taking longer than usual. If nothing appears, refresh the page.

Documentation

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!
  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Auto Values

The Auto Values feature lets an administrator define how auto-generated values, such as reference IDs, are constructed. In places where more than a sequence number (000001234) is required, an Auto Value can be modified to include dates, time, location, teams, user IDs and more. There are many situations where this type of sequence is much more preferable over a simple numeric sequence.

Some examples include:

  • Shipment numbers
  • Document or Article Reference Numbers
  • Stock Item Codes
  • Asset ID’s
  • Access Code numbers

Auto Value Configuration

  • Description
  • Add Auto Value Component
  • Current Value
  • Daily Increment
  • Monthly Increment
  • Yearly Increment
  • Time last generated

Available Auto Value Component Parts

The following list of component parts is available to construct an auto value.

Component Description
seq( z, r ) A number starting at 1 when the sequence is first used and incremented by one each time the sequence is used, and will never be reset for the entire life of the sequence.
seqd( z, r ) A number starting at 1 at the beginning of each day, and incremented by one each time the sequence is used. This is the daily incremental value for this specific sequence instance.
seqm( z, r ) A number starting at 1 at the beginning of each month, and incremented by one each time the sequence is used. This is the monthly incremental value for this specific sequence instance.
seqy( z, r ) A number starting at 1 at the beginning of each year, and incremented by one each time the sequence is used. This is the yearly incremental value for this specific sequence instance.
date() year - The current four-digit year (e.g. 2008)
year2 - The current two-digit year (e.g. 08)
month - The current two-digit month (01-12)
day - The current two-digit day of the month (01-31)
hour - The current two-digit hour (00-23)
hour12 - The current two-digit hour (01-12)
min - The current two-digit minute (00-59) at the point in time of invocation based on the analysts current time zone settings
sec - The current two-digit second (00-59) at the point in time of invocation based on the analysts current time zone settings
udate() not specified - The current UTC time in ISO8601 date/time format
year - The current four-digit year (e.g. 2008)
year2 - The current two-digit year (e.g. 08)
month - The current two-digit month (01-12)
day - The current two-digit day of the month (01-31)
hour - The current two-digit hour (00-23)
hour12 - The current two-digit hour (01-12)
min- The current two-digit minute (00-59) at the point in time of invocation based on the analysts current time zone settings
sec - The current two-digit second (00-59) at the point in time of invocation based on the analysts current time zone settings
epoch - The UTC time as a unix EPOCH time which is a positive number representing the number of seconds elapsed since the 1st January 1970 at 12:00.
tick() Returns high (microsecond) or low (millisecond) resolution tick count value for precision time stamp generation. You would use this in combination with an epoch time to compose a precision timestamp. For example {udate(epoch)}{tick(uM,6)}
uuid() normal - This generates a UUID that is unique to the system it’s being generated on
sess( prop_name ) The current user’s session property.
param(param_name) A value passed into the function when invoking the sequence.
rec( column_name ) Use a value that is stored in the database record.

Note

The ‘z’ parameter is optional, but if specified indicates the number of leading zeros to display: if not specified, then ZERO is assumed. If the number of digits in the resultant value exceeds the number of places defined here, then the left-most digits will be discarded. The ‘r’ parameter allows you to specify the base to use when converting the numeric value to a string. The default value, if not specified, is ten (10), any value between 2 and 36 is valid.

In This Document