==Overview=General Description=XML (Extensible Markup Language) is a type of custom field used to create budgets and lists of information[[File:xmlSample. This advanced custom png|thumb|none|500px|Example field opens in configured as a separate window from the main browser screen, it can have multiple sections, and it is robustly configurable (formulas, validation, reporting)budget sheet. ]]
If you are looking This field type can be used to create a basic lists worksheets or tables such as budgetsheets, you can also use the field called '''[[Custom Field Type: Special and lists of information. A wide range of complexity is supported from very simple tables to multi- Insection, multi-Line Data Grid|Special year budgets. This is accomplished through the ability to configure sub- In-Line Data Grid]]sections within the same worksheet, and also define automatic cell calculations. This all adds up to a very robust, and flexible field.'''
[[File:xmlSampleBy default, the data for this field is stored in the structured XML (Extensible Markup Language) format.png|The look However, you also have the option to instead use this field as a presentation layer for lists of an XML|500px|border]]sub-activity records. For example, you may use this field on a UTA Level 1 record to display any associated UTA Level 2 records for a user to easily update the activities or create new activities.
Creating a XML is If you are looking to create a multi step process. For convenience we have grouped how basic list or budget, you do specific tasks under several groupingscan also use the field called [[Custom Field Type: Special - Basic Data Table|Special - Basic Data Table]].
'''Configuring {| class="wikitable"|-||Summary|||-||Commonly Used in Markets (Philanthropy, Research, Insurance)||All|- Essentials'''*Creating a Special ||Used By (User Type)||All|- XML Data custom ||Requires Administrator Setup||Yes|-||Configuration Complexity (Low, Medium, High)||High|-||Time to Configure (Minutes, Hours, Days)||Hours|}==Field Options==All common options:<br />[[Custom Fields - General Information #General_Settings|General Settings]]<br />[[Custom Fields - General Information #Role Field Permissions and Status Field Permissions|Permissions & Availability]]<br />[[Custom Fields - General Information #Classic Options|Classic Options]]<br />For further information, please refer to [[Custom Fields – General Information]].<br /><br />Options listed below are specific to this particular fieldtype.<br />*Create XML section with defined number of rows{{XSL Template}}*Create XML section with dynamic number of rows*Display {{XML sectionsTag Mapping}}
'''Configuring - Advanced'''*Creating formulas (calculations) in {{XML cells*Adding a formula to a XML cell (working with data in the same section)*Adding a formula to a XML cell (working with data in the different sections)*Validate XML values when saving the worksheet*Validating values when saving record (SmartCheck, Submit Logic, Browser Script)Javascript Function}}
'''Displaying the {{Show View XML data'''*Displaying XML data on a object*Access, Display and Format options for XML data*Styling XML data for web and print (PDF)*Reporting on XML dataButton}}
'''XML - Appendix'''*Field options and settings*Example of an XML{{Show Upload Button}}
{{Show Up/Down Button}}
== Configuring - Essentials =={{Show Clear Button}}
=== Creating a Special - XML Data custom field ==={{Custom Field Ids}}
=Configuration - Essentials===Creating the field==Typically XML Advanced Data table custom fields are created for UTA level 1, 2 or 3, (e.g. a grant application) or they are created for organizations. To create a XML custom the field: #Navigate to the desired place, settings area where you want to create the XML custom field a worksheet (e.g. the UTA level 1).
# Click the '''New Field''' (+) button.
# For Field Type select '''Special - XML Advanced DataTable'''.# Enter a '''Field Name''' and , '''Caption''' then '''Save'''.# Click Use the '''Section Builder''' button to begin process of creating the XML tables.# Use the '''Custom Field'''Savebutton to navigate back from the Section Builder to the Field settings to configure the display of tables. ==Create a Simple Table==Using the '''Section Builder'''you can create sections and define the attributes of each section and the cells within them. You can define the number of rows and columns, the display format, calculation formulas, and modify other parameters. [[File:xml-sectionbuilder1.png|thumb|none|500px|The section builder.]]
# While editing the custom field click on the '''Section Builder''' button (the four square icon) in the action bar.
# Create a '''New''' section and enter a '''Section Name''' (e.g. Expenses).
# Enter '''Number of Rows''' and '''Number of Columns''' desired.
# Once you '''Save''' you will be brought to the '''Cell Details''' tab.
# Define a '''Display Name''' for the column headers (e.g. Item, Amount, Date).
# Define a '''Display Name''' for the first column of each row (e.g. Salaries, Equipment, Other).
# Within each of the column headers you can define a '''Format''' for the column (e.g. Text, Currency, Date). For the Number format option you may also specify a precision.
# When you are done click the '''Build button'''.
Note:
=== Create XML with defined number of rows ===Use # When you choose the XML format '''Section BuilderCurrency''' to create sections, including defining the number of rows and columns displayedin a column header, formulas, and style your XML. Note make sure you must manually enable specify the column alignment as '''Section BuilderRight Align''' before . This way it will be easy for the user to compare the values. This step is also required if you can plan to export this data to PDF for printing.# You must use itunique node names of sections, rows, and columns within this field.
==Create a Table with a Dynamic Number of Rows==[[File:xml-sectionbuilderxmlDynamic.png|The section builderthumb|none|500px|borderExample section set to dynamic rows.]]
In addition to defining a set number of columns and rows, you can also configure a section to handle a dynamic number of rows. The user entering the data can add rows as necessary at time of entry. This is done by entering '''0''' for the '''Number of Rows''', which in turn exposes the following configuration options:
# Scroll down to the '''Options''' section and check '''Enable Builder'''. # Click '''Save'''.# In the action bar click on the '''Section Builder''' button (it has four squares on it).# Enter a '''Section Name''' (e.g. '''expense''').# Click into the '''Section Node Name''' (the name auto populates. Note: '''Section Node Names''' are case sensitive).# Enter * '''Maximum Number of Rows''' desired.# Enter '''Number of Columns''' desired.# Check '''Apply Default Styles'''.# Navigate : Set a maximum limit to the '''Cell Grid''' in the lower section number of the page.# Click into the first cell of the '''Cell Grid''' at the top left.# Enter a '''Display Name'''.# Click into the top row of the column labeled '''1'''.# Enter a '''Display Name''' and a '''Node Name'''.# If desired choose the '''Format''' (e.g. text, number, comma, date, currency, percent). NOTE: If you select numberrows that can be entered, comma or percent you can also specify precision settings (e.g. Whole Number, Nearest Hundred). If you select currency you can also specify precision and currency settings (e.g. US Dollar, Euros).# Repeat leave as 0 for the remaining column headersno limit.# Click into the first cell in the row labeled * '''1Maximum Message'''.# Enter a '''Display Name''' and '''Node Name'''.# Repeat for the remaining row labels.# Click the '''Build''' button.# When you are done, navigate from the builder back : The message to be displayed when the field maximum limit is set and reached by clicking the '''Field''' buttona user.Note: Do not use the same node names across different sections, rows or columns in the xmlA default message is displayed if this input is empty.
=== Create XML with dynamic number Setting the Number of rows ===The XML section builder can Rows to 0 also be configured to allow exposes the following configuration options for each column header within the user to add additional rows of data using a plus button. Cell Details tab:
[[File:xmlDynamic.png|The dynamic XML|500px|border]]It is configured by entering '''0''' for the Number of Rows, which in turn exposes the following configuration options: * '''Maximum Number of RowsHas Total''': if left as 0 Display the user can add as many rows as needed. If populated with a numeric value total sum of the user can only add up to and including that number of rowscolumn. * '''Maximum Reached MessageTotal Row Label''': message For columns without a total display this option allows you to be displayed if user tries to add more that enter a label for the specified maximum number total sum of rowsanother column. A default message is displayed For example, if left blank. * column 3 was displaying a total, then you could configure the '''Has TotalRow Label''': will appear when clicking into the section's of column headers. Check ''2 to display 'Has Total''' to automatically sum and display all the items in that column.
Even though you set ==Configure the Display of Tables==The presentation of the XML Data custom field is configured in the number '''General Settings''' tab of rows to 0 the field. This is defined in the XSL Template (Extensible Style Sheet Language) inputn. The XSL Template includes a sample template link. Once you have inserted sample template you still will need to configure one row of data specify which will be used to format the dynamically created rows. You may also set a maximum number of rows for a dynamic XML sectionsections should appear and where they should appear.
=== Display XML sections ===The XML Data custom field has an XSL Template option within the overall XML Data custom field settings[[File:xml-xsl. png|thumb|none|500px|The XSL Template is used to define how the XML will be displayed. XSL stands for Extensible Style Sheet Languagetemplate and configuration. ]]
The # While editing the custom field locate the '''XSL Template includes a sample template option''' link and insert the '''Sample Template'''. If # Locate the template is used then all that is left to do is to specify what sections should included and where they should appearmarker below.
[[File:xml<pre><!-xsl--- Insert section variable here ----></pre># Below this marker, insert variable references to the each section with the following syntax (e.g. @section.Expenses@) in the order in which you wish the sections to appear.png|The XSL template|500px|border]]
# In the Section builder click the field button to return to the overall XML Data custom field settings. # In the '''XSL Template''' click the '''Sample Template''' link.# Replace <pre><!---- Insert section variable here ----></pre> with <pre>'''@section.''SectionNodeName''@'''</pre># Click '''Save'''.Note:
# Make sure you are using the '''Section Node Name''' and not the '''Section Name'''
# '''Section Node Name''' is case sensitive Example if your '''Section Node Name''' is '''Expenses''' than @section.Expenses@ will work but @section.expenses@ will not because it has a lower case '''e'''.
The syntax ''' @section.''SectionNodeName''@''' will display the section we created using the section builder. Note: you must replace '''SectionNodeName''' with the name you gave your section (e.g. '''@section.''expense''@'''), the section node name is case sensitive, and you must remove the html comments.
== Configuring Configuration - Advanced ===Creating formulas (calculations) in cells==[[File:xml-formula.png|500px|border|Adding a formula]]
=== Creating formulas In the section builder you declare the formatting such as currency or numeric for specific columns as well as choose the precision.You can also do calculations on numeric and currency data (calculations) in XML cells e.g. to sum the contents of column one, over two rows, enter '''===[1,1]+[File:xml-formula2,1]''').png|Adding a formula|500px|border]]
In the section builder you declare the formatting such as currency or numeric for specific columns as well as settings like precision. If you are collecting numeric or currency data you will likely want to do calculations on this information found within your XML (e.g. to sum the contents of column one, over two rows, enter '''=[1,1]+[2,1]''').
=== Adding a formula to a XML cell (working with data in the same section) ===# Navigate to your XML custom field.# Click the '''Section Builder''' button in the action bar (section builder must be enabled).# Click the desired '''Section'''to edit it.
# Click the desired '''Cell'''.
# In Enter the '''Cell Properties''' enter your desired formula into the '''Content''' input.
# Click '''Build'''.
The Syntax for basic calculations within a section:
{| borderclass="1wikitable"|-||'''Operation'''||'''Symbol'''||'''Example'''
|-
|| Add|| +|| =[row#,column#]+[row#,column#]
|-
|| Subtract|| -|| =[row#,column#]-[row#,column#]
|-
|| Divide|| /|| =[row#,column#]/[row#,column#]
|-
|| Multiply|| *|| =[row#,column#]*[row#,column#]
|}
So if you wanted to add the values of row 1 and 2 together in column 1 you would enter '''=[1,1]+[2,1]'''.
=== Adding a formula To minimize divide by zero errors, you can first check if the denominator is 0 (and set value to a XML cell (working with data in 0) by using the different sections) ===following syntax:
<pre>=(ssParseNum([1,3])==0 ? 0 : ([1,2]/[1,3])*100)</pre>
==Adding a formula to a cell (working with data in the different sections)==
Refer to cells in different sections using this syntax
'''[@section.''sectionnodenamesectionname''.id@_''rownodename''_''columnnodename'']'''
=== Validate XML values when saving If you need want to display data in the worksheet ===head of a section (row 0) from another section you can use the following:
'''@xml.customfieldname.sectionnodename.rownodename.columnnodename@'''
==Validate values when saving the worksheet==
Clicking on a cell inside the section builder will present you with the cell properties. There are two cell properties used for the validation of cells when the xml worksheet is saved.
* '''Validation Script''': Validates the input field.
* '''Validation Message''': Content that is displayed, when the validation script is not true (e.g. Value must be greater than 100).
* Total Amount greater than 0, for currency formatted column totals
<pre>ssParseNum([this])>0</pre>
Message: Total must be greater than $0.00
* Date is at least 30 days in the future
<pre>datediff(ConvertDateStr([this],'@dateformat@'),'@date(currentdate)@','d') > 30</pre>
Message: Please select a date that is at least thirty 30 days from today.
* Cell is not empty
<pre>[this].length>0</pre>
Message: Please provide a value.
* Check the user selected something other than the default Combo Box value
<pre>[this]!="Default Combo Box Value"</pre>
Message: Please select a value.
Note, '''Default Combo Box Value''' should be substituted with the default value you have configured, e.g. '''--- Select One ---'''.
* Integer greater than 0 (Allow only an integer or if your field on the XML is formatted to display/use a comma.)
<pre>parseInt([this])>0</pre>
Message: Please provide a numeric value greater than 0.
=== Validating values when saving record (SmartCheck, Submit Logic, Browser Script) ===
* Value entered in one cell cannot be more than 20% above or below the value in another cell <pre>(ssParseNum([this])>=(ssParseNum([1,4])*(0.80)) && ssParseNum([this])<=(ssParseNum([1,4])*1.20))</pre>Message: Value entered in one cell cannot be more than 20% above or below the value in another cell ==Validating values when saving record (SmartCheck, Submit Logic, Browser Script)==In addition to validating values when you save the XML worksheet you can also validate the XML worksheet when you save the record (e.g. save a level 1 grant application). When creating validation for an this custom field use the '''Appear Mandatory''' option. Appear mandatory does not enforce the validation but will make the field look mandatory (it adds the asterisk and or color) just like the mandatory option. Once you have checked '''Appear Mandatory''', validate this field using one of the following validation methods, when the record is saved.
When creating validation for an XML custom field use the '''Appear Mandatory''' option. Appear mandatory does not enforce the validation but will make the field look mandatory (add the asterisk and color) just like the mandatory option. Once you have checked '''Appear Mandatory''', validate the XML worksheet using one of the following validation methods, when the record is saved.
==== SmartCheck Validation ====Use SmartCheck for XML validation when possible. SmartCheck validation is a secure server -side method. SmartCheck also displays all error messages in a context as well as in one central place.
Validate an XML a table node is not empty and display a message.
<pre>if("<ssEscape>@level1.xml.fieldname.sectionnodename.rownodename.columnnodename.nodevalue@</ssEscape>"=="")
{result.isPassed=false;
result.addMsg('xml_@fieldname.id@','YourAlertMessage'); }</pre>
==== Submit Logic Validation ====Use Submit Logic in conjunction with Submit Buttons to Validate a worksheet.
Use Submit Logic Check a node in conjunction with Submit Buttons to Validate a XML not blank when saving the worksheet.
Check an XML node in not blank when saving the XML worksheet.<pre>"
<ssEscape>@level1.xml.fieldname.sectionnodename.rownodename.columnnodename.nodevalue@
</ssEscape>"!=""</pre>
==== Special - Browser Script validation ====You can enter JavaScript and jQuery into XML JavaScript Function input to create specific validations. Use the following syntax when referencing a value in your variables.
You can enter JavaScript and jQuery into XML JavaScript Function input to create specific validations. Use the following syntax when referencing a value in your variables.
<pre>@xml.customfieldname.sectionnodename.rownodename.columnnodename@</pre>
The following function allows you to check for an already selected value from an existing row when using dynamic rows:
<pre>// REPLACE '7172_dsItem_Population' AND '7172_dsItem_Population_' WITH SPECIFIC XML FIELD ID
var saveFunc=saveXML;
saveXML=function() {
checkdupeval();
}
function checkdupeval() {
var result = 0;
var numOfRows = document.getElementsByName('7172_dsItem_Population'); //section node
var ctr=1;
for (ctr=1;ctr<numOfRows.length;ctr++)
{
var field1='7172_dsItem_Population_'+ctr;
var lastfield='7172_dsItem_Population_'+numOfRows.length;
var a = document.getElementById(field1).value;
var b = document.getElementById(lastfield).value;
if( a == b)
{
alert ("Please list each population no more than once.");
result = 1;
}
}
if(result==0)
saveFunc();
}
</pre>
The following function allows you to check for an already selected value from an existing row when using dynamic rows on multiple sections:
<pre>var saveFunc=saveXML;
saveXML=function() {
if (checkdupeval_Section1() == 0 && checkdupeval_Section2() == 0 && checkdupeval_Section3() == 0) {
saveFunc();
}
}
function checkdupeval_Section1() {
var result = 0;
var numOfRows = document.getElementsByName('16580_row_COUNTY'); // REPLACE '16580_row_COUNTY' AND '16580_row_COUNTY_' WITH SPECIFIC XML sectionid_rownodename_columnnodename for Section 1
var ctr=1;
for (ctr=1;ctr<numOfRows.length;ctr++)
{
var field1='16580_row_COUNTY_'+ctr;
var lastfield='16580_row_COUNTY_'+numOfRows.length;
var a = document.getElementById(field1).value;
var b = document.getElementById(lastfield).value;
if( a == b)
{
alert ("Please list each option no more than once for Section 1.");
result = 1;
}
}
return result;
}
function checkdupeval_Section2() {
var result = 0;
var numOfRows = document.getElementsByName('16581_row_COUNTY'); // REPLACE '16581_row_COUNTY' AND '16581_row_COUNTY_' WITH SPECIFIC XML sectionid_rownodename_columnnodename for Section 2
var ctr=1;
for (ctr=1;ctr<numOfRows.length;ctr++)
{
var field1='16581_row_COUNTY_'+ctr;
var lastfield='16581_row_COUNTY_'+numOfRows.length;
var a = document.getElementById(field1).value;
var b = document.getElementById(lastfield).value;
if( a == b)
{
alert ("Please list each option no more than once for Section 2.");
result = 1;
}
}
return result;
}
function checkdupeval_Section3() {
var result = 0;
var numOfRows = document.getElementsByName('16582_row_COUNTY'); // REPLACE '16582_row_COUNTY' AND '16582_row_COUNTY_' WITH SPECIFIC XML sectionid_rownodename_columnnodename for Section 3
var ctr=1;
for (ctr=1;ctr<numOfRows.length;ctr++)
{
var field1='16582_row_COUNTY_'+ctr;
var lastfield='16582_row_COUNTY_'+numOfRows.length;
var a = document.getElementById(field1).value;
var b = document.getElementById(lastfield).value;
if( a == b)
{
alert ("Please list each option no more than once for Section 3.");
result = 1;
}
}
return result;
}
</pre>
The following allows you to hide the Add Row button for a specific section when the record is in a specific status:
<pre>function onloadfunc() {
<!--@sslogic("@statusid@" = "XXXXX" )--> //Replace XXXXX with the ID of the status in which the button should be hidden
$('#addrowbutton_@section.SECTION.id@').hide(); //Replace SECTION with the section name
<!--@end-->
}
</pre>
The following allows you to hide the Delete Row button:
<pre>function onloadfunc() {
$("a[name='@section.SECTION.id@_deletebutton']").remove(); //Replace SECTION with the section name
}
</pre>
==Managing Level 2 / 3 Activities with a Section==
System administrators can configure this field to add, modify or delete {{l2}} records on a {{l1}} entity or {{l3}} records on a {{l2}} entity.
In the '''Section Builder''', when the ''Number of Rows'' for a Section is set to '0', the ''Enable Mapping'' option will be shown.
[[Image:XMLEnableMapping2017.png|link=|800px|border]]
When '''Enable Mapping''' is selected, you can choose one type of activities to be referenced by this field.
== Displaying XML Data==The '''Activity Status Filter''' setting allows you to filter the activities to be referenced by status.
The '''Additional Filter''' setting allows you to select custom fields and associated values. These are used to filter the existing activities that will be listed within this field. The custom fields used have to be fields with pre-defined options (e.g. [[Custom_Field_Type:_Select_One_-_Dropdown_List|Select One - Dropdown List]], and [[Custom_Field_Type:_Select_Many_–_Check_Boxes|Select Many – Check Boxes]]).
=== Displaying XML Data on a object ===[[FileImage:xml-readonlyXMLEnableMappingFilter2017.png|The XML displayed in a read onlylink=|500px650px|border]]
When building your section, you will need to map the fields on the {{l2}}s that will be referenced by the section. For each Section column, enter the field name from the Level 2 type that you have selected from the '''Activity Type''' dropdown in the '''Map Field''' section: [[Image:MappingL2Fields2017.png|link=|800px|border]] The XML syntax for the '''Map Field''' section is: * for [[custom fields]], the field opens in name (i.e., '''Fund Name''');* for [[Standard_Field|Standard Field]]s, use the prefix '''sf_''' and then the system name for the standard field (i.e., '''sf_status'''). see [[Standard Level 2 Field List]] article for a modal window and list of system names for {{l2}} standard fields.If the user must click Standard or Custom field has a button limited number of pre-defined options then these need to be defined in the Content section of the cell properties. You may need to launch reference some standard field options using both the modal window displayed name and see stored ID values. [[Image:MappingL2Fields2018.png|link=|650px|border]] When this section is added to the Template of your field, the list of {{l2}} activities will be displayed when the information enteredworksheet is opened. You Level 2s can howeverbe added, display deleted and modified directly from the information entered into {{l1}} Advanced Data Table field. =Displaying XML Data===Displaying Advanced Data Table data on an object==[[File:xml-readonly.png|500px|border|The XML displayed in a read only]] The Advanced Data Table custom field can open in a new or modal window. The '''Open in Modal Window''Special - XML Data' option is recommended. You can toggle this on under '''Document Options''' custom . By default the information entered into this field type is hidden until the user clicks a button. But there is a way to display the information entered into this field on your object, such as a grant application, without requiring the user to click a button and launch the modal window. To do this we use Use the '''Read Only – System Display - Text and Variables''' custom fieldto display the content of the Advanced Data Table on the object. The same syntax can be used elsewhere in the system (e.g. include Display Only - Web Page View, Special MS Word Merge, visibility conditions, etc.) when referencing the xml this field's values.
# Go to the desired location where you want to create the custom field.
# Click the '''New Field''' (+) button in the action bar.
# For '''Field Type''' select '''Read Only – System Display - Text and Variables'''.
# Enter a '''Field Name'''.
# For '''Variables''' enter '''@xml.''CustomFieldName''.''SectionNodeName''.html@''' (replace the '''CustomFieldName ''' and '''SectionNodeName ''' with the actual names from your XMLexample '''@xml.Budget.Expenses.html@''').
# Scroll Down to the '''Display''' section.
# For '''Caption''' select '''Hide Caption''' (we recommended that you hide the caption for the display so that you can utilize the full screen width).
# Click '''Save'''.
# Navigate back to the XML custom Advanced Data Table field and click '''Save''' ('''Display Fields Refreshed Upon Edit''' will be updated with this updates the linkage and ensures when data is entered into the custom field ID of worksheet the Read Only we just created. From now data displayed on when a user edits the XML the read only object will be also get automatically updated. If you miss this step it , information entered into the Advanced Data Table will only refresh in the Display - Text and Variables field when the object is saved).
Note: you may want to create two '''Display - Text and Variables''' custom fields for each '''Advanced Data Table''' custom field. One that you will use for printing and one for displaying on the object.
==Access, Display and Format options for Data==
The syntax options for accessing, displaying and formatting the data from the Advanced Data Table field is detailed below.
=== Access, Display and Format options for XML Data ===
The syntax options for accessing, displaying and formatting the data from the XML fields are detailed below.
* Extract the value from a specific individual cell using the '''field name'''.
<pre>@xml.fieldname.sectionnodename.rownodename.columnnodename@</pre>
* Extract the value from a specific individual cell using the '''field id'''.
<pre>@xml.#fieldid#.sectionnodename.rownodename.columnnodename@</pre>
* Extract numeric value and return in '''comma format''' (i.e. 1000 will display as 1,000).
<pre>@xml.fieldname.sectionnodename.rownodename[# ~comma(columnnodename.nodevalue)~ #]@</pre>
* Extract a numeric value and return in '''currency format'''.
<pre>@xml.fieldname.sectionnodename.rownodename[# ~currency(columnodename.nodevalue)~ #]@</pre>
* Extract a numeric value and return in a '''specific currency format'''.
<pre>@xml.fieldname.sectionnodename.rownodename[# ~currency_eur(columnodename.nodevalue)~ #]@</pre>
Further currency formatting options below
{| border="1"
|-
|| usd|| $300.00
|-
|| eur|| €300.00
|-
|| jpy|| ¥ 300
|-
|| zar|| R 300.00
|-
|| inr|| ₹300.00
|-
|| frca|| 300,00 $
|}
* Extract a numeric value and return in '''currency format with two decimal places'''. If pulled from a '''dynamic''' XML section then you will see multiple values.
<pre>@xml.fieldname.sectionnodename.rownodename[# ~currency_eur(columnodename.nodevalue,2)~ #]@</pre>
* Extract a value and return the number of characters in the field. <pre>@xml.fieldname.sectionnodename.rownodename.columnodename.nodevaluelength@</pre> * Extract a numeric value and return in '''currency format with two decimal places''' for value pulled from a '''static''' XML section.
<pre><!--@sscalculation(format("@xml.fieldname.sectionnodename.rownodename.columnodename.nodevalue@",2))--></pre>
* Extract a filtered row count from a '''dynamic''' XML section.
<pre><!--@sscalculation(@xml.XML Field.People.Person[#(?criteria="~type.nodevalue~" == "A") 1+#]@ 0)--></pre>
* Extract a percentage value and '''format with two decimal places'''. If pulled from a '''dynamic''' XML section then you will see multiple values.
<pre>@xml.fieldname.sectionnodename.rownodename[# ~percentdisplay(columnodename.nodevalue,2)~ #]@</pre>
* Extract date values and return with specific formatting using the following syntaxReturn the date in the user's date format
<pre>@xml.fieldname.sectionnodename.rownodename.formatdate(columnnodename.nodevalue)@</pre>
* Return the year.
<pre>@xml.fieldname.sectionnodename.year(columnnodename.nodevalue)@</pre>
* Return the month.
<pre>@xml.fieldname.sectionnodename.month(columnnodename.nodevalue)@</pre>
* Return the month name.
<pre>@xml.fieldname.sectionnodename.monthname(columnnodename.nodevalue)@</pre>
* Return the day.
<pre>@xml.fieldname.sectionnodename.day(columnnodename.nodevalue)@</pre>
* Return the day of the week.
<pre>@xml.fieldname.sectionnodename.dayweek(columnnodename.nodevalue)@</pre>
* Count the number of rows the user created in a dynamic XML section.
<pre>@xml.fieldname.sectionnodename.rownodename.nodecount@</pre>
* Return the XML feed (code) from the field.
<pre>@fieldname.xmlvalue@</pre>
* Return multiple rows for XML with dynamic sections.
<pre>@xml.fieldname.sectionnodename.rownodename[# ~columnnodename.nodevalue~ #]@</pre>
* Return Filtered row values for XML with dynamic sections.
<pre>@xml.fieldname.sectionodename.rownodename[#(?criteria="~colunnnodename.nodevalue~" == "matching criteria")~columnnodename.nodevalue~ #]@</pre>
=== Styling XML data * Return multiple rows for web and print (PDF) ===[[File:xml-readonly-styled.png|The XML styled at 700 pixels wide with dynamic sections in a read only|500px|border]]custom html table.
If you enable the '''Section Builder''' and check '''Apply Default Styles''' in each section of your XML custom field, the field will be automatically styled<pre>@xml. If you have manually added CSS classes to your cells, you will need to remove those classes and check '''Apply Default Styles''' again and then click '''Build''' on your XML in section builderfieldname. Administrators with CSS knowledge can modify the look and feel of their XMLs (e.g. make columns wider or thinner). To modify the look and feel of your XML, create an external CSS style sheet, upload the style sheet to a SmartFolder, add classes to the elements in your XML, and add a link to the style sheet in your '''Special - XML Data''' or '''Read Only - System Variable''' custom fieldssectionnodename.rownodename[# #]@</pre>
{| border="1"
|-
||~columnodename.nodevalue~
||~columnodename.nodevalue~
||~columnodename.nodevalue~
|}
==== Styling XML Data for Printing ====You can print your XML if you are displaying it * Return a single value in a '''Read Only - System Variable'''. Size your your XML to fit within 700 pixels wide (portrait) or 900 pixels wide (landscape) to avoid content cutting off, when a PDF is generated. If you have more than one section and more than a few columns, some the total row of your content may cut off when printed if it is not sized. You will also notice columns between sections do not align. To fix this, we will use CSS in a SmartFolder and amend our '''Read Only - System Variable''', which is displaying the Dynamic XML information.
Wrap the content in your read only system variable with a div and give the div a class<pre>@xml. We do this to control the widthfieldname. Wrap the section syntax in a div and give it a classsectionnodename. We do this so we can control the size of cells and the fontstotal. e.gcolumnnodename.nodevalue@</pre>
<pre><div class="xml700"><div class="xmlTitleBar">Title Bar Name</div><div classStyling Advanced Data Table for web, print and conversion to PDF="xml3col">@=[[File:xml-readonly-styled.fieldname.sectionnodename.html@</div></div></pre>png|500px|border|The worksheet styled at 700 pixels wide in a Display Text and Variables custom field]]
To ensure data entered into an '''Advanced Data Table''' fits on screen and will converted to a PDF without having data cut off, administrators need to upload two external CSS style sheet to a SmartFolder, reference it on the '''Advanced Data Table''' and the '''Display Text and Variables''' fields as well as add some code to both of these fields.
Now create a CSS file. e.g.Note:
<pre>@charset "utf-# Make sure your Advanced Data Table has 8";/* CSS Document */.LeftAlign {text-align:left;}.RightAlign {text-align:right;} <!--Used to align numbers like money to the right-->.xml700 {width:700px;} <!--Used or less columns to constrain the xml ensure it will print and title bars to 700px-->.xml3col fit on screen.xmlHead {font-size:12px;} <!--Used to change the header font size-->.xml3col .xmlLabel {width:470px; min-width:470px; max-width:470px; font-size:12px;} <!--Used to set # If the first column user is expected to enter paragraphs of information, do so in a set size and change the font size-->new row or new section, instead of adding another column..xml3col .xmlCell {width:80px; min-width:80px; max-width:80px; font-size:12px} <!--Used to set # If your worksheet does not look as expected make sure '''Apply Default Styles''' is toggled on in the rest '''Section Builder''' and then click '''Build''' on each of your sections in the columns to a set size and change the font size-->section builder.xml3col .xmlCell.note {width:150px; min-width:150px; max-width:150px; font-size:12px} <!--Used to set one column to a larger size than the other cells--></pre>
Go to the desired SmartFolders and upload your CSS file. Use '''View URL''' to get the path to the CSS file. Then add the relative link back into your '''Read Only - System Variable'''. e.g.
===Styling the Advanced Data Table for viewing onscreen===
Ensure the columns and rows of your '''Advanced Data Table''' look good onscreen, when a user enters information, by following the steps below.
<====Uploading the external CSS files and getting the relative links====# Download the CSS files [[File:CSS.zip|CSS.zip]]# In your desired instance navigate to the Menu Icon and choose '''SmartFolders'''# If it does not exist already create a '''New Folder''' and call it '''System Files'''# Upload the CSS files found inside the Zip file you downloaded in step 1# Inside SmartFolders in the column called '''File Options''' for the desired file select '''View URL''' from the drop down. This will give you the absolute path to the file you uploaded# Copy this link that starts with '''https:''' and ends with '''/CSS_for_XSL_onscreen_1290.css'''.# Remove the first part of the link before the '''/files...''' to make it a relative link. Absolute links can have an adverse affect on your instance and they won't work as expected on your backup. So Always convert the absolute link to a relative link. Your relative link href="will look like '''/files/427076000000/f114840f000000/filenameCSS_for_XSL_onscreen_1290.css" rel="stylesheet" type="'''# Save this relative link in a text/css" />file so we can add it to each '''Advanced Data Table''' custom field in your instance.# Repeat steps 5 to 8 for the second CSS file which will be used for rendering on the object and in the PDF.
====Modifying the Advanced Data Table template====
# Download the templates used for the '''Advanced Data Table''' and the '''Display Text and Variables''' fields [[File:TEMPLATES.zip]].
# In the desired '''Advanced Data Table''' Field paste the content from the xsl_template_1290 file you downloaded, into the XSL Template input.
# Change the href in the link to the relative URL that points to the CSS file you previously uploaded to the SmartFolder (Example href="/files/000000/f000000/CSS_for_XSL_onscreen_1290").
# Update the text called '''Title''' in two places inside the XSL template.
# Update '''@section.Section Node Name@''' with the '''Section Node Name''' you want to display.
# Modify the class wrapper with the amount of columns in your section. Example '''class="xml6col"''' is for a 6 column section. If you have 2 columns, change it to '''class="xml2col"'''.
# Save the Advanced Data table Field.
Add Now when you click the class '''RightAlign''' button to open the desired cells Advanced Data Table you will see your columns will render nicely and they will be equal in the section builderwidth.
Note:
If # Under Display you want can customize the Button Label. To meet with Accessibility guidelines you must change the button label from '''Open''' to make one cell larger than something meaningful like '''Modify Budget'''. The user must know what the button will do based on the others, add a custom class to that cell text in the section builder ebutton.gYou cannot have a generic link that says '''open''' or '''click here''' as that does not provide enough information when read out of context by a screen reader.<pre>.xml3col .xmlCell# Sections must contain 8 or less columns to render properly and be usable.note {width:150px; min-width:150px; max-width:150px; font-size:12px}</pre>
I ===Styling Advanced Data Table for Converting to PDF and Printing===You can add print your Advanced Data Table content by displaying it in a '''noteDisplay Text and Variables''' custom field. In order to do this the content must fit within 700 pixels wide (portrait) or 900 pixels wide (landscape) otherwise content will cut off when a cell that has xmlCell PDF is generated. To ensure content does not cut off and to ensure columns between sections align, we will use CSS in a section wrapped in a div with a class SmartFolder and amend our '''xml3colDisplay Text and Variables''' and that cell will become 150 pixels widecustom field.
Note: your cells must add up # Navigate to the desired '''Display Text and Variables'''.# Paste the contents of '''display.html''' into the '''Content''' section of the field.# update the href to point to the relative path to 700 pixels if the file called '''xml-print.css''' that you are displaying uploaded to the SmartFolders.# Add your budget desired variable example '''@xml.Budget.Expenses.html@''' inside the div with the '''class="xml8col"'''.# Change the '''8''' in '''class="xml8col"''' to the number of columns in a portrait PDF on letter size paper (your section. Note you must have 8or less columns.5 x 11”)# If you want this table to be displayed wider for landscape printing add the word '''landscape''' in the class example '''class="xml8col landscape"'''.# Save your custom field
You now have a version of your Advanced Data Table that you can display on the object such as the level 1 application and you can convert this to a PDF using the Web Page View custom field.
==== Using different styles If you created two '''Display - Text and Variables''' custom fields one for Print printing and Web with XML Data ====one for onscreen. The above instructions are for the print version as it will reduce the font size and constrain the content to 700 pixels. In this print version use the setting '''SmartFields View''' and choose '''Include'''. This will include this field in the PDF. On the second '''Display - Text and Variables''' intended for on screen use '''SmartFields View''' and choose '''Exclude'''. This will hide the onscreen version from the PDF. Lastly for the onscreen version you do not use the xml-print.css or the div wrappers.
You can have one look for your XML when it is onscreen and another when it is ==Reporting on Advanced Data Table data==Extract values in PDF format for printing. To do this, create two '''Read Only - System Variables''' custom fields, create two CSS style sheets in '''SmartFolders''' and reference a report using the desired style sheet following syntax in the desired '''Read Only - System Variables'''. Then on the '''Read Only - System Variables''' for viewing on screen for '''SmartFields''' View choose '''Exclude'''report builder. This custom field will no longer be included in PDFs generated using the SmartFields variable. For the other custom field you want to print, choose '''Only display return one value for SmartFields View'''. Now one '''Read Only - System Variables''' will appear on screen and another when the PDF is created, and you can have a separate style sheet static sections specific to control the look row and feel of bothmultiple values for Dynamic sections across all rows.
=== Reporting on XML data ===
Extract XML value in a report using the following syntax in the report builder. This will return one value for static XML sections specific to the row and multiple values for Dynamic XML sections across all rows.
<pre>ExtractValue([this], '/worksheet/sectionnodename/rownodename/columnnodename')</pre>
== XML Data - Appendix ==
=== Field options and settings ===
==== General Settings ====
'''Custom Field ID''': Used internally to reference the user's input.
'''Field Type''': Used to select the field type from list of available field types.
'''Field Name''': Used internally to reference the user's input.
'''Description''': Used for a general description, this field only appears on the configuration page.
'''XSL Template''': Used to define how the XML will look.
'''XML Tag Mapping''': Used to Tag Maps.
'''XML Javascript Function''': Used for JavaScript and jQuery functions such as validations.
'''Show View XML Button''': Used to display the XML button. This button opens the xml feed (code) in a new window.
'''Show Upload Button''': Used to display the upload button. This button enables the user to upload an XML, and if the node structure matches that of the field, it will populate the cells with the correct values.
'''Show Up/Down Button''': Used to display an up and down arrow on each row of a dynamic XML section. Enabling the user to move rows up and down.
'''Display fields refreshed upon edit''': Displays the ID of custom fields that reference this field. When this field is modified the references will automatically update.
'''Custom Field Ids''': Used to reduce variable processing time. Specify field ids of custom fields referenced from within the current field.
==== Display ====
'''Display Order''': Used to define where this field appears relative to other fields. Lower numbers appear closer to the top of the page.
'''Tab Name''': Used to display the field under a specific tab.
'''Caption''': Used as a label or question before the field. If left blank, the Field Name will be displayed as the caption.
'''Caption Location''': Used to control the position and visibility of the caption. See Examples [[Label_Display_Options]]
'''Instructions''': Used to display text in the caption area. Instructions appear below the caption and are always visible unlike tool tips that appear on mouse over.
'''Button Label''': Used to specify the text that appears on the button. You can also specify an icon.
'''Tool Tip''': Used to display a text message when the user hovers over the question mark. These messages are intended to assist the user in filling in the desired field.
'''On New Record''': Used to control when the field should be displayed.
==== Options ====
'''Appear Mandatory''': Used to make the field look like it is required without doing validation. This is used in conjunction with other validation methods such as SmartCheck, Submit Logic or Browser Script.
'''Track Changes''': Used to log changes to the field e.g. who updated the field when and what was the new and old values.
'''Enable Builder''': Used to create sections, define rows, columns, formulas and styles in your XML.
'''[[KML|Enable KML]]''': Used to upload a KML file which is used to display geographic data on a map.
'''Disable Field from Global Search''': Used to control the display of this field in the global search results.
==== Value Storage ====
'''Value Storage''': Used to save values to another field on the same entity.
=== Example of XML field ===
Here is an example of an XML field with one section (Expenses) 3 static rows (Salaries, Supplies and Total) and 3 columns (Amount, Notes and Date).
<pre><?xml version="1.0" encoding="UTF-8"?>
<worksheet>
<Expenses>
<Salaries>
<Amount>50000</Amount>
<Notes>People I work with</Notes>
<Date>2016-11-30</Date>
</Salaries>
<Supplies>
<Amount>30000</Amount>
<Notes>Things I need</Notes>
<Date>2016-11-30</Date>
</Supplies>
<Total>
<Amount>8000</Amount>
<Notes></Notes>
<Date>2016-11-30</Date>
</Total>
</Expenses>
</worksheet></pre>
{{CustomFieldPageFooter}}
[[Category:XML]]