Difference between revisions of "Custom Field Type: Special - Advanced Data Table"

Revision as of 14:49, 26 October 2016

Click here to peruse our selection of custom fields.

General Description

The XML Field Type is used to store a block of XML.

Field Options

• XSL Template: see XSL Template page for instructions.
• XML Tag Mapping: see XML Tag Mapping page for instructions.
• XML Javascript Function: see XML Javascript Function page for instructions.
• Button Options: Number of options available:
  • Show View XML Button: displays View XML button alongside the Open XML button
  • Show Upload Button: see Uploading to an XML Custom field page for instructions.
  • Show Up/Down Button: displays up/down arrows against the individual rows in the XML sections, allowing these rows to be moved up or down
• Custom Field Ids: See Custom Field IDs for instructions.
• Button Label: Text to be displayed on the field's button. If no text is entered, the system will use a default label.
• Display fields refreshed: will display ID of other custom fields that reference the XML field variables.

• Tool Tip: When the user hovers their mouse pointer over the caption of a field, the text in this section will appear.

• On New Record: Controls how the field should be displayed until record has been saved once.
  • Always Display: Field will be exposed both before and after the record is saved.
  • Hide on New Record: Field will be hidden until record is saved.
  • Only Show on New Record: Field will be exposed until record is saved, and then it will be hidden. This option is useful for fields that provide instructions for filling out forms before saving.

Options

General Options

• Appear Mandatory: Makes the field appear as though it is a required field. Typically used in conjunction with browser scripts, JavaScript Validation or Submit Logic that perform validation.
• Track Changes: Keeps track of changes made to this field.
• Enable Builder: see XML Section Builder.

Enable KML: Used to upload a KML file which is used to display geographic data on a map.

• Disable Field From Global Search: Selecting this option means that the contents of this field will not be displayed in Global Search results.

Value Storage

• Value Storage: Enables linking two different custom fields to the same user data. See Value Stores To page.

The XML stored in this field can be:

• Copied and Pasted from a source file.
• Stored into the field from a workflow process using the SmartSimple Integration Server.
• Used with other Web Service types processes.

Example

Here is an example of XML field called mypasta which stores a recipe (Note that although this stores only one, multiple recipes could be stored in the same block of XML):

<?xml version="1.0" encoding="UTF-8"?>
<recipe>
   <title>Beef Parmesan with Garlic Angel Hair Pasta</title>
   <Author>
      <Firstname>Wendy</Firstname>
      <Lastname>Houston</Lastname>
      <Address>
         <Street>148 Peter Street</Street>
         <postalcode>L7Y 2P5</postalcode>
      </Address>
   </Author>
   <ingredients>
      <ingredient amount="1.5" unit="pound">Beef cube</ingredient>
      <ingredient amount="2" unit="kg">Italian Pasta</ingredient>
   </ingredients>
   <preparation>
      <step order='1'>
         <description>Preheat oven to 350 degrees F (175 degrees C).</description>
      </step>
      <step order='2'>
         <description>Mix all ingredients.</description>
      </step>
      <step order='3'>
         <description>Put everything into oven.</description>
      </step>
      <step order='4'>
         <description>Done.</description>
      </step>
     <step order='5'>
        <description>Find a phone number of the closest take out restaurant.</description> 
     </step>
   </preparation>
   <comment> Make the meat ahead of time, and refrigerate over night, the acid in the  tomato sauce will tenderize the meat even more. 
            If you do this, save the  mozzarella till the last minute.
   </comment>
   <nutrition calories="1167" fat="23" carbohydrates="45" protein="32"/>
</recipe>

Variables

Access to the data within an entire XML section using Language Settings enabled

Uses standard SmartSimple variable references.

To display the section configured for a different language include this section under the language settings of a readonly field.:

@xml.FIELDNAME.SECTIONNODENAME.html::SECTIONNAME@

Display fields refresh

Any custom field that references the XML field as a variable will have its custom field id listed in the Display fields refresh setting.

The XML field has to be saved to add new custom fields to the list.

The custom fields will be automatically refreshed upon editing of this XML field, without requiring the object be resaved.

Access to the data within an entire XML section

Uses standard SmartSimple variable references.

To display the section when there are no variables references within the section itself:

@xml.fieldname.sectionname.html@

To display the section when there are variables referenced within the section itself:

@xmlpre.fieldname.sectionname.html@

Access to the data within the XML field

Uses standard SmartSimple variable references.

@xml.field name.parentnodename.nodename.nodevalue@

