Application Configuration at the Site Level (XML) - Revision history

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Rwest

2010-11-24T17:41:03Z

Reverted edits by Ecaxabu (Talk) to last revision by Rwest

Ecaxabu at 23:02, 23 November 2010

2010-11-23T23:02:08Z

Rwest: moved Application Site Config to Application Configuration at the Site Level (XML)

2010-04-11T19:47:13Z

moved Application Site Config to Application Configuration at the Site Level (XML)

Rwest: /* Related Guides */

2010-03-30T02:12:09Z

‎Related Guides

Rwest at 01:35, 8 March 2010

2010-03-08T01:35:39Z

Renee.mckechnie at 00:51, 20 December 2009

2009-12-20T00:51:05Z

WikiSysop: Created page with '== Application Site Configuration == See Custom Application Site Level Configuration wiki page for more details. Following are th…'

2009-11-22T05:58:20Z

Created page with '== Application Site Configuration == See Custom Application Site Level Configuration wiki page for more details. Following are th…'

New page

== Application Site Configuration ==
See [[Custom Application Site Level Configuration|Custom Application Site Level Configuration]] wiki page for more details.

Following are the steps to setup a site configuration for an ADF application:

# Locate the ''_cs_apps'' directory in your site.
# If the ''_cs_apps/config'' directory does not exist, then create it.
# Identify the ADF applications sample XML configuration file. Update the file accordingly with the site information.
# Ensure that the file name is the ADF application name. For example, with the Profile Application the XML config file name is ''ptProfile.xml''.
# Place the XML config file into the ''_cs_apps/config'' directory.

== Related Guides ==
* [[Create_New_App|Create New ADF Application]]
* [[Load_ADF_Components_into_Site|Load ADF Library Components into Site]]

@@ Line 1: / Line 1: @@
 == Overview ==
 Every ADF Application can have Site Level configuration file to help the application do special things depending on the settings/pages/templates within your site. For example, the [[Profile| Profile Application]] has several settings which allow the application to interact with various pages within your site.  The settings at the site level allow more than one CommonSpot site on your server to act differently but use the same application code base.
 == Example Site Level Configuration for your App ==
-Below is an example of how you could take advantage of an Site Level Configuration file within your application.  For our example, we will create a fictitious application called &quot;twitter&quot;.  The application folder is located in /ADF/apps/twitter/ and contains various scripts/components and Custom Elements.
+Below is an example of how you could take advantage of an Site Level Configuration file within your application.  For our example, we will create a fictitious application called "twitter".  The application folder is located in /ADF/apps/twitter/ and contains various scripts/components and Custom Elements.
 Lets say in your Twitter application you wanted to have various settings like API Limit and Retweet Style.  By having these settings your application can be used in many sites and each site can have its own values.
@@ Line 21: / Line 13: @@
 # Place the following code in your twitter.xml file:
-&lt;pre&gt;
+<pre>
-&lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot;?&gt;
+<?xml version="1.0" encoding="utf-8"?>
-&lt;settings&gt;
+<settings>
-   &lt;apiLimit&gt;150&lt;/apiLimit&gt;
+   <apiLimit>150</apiLimit>
-   &lt;retweetStyle&gt;Old&lt;/retweet&gt;
+   <retweetStyle>Old</retweet>
-&lt;/settings&gt;
+</settings>
-&lt;/pre&gt;
+</pre>
 === Using site config variables ===
