Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Widget Use

Excerpt

Renders Order Import functionality on the Order Import page template. This allows users to import order data directly to the cart, either via CSV file, or by pasting data into an import window. The data is then validated and feedback given to the user. the Customer Client Project Maintenance page for the Customer Client Project feature.


Example of Widget Use

Following is an example of the widget in use:

Image RemovedImage Added


Where can the Widget be placed?

The widget can be used in the following templates:

  • Order Import Page TemplateCustomer Client Project Maint Template


Info

To use the Customer Client Projects feature, this widget must be added.


Widget Options

OptionUseCommentsAvailable from Version
Description
A short
Short specific description of
the
widget's use.
We recommend this field be updated so
This description is added to the widget title. It makes the widget's
purpose is clear at a glance from This is handy if the content is only valid for a certain type of user, or if the same widget is required
use clear on the template page.All
LayerThe layer the widget is valid for.

The layering technology allows for the content to be shown to specific audiences.

Use Layering to limit widget content to certain groups of users. 

To use the same widget for more than one

audience,

user group but

different configuration is needed.The widget can be added to the zone more than once and the layer feature can determine which audience can see each widgetDetermines whether the Data Import section is rendered, in which users can paste CSV-formatted data (rather than uploading a saved file)

with different options set, add the widget as many times as needed in the same zone. Then add layering to define the user group each time

All
Enable Data Import
HeadingHeading for the Search section.

Default

is

:

ticked

Untick to disable

3.88Enable File UploadDetermines whether the File Upload section is rendered, which users can use to upload a saved CSV file (rather than pasting raw data).

Default is: ticked

Untick to disable

3.88Allow Continue On Analysis Errors

Determines whether the import process will continue if the system detects data it can't interpret (e.g. extra columns, for example).

If the flag is enabled, the system will use whatever data it can decipher. If not enabled, the import will be halted and the user will have to correct their data and try again.

Default is: unticked

Tick to enable

3.90Allow Continue On Validation Errors

Determines whether the import process will continue if the system encounters invalid data.

If the flag is enabled, the valid lines will be imported and the invalid lines will be skipped. If not enabled, the import will be halted and the user will have to correct their data and try again.

Default is: unticked

Tick to enable

3.90Data ImportData Import Subtitle TextThe heading text displayed at the top of the Data Import section.Default is: Data Import3.88Data Import Subtitle Icon

The icon displayed to the left of the Data Import heading text.

Default is: cv-ico-general-keyboard3.88Data Import Instruction TextThe instruction text displayed above the data input box.Default is:  Paste CSV data directly into the textbox below following the format: Product Code or APN, Order Quantity.3.88Data Import Button TextThe text on the Import button in the Data Import section.Default is: Import Data3.88File UploadFile Upload Subtitle TextThe heading text displayed at the top of the File Upload section.Default is: File Upload3.88

File Upload Subtitle Icon

The icon displayed to the left of the File Upload heading text.Default is: cv-ico-general-file3.88File Upload Instruction TextThe instruction text displayed above the file selector.Default is: Select file(s) to upload:3.88File Upload Button TextThe text on the Import button in the File Upload section.Default is: Import Files3.88File Upload Placeholder TextThe text on the file selector button.Default is:  Select Files...3.88Allow Multiple FilesDetermines whether the import of multiple files at once is permitted.

Default is: ticked

Untick to disable

3.88NotificationsShow MessagesDetermines whether feedback messages are displayed to the user in the Log.

Default is: ticked

Untick to disable

3.88Clear Process MessagesDetermines whether progress messages are cleared after each phase is completed.

Default is: ticked

Untick to disable

3.88Wait For Response

Determines whether the browser will wait to process the entire import before giving feedback, or alternatively refresh and display messages as different phases of the import are completed.

Default is: unticked

Tick to enable

Note - Waiting for response can occasionally cause timeout issues with very large datasets or many files. For the user experience, NOT waiting for response is recommended.