@xml.#fieldid#.parentnodename.nodename.nodevalue@

@xml.field name.parentnodename.nodename.attribute(attributename)@

• There may not be a parent node, or there may be multiple parent nodes, depending on how the XML is formatted.

Number Formatting node values

• The syntax below will return a numeric nodevalue with comma formatting (i.e. 1000 will be displayed as 1,000)

@xml.field name.parentnodename[# ~comma(nodename.nodevalue)~ #]@

Currency Formatting node values

• The syntax below will return a numeric nodevalue in currency format.

@xml.field name.parentnodename.currency(nodename.nodevalue)@

• The syntax below will return a numeric nodevalue in currency format with 2-decimal places for value pulled from a dynamic XML section

@xml.field name.parentnodename[#~comma(nodename.nodevalue,2)~#]@

• The syntax below will return a numeric nodevalue in currency format with 2-decimal places for value pulled from a static XML section

<!--@sscalculation(format("@xml.field name.parentnodename.nodename.nodevalue@",2))-->

See also Displaying a Number Value as Currency.

Date formatting node values

The available syntax for date formats are as follows:

• ~formatdate(Date.nodevalue)~ >> returns the date in the user's date format
• ~year(Date.nodevalue)~ >> returns the year from the date
• ~month(Date.nodevalue)~ >> returns the month from the date
• ~monthname(Date.nodevalue)~ >> returns the month name from the date
• ~day(Date.nodevalue)~ >> returns the day from the date
• ~dayweek(Date.nodevalue)~ >> returns the day of week from the date

Counting nodes

@xml.field name.parentnodename.nodename.nodecount@

For child records

@xml.fieldname.nodename[# ~nodevalue~ ~attributes(attribute name)~ #]@

@xml.fieldname.nodename[# ~childnodename.nodevalue~ ~childnodename.attributes(attribute name)~ #]@

To return the actual XML code from the field

@fieldname.xmlvalue@

• Important: XML node names are case sensitive.

Filtered XML

@xml.XML Field.People.Person[#(?criteria="~type.nodevalue~" == "A")

Created By @xml.mypasta.Author.Firstname.nodevalue@ @xml.mypasta.Author.Lastname.nodevalue@

@xml.mypasta.Author.Address.Street.nodevalue@ @xml.mypasta.Author.Address.postalcode.nodevalue@

@xml.mypasta.title.nodevalue@  
@xml.mypasta.comment.nodevalue@ 
Calories=@xml.mypasta.nutrition.attributes(calories)@

Ingredients
Name - amount - unit
@xml.mypasta.ingredients.ingredient[#~nodevalue~ - ~attributes(amount)~ - ~attributes(unit)~#]@

Steps
Order Description
@xml.mypasta.preparation.step[#~attributes(order)~ ~description.nodevalue~#]@

FORMAT: @xml.fieldname.Expenses-Static.row[# ~formatdate(col4.nodevalue)~ #]@ <br/>
YEAR: @xml.L1-XML Budget.Expenses-Static.row[# ~year(col4.nodevalue)~ #]@ <br/>
MONTH: @xml.L1-XML Budget.Expenses-Static.row[# ~month(col4.nodevalue)~ #]@ <br/>
MONTHNAME: @xml.L1-XML Budget.Expenses-Static.row[# ~monthname(col4.nodevalue)~ #]@ <br/>
DAY: @xml.L1-XML Budget.Expenses-Static.row[# ~day(col4.nodevalue)~ #]@ <br/>
DAYWEEK: @xml.L1-XML Budget.Expenses-Static.row[# ~dayweek(col4.nodevalue)~ #]@ <br/>

@xml.Budget.source.category-total.currency(cash.nodevalue)@

@xml.Budget.source.category-total.currency_eur(cash.nodevalue)@

 @xml.budget.funding-source.requested[#
   <tr>
      <td> </td>
      <td class="answer border">Requested from the program</td>
      <td class="answer border"><div align="right"> ~currency(cash.nodevalue)~</div></td>
      <td class="answer border">~status.nodevalue~ </td>
      <td class="answer border">~field.nodevalue~ </td>
  </tr>
 #]@

ExtractValue([this], '/recipe/title')

ExtractValue([this], '/recipe/Author/Address/Street')

• XML Section Builder
• Managing Level 2 Activities with an XML Section
• XSL Template
• Referencing Other Sections in XML Calculations
• Adding Styles to XML Worksheets
• MySQL XML Functions Note: this is an external website.
• Number Format