Configurable POD Reports - Revision history

Anw: Added more details to description of custom scripts in configurable reports

2022-01-28T16:11:38Z

Added more details to description of custom scripts in configurable reports

@@ Line 241: / Line 241: @@
 * Extract portions of a particular field
 * Apply unusual formatting
 When adding the elements, ensure that the element is classed with the name of the function you want to apply to that element, or a common class to all functions that need this applying.

Anw: Added more details to use of IIF in configurable reports

2022-01-28T15:35:55Z

Added more details to use of IIF in configurable reports

← Older revision		Revision as of 17:35, 28 January 2022
Line 184:		Line 184:
	This example will control adding some text if the status code of the job is 'X'.		This example will control adding some text if the status code of the job is 'X'.

	{{Note}} When putting ~~this~~ in SQL packages to update or create a configurable report, the single quotes in the text must be doubled, for example:		This can also be used to check multiple values, with logical OR and AND, for example:
			* <nowiki>[CALC:IIF('EPOD_JOB_ADDRESS.EPL_ADDRESS_5'='GB' OR 'EPOD_JOB_ADDRESS.EPL_ADDRESS_5'='GBR'','UKCA','CE')]</nowiki>

			{{Note}} When putting these in SQL packages to update or create a configurable report, the single quotes in the text must be doubled, for example:
	* <nowiki>[CALC:IIF(''EPOD_JOB.EPL_STATUS''=''X'',''CANCELLED - EPOD_JOB.EPL_REASON_DESCRIPTION'','''')]</nowiki>		* <nowiki>[CALC:IIF(''EPOD_JOB.EPL_STATUS''=''X'',''CANCELLED - EPOD_JOB.EPL_REASON_DESCRIPTION'','''')]</nowiki>

Anw: Updated based on version 4.5.00.02

2019-04-08T13:21:21Z

Updated based on version 4.5.00.02

@@ Line 19: / Line 19: @@
 **     Final footer
 **     Page footer
 *   The page-specific styling CSS, for display and printing
 * Parameters for:
@@ Line 57: / Line 58: @@
 |-
 |ECR_PAGE_FOOTER || HTML for the page footer, appearing once at the top of every page.
 |}
 == Embedding Data ==
-All sections are built from the HTML in the sections in the database, replacing data tags ([...]) with real data from a selection of tables.
+All report sections are built from the HTML in the sections in the database, replacing data tags ([...]) with real data from a selection of tables.
 Tables allowed:
@@ Line 228: / Line 231: @@
 Current line number in the content/detail sections can be obtained using [LINE].

Anw: Added more detail on common styling and classes.

2019-03-25T10:35:15Z

Added more detail on common styling and classes.

← Older revision		Revision as of 12:35, 25 March 2019
Line 233:		Line 233:
	In the general POD document, the designer is in control of what classes and styles are in use. Most of the POD notes created in the system use a standard class set to make changing POD notes as similar as possible, whilst also allowing great flexibility and cross-browser compatibility. Each POD report can add to these classes and styles.		In the general POD document, the designer is in control of what classes and styles are in use. Most of the POD notes created in the system use a standard class set to make changing POD notes as similar as possible, whilst also allowing great flexibility and cross-browser compatibility. Each POD report can add to these classes and styles.

			Certain common elements can be controlled through use of standard styles and classes, whereas some styling depends on predefined class definitions. The following sections show how to achieve styling of these elements.


			=== Coloured Elements based on Status Code ===
			This is achieved through basic classes:
			* Create classes for the specific status, for example status_X
			* Apply the class to the element that requires the formatting, by adding the status to the class name, for example:
			<nowiki><span class="status_[EPOD_CONTAINER.EPL_STATUS_CODE]">MyText</span></nowiki>


			===Styling the Photo Page===
	The photo page, however, is not able to be directly designed for the report. It is, however, very customizable.		The photo page, however, is not able to be directly designed for the report. It is, however, very customizable.

Line 273:		Line 283:


			===UDF Form/Field Classes===
	UDF forms may be retrieved as a whole from the database (e.g. [EPOD_JOB.EPL_UDF_JOBSDETS]). These are strongly classed and ID'd.		UDF forms may be retrieved as a whole from the database (e.g. [EPOD_JOB.EPL_UDF_JOBSDETS]). These are strongly classed and ID'd.
	These classes and IDs can then be used by the designer to specifically format certain sections.		These classes and IDs can then be used by the designer to specifically format certain sections.
Line 305:		Line 316:

	This allows for generic styling of all fields uniformly, with exceptions for certain forms, field types or specific fields.		This allows for generic styling of all fields uniformly, with exceptions for certain forms, field types or specific fields.


	==Setting Up the Report==		==Setting Up the Report==

Anw: Updated based on version 4.0.02.47

2019-03-11T17:18:56Z

Updated based on version 4.0.02.47

← Older revision		Revision as of 19:18, 11 March 2019
Line 222:		Line 222:
	The reason code and description can be returned delimited by "-" using [table.EPL_REASON_DESCRIPTION(Y)].		The reason code and description can be returned delimited by "-" using [table.EPL_REASON_DESCRIPTION(Y)].

	{{Note}} If the item has been cancelled through the C-ePOD Admin console, the reason code is set to "AdminCancel". EPL_REASON_DESCRIPTION will return "~~Cancelled~~" as the reason code.		{{Note}} If the item has been cancelled through the C-ePOD Admin console, the reason code is set to "AdminCancel". EPL_REASON_DESCRIPTION will return "Admin Cancellation" as the reason code.

Anw: Updated based on version 4.0.02.47

2019-03-11T17:17:40Z

Updated based on version 4.0.02.47

Show changes

Anw: Minor formatting changes

2019-01-25T11:33:24Z

Minor formatting changes

Anw: Minor grammar corrections

2019-01-25T11:27:30Z

Minor grammar corrections

← Older revision		Revision as of 13:27, 25 January 2019
Line 1:		Line 1:
	For each completed collection or delivery job, POC or POD reports may be produced from the system. These reports are no defined with configurable attributes, allowing reports to be designed and distributed to the customer without requiring code changes.		For each completed collection or delivery job, POC or POD reports may be produced from the system. These reports are now defined with configurable attributes, allowing reports to be designed and distributed to the customer without requiring code changes.

	At times, very bespoke requirements for a report layout mean that a bespoke report format will be written. In the main, however, any new reports should be produced as configurable reports, adding all required new functionality to the generic report producer, ensuring that the report becomes more feature-rich in time.		At times, very bespoke requirements for a report layout mean that a bespoke report format will be written. In the main, however, any new reports should be produced as configurable reports, adding all required new functionality to the generic report producer, ensuring that the report becomes more feature-rich in time.
Line 61:		Line 61:

	== Embedding Data ==		== Embedding Data ==
	All sections are ~~build~~ from the HTML in the sections in the database, replacing data tags ([...]) with real data from a selection of tables.		All sections are built from the HTML in the sections in the database, replacing data tags ([...]) with real data from a selection of tables.

	Tables allowed:		Tables allowed:
Line 118:		Line 118:
	* Date/Time fields have standard OBS formatting applied by default, although this can be overridden by the Format modifier e.g. [table.EPL_DATE/Fdd MMM yyyy] for explicit date formatting.		* Date/Time fields have standard OBS formatting applied by default, although this can be overridden by the Format modifier e.g. [table.EPL_DATE/Fdd MMM yyyy] for explicit date formatting.
	* Telephone Numbers - selects the indicated telephone number EPOD_CUSTOMER.EPL_TELEPHONE(0)		* Telephone Numbers - selects the indicated telephone number EPOD_CUSTOMER.EPL_TELEPHONE(0)
	* UDF Fields - selects the UDField from the specified UDF e.g. EPOD_JOB.EPL_UDF_JOBDETS.WEIGHBRIDGE_NO (normal field) or EPOD_JOB.EPL_UDF_JOBDETS.EPOD_JOB.TRAILER_ID (~~databound~~ field).		* UDF Fields - selects the UDField from the specified UDF e.g. EPOD_JOB.EPL_UDF_JOBDETS.WEIGHBRIDGE_NO (normal field) or EPOD_JOB.EPL_UDF_JOBDETS.EPOD_JOB.TRAILER_ID (data-bound field).
	* TNCs - gets the T&Cs (in either format). Fields other than labels (i.e. the basic text) can be removed by EPOD_JOB.EPL_TNCS(N). If UDF TNCs, a specific field can be requested e.g. EPOD_JOB.EPL_TNCS.EMAIL_REQD		* TNCs - gets the T&Cs (in either format). Fields other than labels (i.e. the basic text) can be removed by EPOD_JOB.EPL_TNCS(N). If UDF TNCs, a specific field can be requested e.g. EPOD_JOB.EPL_TNCS.EMAIL_REQD
	* Signatures - automatically displays as No Image Found.		* Signatures - automatically displays as No Image Found.
Line 188:		Line 188:


	The photo page however is not able to be directly designed for the report. It is however, very ~~customisable~~.		The photo page, however, is not able to be directly designed for the report. It is, however, very customizable.

	The photo page can be basically changed from one photo per page to two using the setting against the report.		The photo page can be basically changed from one photo per page to two using the setting against the report.

Anw: Updated to latest version

2019-01-16T12:07:31Z

Updated to latest version

← Older revision		Revision as of 14:07, 16 January 2019
Line 20:		Line 20:
	** Page footer		** Page footer
	* The page-specific styling CSS, for display and printing		* The page-specific styling CSS, for display and printing
			* Parameters for:
	Parameters for the number of content lines per page of each type		** the number of content lines per page of each type
			** the number of images displayed per row on the Images page. {{Note}} This is deprecated - use styles to control this instead.
	* Flags to control whether certain aspects are included in the report:		* Flags to control whether certain aspects are included in the report:
	** Alt rows - are alternate rows printed with a different format.		** Alt rows - are alternate rows printed with a different format.
	** Inc Products - whether content rows are produced per product or container		** Inc Products - whether content rows are produced per product or container.
	** Inc Cancelled - whether cancelled products or containers are included		** Inc Cancelled - whether cancelled products or containers are included.
	** Inc Images - whether an images page is included		** Inc Images - whether an images page is included.
	** Email Images - whether the images page is included when emailing the PDF.		** Email Images - whether the images page is included when emailing the PDF.
	** PDF Orientation - portrait or landscape		** PDF Orientation - portrait or landscape.


Line 125:		Line 126:
	* Status and Job Type automatically translate to descriptions. This can be overridden by a pipe-delimited set of descriptions in parenthesis following the field e.g. (Collecting\|Delivering\|Servicing).		* Status and Job Type automatically translate to descriptions. This can be overridden by a pipe-delimited set of descriptions in parenthesis following the field e.g. (Collecting\|Delivering\|Servicing).

			{{Note}} Accessing an X type UDF field does not return the value - there are many items. Therefore it returns formatted HTML of the checkbox items and labels, formatted with the class UDFFieldX. Note you should not format these fields.

	Explicit field ~~data~~ formatting is controlled with a /F modifier - N? - numeric no of digits or C? currency no of digits ~~currently~~.
			Explicit field formatting is controlled with a /F modifier:
			* N? - numeric no of digits or a pattern e.g. /FN##,##0.00;-##,##0.00;#.
			* C? currency no of digits or a pattern e.g. /FC£##,##0.00;-£##,##0.00;#
			Any other value is considered to be a date or time format e.g. dd/mm/yyyy HH:mm


Line 150:		Line 156:
	{{Note}} Everything must be enclosed in strings, as these are substituted for literal values.		{{Note}} Everything must be enclosed in strings, as these are substituted for literal values.

			Calculations can be used to make decisions based on values, using the IIF function call.
			For example:
			* [CALC:IIF('EPOD_JOB.EPL_STATUS'='X','CANCELLED - EPOD_JOB.EPL_REASON_DESCRIPTION','')]
			This example will control adding some text if the status code of the job is X.
			{{Note}} When putting this in SQL packages to update or create a configurable report, the single quotes in the text must be doubled
			* [CALC:IIF(''EPOD_JOB.EPL_STATUS''=''X'',''CANCELLED - EPOD_JOB.EPL_REASON_DESCRIPTION'','''')]

	* Barcode printing may be added as in the following example:
			Barcode printing may be added as in the following example:
	* <img id="barcode"/></p><script>JsBarcode('#barcode', "[EPOD_JOB.EPL_JOB_CODE]", {height: 40, displayValue: false});</script>		* <img id="barcode"/></p><script>JsBarcode('#barcode', "[EPOD_JOB.EPL_JOB_CODE]", {height: 40, displayValue: false});</script>
	* You can set many parameters of the barcode being printed - see the JSBarcode documentation for details		You can set many parameters of the barcode being printed - see the JSBarcode documentation for details


Line 162:		Line 175:

	The reason code and description can be returned delimited by "-" using [table.EPL_REASON_DESCRIPTION(Y)].		The reason code and description can be returned delimited by "-" using [table.EPL_REASON_DESCRIPTION(Y)].

			{{Note}} If the item has been cancelled through the C-ePOD Admin console, the reason code is set to "AdminCancel". EPL_REASON_DESCRIPTION will return "Cancelled" as the reason code.


Line 167:		Line 182:

	Current line number in the content/detail sections can be obtained using [LINE].		Current line number in the content/detail sections can be obtained using [LINE].


			== Notes on Styling and Classes ==
			In the general POD document, the designer is in control of what classes and styles are in use. Most of the POD notes created in the system use a standard class set to make changing POD notes as similar as possible, whilst also allowing great flexibility and cross-browser compatibility. Each POD report can add to these classes and styles.


			The photo page however is not able to be directly designed for the report. It is however, very customisable.

			The photo page can be basically changed from one photo per page to two using the setting against the report.

			The designer now has far more control now through styling the classes.

			The basic photo page class styling is already included in the aspx page. This can be over-ridden by the CSS in the report itself

			The designer now has control over:
			* Number of photos per row.
			* Size of detail and image cells.
			* The text included against the header, the job photos, the container photos and the product photos.
			* The labels for all included text.

			{{Note}} The photo page exports perfectly in the PDF conversion, but does NOT work well when printing from Chrome.

			Samples:

			Displaying 1 photo per page
			* .photo { width: 100%;}
			* .photo {page-break-after: always;}
			* .photoSection div:first-child {page-break-after: always !important;page-break-before: avoid !important;}

			Displaying 2 photos per row
			* .photo { width: 49.5%;}

			Displaying 3 photos per row
			* .photo { width: 33%;}

			Displaying text above photo (rather than to the left)
			* .photoDetails { width: 100%; display: block; float: none;}
			* .photoImage { width: 100%; display: block; float: none;}

			Throwing a page break after every even/3rd/4th photo
			* .photoSection > div:nth-child(even) {page-break-after: always !important;}
			* .photoSection > div:nth-child(3n+0) {page-break-after: always !important;}
			* .photoSection > div:nth-child(4n+0) {page-break-after: always !important;}


Line 205:		Line 263:
	\| ECR_SINGLE_FOOTER \|\| If set, only produces the fixed footer on the last or single page.		\| ECR_SINGLE_FOOTER \|\| If set, only produces the fixed footer on the last or single page.
	\|-		\|-
	\| ECR_PHOTOS_PER_ROW \|\| How many columns are shown on the Images page per row. The default is 2.		\| ECR_PHOTOS_PER_ROW \|\| How many columns are shown on the Images page per row. The default is 2. {{Note}} This is deprecated - use styling instead.
	\|}		\|}

Anw: Added Single Header/Footer and Photos Per Row functionality

2018-09-25T13:00:16Z

Added Single Header/Footer and Photos Per Row functionality

← Older revision		Revision as of 15:00, 25 September 2018
Line 2:		Line 2:

	At times, very bespoke requirements for a report layout mean that a bespoke report format will be written. In the main, however, any new reports should be produced as configurable reports, adding all required new functionality to the generic report producer, ensuring that the report becomes more feature-rich in time.		At times, very bespoke requirements for a report layout mean that a bespoke report format will be written. In the main, however, any new reports should be produced as configurable reports, adding all required new functionality to the generic report producer, ensuring that the report becomes more feature-rich in time.

			{{Note}} All new reports (that have no bespoke components) should be created using this report.


Line 91:		Line 93:
	\| EPOD_COLLECTION_JOB_ADDRESS \|\| The job address of the collection job. If not present, this will show the customer address.		\| EPOD_COLLECTION_JOB_ADDRESS \|\| The job address of the collection job. If not present, this will show the customer address.
	\|-		\|-
	\| EPOD_DELIVERY_JOB \|\| The ~~collection~~ job associated to the job selected.		\| EPOD_DELIVERY_JOB \|\| The delivery job associated to the job selected.
	\|-		\|-
	\| EPOD_DELIVERY_CUSTOMER \|\| The customer address of the ~~collection~~ job.		\| EPOD_DELIVERY_CUSTOMER \|\| The customer address of the delivery job.
	\|-		\|-
	\| EPOD_DELIVERY_JOB_ADDRESS \|\| The job address of the ~~collection~~ job. If not present, this will show the customer address.		\| EPOD_DELIVERY_JOB_ADDRESS \|\| The job address of the delivery job. If not present, this will show the customer address.
	\|-		\|-
	\| EPOD_PRODUCT \|\| The products of the job.		\| EPOD_PRODUCT \|\| The products of the job.
Line 108:		Line 110:

	Example: [EPOD_JOB.EPL_JOB_CODE]		Example: [EPOD_JOB.EPL_JOB_CODE]

			{{Note}} links between EPOD_JOB/EPOD_COLLECTION_JOB/EPOD_DELIVERY_JOB - ONLY EPOD_JOB connects to EPOD_CONTAINERS and EPOD_PRODUCTS


Line 163:		Line 167:

	Current line number in the content/detail sections can be obtained using [LINE].		Current line number in the content/detail sections can be obtained using [LINE].


	==Setting Up the Report==		==Setting Up the Report==
Line 195:		Line 200:
	\|-		\|-
	\| ECR_CONTENT_GROUP \|\| The fields on which to group detail (product or container) records, delimited by commas. For example: "EPOD_CONTAINER:EPL_CONTAINER_PACKAGE_DESC".		\| ECR_CONTENT_GROUP \|\| The fields on which to group detail (product or container) records, delimited by commas. For example: "EPOD_CONTAINER:EPL_CONTAINER_PACKAGE_DESC".
			\|-
			\| ECR_SINGLE_HEADER \|\| If set, only produces the fixed header on the first or single page.
			\|-
			\| ECR_SINGLE_FOOTER \|\| If set, only produces the fixed footer on the last or single page.
			\|-
			\| ECR_PHOTOS_PER_ROW \|\| How many columns are shown on the Images page per row. The default is 2.
	\|}		\|}

← Older revision		Revision as of 13:33, 25 January 2019
Line 137:		Line 137:
	Totals are indicated on fields with a /T? modifier, indicating which total this is. They are used with a special data tag [TOT?], identifying the total to use.		Totals are indicated on fields with a /T? modifier, indicating which total this is. They are used with a special data tag [TOT?], identifying the total to use.

	These may also be formatted i.e. [TOT0/FN2]		These may also be formatted i.e. <nowiki>[TOT0/FN2]</nowiki>

	* Up to 8 totals may be specified in the sections, accessed using 0-7.		* Up to 8 totals may be specified in the sections, accessed using 0-7.
Line 145:		Line 145:


	Calculations may be identified as follows: [CALC: ... ], with the fields inside the calculation NOT in square barckets		Calculations may be identified as follows: <nowiki>[CALC: ... ]</nowiki>, with the fields inside the calculation NOT in square barckets
	For example:		For example:
	* [CALC: EPOD_PRODUCT.EPL_PRODUCT_QTY_ACTUAL * EPOD_PRODUCT.EPL_WEIGHT/FN3]		* <nowiki>[CALC: EPOD_PRODUCT.EPL_PRODUCT_QTY_ACTUAL * EPOD_PRODUCT.EPL_WEIGHT/FN3]</nowiki>
	* Note: The above is formatting the calculation to 3 decimal places.		* Note: The above is formatting the calculation to 3 decimal places.
	* Warning: You can include parentheses, BUT YOU MUST LEAVE SPACES AROUND THEM. For example:		* Warning: You can include parentheses, BUT YOU MUST LEAVE SPACES AROUND THEM. For example:
	** [CALC: EPOD_PRODUCT.EPL_PRODUCT_QTY_ACTUAL * ( EPOD_PRODUCT.EPL_UNIT_PRICE + EPOD_PRODUCT.EPL_UNIT_VAT )/FN3]		** <nowiki>[CALC: EPOD_PRODUCT.EPL_PRODUCT_QTY_ACTUAL * ( EPOD_PRODUCT.EPL_UNIT_PRICE + EPOD_PRODUCT.EPL_UNIT_VAT )/FN3]</nowiki>

	Conditional statements are part of Calculations, as follows:		Conditional statements are part of Calculations, as follows:
	* [CALC: IIF('EPOD_JOB.EPL_STATUS' = 'X', 'CANCELLED', ~~<nowiki>~~''</nowiki>)]		* <nowiki>[CALC: IIF('EPOD_JOB.EPL_STATUS' = 'X', 'CANCELLED', '')]</nowiki>
	{{Note}} Everything must be enclosed in strings, as these are substituted for literal values.		{{Note}} Everything must be enclosed in strings, as these are substituted for literal values.

	Calculations can be used to make decisions based on values, using the IIF function call.		Calculations can be used to make decisions based on values, using the IIF function call.
	For example:		For example:
	* [CALC:IIF('EPOD_JOB.EPL_STATUS'='X','CANCELLED - EPOD_JOB.EPL_REASON_DESCRIPTION','')]		* <nowiki>[CALC:IIF('EPOD_JOB.EPL_STATUS'='X','CANCELLED - EPOD_JOB.EPL_REASON_DESCRIPTION','')]</nowiki>
	This example will control adding some text if the status code of the job is X.		This example will control adding some text if the status code of the job is X.
	{{Note}} When putting this in SQL packages to update or create a configurable report, the single quotes in the text must be doubled		{{Note}} When putting this in SQL packages to update or create a configurable report, the single quotes in the text must be doubled
	* [CALC:IIF(''EPOD_JOB.EPL_STATUS''=''X'',''CANCELLED - EPOD_JOB.EPL_REASON_DESCRIPTION'','''')]		* <nowiki>[CALC:IIF(''EPOD_JOB.EPL_STATUS''=''X'',''CANCELLED - EPOD_JOB.EPL_REASON_DESCRIPTION'','''')]</nowiki>


	Barcode printing may be added as in the following example:		Barcode printing may be added as in the following example:
	* <img id="barcode"/></p><script>JsBarcode('#barcode', "[EPOD_JOB.EPL_JOB_CODE]", {height: 40, displayValue: false});</script>		* <nowiki><img id="barcode"/></p><script>JsBarcode('#barcode', "[EPOD_JOB.EPL_JOB_CODE]", {height: 40, displayValue: false});</script></nowiki>
	You can set many parameters of the barcode being printed - see the JSBarcode documentation for details		You can set many parameters of the barcode being printed - see the JSBarcode documentation for details