3.88Messages Subtitle TextThe heading text displayed at the top of the Log section.Default is: Import Log3.88

Messages Subtitle Icon

The icon displayed to the left of the Log heading text.Default is: cv-ico-general-info23.88Status Update Frequency (seconds)The time (in seconds) between status update requests when an order import is in progress.Default is: 13.88Delay Before Closing Status Overlay (seconds)The time (in seconds) before we close the status overlay, once the import process has finished.Default is: 33.90Success Message Text

The message displayed once the data has been successfully imported.

The placeholders {0} and {1} are replaced with the number of successfully imported products out of the total attempted.

Default is: Order import process complete. Successfully imported {0} of {1} products.3.88Failed Message Text

The message displayed when the data import has failed.

The placeholder {0} is replaced the error returned by the system.

Default is: Order Import Process Failed. {0}3.88Parsing Phase Message Text

The message displayed while the data is being analysed.

The placeholders are replaced by:

  • {0} the row currently being analysed
  • {1} the number of rows that have failed analysis
  • {2} letter 's' to pluralise row to rows (where required)
Default is: Checking row {0}. {1} row{2} failed to parse.3.88Validation Phase Message Text

The message displayed in the overlay while the data is being validated.

The placeholders are replaced by:

  • {0} the number of products validated thus far
  • {1} the total number of produtcs to be validated
  • {2} the number of products that have failed validation
  • {3} letter 's' to pluralise product to products (where required)
Default is: Validating {0} of {1} products. {2} product{3} failed validation.3.88Import Phase Message Text

The message displayed while the data is being imported.

The placeholders are replaced by:

  • {0} the number of products imported thus far
  • {1} the total number of produtcs to be imported
  • {2} the number of products that have failed to import
  • {3} letter 's' to pluralise product to products (where required)
Default is: Importing {0} of {1} products. {2} product{3} not imported.3.88Substituted Product Status Text

The message displayed when a product in the import is substituted with another.

The placeholders are replaced with actual product codes.

Default is: Product with code [SubstitutedProduct.ProductCode] has been substituted for product with code [Product.ProductCode].3.90Substituted Product Not Found Status Text

The message displayed when a product in the import is set to be substituted, but the substitution product is not found on the web.

The placeholders are replaced with actual product codes.

Default is: Product with code [SubstitutedProduct.ProductCode] is set for substitution with product with code [Product.ProductCode] however this product could not be found. Keeping original product.3.90Substituted Product Not Valid Status Text

The message displayed when a product in the import is set to be substituted, but the substitution product is invalid for ordering (out of stock or other condition).

The placeholders are replaced with actual product codes.

