ITrack/Enterprise/EDocuments Extension - Revision history

Dillon Sadofsky at 20:29, 14 October 2025

2025-10-14T20:29:14Z

← Older revision		Revision as of 15:29, 14 October 2025
Line 4:		Line 4:
	* To create output for [[HDExchange\|HD Exchange]] and [[TransNet]] electronic purchase orders on the [[Purchase Orders Screen (Enterprise)\|PO screen]]		* To create output for [[HDExchange\|HD Exchange]] and [[TransNet]] electronic purchase orders on the [[Purchase Orders Screen (Enterprise)\|PO screen]]
	* To create quote emails from the [[Sales Orders Screen (Enterprise)\|sales orders screen]]		* To create quote emails from the [[Sales Orders Screen (Enterprise)\|sales orders screen]]
	* To fill out dynamic document (SO, WO, TO, PO) lineitem descriptions based on user preferences		* To fill out dynamic document (SO, WO, TO, PO) lineitem descriptions based on [[#Document Descriptions\|user preferences]]

	==Database Structure==		==Database Structure==
Line 146:		Line 146:
	test1_____1__________@ $1,000.00 $1,000.00__This is a test item that I created to demonstrate this process<br>		test1_____1__________@ $1,000.00 $1,000.00__This is a test item that I created to demonstrate this process<br>
	test2_____20_________@ $500.00___$10,000.00 This is another item		test2_____20_________@ $500.00___$10,000.00 This is another item

			==Document Descriptions==
			Companies can change the default SO, WO, PO, and TO descriptions generated by the system when items are added to documents by changing the settings:
			* Sales Order: Template for line-item description
			* Work Order: Template for line-item description
			* Purchase Order: Template for line-item description
			* Transfer Order: Template for line-item description

			The top-level tables that are available in the template string are: inventory, inventorytype, vehicle, manufacturer, model, store

	[[Category:ITrack/Enterprise/Extensions]]		[[Category:ITrack/Enterprise/Extensions]]

Dillon Sadofsky at 17:16, 23 April 2024

2024-04-23T17:16:47Z

← Older revision		Revision as of 12:16, 23 April 2024
Line 4:		Line 4:
	* To create output for [[HDExchange\|HD Exchange]] and [[TransNet]] electronic purchase orders on the [[Purchase Orders Screen (Enterprise)\|PO screen]]		* To create output for [[HDExchange\|HD Exchange]] and [[TransNet]] electronic purchase orders on the [[Purchase Orders Screen (Enterprise)\|PO screen]]
	* To create quote emails from the [[Sales Orders Screen (Enterprise)\|sales orders screen]]		* To create quote emails from the [[Sales Orders Screen (Enterprise)\|sales orders screen]]
			* To fill out dynamic document (SO, WO, TO, PO) lineitem descriptions based on user preferences

	==Database Structure==		==Database Structure==

Dillon Sadofsky: /* Subreports */

2017-09-20T22:32:16Z

Subreports

← Older revision		Revision as of 17:32, 20 September 2017
Line 21:		Line 21:

	==Subreports==		==Subreports==
	Subreports represent dynamic sections of the top-level report that are repeated once for each data source registered in the subreport. A report can have unlimited subreports (they can be nested). Subreports are initiated with the special string '#BEGIN DETAIL#~~' (without quotation marks)~~ and terminated by '#END DETAIL#~~' (without quotation marks).~~		Subreports represent dynamic sections of the top-level report that are repeated once for each data source registered in the subreport. A report can have unlimited subreports (they can be nested). Subreports are initiated with the special string:
			#BEGIN DETAIL#
			and terminated by the string:
			#END DETAIL#

	Each subreport is given a 0-based index. A datasource is created for each subreport with the name subreportN, where N is the index of the subreport (example: subreport0 is the data source that represents metadata for the first subreport in the document).		Each subreport is given a 0-based index. A datasource is created for each subreport with the name subreportN, where N is the index of the subreport (example: subreport0 is the data source that represents metadata for the first subreport in the document).

Dillon Sadofsky: /* Inserting a Subreport */

2017-09-20T22:31:14Z

Inserting a Subreport

← Older revision		Revision as of 17:31, 20 September 2017
Line 27:		Line 27:
	===Inserting a Subreport===		===Inserting a Subreport===
	The sub-report declaration has an optional area for passing in commands to the subreport generator. They follow the following syntax:		The sub-report declaration has an optional area for passing in commands to the subreport generator. They follow the following syntax:
	#BEGIN DETAIL[('''subreport_name''', '''row_offset''', '''row_count''', '''row_separator''')]#		#BEGIN DETAIL[('''subreport_name''', '''row_offset''', '''row_count''', '''row_separator''')]#

	Here are all the optional arguments explained. Not all of the parameters have to be specified, but a parameter must have all previous parameters specified.		Here are all the optional arguments explained. Not all of the parameters have to be specified, but a parameter must have all previous parameters specified.

Dillon Sadofsky: /* Subreports */

2017-09-20T20:58:19Z

Subreports

← Older revision		Revision as of 15:58, 20 September 2017
Line 25:		Line 25:
	Each subreport is given a 0-based index. A datasource is created for each subreport with the name subreportN, where N is the index of the subreport (example: subreport0 is the data source that represents metadata for the first subreport in the document).		Each subreport is given a 0-based index. A datasource is created for each subreport with the name subreportN, where N is the index of the subreport (example: subreport0 is the data source that represents metadata for the first subreport in the document).

			===Inserting a Subreport===
	The sub-report declaration has an optional area for passing in commands to the subreport generator. They follow the following syntax:		The sub-report declaration has an optional area for passing in commands to the subreport generator. They follow the following syntax:
	#BEGIN DETAIL[('''subreport_name''', '''row_offset''', '''row_count''', '''row_separator''')]#		#BEGIN DETAIL[('''subreport_name''', '''row_offset''', '''row_count''', '''row_separator''')]#
Line 33:		Line 34:
	* '''row_count''': This is the number of rows to output in the subreport. This is similar to the second argument to a LIMIT clause in MySQL.		* '''row_count''': This is the number of rows to output in the subreport. This is similar to the second argument to a LIMIT clause in MySQL.
	* '''row_separator''': This string represents the character sequence to automatically insert between all occurrences of the subreport. A common option for this section is "\n"		* '''row_separator''': This string represents the character sequence to automatically insert between all occurrences of the subreport. A common option for this section is "\n"

			===Special variables in subreports===
			A couple special non-database tokens are available when using subreports.

			* {?subreport_name.count} - will give you the number of rows in a subreport. Useful for reporting a number of rows before or after the subreport. This variable is available anywhere in the report.
			* {?detail_id} - will add an index of the current row inside a subreport. This counts from 0 to N where N is the number of rows in the subreport. This variable is available only inside a subreport.

	==Variables==		==Variables==

Dillon Sadofsky: /* Functions */

2017-03-30T21:41:45Z

Functions

← Older revision		Revision as of 16:41, 30 March 2017
Line 60:		Line 60:
	**''if_true'': used if the expression evaluates to true		**''if_true'': used if the expression evaluates to true
	**''if_false'': used if the expression evaluates to false		**''if_false'': used if the expression evaluates to false
			*IFEMPTY(''str'', ''replacement''): simply tests ''str'' to see if its an empty string. If it is, replace it with ''replacement''. Otherwise ''str'' is returned.
	* PAD/PADLEFT(''str'', ''count'', [''padChar'']). This function pads a string out to a particular minimum length with a specified substring. If the string is already long enough, the string will not be modified.		* PAD/PADLEFT(''str'', ''count'', [''padChar'']). This function pads a string out to a particular minimum length with a specified substring. If the string is already long enough, the string will not be modified.
	** ''str'': the string to be padded.		** ''str'': the string to be padded.

Dillon Sadofsky: /* Functions */

2017-03-30T21:39:36Z

Functions

← Older revision		Revision as of 16:39, 30 March 2017
Line 54:		Line 54:

	Below is a list of all functions currently processed by the EDocument manager (optional parameters are enclosed by brackets):		Below is a list of all functions currently processed by the EDocument manager (optional parameters are enclosed by brackets):
			*IF(''expression'', ''if_true'', ''if_false''). This is a simple IF operation that attempts to evaluate an expression and use one of two arguments as replacement.
			**''expression'': a pretty standard IF expression, but it follows one of the following 2 syntaxes:
			***''x'' OPERATION ''y'': OPERATION can be one of (=, !=, <, >, <=, >=)
			***''x'': x is tested for 'truthiness'. Anything other than 'False', '', or '0' is True.
			**''if_true'': used if the expression evaluates to true
			**''if_false'': used if the expression evaluates to false
	* PAD/PADLEFT(''str'', ''count'', [''padChar'']). This function pads a string out to a particular minimum length with a specified substring. If the string is already long enough, the string will not be modified.		* PAD/PADLEFT(''str'', ''count'', [''padChar'']). This function pads a string out to a particular minimum length with a specified substring. If the string is already long enough, the string will not be modified.
	** ''str'': the string to be padded.		** ''str'': the string to be padded.
Line 90:		Line 96:
	**''default'': the default value for the setting that will be used (and written to that setting) if it didn't previously exist (default is "").		**''default'': the default value for the setting that will be used (and written to that setting) if it didn't previously exist (default is "").
	**''cascade'': whether the setting should cascade to user settings (non-cascading functions shouldn't be defined at lower scopes). (See [[Settings (Enterprise)\|settings]] for more info).		**''cascade'': whether the setting should cascade to user settings (non-cascading functions shouldn't be defined at lower scopes). (See [[Settings (Enterprise)\|settings]] for more info).
	*CONCAT([''str'', ]). Simply concatenates all arguments together. Not usually required, but useful at times if nesting functions within each other.		*CONCAT([SEPARATOR ''sep'',][PREPEND ''pre'',][APPEND ''post'',][''str'',]). Simply concatenates all arguments together. Not usually required, but useful at times if nesting functions within each other.
			**''sep'': an optional separator to go between any two non-empty arguments
			**''pre'': an optional string to be put at the start of the output if its not empty
			**''post'': an optional string to be put at the end of the output if its not empty
			**''str'': any number of other strings to concatenate

	==Pre-processing==		==Pre-processing==

Dillon Sadofsky: /* Functions */

2017-03-29T20:53:54Z

Functions

← Older revision		Revision as of 15:53, 29 March 2017
Line 50:		Line 50:
	The general syntax for calling functions is:		The general syntax for calling functions is:
	{#FUNCTION_NAME(param1[, more_params])}		{#FUNCTION_NAME(param1[, more_params])}

			Arguments can optionally be enclosed in single or double quotes. This is sometimes helpful to make spaces, commas, or parentheses part of arguments (such as strip). Characters can be escaped with backslashes.

	Below is a list of all functions currently processed by the EDocument manager (optional parameters are enclosed by brackets):		Below is a list of all functions currently processed by the EDocument manager (optional parameters are enclosed by brackets):
Line 88:		Line 90:
	**''default'': the default value for the setting that will be used (and written to that setting) if it didn't previously exist (default is "").		**''default'': the default value for the setting that will be used (and written to that setting) if it didn't previously exist (default is "").
	**''cascade'': whether the setting should cascade to user settings (non-cascading functions shouldn't be defined at lower scopes). (See [[Settings (Enterprise)\|settings]] for more info).		**''cascade'': whether the setting should cascade to user settings (non-cascading functions shouldn't be defined at lower scopes). (See [[Settings (Enterprise)\|settings]] for more info).
			*CONCAT([''str'', ]). Simply concatenates all arguments together. Not usually required, but useful at times if nesting functions within each other.

	==Pre-processing==		==Pre-processing==

Dillon Sadofsky: /* Functions */

2017-03-29T16:12:39Z

Functions

← Older revision		Revision as of 11:12, 29 March 2017
Line 47:		Line 47:
	==Functions==		==Functions==
	Functions are data interpreting clauses that mutate parts of the content of an edocument. They are usually string modification, formatting, or math functions. Their format is a variable name (case-insensitive, but all caps is expected) surrounded by the appropriate function symbols (see syntax below), followed by parenthesis containing an N-tuple of comma separated parameters (example: PAD(test, 10). Some of these functions have optional parameters. All non-optional parameters are required for document generation (an error will be thrown if less than the minimum # of parameters is passed to a particular function).		Functions are data interpreting clauses that mutate parts of the content of an edocument. They are usually string modification, formatting, or math functions. Their format is a variable name (case-insensitive, but all caps is expected) surrounded by the appropriate function symbols (see syntax below), followed by parenthesis containing an N-tuple of comma separated parameters (example: PAD(test, 10). Some of these functions have optional parameters. All non-optional parameters are required for document generation (an error will be thrown if less than the minimum # of parameters is passed to a particular function).

			The general syntax for calling functions is:
			{#FUNCTION_NAME(param1[, more_params])}

	Below is a list of all functions currently processed by the EDocument manager (optional parameters are enclosed by brackets):		Below is a list of all functions currently processed by the EDocument manager (optional parameters are enclosed by brackets):

Dillon Sadofsky: /* Functions */

2017-03-29T15:44:39Z

Functions

← Older revision		Revision as of 10:44, 29 March 2017
Line 54:		Line 54:
	** ''padChar'': the substring that will be added to the left of the string repeatedly until the string is at or longer than ''count''. If this string is omitted, it will be assumed to be a single space character.		** ''padChar'': the substring that will be added to the left of the string repeatedly until the string is at or longer than ''count''. If this string is omitted, it will be assumed to be a single space character.
	*PADRIGHT(''str'', ''count'', [''padChar'']). This function is the same as above, but the substring will be added to the right side of the string until the desired length is reached.		*PADRIGHT(''str'', ''count'', [''padChar'']). This function is the same as above, but the substring will be added to the right side of the string until the desired length is reached.
			*TRIM(''trim_side'', ''str'', ''to_remove''). This function will remove all occurances of the set of characters from either side of the argument string
			**''trim_side'': is RIGHT, LEFT, or BOTH, specifying which side of the string to trim from
			**''str'': is the main string to trim from
			**''to_remove'': is an array of characters to trim from the string.
			*REMOVE(''remove_side'', ''str'', ''to_remove''). This function is like TRIM, but it removes an exact string from the left or right (or both) of the argument
			**''remove_side'': is RIGHT, LEFT, or BOTH, specifying which side of the string to remove from
			**''str'': is the main string to remove from
			**''to_remove'': is an exact string to be removed from the main string.
	*ESCAPE(''str''): This function will do standard SQL escaping on the string ''str''. In other words, the characters \ and ' will be escaped with the character \.		*ESCAPE(''str''): This function will do standard SQL escaping on the string ''str''. In other words, the characters \ and ' will be escaped with the character \.
	*CURRENCY(''str'', [''prechar'' = $], [''precision'' = 2], [''delimit_thousands'' = false]): this string formats a numerical (decimal) string to be a currency formatted string.		*CURRENCY(''str'', [''prechar'' = $], [''precision'' = 2], [''delimit_thousands'' = false]): this string formats a numerical (decimal) string to be a currency formatted string.