Configuration Files Creation Example

Version:
Current
Last modified: March 19, 2020

Use the configuration files required to create a custom loader to pass data to your Connect instance.

Table Configuration File Example

Download or create configuration file County.xml to store county information.

The file XML example can be used as a basic template and contains inline assistance.

File XML

XML
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <xforms-apps xmlns="http://semanta.cz/schema/xf3">
  3. <!-- this is a really minimalistic example of the application, it can be used as a template for your new application -->    
  4. <!-- start with definition of the application -->
  5.     <xforms-app>
  6.  
  7. <!-- xid is the unique identifier for the application -->
  8.         <xid>county</xid>
  9.  
  10. <!-- insert an icon visually representing entities of your application, use base64 code of the icon here -->
  11. <!-- use base64 code of the icon here which can be encoded by various online services such as https://www.base64encode.org/ -->        
  12.         <icon> iVBORw0KGgoAAAANSUhEUgAAAEgAAABICAYAAABV7bNHAAAJl0lEQVR42s1ca2gUVxSWEEREREREpJSwr2iMia9aa8Vaaa0tVsSCBPFHKc3mYRJjfAe1WC0WSiulSBHRzeZhjDamqY1WShERKUVKkVJEREqRUEQkSBARke33zc7szs7MnZk7+7g9cNnL7n2cc+Z895x77p2dMEERtfXNDzUmYy0NXdH+hq7InyiPGxKRlFZY176L9rMN26ris6S078Ly8qZk5RYI/ms8EU7JFPZhX46hWo6iUHP3nHWwjjsUtv40SiKUiuufMnWOwbFUy1Mw2namdmpjV7QvrRgKqn9CWE14vcjUORbH5Niq5cuLWnqqQnjit2Xh5Bt2GJtzqJYzEG3tqYpBiFFaS8Z6zPVE2ASf4PV4IjLKuVTLK0WtvdWzwPg/hlLqTQoqBMRsdczFOVXL7Yv2XXi9HC76WrFgJfZykWucW7X8ntSUjO0UwioHYsG8mFudc6uW35UQ0AFa4XExrHIhVujCucmDaj0ICa73i1JDy1rIg2o9ONKuc0snYbEcc4VVkSGme7WxXedemaRaHzZCdLveG1Z2iEFhT/HUv4arXnJkZO1kFtb5HX8LArXm7sr1qvVhIwh0PAAk7kMZNaIx+RvbBIDZcdX6sBHc7G+esDLVaR1uyrEo6anUfg28qNaHk4IeykCMEPI7NttqSj1tUrRLnbyo1oddQYnICxkYcJ3xOzbbxhMhvW8o5VUnL6r14aQgb89lqnMx9js220qmRFKq9eGkoHEZiEkrSAZi4EW1PuwK6orc/d9ADLyo1oeDgqIXZSAmvUhLebHoRdX6sAuRjO2VgZi0m5eAGHlRrQ8btfTOq5EL6EISgaI3rMx18qJaH44E7N+S3Yt5bTVk92LkQbUehNSUrPzI/17MP2Rk6uRBtR6EtGdwWblxtOMTYr4g47fOucmDaj24Enb1aw0llDLdwXE5t2r5fRHWj2SpIcY5Vcvtm9r7a6d6Q61wEONcnFO13FK0tWdujZGfLibEOAfnUi1vIMKasBECaLv8er0Uss6xOYdqOfOipmRsv3jtCOVV59iq5SsIYQHtqT8dNkHMfLsjWJ1jqparYLRjYPEkRLg3CgUxjsUxVctVUGrt087r7+cLMY7BsVTLUxSCt1kKK3gWGGLoyzFUy1FUwl6pOSjE2Fc1/yUhLLDDshBjH9V8l4za+qpnwjIe+oUY27KPar5LSk3dlVv8QoxtVfNbcGrpqVoKWJxo6Z0nvEPY0BW95gUxthHOgbExxyks3MtVy+uLtp9dOBXRbSPilD+MgBD16weHV5U5tYdgS7hdEEGMv7GNU1+OybFNx81/NSZj7e1nameo1oONdGs5qW1OHb1PrEXUFxYyKA4Io4OifvBoLQJIPuUN/a3dc1cfvbyubIIqsluLS74mEX7c1jffcZGFchdpG09bQBhO8TenPhyLY3rDM3IXVrV725ma0gWWOdZi3lt51NHnW9GYeOJXrRDjd6L2HEsmyGSASWtkxvHQj28Xz6qwHqyIZ6NamWDvGZ5k3+c/ve/IHOCyyea58J1T26+uflCGsXq0iDxAwOkG97yJT8GAjvVTcA3lHg/xvEx89/lXLdf3ImP8zq0PxpyBsTswx22ZgBPt7xweWVN4K2qFS80kv3IvQuVASTfn8zDnt45cetc3I3TXplTGKRneaNnMSWPuJ36gV5SXYfSDvJQIYn6tRURk2oBDUAHa+xdMa9LeQYvcirvADQ/w54Iqp72/dhoX5XjmFYAsnBiLQKA1R0bW5mW2u84vnaydpKKwni/PdCa0ZEe4acfTVdUFU1Cj6fa8GVqEHKAXcRG6QmYeei437+VEHWcXCa/R7BxYAqXzaqAdbvTEBVEO3/Br4IspCZOCMvdwokMuypnY3D23Q2YuMH2IRaYPrPfo/qGV5eIxY58JEv5PudDnrSC42zozrMx1LI4rxf1i7ShS5+QQ9j0WOaXGDrqdxyOonE3HkevR9DtKyVhn3goyX+81Qwzf3xT1wZOZjnaPsJmUwjngMptFVqlMw+4YWCRct7Q3Hm0eTTtwHN3z3bKJgZVjBIZmWBl1PLXNLgwdA9Pjh0feKfpFAih0lhapu1ya4oJt92ghI0u5WWa+HDICQyvEoPn7ewdfc9Q8rCaSjoUi14utnCyfEd7GH6PlushywymgdUOCK5kDQyvEuAEU9Wvk7jydIv2ydAqKDtWn93vHRG2auis3WSFmoCJQPil9cTKccoDYePuZ2mlOfbhoZ/c8lXWlUhAW6k5jz4cHW+HUpnNohe6NcyGme+PzUhMyIs3s1i0Qg+K+cWg/HR6rGevO34bpwtyl30Y+OLyq/JMfVkuvWwxUTRnIYVE0T8t32jNC1uetfdUv+38iCAydPJc5MIQgZUwfgKGBzC1UfV/GdkxoMWckIygscJnM/enOCyv4Tw51WEd+tyT5n4OvK/ynhh0Di6dkH2Tt9Ox+LfeWiO8X8bSXcmGK8dygSr8gGR1q7a2OYbCjXKh93L54TKhCqb5e2+YTRmnzatdxduEUWGxbAy3Wm4dxnuPTyg7AQrVckgVi+vIxBo84xZNJLGZ12ZfTzO+Waiv+v9m7PmHfhRYF5V5mzALXL9yzoc0ILVL0O99HZWTMGCvILTTGPXgAwyL5uEx4KsgIDAUQs6U5zArzU2calE9/e/+CHPh9OrKmjHkgumwrTwgdqpgCievvjRXrdU7mio5cctl0ZwPDUCr3qltYUM/n6pxm+sch/BxNCVpuOv07FtkKnZ+V+isOL3J5yreIeXPd6jToMYzIBJ3rGUt6QuuQgl4Wfleyd4i0OOsELVn2Xxi4LsIKH3m1rzdBz1oX5oqMwNALVtY67+oAMh8bkGEm0XjqrnArLDRu0WMhui/n3qq5u3KDtgsIAEn9VQb7HjKdMRSZYy7EtMUOnszNO/E3xkxaok1o0vnBBEr4hd5JxMP2dHwWR7vruTB1h78tV5QNDMVQ0g/kBhj7HPj+Dd/BHJicxhNPKPWeE8Rk64xxIEC/6MxMRG191RXgYz8XYjeI6eh4kpMrMgJDK3x0CN2k+2OQJcOQlXhUDOVu0M7AnPZEPq770iIRh1XkwwdJP9uDdUceiObN5Ir2DS7PBIZZU4s84GZTNp/jm8HeqhqMn0jnoL2gBF7w5N126kGJkbj212Hp3cATy+X0US1jwVBdtxoe1wzxHxRK9UdqEHqmZvZgxgolQoHrx86BJSW5rNmhHaVXfsh1Le1g9FwRFHKSawSZLQUjTkTPQ2YIZ/7bHbzQxoPDbyq7eICI/SVue6CbxH/iWwFdBVch4wAAAABJRU5ErkJggg==
  13.         </icon>
  14. <!-- entry-name is a label which will be used in the application as a type for you entries -->                
  15.         <entry-name>County</entry-name>
  16.  
  17. <!-- now we are going to declare the structure of the application, it's a grid structure to ensure great design potential on all platforms (desktop, mobile) -->
  18. <!-- structure of the app is rows, columns - one or more (max 12) columns in a row, group which is a container for the fields, field stores information and can have various data types such as rich-text, plain-text, relation, date ... -->
  19.         <structure>
  20.             <row>
  21.                 <column>
  22.                     <width>9</width>
  23.                     <group>
  24.                         <id>stream</id>
  25.                         <name>Description</name>
  26.                         <fields>
  27. <!-- we are using fragments which are parts of definitions we have declared once and used many times, every app has entry name, business name, description -->                                                                        
  28.                             <!--@import fragment="entry-name" name="Term Name"-->
  29.                             <!--@import fragment="business-name" -->
  30.                             <!--@import fragment="description" -->
  31.                             <field>
  32.                                 <code>entryAttachments</code>
  33.                                 <name>Attachments</name>
  34.                                 <type>
  35.                                     <attachments>
  36.                                         <display-as>thumbnails</display-as>
  37.                                     </attachments>
  38.                                 </type>
  39.                             </field>
  40.                         </fields>
  41.                     </group>
  42.                     <group>
  43.                         <id>nexus</id>
  44.  
  45. <!-- again generic relationship field which shows nexus tool inside the page -->                                        
  46.                         <name>Relationships</name>
  47.                         <fields>
  48.                             <field>
  49.                                 <code>my_relations</code>
  50.                                 <name>Relations</name>
  51.                                 <hide-in-edit-if-loaded>true</hide-in-edit-if-loaded>
  52.                                 <type>
  53.                                     <info>
  54.                                         <velocity>
  55.                                             <![CDATA[
  56.                                             #embeddedNexus("All", $entry)
  57.                                         ]]>
  58.                                         </velocity>
  59.                                     </info>
  60.                                 </type>
  61.                             </field>
  62.                         </fields>
  63.                     </group>
  64.                 </column>
  65.             </row>
  66.  
  67. <!-- now we will declare which fields from above definition will be displayed on the list of entries (list of counties in this case) -->                            
  68.             <list>
  69.                 <fieldCode>entryName</fieldCode>
  70.                 <fieldCode human-readable="Description">entryExcerpt</fieldCode>
  71.                 <fieldCode human-readable="Rating">entryLikeCount</fieldCode>
  72.             </list>
  73.         </structure>
  74.     </xforms-app>
  75. </xforms-apps>

