Difference between revisions of "SmartSimple XML Editor"

From SmartWiki
Jump to: navigation, search
(Deprecating)
 
(17 intermediate revisions by one other user not shown)
Line 1: Line 1:
−
SmartSimple XML Editor Help Page...
+
{{Deprecated}}
  
−
The '''SmartSimple XML Editor''' is standalone tool that will allow you to '''download to your desktop''' the files that are stored in [[Custom Field Type: Link – Single File|Single File]] or [[Custom Field Type: Link – Multiple Files|Multiple Files]] custom fields at Level 1 within your [[SmartSimple]] [[Universal Tracking Application]].
+
The '''SmartSimple XML Editor''' is standalone tool that will allow you to:
 +
* Export XML data to MS Excel so it can be reviewed and/or revised outside of [[SmartSimple]].
 +
* Import XML data from MS Excel into [[SmartSimple]].
  
 
  If you wish to have access to this application please contact [[SmartSimple]] support.
 
  If you wish to have access to this application please contact [[SmartSimple]] support.
  
  
−
==Instructions==
+
==Logging In==
−
* Install the '''SmartSimple XML Editor''' application, following the instructions that came with the tool.
+
* Install the '''SmartSimple XML Editor''' application, following these [[Installation of SmartSimple XML Editor|instructions]].
 
* Open '''SmartUTABudget''' from your Programs menu.
 
* Open '''SmartUTABudget''' from your Programs menu.
 
:''If you are logged into SmartSimple via a web browser you should log out.''
 
:''If you are logged into SmartSimple via a web browser you should log out.''
 
* Enter your [[SmartSimple]] Server URL, Alias, User Name and Password:<br>
 
* Enter your [[SmartSimple]] Server URL, Alias, User Name and Password:<br>
−
[[Image:UTABrowser1.PNG]]
+
[[Image:Loginxml.png]]
 
* Click to Enable SSL if you wish to encrypt the connection to SmartSimple.
 
* Click to Enable SSL if you wish to encrypt the connection to SmartSimple.
  
 
* Click '''Login.'''<br />
 
* Click '''Login.'''<br />
−
:''Once the Smart XML Editor has authenticated with [[SmartSimple]] the Application pull-down list will populate with a list of the UTAs in your [[SmartSimple]] instance, and the "List" button will become active.''
+
:''Once the SmartSimple XML Editor has authenticated with [[SmartSimple]] the Application pull-down list will populate with a list of the UTAs in your [[SmartSimple]] instance, and the '''List''' button will become active.''
  
  
−
* Select the desired UTA from the Applications list and click '''Launch'''. After a few seconds you will be presented with the Level 1 interface for your UTA.  
+
* Select the desired UTA from the Applications list and click '''List'''. After a few seconds you will be presented with the Level 1 interface for your UTA.  
−
* Using the filter options on the right-hand side of the '''Smart XML Editor''' window you should now search for the records as desired. ''(Click "Show Search" if you do not see the search panel on the right).''  
+
* Using the filter and search options on the right-hand side of the '''SmartSimple XML Editor''' window you should now search for the desired record. ''(Click "Show Search" if you do not see the search panel on the right).''
−
::[[Image:UTABrowser2.PNG]]
 
  
  
−
* '''Important:''' if you have more than one page of records be sure to click on the '''Show All''' button in the upper-right corner of the screen before proceeding to the next step:
+
==Exporting XML Fields==
−
:[[Image:UTABrowser3.PNG]]
+
* Once you have opened the desired record with the '''SmartSimple XML Editor''' find the '''XML Data''' field you wish to export and click on the '''Open''' button on the record:
 +
:[[Image:Xmlopen.png]]
 +
* The XML Data field will open in a pop-up window. Open the '''Export''' menu and select '''MS Excel''':
 +
:[[Image:Xmlexport.png]]
 +
* A MS Excel window will now open containing the data from the XML field that you exported. This document can now be treated as a normal MS Excel document and saved locally, e-mailed etc.
  
  
−
* You should now click on the check-box in the upper left corner of the screen in order to select all records, or if you want a sub-set of the records displayed you can manually select individual records:
+
'''Important''': If you plan to edit the data using MS Excel and Import it back into [[SmartSimple]] the structure of the data must be retained so that it matches the XML structure of the XML Data field in [[SmartSimple]].
−
::[[Image:UTABrowser4.PNG]]
 
−
:''Selecting all may take a few moments if there are a large number of records.''
 
  
−
:''If you do not see the check boxes in the first column of the Level 1 list view you will need to close the '''SmartFileRetriever''', open your UTA via a Web Browser, go to Settings >> Application Configuration and check to '''Enable Calendar''' in the Level 1 Settings section.
 
−
 
−
* Once all the desired records have been selected click on the '''Next''' button in the lower left-hand corner of the screen:
 
−
::[[Image:UTABrowser5.PNG]]
 
  
−
 
+
==Importing XML Fields==
−
* The following page will tell you how many records you have selected, and will provide a list of all the [[Custom Field Type: Link – Single File|Single File]] and [[Custom Field Type: Link – Multiple Files|Multiple Files]] custom fields available at Level 1.  
+
* First close the MS Excel document that you wish to import, if it is open.
−
* If you wish to download the files stored in all the fields listed click the check box at the top of the list. Otherwise select the subset of fields you wish.
+
* Opened the desired record within SmartSimple with the '''SmartSimple XML Editor'''.
−
::[[Image:UTABrowser6.PNG]]
+
::'''Note:''' if you wish to import the data into a new record you should create and save the new record now.
−
* Click '''Next'''
+
* Find the '''XML Data''' field into which you wish to import and click on the '''Open''' button on the record:
−
 
