Versions Compared

Key

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

Excerpt

This page offers information on the documents custom fields that appear in Storefront. Also, you can find a guide on how you can publish to Storefront documents custom fields, as well as how you can define a Display Rule for the manually created document custom fields.

Documents Custom Fields in Storefront


In Storefront, certain automatically-published (extra) custom fields for documents can be visible after the user uploads them and publishes them to Storefront, either via the My AccountDocuments path in Storefront, or via the Storefront’s Widget Dashboard by locating the widget called Recently Updated Documents.

Rw ui textbox macro
typeinfo

Document List Viewability

The Document List page is only visible to the Billing Agent, Buyer, and Subscription Manager user roles.

For more information regarding the viewability of Documents Custom Fields in Storefront, please check the Viewing Published Documents page.

 

Enabling Documents Custom Fields in Storefront


If you want to display document information to your customers or keep certain user-specific information on display, you can publish the documents' custom fields in the My Account → Documents List view page in Storefront as well as in the Recently Updated Documents dashboard widget in Storefront. To do so, you can navigate to BSS Setup > Office > Documents > Custom Fields and add a new Document Custom field entity by clicking on the Add button.

By creating a new Documents custom field, the BSS user has the following two Type options for being able to display the
Document’s custom field data in Storefront.

  1. The Type ‘Simple Value’

  1. The Type ‘Text Area’

The "Simple Value" Type can contain the following Value Types:

  • Text (is default value type)

  • Number

  • Currency

  • Date

The "Text Area" Type can contain a textual or numeric value inside the Default Value text box.


Once one of the two aforementioned Types is selected and defined, by selecting the Advanced Options tab, you can choose to publish it in Storefront once the Show in Storefront checkbox is enabled.

Rw ui textbox macro
typetip

Remember to define the Display Rule for the manually-created Documents Custom Fields

When you have manually created a document custom field and not one that was automatically created and published in Storefront, you are required to assign the proper Display Rule for each manually created custom field.

What are the Display Rules: Display Rules are display-controlers that define which custom fields are displayed in Storefront based on either the Document Status (New, Processed) or the Document Type (Agreement, Invoice, Price Catalogue). For example, when a display rule for a specific status or type of a document custom field is set, then that custom field will only be displayed on documents with the specified display rule and not on every document, in Storefront.

Setting Up Display Rules: To setup such Display Rules, you must click on the Field Details tab, and under the section Display Rulechoose from the dropdown button either the option “Status“ or “Type” and on the adjacent text field, you can utilize the magnifying glass icon to track the exact option for that custom field.

Type - Display Rule

Status- Display Rule

After finishing those changes, by clicking on the Save or Save and Close button, the changes will be in effect, and the particular custom field that you have chosen will be displayed on the My Account → Documents view page in Storefront as well as in the Recently Updated Documents dashboard widget in Storefront

Viewing Documents Custom Fields in Storefront


You can verify your changes by logging into your Storefront and navigating to the My Account → Documents List view page in Storefront or in the Recently Updated Documents dashboard widget in Storefront, and choosing the Document that you have made the changes to. For example, the following ……… Document.

Documents List - Example

Widget Dashboard - Example

Image AddedImage Added

The Custom Field has a value

The Custom Field has no value

In the MyAccount page's Document List section, when you select a custom field (which is of a Type, Text Area or Simple Value) to be shown in the Storefront, the following actions occur in the Documents List and in the Dashboard Widget:

  1. An additional column is added at the end on the table.

  2. This column has its header as the name of the custom field.

  3. The content of this column displays the value defined by the BSS user for that custom field.

  4. The Storefront Account is not able to edit the value of the custom field.

In case the custom field doesn't contain a value for the document but is set to 'Show in Storefront,' then in the Document List and in the Dashboard Widget:



  1. An additional column is added at the end on the table.

  2. This column has its header as the name of the custom field.

  3. The content appears empty.

  4. The Storefront Account is not able to edit the value of the custom field.

Info

In the case where there are two different custom fields with the same name in different groups, these two custom fields will be displayed in separate columns in the grid. Each custom field will have its own column in the grid regardless of its name.

Shorting & Filtering in the Documents List

The Storefront user does not have the ability to move the custom field column within the table, and there is no filter option available in the column.

Standard Reseller (Admin Panel)

In the Admin Panel of the Standard Reseller, within the Documents Section on the Dashboard, the custom fields in the widget are displayed in the same way as they appear in the widget on the Distributor's Storefront.

Image Added

Table of Contents


Table of Contents
minLevel1
maxLevel7
excludeTable of Contents