Default is: Product with code [SubstitutedProduct.ProductCode] is set for substitution with product with code [Product.ProductCode] however this product is not valid for order. Keeping original product.3.90Analysis Phase Begin Status TextThe message displayed when the analysis phase begins.Default is: Beginning analysis phase.3.90Analysis Phase Complete Without Errors Status TextThe message displayed when the analysis phase completes with zero errors.Default is: Analysis phase completed without errors. 3.90Analysis Phase Complete With Errors Disallow Continue Status TextThe message displayed when the analysis phase finds errors, and the widget option "Allow Continue On Analysis Errors" is NOT enabled.Default is: Analysis phase completed with errors. Please fix the errors and try again.3.90Analysis Phase Complete With Errors Allow Continue Status TextThe message displayed when the analysis phase finds errors, and the widget option "Allow Continue On Analysis Errors" IS enabled. Default is: Analysis phase completed with errors. Skipping invalid rows and continuing.3.90Analysis Phase No Data Available Status TextThe message displayed when the user clicks the import button, but has not attached any files or pasted any product data.Default is: No data available for analysis. Please either upload some files or paste some data.3.90Validation Phase Begin Status TextThe message displayed when the validation phase begins.Default is: Beginning validation phase.3.90Validation Phase Complete Without Errors Status TextThe message displayed when the validation phase completes with zero errors. Default is: Validation phase completed without errors.3.90Validation Phase Complete With Errors Disallow Continue Status TextThe message displayed when the validation phase finds errors, and the widget option "Allow Continue On Validation Errors" is NOT enabled. Default is: Validation phase completed with errors. Please fix the errors and try again.3.90Validation Phase Complete With Errors Allow Continue Status TextThe message displayed when the validation phase finds errors, and the widget option "Allow Continue On Validation Errors" IS enabled. Default is: Validation phase completed with errors. Skipping invalid products and continuing.3.90Validation Phase No Products Available Status TextThe message displayed when the user clicks the import button, but has not attached any files or pasted any product data. Default is: No products available for validation. Please either upload some files or paste some data.3.90Import Phase Begin Status TextThe message displayed when the import phase begins.Default is: Beginning import phase.3.90Import Phase Complete Without Errors Status TextThe message displayed when the import phase completes with zero errors.Default is: Import phase completed without errors.3.90Import Phase Complete With Errors Status TextThe message displayed when the import phase completes with errors.Default is: Import phase completed with errors.3.90Order Import Complete Without Errors Status TextThe completion message displayed at the end of all phases, when the import has completed without errors.Default is: Order import completed without errors.3.90Order Import Complete With Errors Status TextThe completion message displayed at the end of all phases, when the import has completed with some errors.Default is: Order import completed with errors.3.90Order Import Failed Status TextThe completion message displayed at the end of all phases, when the import has failed.Default is: Order import failed. See error log for details.3.90

Implementation Notes 

  • Default functionality when errors or zero quantities are encountered is for all lines to be skipped and no lines imported. The user must correct the data and re-import.
  • If you would prefer the Order Import to skip error lines / zero quantities, please refer to the widget options "Allow Continue On Analysis Errors" and "Allow Continue On Validation Errors".

Other Widgets

...

Projects

4.31
Prompts
Client Status LabelText for Client Status dropdown label in Search section.Default: Client Status4.31
Create Start Date Label

Text for Create Start Date input label in Search section.

Default: Create Start Date4.31
Create End Date LabelText for Create End Date input label in Search section.Default: Create End Date4.31
Project Name Filter LabelText for project name input label in Search section.Default: Project Name4.31
Client Name LabelText for Client Name input label in Search section.Default: Client Name4.31
Search Button LabelText for Search button in Search section.Default: Search4.31
New Project Button LabelText for Add New Project button in Search section. Default: New Project4.31
Edit Button LabelText for Edit button in Project list section.Default: Edit4.31
Delete Button LabelText for Delete button in Project list section.Default: Delete4.31
Cancel Delete Button LabelText for Cancel deletion button in confirmation popup window.Default: Cancel4.31
Confirm Delete Button LabelText for Confirm deletion button in confirmation popup window.Default: Delete4.31
Titles
Search Results TitleHeading text for Search Results section.Default: Search Results4.31
Tooltips
Delete Unavailable TooltipMessage displayed when user hovers over greyed Delete button of a project with a linked order.

Default: This project cannot be deleted because it is associated with an order.

4.31


Related help

Content by Label
showLabelsfalse
max5
spacesKB
showSpacefalse
sortmodified
reversetrue
typepage
cqllabel = "customer" and type = "page" and space = "KB" and title ~ "'client projects'"
labelsuser accounts

Content by Label
showLabelsfalse
max5
spacesKB
showSpacefalse
sortmodified
reversetrue
titleRelated widgets
typepage
cqllabel = "widget" and type = "page" and space = "KB" and title ~ "client"
labelsuser accounts

Content by Label
excerptAND
showLabelsfalse
max5
spacesKB
showSpacefalse
sortcreationmodified
truereversetrue
excerptTypesimple
operatortypepage
cqllabel = "cmswidget" and label type = "widgetpage" and space = "KB" and title ~ "'order project'"
labelswidget cmsuser accounts