Upload File

Upload the completed configuration file to your Connect instance.

  1. Log in to Connect using an admin account.
  2. Select your user avatar in the top right and select Administration.
  3. In the Upload section, drag and drop or browse to the configuration file: county.xml.

Alternatively, see Configuration File Upload Workflow to upload files with a Designer workflow via the REST API.

Verify Configuration

Check that the uploaded configuration file is valid.

  1. Log in to Connect.
  2. Select Data Sources.
  3. Click the red plus sign in the lower right.
  4. Type the Title "County Test" and select CREATE.

  5. Under Folders, enter:

    • Folder entry type: County

      Creates County instances in the folder.

    • All Entries: "type:county"

      Define which entries are displayed in the folder, allowing multiple entry types from the descendants.

  6. Select SAVE. A new folder is now available.
  7. Click the red plus sign in the lower right.
  8. Select County in this Folder.

     

     

  9. Enter the Title "Orange County" and select CREATE.
  10. Access the folder "County Test" one level up. The descendant "Orange County" should be available.

     

Load Job Configuration File Example

Download or create a loading job configuration file, which maps between the stage table and the Connect interface, allowing users to access loaded data.

The file XML example can be used as a basic template and contains inline assistance.

File XML

XML
  1. <?xml version="1.0" encoding="UTF-8"?>
  2.  
  3. <!-- The definition of the application. -->
  4. <loading-instructions xmlns="http://semanta.cz/schema/xf3/load">
  5. 	<loading-instruction>
  6.  
  7. 		<!-- The  unique job identifier, called from the API. -->
  8. 		<job-id>load-alteryx-countries</job-id>
  9.  
  10. 		<!-- every job can have sub-jobs, creating hierarchical loaded structures. In this example, we load a top level folder containing one County entry per record in the stage table. -->       
  11. 		<for-each-row>
  12. 			<sub-job-id>mainFolder</sub-job-id>
  13.  
  14. 			<!-- The query to retrieve data from the stage table, to map to Connect's UI configuration. -->            
  15. 			<of-query>
  16. 				<sql>
  17. 					<connection-id>master</connection-id>
  18. 					<query-body>select 1</query-body>
  19. 				</sql>
  20. 			</of-query>
  21.  
  22. 			<!-- For each row in the dataset returned from the query, an entry is created. In this example, there is only one row in the dataset, so only the top level folder entry is created.  -->
  23. 			<define-entry>
  24.  
  25. 				<!-- The definition of the entry type. -->                                        
  26. 				<app>folder</app>
  27.  
  28. 				<!-- The unique identifier of the parent entry, which must already exist to hold the entry being created. In this example, we use the Data Source folder ID, creating sub-folder. -->                                       
  29. 				<parent>f19f38ae-1c68-49f9-8654-288b92284bab</parent>
  30. 				<parent-field>subfolders</parent-field>
  31.  
  32. 				<!-- The unique identifier of the entry, usually the UUID taken from the source system. In this example, we use a hash created out of string "counties". -->                                                       
  33. 				<xid>$lu.toXidEncoded("counties")</xid>
  34.  
  35. 				<!-- The name of the entry as it is displayed in Connect's UI. -->                                                                        
  36. 				<name>Countries Example</name>
  37.  
  38. 				<!-- Set individual fields by defining the fieldcode of the application and the associated value from the datasource. In this example, the values are hardcoded. -->
  39. 				<fields>
  40. 					<![CDATA[
  41. 						#set($foldertype="county")
  42. 						#set($entrytypelist="type:county")
  43. 						#set($platformDescription="<p>SDK Sample Countries.</p>")
  44. 						#set($displaytype="smallcard")
  45. 						#set($displaytype_readable="Small Card")
  46. 						#set($displaytypeallentries="smallcard")
  47. 						#set($displaytypeallentries_readable="Small Card")
  48. 						#set($displaytypefolder="smallcard")
  49. 						#set($displaytypefolder_readable="Small Card")
  50. 						#set($integrationcode="promoteInstances")
  51. 						#set($entriesgroupname="Promote Instances")
  52. 						#set($subfoldersgroupname="Subfolders")
  53. 						#set($allentriesgroupname="Counties")
  54. 					]]>
  55. 				</fields>
  56.  
  57. 				<!-- do not touch fields are fields which should be editable in UI and should not be touch (overwritten) by the loading job -->
  58. 				<!-- usually description, owner are such fields -->               
  59. 				<do-not-touch>
  60. 					<!--@import fragment="common-dont-touch"-->
  61. 					<field>MainThumbnail</field>
  62. 					<field>orderbytype</field>
  63. 					<field>orderascending</field>
  64. 					<field>entryOwner</field>
  65. 				</do-not-touch>
  66. 				<for-each-row>
  67.  
  68. 					<!-- this is the tick how to add attachment, in this case thumbnail of the folder -->                                    
  69. 					<add-attachment>
  70. 						<xid>$lu.toXidEncoded("counties-icon")</xid>
  71. 						<name>Alteryx_Counties.png</name>
  72. 						<field-code>MainIcon</field-code>
  73. 						<base64content>
  74. 							<!-- Set to an icon encoded in base64 code (https://www.base64encode.org/). The icon will be used to visually represent your application. -->
  75. 						</base64content>
  76. 					</add-attachment>
  77. 				</for-each-row>
  78. 			</define-entry>
  79. 		</for-each-row>
  80.  
  81. 		<!-- so right now, we have created just one folder -->
  82. 		<!-- right now we are going to iterate on dataset of Counties and create a record for each County -->               
  83. 		<for-each-row>           
  84. 			<sub-job-id>countriesList</sub-job-id>
  85.  
  86. 			<!-- get datset of Counties (from the stage table EXT_COUNTRIES) -->                
  87. 			<of-query>
  88. 				<sql>
  89. 					<connection-id>master</connection-id>
  90. 					<query-body>
  91. 						<![CDATA[
  92. 							SELECT name, key FROM EXT_COUNTRIES
  93. 						]]>
  94. 					</query-body>
  95. 				</sql>
  96. 			</of-query>
  97.  
  98. 			<!-- and now create entry one per each row from dataset -->                            
  99. 			<define-entry>
  100.  
  101. 				<!-- creating entry of "county" app we have defined in previous chapter -->                                
  102. 				<app>county</app>
  103.  
  104. 				<!-- start under folder created in previous step -->                                
  105. 				<parent>$lu.toXidEncoded("counties")</parent>
  106. 				<parent-field>entries</parent-field>
  107.  
  108. 				<!-- create uuid out of the county name -->                                
  109. 				<xid>$lu.toXidEncoded("${name}")</xid>
  110.  
  111. 				<!-- county name -->                                                
  112. 				<name>${name}</name>
  113.  
  114. 				<!-- set values for the entry -->
  115. 				<!-- in our case we are setting just one which is description, others are parameters for setting displaying behavior of the folder, entries, subentries and are not important for this example too much -->                           
  116. 				<fields>
  117. 					<![CDATA[
  118. 						#set($description="${key}")
  119. 						#set($foldertype="folder")
  120. 						#set($entrytypelist="folder")
  121. 						#set($platformDescription="<p>SDK Example.</p>")
  122. 						#set($displaytype="table")
  123. 						#set($displaytype_readable="Table")
  124. 						#set($displaytypeallentries="table")
  125. 						#set($displaytypeallentries_readable="Table")
  126. 						#set($displaytypefolder="smallcard")
  127. 						#set($displaytypefolder_readable="Small Card")
  128. 						#set($integrationcode="")
  129. 						#set($entriesgroupname="Promote Owners")
  130. 						#set($subfoldersgroupname="Subfolders")
  131. 						#set($allentriesgroupname="County List")
  132. 					]]>
  133. 				</fields>
  134. 				<do-not-touch>
  135. 					<!--@import fragment="common-dont-touch"-->
  136. 					<field>entryOwner</field>
  137. 				</do-not-touch>
  138. 			</define-entry>
  139. 		</for-each-row>
  140. 	</loading-instruction>
  141. </loading-instructions>

Upload File

Upload the completed configuration file to your Connect instance.

  1. Log in to Connect using an admin account.
  2. Select your user avatar in the top right and select Administration.
  3. In the Upload section, drag and drop or browse to the configuration file: loading-alteryx-counties.xml.

Alternatively, see Configuration File Upload Workflow to upload files with a Designer workflow via the REST API.

Verify Configuration

Check that the uploaded configuration file is valid. The best way to test this is to perform an end-to-end test by running a workflow that pulls metadata into stage tables and calls a loading job to create entries in Connect.

See Data Upload Workflow.

Was This Helpful?

Running into problems or issues with your Alteryx product? Visit the Alteryx Community or contact support.