Top

Document Builder: Fields

Fields are the very foundation of Document Builder. Fields are placeholder codes that appear as {{FIELD}} that in turn get filled in with the data once a document is generated. Their appearance can be adjusted and there are various types available for use. When a Field is added to a template, it will appear in every document generated from that template. That document will then display options for entering data into the Field. This article describes the steps to locate and edit Fields, create new Fields, and add Fields to document. For more information on creating documents, see Document Builder.

Existing Fields

Creating/Editing Fields

Input Types

 

Existing Fields                                                                                         

The bottom half of the page consists of a list of available Fields that can be added to a document. Search for fields using the various filters at the top of the page. Enter text into the Names, Codes, Categories, or Search fields to locate Fields. DocBuilderFieldsTabFilters.PNG

Click on a Field to make edits.                   DocBuilderExistingField.PNG

 

Creating/Editing Fields                                                                             

Click on a Field to make edits or click the Plus icon in the top right corner of the page to create a new Field.                                                                                                                                                                                                            DocBuilderExistingFields.PNG

  • Input Type: See Input Types.
  • Name: Enter a name for the field.
  • Code:
  • Category: Select a Category from the drop-down.
  • Permission:
  • Sequence:
  • Description: Click the Pencil icon to enter or edit the Field Description. Click the Ok button once edits are complete.
  • Input Data:

 

Click the Copy (for an existing field) or Create (for a new field) button to save. When a Field is added to a document it will not have any effect upon the template.

 

Input Types                                                                                               

Wavebid offers availability of many different types of fields and, depending on what type is chosen, the information will appear in different ways in the document editor. Regardless of the field type, it is important to remember they will appear in the document editor tab determined by the category attribute, and will be ordered according to the sequence attribute.

Note: In addition to these field types there is one called Special. This is reserved for internal Wavebid use.

 

Check Box

Places a checkbox to be ENABLED or DISABLED. The default is DISABLED.

Color

Places an empty entry box where text can be typed in. If any Input Data is entered when the field is created it will appear in the entry box. The default is empty.

Select

Places a drop-down menu from which the user may choose a single option; the option selected then substitutes the field code in the document.

  • The Input Data must be entered as a comma-separated list of values: value1, value2, value3. These then become the options available for a user to choose from.
  • In the document editor select one of the values entered in the Input Data. The value chosen will then substitute the text in the document once a PDF is viewed. If no value is chosen, the field will not be shown when the PDF document is viewed.

Select Advanced

"Advanced" has two components: a drop-down menu and a field text editor. The drop-down menu will contain an element name, from which the user may choose a single option. A field text editor will show an element value to be substituted for the field code. The data contained in the element value may be modified by an user.

  • Separate elements must be entered in the Input Data area:
    • You can sort them in any desired order.
    • Only one element may be the default at any given time but no default is required.
    • Element name is the value to be shown in the dropdown menu
    • Element value: The text to be shown in the field text editor once the element name is chosen. This text may be formatted as desired and there is no limit to how much text you can have within it.
  • To add more elements to the list, click on the  Add Element Button. To remove elements click on the Trash icon in the element row.
  • In the document editor, select one of the values entered for element name; this will update the field text editor with the associated element value. Clicking on the field text editor will allow the user to modify the element value in its entirety
  • If no value is chosen, the field will not be shown when the PDF document is viewed.

Table Advanced

Places a table in the document editor, then the user selects which rows will be inserted into the document.

  • In the Input Data the column names are entered, followed by the values shown within each row in the table:
    • The table can be set to show cell borders.
    • Each column name is entered in simple text.
    • Each row may be sorted in any desired order.
    • Each row can be shown by default in the document
    • The values within each cell maybe for formatted as desired, and there is no limit to how much text each cell may hold.
  • To manipulate the contents of the table:
    • To add more columns click on  Add Column.
    • To add more rows click on  Add Row.
    • To remove a column click on the  Trash icon next to the column name.
    • To remove a row click on the  Trash icon in the row.
  • In the document editor the user can manipulate the table as needed, including altering borders, resorting rows, changing column names, etc. When changing the values within each cell the full appearance can be altered as needed.

Text

Places a simple text box.

  • The Input Data is simple text, which then becomes the default value for the field. If no Input Data is entered the text box in the document editor will be blank.
  • In the document editor a simple text entry box will appear with the Input Data entered already filled in. A user may modify this text but cannot alter its appearance.

 

Have more questions? Submit a request

0 Comments

Article is closed for comments.