-By default your Sites &quot;App.cfc&quot; (located in the /ADF/apps/myApp/components/ directory) contains a method (by virtue of extending AppBase.cfc (located in the /ADF/core/ directory) called &quot;getAppConfig()&quot;.  This returns back the current sites configuration which is based on the values entered into the XML file (mentioned above). Calling that function would return a structure like this:
+By default your Sites "App.cfc" (located in the /ADF/apps/myApp/components/ directory) contains a method (by virtue of extending AppBase.cfc (located in the /ADF/core/ directory) called "getAppConfig()".  This returns back the current sites configuration which is based on the values entered into the XML file (mentioned above). Calling that function would return a structure like this:
 [[File:Site_config_struct.png]]

@@ Line 1: / Line 1: @@
 == Overview ==
 Every ADF Application can have Site Level configuration file to help the application do special things depending on the settings/pages/templates within your site. For example, the [[Profile| Profile Application]] has several settings which allow the application to interact with various pages within your site.  The settings at the site level allow more than one CommonSpot site on your server to act differently but use the same application code base.
 == Example Site Level Configuration for your App ==
-Below is an example of how you could take advantage of an Site Level Configuration file within your application.  For our example, we will create a fictitious application called "twitter".  The application folder is located in /ADF/apps/twitter/ and contains various scripts/components and Custom Elements.
+Below is an example of how you could take advantage of an Site Level Configuration file within your application.  For our example, we will create a fictitious application called &quot;twitter&quot;.  The application folder is located in /ADF/apps/twitter/ and contains various scripts/components and Custom Elements.
 Lets say in your Twitter application you wanted to have various settings like API Limit and Retweet Style.  By having these settings your application can be used in many sites and each site can have its own values.
@@ Line 13: / Line 21: @@
 # Place the following code in your twitter.xml file:
-<pre>
+&lt;pre&gt;
-<?xml version="1.0" encoding="utf-8"?>
+&lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot;?&gt;
-<settings>
+&lt;settings&gt;
-   <apiLimit>150</apiLimit>
+   &lt;apiLimit&gt;150&lt;/apiLimit&gt;
-   <retweetStyle>Old</retweet>
+   &lt;retweetStyle&gt;Old&lt;/retweet&gt;
-</settings>
+&lt;/settings&gt;
-</pre>
+&lt;/pre&gt;
 === Using site config variables ===
-By default your Sites "App.cfc" (located in the /ADF/apps/myApp/components/ directory) contains a method (by virtue of extending AppBase.cfc (located in the /ADF/core/ directory) called "getAppConfig()".  This returns back the current sites configuration which is based on the values entered into the XML file (mentioned above). Calling that function would return a structure like this:
+By default your Sites &quot;App.cfc&quot; (located in the /ADF/apps/myApp/components/ directory) contains a method (by virtue of extending AppBase.cfc (located in the /ADF/core/ directory) called &quot;getAppConfig()&quot;.  This returns back the current sites configuration which is based on the values entered into the XML file (mentioned above). Calling that function would return a structure like this:
 [[File:Site_config_struct.png]]

@@ Line 1: / Line 1: @@
-== Application Site Configuration ==
+== Overview ==
-See the[[Custom Application Site Level Configuration|Custom Application Site Level Configuration]] wiki page for more details.
+Every ADF Application can have Site Level configuration file to help the application do special things depending on the settings/pages/templates within your site. For example, the [[Profile| Profile Application]] has several settings which allow the application to interact with various pages within your site.  The settings at the site level allow more than one CommonSpot site on your server to act differently but use the same application code base.
-Following are the steps to set up a site configuration for an ADF application:
+== Example Site Level Configuration for your App ==
 # Locate the ''_cs_apps'' directory in your site.
 # If the ''_cs_apps/config'' directory does not exist, create it.
-# Identify the ADF applications sample XML configuration file.  Update the file with the site information.
+# Create a file called twitter.xml
-# Ensure the file name is the ADF application name.  For example, with the Profile Application the XML config file name is ''ptProfile.xml''.
+# Place the following code in your twitter.xml file:
-# Place the XML config file into the ''_cs_apps/config'' directory.
 == Related Guides ==

← Older revision	Revision as of 19:47, 11 April 2010
(No difference)

@@ Line 27: / Line 27: @@
 == Related Guides ==
-* [[Create_New_App|Create New ADF Application]]
+* [[Buidling an ADF Application]]
 * [[Load_ADF_Components_into_Site|Load ADF Library Components into Site]]
 [[Category: How-to Guide]][[Category: Site Configuration]]