+
:[[Image:Xmlopen.png]]
−
* You will be asked to choose a location to download the files. Select a folder on your local machine and click '''OK'''.
+
* The XML Data field will open in a pop-up window. Open the '''Import''' menu, select '''MS Excel''', then '''Launch MS Excel'''.
−
:''If the file download does not start automatically, please click the '''Download''' button on the toolbar.''
+
:[[Image:Xmlimport.png]]
−
* A window will appear to indicate the progress of the download. Any errors will be reported in this window.
+
* Click OK when the following message appears:
−
* The '''SmartFileRetriever''' window will also show the total number of "Records", "Fields", "Files" and the "Total Size" of the download.
+
:[[Image:Xmlmsg.png]]
−
 
+
* A Microsoft Excel window will now open. You '''must''' use that window to open the MS Excel file to be imported.
−
 
+
* Once you have opened the relevant MS Excel file, return to the XML file window of the '''SmartSimple XML Editor''' and select '''Import''' >> '''MS Excel''' >> '''Import Active Worksheet''':
−
==Results==
+
:[[Image:Xmlimport2.png]]
−
Within the folder you selected for the download you will find the following:
+
* Click OK when asked if you wish to overwrite the current server data.
−
* A folder will have been created for each Level 1 record. The folder will be given the same name as the Level 1 record.<br />
+
* The data in the MS Excel file will now be uploaded into the XML field in [[SmartSimple]]. Save the XML Field.
−
::-''If no files were present in any of the selected fields for a given record, no folder will be created for that record.''
 
−
::-''If you have not used the Level 1 Standard Field "Application Name", the folders will be named with the Tracking ID of the record.
 
−
* Within each Level 1 record folder you will find folder(s) with the same name as the [[Custom Field Type: Link – Single File|Single File]] or [[Custom Field Type: Link – Multiple Files|Multiple Files]] Custom Fields that you selected to be downloaded.
 
−
::''If no files were present in a given field for that record, no folder will be created for that field.''
 
−
* Within each of the folders you will find the files that were stored within the relevant [[SmartSimple]] Custom Fields.
 
−
 
 
−
 
 
−
 
 
−
[[Category:Applications]][[Category:Universal Tracking Application]][[Category:Integration]]
 
  
  
 +
'''Important''': The structure of the data in the MS Excel file you import must match the XML structure of the XML Data field in [[SmartSimple]].
  
  
 
==See Also==
 
==See Also==
 
* [[Installation of SmartSimple XML Editor]]
 
* [[Installation of SmartSimple XML Editor]]
−
 
−
[[Category:Applications]][[Category:Universal Tracking Application]][[Category:Integration]]
 

Latest revision as of 14:32, 20 July 2017


Ambox warning pn.png This feature is deprecated and should no longer be used, but may still be available for reasons of backwards compatibility.

The SmartSimple XML Editor is standalone tool that will allow you to:

  • Export XML data to MS Excel so it can be reviewed and/or revised outside of SmartSimple.
  • Import XML data from MS Excel into SmartSimple.
If you wish to have access to this application please contact SmartSimple support.


Logging In

  • Install the SmartSimple XML Editor application, following these instructions.
  • Open SmartUTABudget from your Programs menu.
If you are logged into SmartSimple via a web browser you should log out.
  • Enter your SmartSimple Server URL, Alias, User Name and Password:

Loginxml.png

  • Click to Enable SSL if you wish to encrypt the connection to SmartSimple.
  • Click Login.
Once the SmartSimple XML Editor has authenticated with SmartSimple the Application pull-down list will populate with a list of the UTAs in your SmartSimple instance, and the List button will become active.


  • Select the desired UTA from the Applications list and click List. After a few seconds you will be presented with the Level 1 interface for your UTA.
  • Using the filter and search options on the right-hand side of the SmartSimple XML Editor window you should now search for the desired record. (Click "Show Search" if you do not see the search panel on the right).


Exporting XML Fields

  • Once you have opened the desired record with the SmartSimple XML Editor find the XML Data field you wish to export and click on the Open button on the record:
Xmlopen.png
  • The XML Data field will open in a pop-up window. Open the Export menu and select MS Excel:
Xmlexport.png
  • A MS Excel window will now open containing the data from the XML field that you exported. This document can now be treated as a normal MS Excel document and saved locally, e-mailed etc.


Important: If you plan to edit the data using MS Excel and Import it back into SmartSimple the structure of the data must be retained so that it matches the XML structure of the XML Data field in SmartSimple.


Importing XML Fields

  • First close the MS Excel document that you wish to import, if it is open.
  • Opened the desired record within SmartSimple with the SmartSimple XML Editor.
Note: if you wish to import the data into a new record you should create and save the new record now.
  • Find the XML Data field into which you wish to import and click on the Open button on the record:
Xmlopen.png
  • The XML Data field will open in a pop-up window. Open the Import menu, select MS Excel, then Launch MS Excel.
Xmlimport.png
  • Click OK when the following message appears:
Xmlmsg.png
  • A Microsoft Excel window will now open. You must use that window to open the MS Excel file to be imported.
  • Once you have opened the relevant MS Excel file, return to the XML file window of the SmartSimple XML Editor and select Import >> MS Excel >> Import Active Worksheet:
Xmlimport2.png
  • Click OK when asked if you wish to overwrite the current server data.
  • The data in the MS Excel file will now be uploaded into the XML field in SmartSimple. Save the XML Field.


Important: The structure of the data in the MS Excel file you import must match the XML structure of the XML Data field in SmartSimple.


See Also

Retrieved from ‘https://wiki.smartsimple.com/index.php?title=SmartSimple_XML_Editor&oldid=30552’