Smartstaff, administrator
3,316
edits
Changes
no edit summary
==What is the "Special - XML" Custom field and why would I use it?==[[File:PlayingCard-XMLxml-Acsample.jpgpng|thumb|150px|Click [http://www.smartsimple.com/images/customfield/cards.html here] to peruse our selection The look of custom fields.an XML]]
'''Configuring the XML - Advanced'''
*Creating formulas (calculations) in XML
*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)
'''Displaying the XML'''
*Displaying an XML on a object
*Access, Display and Format options for XML
*Styling an XML for web and print (PDF)
*Reporting on a XML
'''XML - Appendix'''
*Field options and settings
*Example of an XML
== Configuring the XML - Essentials ==
=== Creating a Special - XML custom field ===
=== Using XMLs Section Builder to create static XML ===
[[File:xml-sectionbuilder.png|The section builder]]
Use the XML '''Section Builder''' to create sections, define your rows, columns, formulas, and style your XML. Note you must manually enable the '''Section Builder''' before you can use it.
# 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''' (example: '''expense''').
# Click into the '''Section Node Name''' (notice the name auto populates. Note: '''Section Node Names''' are case sensitive).
# Enter '''Number of Rows''' desired.
# Enter '''Number of Columns''' desired.
# Check '''Apply Default Styles'''.
# Notice and scroll down to the '''Cell Grid''' in the lower section 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''' (example: number, comma, date, currency, percent) and other settings for this column.
# Repeat for the remaining column headers.
# Click into the first cell in the row labeled '''1'''.
# 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 to the field by clicking the '''Field''' button.
Note: Do not use the same node names across different sections, rows or columns in the xml.
=== Using XMLs Section Builder to create dynamic XMLs ===
[[File:xml-dynamic.png|The dynamic XML]]
Note: you must replace '''SectionNodeName''' with the name you gave your section (example: '''@section.''expense''@'''), the section node name is case sensitive, and you must remove the html comments.
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 (example: to sum the contents of column one, over two rows, enter '''=[1,1]+[2,1]''').===Access Adding a formula to a XML cell (working with data in the data within an entire XML 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'''.# Click the desired '''Cell'''.# In the '''Cell Properties''' enter your desired formula into the '''Content''' input.# Click '''Build'''.
=== Adding a formula to a XML cell (working with data in the different sections) ===
Example '''===Date formatting node values===[@section.''expense''.id@_''Total_Amount'']-[@section.''income''.id@_''Existing-funds''_''Amount'']'''
=== Validate XML values when saving the worksheet ===
Examples:
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.
Message: Please select a value.
'''Default Combo Box Value''' should be substituted with the default value you have configured, example '''--- 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.
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.
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.
<pre>if("<ssEscape>@level1.xml.fieldname.sectionnodename.rownodename.columnnodename.nodevalue@</ssEscape>"=="")
{result.isPassed=false;
result.addMsg('xml_@fieldname.id@','YourAlertMessage'); }</pre>
==See Also==* [[XML Section Builder]]* [[Managing Level 2 Activities with an XML Section]]* [[XSL Template]]* [[Referencing Other Sections in XML Calculations]]* [[Adding Styles to XML Worksheets]]* [http://dev.mysql.com/doc/refman/5.1/en/xmlSpecial -functions.html MySQL XML Functions] Note: this is an external website.* [[Number Format]]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.<pre>@xml.customfieldname.sectionnodename.rownodename.columnnodename@</pre>== Displaying an XML == === Displaying an XML on a object ===[[File:xml-readonly.png|The XML displayed in a read only]] 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''' 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 (examples: 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 Variables'''.# Enter a '''Field Name'''.# For '''Variables''' enter '''@xml.''CustomFieldName''.''SectionNodeName''.html@''' (replace the CustomFieldName and SectionNodeName with the actual names from your XML).# 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 field and click '''Save''' (notice '''Display Fields Refreshed Upon Edit''' will be updated with the custom field ID of the Read Only we just created. From now on when a user edits the XML the read only will be automatically updated. If you miss this step it will only refresh when the object is saved). === Access, Display and Format options for XML === Access data from within the XML field. 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> Specific currency formatting examples:{{CustomFieldPageFooter}| 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 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 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 an XML for web and print (PDF) ===[[CategoryFile:xml-readonly-styled.png|The XMLstyled at 700 pixels wide in a read only]] 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. 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 builder.Administrators with CSS knowledge can modify the look and feel of their XMLs (Example: 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''' or '''Read Only - System Variable''' custom fields. ==== Styling XML for Print ==== You can print your XML if you are displaying it 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 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 XML information. Wrap the content in your read only system variable with a div and give the div a class. We do this to control the width. Wrap the section syntax in a div and give it a class. We do this so we can control the size of cells and the fonts. Example: <pre><div class="xml700"><div class="xmlTitleBar">Title Bar Name</div><div class="xml3col">@xml.fieldname.sectionnodename.html@</div></div></pre> Now create a CSS file. Example: <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 {WCwidth: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'''. Example: <link href="/files/427076/f114840/filename.css" rel="stylesheet" type="text/css" /> Add the class '''RightAlign''' to the desired cells in the section builder. If you want to make one cell larger than the others, add a custom class to that cell in the section builder Example: <pre>.xml3col .xmlCell.note {width:150px; min-width:150px; max-width:150px; font-size:12px}</pre> I can add '''note''' to a cell that has xmlCell in a section wrapped in a div with a class '''xml3col''' and that cell will become 150 pixels wide. Note: your cells must add up to 700 pixels if you are displaying your budget in a portrait PDF on letter size paper (8.5 x 11”). ==== Using different styles for Print and Web with XML ==== 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 a XML ===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 - 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 example: 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. '''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>
