Changes

Custom Field Type: Special - Advanced Data Table

6,522 bytes added, 3 June

no edit summary

=OverviewGeneral Description= [[File:xmlSample.png|thumb|none|middle|500px|Example field configured as a budget sheet.]]

This field type can be used to create worksheets or tables such as budget sheets, and lists of information. A wide range of complexity is supported from very simple tables to multi-section, multi-year budgets. This is accomplished through the ability to configure sub-sections within the same worksheet, and also define automatic cell calculations. This all adds up to a very robust, and flexible field.

By default, the data for this field is stored in the structured XML (Extensible Markup Language) format. However, you also have the option to instead use this field as a presentation layer for lists of 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.

If you are looking to create a basic list or budget, you can also use the field called '''[[Custom Field Type: Special - In-Line Basic Data GridTable|Special - In-Line Basic Data GridTable]].'''

{| class="wikitable"

| Summary

|

|-

| Commonly Used in Markets (Philanthropy, Research, Insurance)|Summary| All|

|-

| |Commonly Used By in Markets (User TypePhilanthropy, Research, Insurance)|| All

|-

| Requires Administrator Setup|Used By (User Type)| Yes|All

|-

| Configuration Complexity (Low, Medium, High)|Requires Administrator Setup| High|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 field type.<br />

{{XSL Template}}

 

{{XML Tag Mapping}}

 

{{XML Javascript Function}}

 

{{Show View XML Button}}

 

{{Show Upload Button}}

 

{{Show Up/Down Button}}

 

{{Show Clear Button}}

= Configuration - Essentials ={{Custom Field Ids}}

=Configuration - Essentials=== Creating the field ==Typically 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 the field:

Typically XML Data custom fields are created for UTA level 1, 2 or 3, (e.g. a grant application) or they are created for organizations. To create the field:

# Navigate to the desired settings area where you want to create 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'''.# Use the '''Section Builder''' button to begin process of creating the XML tables.# Use the '''Custom Field''' button 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.

Using the XML '''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 style your XML. [[File:xml-sectionbuilder1.png|thumb|none|middle|500px|The section builder.]]

# While editing the custom field click on the '''Section Builder''' button (the four square icon) in the action bar.

# 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 each of the row and 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. plain textText, currencyCurrency, dateDate). For numeric formats the Number format option you may also specify a precision.# Note: to avoid confusion it is recommended to use unique node names of sections, rows, and columns within When you are done click the field'''Build button'''.

== Create a Table with a Dynamic Number of Rows ==Note:

[[File:xmlDynamic# When you choose the format '''Currency''' in a column header, make sure you specify the column alignment as '''Right Align'''.png|thumb|none|middle|500px|Example section set This way it will be easy for the user to dynamic compare the values. This step is also required if you plan to export this data to PDF for printing.# You must use unique node names of sections, rows, and columns within this field.]]

In addition to defining a set number of columns and rows, you can also configure ==Create a section to handle Table with 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 '''Dynamic Number of Rows''', which in turn exposes the following configuration options: ==* '''Maximum Number of Rows'''[[File: Set a maximum limit xmlDynamic.png|thumb|none|500px|Example section set to the number of dynamic rows that can be entered, or leave as 0 for no limit. * '''Maximum Message''': The message to be displayed when the maximum limit is set and reached by a user. A default message is displayed if left blank.]]

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: * '''Maximum Number of Rows''': Set a maximum limit to the number of rows that can be entered, or leave as 0 for no limit.* '''Maximum Message''': The message to be displayed when the maximum limit is set and reached by a user. A default message is displayed if this input is empty. Setting the Number of Rows to 0 also exposes the following configuration options for each column header within the Cell Details tab:  * '''Has Total''': Display the total sum of a the column.

* '''Total Row Label''': For columns without a total display this option allows you to enter a label for the total sum of another column. For example, if column 3 was displaying a total, then you could configure the '''Total Row Label''' of column 2 to display 'Total'.

== Configure the Display of Tables ==The presentation of the XML Data custom field is configured in the '''General Settings''' tab of 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 will need to specify which sections should appear and where they should appear. [[File:xml-xsl.png|thumb|none|500px|The XSL template and configuration.]] # While editing the custom field locate the '''XSL Template''' link and insert the '''Sample Template'''.# Locate the marker below. <pre><!---- 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.

The presentation of the XML Data custom field is configured in the general settings page of the field. This is defined in the XSL Template (Extensible Style Sheet Language) option. The XSL Template includes a sample template option. Once you have inserted sample template you will need to specify which sections should appear and where they should appear.Note:

[[File:xml-xsl# 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.png|thumb|none|middle|500px|The XSL template and configurationExpenses@ will work but @section.expenses@ will not because it has a lower case '''e'''.]]

# While editing the custom field locate the '''XSL Template''' option and insert the '''Sample Template'''.

# Locate the below marker.

<pre><!---- Insert section variable here ----></pre>

# Below the 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. Note: the section node name is case sensitive.

@section.''SectionNodeName''@

= 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.

# Click the desired '''Section'''to edit it.

# Click the desired '''Cell'''.

# Under '''Cell Properties''' enter your Enter the desired formula into the '''Content''' input.

# Click '''Build'''.

The Syntax for basic calculations within a section:

 

{| class="wikitable"

|'''Operation'''

|'''Symbol'''

|'''Example'''

|-

| Add|'''Operation'''| +|'''Symbol'''| =[row#,column#]+[row#,column#]|'''Example'''

|-

| Subtract|Add| -|+|| =[row#,column#]-+[row#,column#]

|-

| Divide|Subtract| /|-|| =[row#,column#]/-[row#,column#]

|-

||Divide||/||=[row#,column#]/[row#,column#]|-|| Multiply|| *|| =[row#,column#]*[row#,column#]

|}

== Adding a formula So if you wanted to a XML cell (working with data add the values of row 1 and 2 together in column 1 you would enter '''=[1,1]+[2,1]'''. To minimize divide by zero errors, you can first check if the different sectionsdenominator is 0 (and set value to 0) ==by using the 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

== 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) ==

In addition to validating values when you save * Value entered in one cell cannot be more than 20% above or below the XML worksheet you can also validate the XML worksheet when you save the record value in another cell <pre>(ssParseNum([this])>=(ssParseNum([1,4])*(e0.g. save a level 80)) && ssParseNum([this])<=(ssParseNum([1 grant application,4])*1.20))</pre>Message: Value entered in one cell cannot be more than 20% above or below the value in another cell 

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.

==Validating values when saving record (SmartCheck, Submit Logic, Browser Script)==

In addition to validating values when you save the worksheet you can also validate the worksheet when you save the record (e.g. save a level 1 grant application).

=== SmartCheck Validation ===Use SmartCheck When creating validation for XML an this custom field use the '''Appear Mandatory''' option. Appear mandatory does not enforce the validation when possiblebut will make the field look mandatory (it adds the asterisk and or color) just like the mandatory option. SmartCheck Once you have checked '''Appear Mandatory''', validate this field using one of the following validation methods, when the record is a secure server side method. SmartCheck also displays all error messages in a context as well as in one central placesaved.

Validate an XML table node is not empty and display a message.

 ===SmartCheck Validation===Use SmartCheck for 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 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;

</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= Managing Level 2 / 3 Activities with an XML Section function() {if (checkdupeval_Section1() ==0 && checkdupeval_Section2() == 0 && checkdupeval_Section3() == 0) { saveFunc(); }

System administrators can configure }function checkdupeval_Section1() {var result = 0;var numOfRows = document.getElementsByName('16580_row_COUNTY'); // REPLACE '16580_row_COUNTY' AND '16580_row_COUNTY_' WITH SPECIFIC XML fields to add, modify or delete sectionid_rownodename_columnnodename for Section 1var ctr=1;for (ctr=1;ctr<numOfRows.length;ctr++){{l2}} records on var field1='16580_row_COUNTY_'+ctr;var lastfield='16580_row_COUNTY_'+numOfRows.length;var a {{l1}} entity or {{l3}} records on = document.getElementById(field1).value;var b = document.getElementById(lastfield).value;if( a == b){{l2 alert ("Please list each option no more than once for Section 1."); result = 1;}} entity. return result;

In the [[XML Section Builder]], when the ''Number of Rows'' for a Section is set to '0', the ''Enable Mapping'' option will be shown. }

[[Image:XMLEnableMapping2017function 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 2var 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.png|link"); result =]]1;}} return result;}

When function checkdupeval_Section3() {var result = 0;var numOfRows = document.getElementsByName('16582_row_COUNTY'); // REPLACE '16582_row_COUNTY'Enable MappingAND '16582_row_COUNTY_' is selected, you can choose one type of activities to be referenced by the WITH SPECIFIC XML fieldsectionid_rownodename_columnnodename for Section 3var 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 ''Activity Status Filter'' setting following allows you to filter hide the activities to 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 referenced by statushidden $('#addrowbutton_@section.SECTION.id@').hide(); //Replace SECTION with the section name <!--@end-->}</pre>

The ''Additional Filter'' setting following allows you to select custom fields and associated values. These are used to filter hide the existing activities that will be listed within the XML. The custom fields used have to be those with pre-defined options (e.g. [[Custom Field Type: Select One – Combo Box|Combo box]], [[Custom Field Type: Select Many – Check Boxes|Check Boxes]], [[Custom Field TypeDelete Row button: Dynamic Data – Dynamic Control Field|Dynamic Control]], Ajax Lookup).

<pre>function onloadfunc() { $("a[[Image:XMLEnableMappingFilter2017name='@section.SECTION.png|link=]id@_deletebutton']").remove(); //Replace SECTION with the section name}</pre>

When building your section==Managing Level 2 / 3 Activities with a Section==System administrators can configure this field to add, you will need to map the fields modify or delete {{l2}} records on a {{l1}} entity or {{l3}} records on the a {{l2}}s that will be referenced by the XML sectionentity.

For each In the '''Section columnBuilder''', enter the field name from the Level 2 type that you have selected from when the ''Activity TypeNumber of Rows'' for a Section is set to '0' dropdown in , the ''Map FieldEnable Mapping'' section:option will be shown.

[[Image:MappingL2FieldsXMLEnableMapping2017.png|link=|800px|border]]

The syntax for the ''Map Field'' section is:

* for [[custom fields]], simply the field name (i.e., ''Fund Name'');

* for [[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 list of system names for {{l2}} standard fields.

When this section '''Enable Mapping''' is added to the XSL Template of your XML fieldselected, the list you can choose one type of {{l2}} activities will to be displayed when the XML is opened. Level 2s can be added, deleted and modified directly from the {{l1}} XML referenced by this field.

The '''Activity Status Filter''' setting allows you to filter the activities to be referenced by status.

= Displaying XML Data=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]]).

[[Image:XMLEnableMappingFilter2017.png|link=|650px|border]]

== Displaying XML Data on an object ==

[[File:xml-readonly.png|The XML displayed in a read only|500px|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 syntax for the '''Map Field''' section is:

 

* for [[custom fields]], the field 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 list of system names for {{l2}} standard fields.

If the Standard or Custom field has a limited number of pre-defined options then these need to be defined in the Content section of the cell properties.

 

You may need to reference some standard field options using both the displayed name and 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 worksheet is opened. Level 2s can be added, deleted and modified directly from the {{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''' option is recommended. You can toggle this on under '''Document Options'''.

 

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.

 

Use the '''Display - Text and Variables''' custom field to display the content of the Advanced Data Table on the object. The same syntax can be used elsewhere in the system when referencing this field's values.

The XML custom field opens in a modal window and the user must click a button to launch the modal window and see the information entered. You can however, display the information entered into a '''Special - XML Data''' custom 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 the '''Read Only – System Variables''' custom field. 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 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 '''Apply Default Styles''' is enabled 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.sectionnodename.rownodename[# #]@</pre>

Administrators with CSS knowledge can modify the look and feel of their XMLs (e.g{| border="1"|-||~columnodename. make columns wider or thinner)nodevalue~||~columnodename. 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 fieldsnodevalue~||~columnodename.nodevalue~|}

* Return a single value in the total row of a Dynamic XML.

=== Styling XML Data for Printing ===You can print your XML if you are displaying it in a '''Read Only - System Variable'''<pre>@xml. 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 generatedfieldname. If you have more than one section and more than a few columns, some of your content may cut off when printed if it is not sizedsectionnodename. You will also notice columns between sections do not aligntotal. To fix this, we will use CSS in a SmartFolder and amend our '''Read Only - System Variable''', which is displaying the XML informationcolumnnodename.nodevalue@</pre>

Wrap the content in your read only system variable with a div ==Styling Advanced Data Table for web, print and give the div a class. We do this conversion to control the widthPDF==[[File:xml-readonly-styled. Wrap the section syntax png|500px|border|The worksheet styled at 700 pixels wide in a div and give it a class. We do this so we can control the size of cells Display Text and the fonts. e.g.Variables custom field]]

<pre><div class="xml700"><div class="xmlTitleBar">Title Bar Name</div><div class="xml3col">@xmlTo 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.fieldname.sectionnodename.html@</div></div></pre>

Note:

Now create # Make sure your Advanced Data Table has 8 or less columns to ensure it will print and fit on screen.# If the user is expected to enter paragraphs of information, do so in a CSS file. enew row or new section, instead of adding another column.g# If your worksheet does not look as expected make sure '''Apply Default Styles''' is toggled on in the '''Section Builder''' and then click '''Build''' on each of your sections in the section builder.

<pre>@charset "utf-8";

/* CSS Document */

.LeftAlign {text-align:left;}

.RightAlign {text-align:right;} <!--Used to align numbers like money to the right-->

.xml700 {width:700px;} <!--Used to constrain the xml and title bars to 700px-->

.xml3col .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 the first column to a set size and change the font size-->

.xml3col .xmlCell {width:80px; min-width:80px; max-width:80px; font-size:12px} <!--Used to set the rest of the columns to a set size and change the font size-->

.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 ===Styling the desired SmartFolders Advanced Data Table for viewing onscreen===Ensure the columns and upload rows of your CSS file. Use '''View URLAdvanced Data Table''' to get look good onscreen, when a user enters information, by following the path to the CSS file. Then add the relative link back into your '''Read Only - System Variable'''. e.gsteps 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 will look like '''/files/000000/f000000/CSS_for_XSL_onscreen_1290.css'''

# Save this relative link in a text 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/427076000000/f114840f000000/filenameCSS_for_XSL_onscreen_1290").css" rel# 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="stylesheetxml6col" type''' is for a 6 column section. If you have 2 columns, change it to '''class="text/cssxml2col" />'''.# Save the Advanced Data table Field.

Now when you click the button to open the Advanced Data Table you will see your columns will render nicely and they will be equal in width.

Add the class '''RightAlign''' to the desired cells in the section builder.Note:

# Under Display you can customize the Button Label. To meet with Accessibility guidelines you must change the button label from '''Open''' to something meaningful like '''Modify Budget'''. The user must know what the button will do based on the text in the button. You 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.

# Sections must contain 8 or less columns to render properly and be usable.

If you want ===Styling Advanced Data Table for Converting to make one cell larger than the others, add PDF and Printing===You can print your Advanced Data Table content by displaying it in a '''Display Text and Variables''' custom class field. In order to that cell in do this the section builder econtent must fit within 700 pixels wide (portrait) or 900 pixels wide (landscape) otherwise content will cut off when a PDF is generated.g.<pre>.xml3col .xmlCellTo ensure content does not cut off and to ensure columns between sections align, we will use CSS in a SmartFolder and amend our '''Display Text and Variables''' custom field.note {width:150px; min-width:150px; max-width:150px; font-size:12px}</pre>

I can add # Navigate to the desired '''Display Text and Variables'''.# Paste the contents of '''display.html''' into the '''noteContent''' section of the field.# update the href to point to the relative path to a cell the file called '''xml-print.css''' that has xmlCell you uploaded to the SmartFolders.# Add your desired variable example '''@xml.Budget.Expenses.html@''' inside the div with the '''class="xml8col"'''.# Change the '''8''' in a '''class="xml8col"''' to the number of columns in your section wrapped . Note you must have 8 or less columns.# If you want this table to be displayed wider for landscape printing add the word '''landscape''' in a div with a the class example '''xml3colclass="xml8col landscape"''' and that cell will become 150 pixels wide.# Save your custom field

Note: You now have a version of your cells must add up Advanced Data Table that you can display on the object such as the level 1 application and you can convert this to 700 pixels if you are displaying your budget in a portrait PDF on letter size paper (8.5 x 11”)using the Web Page View custom field.

If you created two '''Display - Text and Variables''' custom fields one for printing and 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.

==Reporting on Advanced Data Table data== Using different styles Extract values in a report using the following syntax in the report builder. This will return one value for Print static sections specific to the row and Web with XML Data ===multiple values for Dynamic sections across all rows.

You can have one look for your XML when it is onscreen and another when it is 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 the desired style sheet in the desired '''Read Only - System Variables'''. Then on the '''Read Only - System Variables''' for viewing on screen for '''SmartFields''' View choose '''Exclude'''. 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 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 to control the look and feel of both.

 

== 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>

 

= Appendix =

 

== Field options and settings ==

 

=== General Settings ===

 

{{Custom Field ID}}

 

{{Field Type}}

 

{{Field Name}}

 

{{Description}}

 

{{XSL Template}}

 

{{XML Tag Mapping}}

 

{{XML Javascript Function}}

 

{{Show View XML Button}}

 

{{Show Upload Button}}

 

{{Show Up/Down Button}}

 

{{Display fields refreshed upon edit}}

 

{{Custom Field Ids}}

 

 

=== Display ===

 

{{Display Order}}

 

{{Tab Name}}

 

{{Caption}}

 

{{Caption Location}}

 

{{Instructions}}

 

{{Button Label}}

 

{{Tool Tip}}

 

{{On New Record}}

 

 

=== Options ===

 

 

{{Appear Mandatory}}

 

{{Track Changes}}

 

{{Enable Builder}}

 

{{EnableKML}}

 

{{Disable Field from Global Search}}

 

 

=== Value Storage ===

 

{{Value Storage}}

 

== 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]]

• ← Older edit

Devon Wan

Smartstaff

34

edits