Difference between revisions of "Auto Values"

From Hornbill
Jump to navigation Jump to search
 
(47 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
__NOTOC__[[Main_Page|Home]] > [[Administration]] > [[Data]] > Auto Values
+
This document can now be found at its new location in the [https://docs.hornbill.com/esp-config/advanced-tools-and-settings/auto-values/ Hornbill Document Library].
 +
 
 +
[[file:hornbill-document-library.png|Hornbill Cloud|link=https://docs.hornbill.com/esp-config/advanced-tools-and-settings/auto-values/]]
 +
<!--
 +
__NOTOC__[[Main_Page|Home]] > [[Administration]] > [[System Administration|System]] > [[Data]] > Auto Values {{#ev:youtube|_9Dduf-Ga10|400|right}}
 
==Introduction==
 
==Introduction==
−
The Auto Values feature lets an administrator define how auto-generated values are constructed.
+
The Auto Values feature lets an administrator define how auto-generated values, such as reference IDs, are constructed. 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 sequences. 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 lists of component parts are available to construct an auto value.
 +
 
 +
{| class="wikitable"
 +
 
 +
|-
 +
|nowrap="1"|'''seq(''' ''z'', ''r'' ''')'''
 +
|
 +
 
 +
:{| class="prettytable"
 +
 
 +
|- bgcolor="#e0e0e0"
 +
|'''Description'''
 +
 
 +
|-
 +
|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.
 +
|}
 +
 
 +
 
 +
|-
 +
|nowrap="1"|'''seqd(''' ''z'', ''r'' ''')'''
 +
|
 +
 
 +
:{| class="prettytable"
 +
 
 +
|- bgcolor="#e0e0e0"
 +
|'''Description'''
 +
 
 +
|-
 +
|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.
 +
|}
 +
 
 +
 
 +
|-
 +
|nowrap="1"|'''seqm(''' ''z'', ''r'' ''')'''
 +
|
 +
 
 +
:{| class="prettytable"
 +
 
 +
|- bgcolor="#e0e0e0"
 +
|'''Description'''
 +
 
 +
|-
 +
|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.
 +
|}
 +
 
 +
 
 +
|-
 +
|nowrap="1"|'''seqy(''' ''z'', ''r'' ''')'''
 +
|
 +
 
 +
:{| class="prettytable"
 +
 
 +
|- bgcolor="#e0e0e0"
 +
|'''Description'''
 +
|
 +
 
 +
|-
 +
|Will be translated into 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.
 +
|}
 +
 
 +
|-
 +
|
 +
|
 +
 
 +
:{| class="prettytable"
 +
 
 +
|-
 +
|
 +
|
 +
 
 +
|-
 +
 
 +
 
 +
|''The 'z' parameter is optional but if specified indicates the number of leading zero's 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. ''
 +
 
 +
|}
 +
 
 +
|-
 +
|nowrap="1"|'''date(''' ''[part]'' ''')
 +
|
 +
 
 +
 
 +
:{| class="prettytable"
 +
 
 +
|- bgcolor="#e0e0e0"
 +
|Part
 +
|'''Description'''
 +
 
 +
|-
 +
|nowrap="1"|'''year'''
 +
|The current four-digit year (e.g. 2008)
 +
 
 +
|-
 +
|nowrap="1"|'''year2'''
 +
|The current two-digit year (e.g. 08)
 +
 
 +
|-
 +
|nowrap="1"|'''month'''
 +
|The current two-digit month (01-12)
 +
 
 +
|-
 +
|nowrap="1"|'''day'''
 +
|The current two-digit day of the month (01-31)
 +
 
 +
|-
 +
|nowrap="1"|'''hour'''
 +
|The current two-digit hour (00-23)
 +
 
 +
|-
 +
|nowrap="1"|'''hour12'''
 +
|The current two-digit hour (01-12)
 +
 
 +
|-
 +
|nowrap="1"|'''min'''
 +
|The current two-digit minute (00-59) at the point in time of invocation based on the analysts current time zone settings
 +
 
 +
|-
 +
|nowrap="1"|'''sec'''
 +
|The current two-digit second (00-59) at the point in time of invocation based on the analysts current time zone settings
 +
 
 +
|}
 +
 
 +
 
 +
|-
 +
|nowrap="1"|'''udate(''' ''[part]'' ''')
 +
|
 +
 
 +
:{| class="prettytable"
 +
 
 +
|- bgcolor="#e0e0e0"
 +
|Part
 +
|'''Description'''
 +
 
 +
|-
 +
|nowrap="1"|''not specified''
 +
|The current UTC time in ISO8601 date/time format
 +
 
 +
|-
 +
|nowrap="1"|'''year'''
 +
|The current four-digit year (e.g. 2008)
 +
 
 +
|-
 +
|nowrap="1"|'''year2'''
 +
|The current two-digit year (e.g. 08)
 +
 
 +
|-
 +
|nowrap="1"|'''month'''
 +
|The current two-digit month (01-12)
 +
 
 +
|-
 +
|nowrap="1"|'''day'''
 +
|The current two-digit day of the month (01-31)
 +
 
 +
|-
 +
|nowrap="1"|'''hour'''
 +
|The current two-digit hour (00-23)
 +
 
 +
|-
 +
|nowrap="1"|'''hour12'''
 +
|The current two-digit hour (01-12)
 +
 
 +
|-
 +
|nowrap="1"|'''min'''
 +
|The current two-digit minute (00-59) at the point in time of invocation based on the analysts current time zone settings
 +
 
 +
|-
 +
|nowrap="1"|'''sec'''
 +
|The current two-digit second (00-59) at the point in time of invocation based on the analysts current time zone settings
 +
 
 +
|-
 +
|nowrap="1"|'''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.
 +
 
 +
|}
 +
 
 +
 
 +
 
 +
|-
 +
|nowrap="1"|'''uuid(''' ''[type]'' ''')
 +
|
 +
 
 +
:{| class="prettytable"
 +
 
 +
|- bgcolor="#e0e0e0"
 +
|Type
 +
|'''Description'''
 +
 
 +
|-
 +
|nowrap="1"|''normal''
 +
|This generates a UUID that is unique to the system its being generated on
 +
 
 +
|-
 +
|nowrap="1"|''secure''
 +
|This generates a UUID that cannot be traced to the Ethernet address of the computer on which it was generated
 +
 
 +
|-
 +
|nowrap="1"|''not specified''
 +
|The same as 'normal'.
 +
 
 +
|}
 +
 
 +
|-
 +
 
 +
|-
 +
|nowrap="1"|'''sess( ''prop_name'' )'''
 +
|
 +
:{| class="prettytable"
 +
 
 +
|-
 +
|
 +
|
 +
 
 +
|-
 +
|The current user’s session property.
 +
|}
 +
 
 +
|-
 +
|nowrap="1"|'''param(''param_name'')'''
 +
|
 +
:{| class="prettytable"
 +
 
 +
|-
 +
|
 +
|
 +
 
 +
|-
 +
|A value passed into the function when invoking the sequence.
 +
|}
 +
 
 +
|-
 +
|nowrap="1"|'''rec( ''column_name'' )'''
 +
|
 +
:{| class="prettytable"
  
−
== Options ==
+
|-
−
* Name
+
|
−
* Description
+
|
−
*Auto Value Components
 
−
:* seq(z,r)
 
−
:* seqd(z,r)
 
−
:* seqm(z,r)
 
−
:* seqy(z,r)
 
−
:* date()
 
−
:* udate()
 
−
:* uuid()
 
−
:* sess(name)
 
−
:* param(name)
 
−
:* rec(name)
 
  
−
* Current Value
+
|-
−
* Daily Increment
+
|Use a value that is stored in the database record.
−
* Monthly Increment
+
|}
−
* Yearly Increment
+
|}
−
* Time Last Generated
+
[[Category:Administration]][[Category:Videos]]
 +
-->
 +
[[Category:HDOC]]

Latest revision as of 18:07, 10 April 2024

This document can now be found at its new location in the Hornbill Document Library.

Hornbill Cloud

Retrieved from "https://wiki.hornbill.com/index.php?title=Auto_Values&oldid=32096"