ADF Docs - User contributions [en]

Differential Sync

2011-10-06T14:38:00Z

Rkahn:

The differentialSync function will optimally update a large set of data based on a comparison of existing data. The function takes many arguments, most notably the newOverride, updateOverride and deleteOverride; those 3 parameters can allow you to write custom code that will handle new, updates or deletions.

Parameters
*'''elementName''' - String (Required)
**The element name that we are going to sync.
*'''newElements''' - Array (Required)
**The elements that you would like to have as the result after the sync is complete
*'''preformDelete''' - Boolean
**default: false
**This will call the delete function if set to true, otherwise deletions will not be processed. This can be helpful if you want old elements to remain.
*'''primaryKeys''' - String
**List of primary keys to use in the comparision
**_pageID is a reserved word and will compare the elements pageID if it exists in the source data
**Example: "links,title" or "_pageID,title"
*'''ignoreFields''' - String
**A list of fields to ignore in the comparison.
**Example: "id,title"
*'''newOverride''' - Structure
**default:
***newOverride.bean = "csContent_1_0"
***newOverride.method = "populateContent_1_0"
**You can override this to handle all new items with your own bean/method argument. It will get called with the parameter of "data" which is a structure of the element data. It will also get a paremter of elementName which is the ccapiName of the element.
*'''updateOverride''' - Structure
**default:
***updateOverride.bean = "csContent_1_0"
***updateOverride.method = "populateContent_1_0"
**You can override this to handle all items that changed with your own bean/method argument. It will get called with the parameter of "data" which is a structure ot the element data. It will also get a paremter of elementName which is the ccapiName of the element.
*'''deleteOverride''' - Structure
**default:
***deleteOverride.bean = "ceData_1_0"
***deleteOverride.method = "deleteCE"
**You can override this to handle all items that should be deleted with your own bean/method argument. It will get called with the parameter of datapageidList as a list of data page id's to be deleted. One reason why you may use this is do "deactivate" an item instead of deleting it
*'''syncSourceContent''' - Array
**Accepts an array of CE data
**If you pass syncSourceContent it will use that data instead of pulling the data based on element name. This can be useful when you only want to sync a small set of data against another smaller set. It can also be helpful when your data may live in multiple locations and you need to combine them together prior to sync.
*'''elementCCAPIName'''
**Default: arguments.elementName
**This is the CCAPI name for the element, this is used when calling the new and update methods

Sample Call
<pre>
myNewElements = ArrayNew(1);
myNewElements[1].values = StructNew();
myNewElements[1].values.id = "1234";
myNewElements[1].values.title = "title";
myNewElements[1].values.description = "This should be ignored";

myDeleteOverride = StructNew();
myDeleteOverride.bean = "myCustomBean";
myDeleteOverride.method = "myCustomMethod";

application.ADF.ceData.differentialSync(
elementName="MyElementName",
newElements=myNewElements,
preformDelete=true,
primaryKeys="id",
ignoreFields="description",
deleteOverride=myDeleteOverride,
elementCCAPIName="myElementCCAPINAme"
);
</pre>
Lets walk through that, firstly we create an array of ce_data
<pre>
myNewElements = ArrayNew(1);
myNewElements[1].values = StructNew();
myNewElements[1].values.id = "1234";
myNewElements[1].values.title = "title";
myNewElements[1].values.description = "This should be ignored";
</pre>
This data could be pulled from a database and built dynamically, it could be data extracted from virtually any datasource, including CommonSpot itself. It simply needs to be formatted as an array of CE data.

Then we define a deletion override:
<pre>
myDeleteOverride = StructNew();
myDeleteOverride.bean = "myCustomBean";
myDeleteOverride.method = "myCustomMethod";
</pre>
It will utilize the application.ADF.utils.runCommand function to execute this override.

Then we call the meat of the differential sync with our parameters:
<pre>
application.ADF.ceData.differentialSync(
elementName="MyElementName",
newElements=myNewElements,
preformDelete=true,
primaryKeys="id",
ignoreFields="description",
deleteOverride=myDeleteOverride,
elementCCAPIName="myElementCCAPINAme"
);
</pre>
This sync will sync on the element "MyElementName", it will process the deletions using our override method. It will align items for comparision using the ID field and it will not compare the description field. It will process new and updated items using the "myElementCCAPINAme" as the ccapi element name.

Differential Sync

2011-10-06T14:29:37Z

Rkahn:

Differential Sync

2011-10-06T14:18:07Z

Rkahn:

Differential Sync

2011-10-06T14:17:15Z

Rkahn: Created page with 'The differentialSync function will optimally update a large set of data based on a comparison of existing data. The function takes many arguments, most notably the newOverride, u…'

Scheduler

2011-10-04T20:47:10Z

Rkahn: /* Overview */

== Overview ==
The scheduler is used to run a series of commands in different server requests. This prevents too much load on the server and allows a long process to have a progress bar instead of simply waiting for the page to load forever. The scheduler can call commands/urls and has the ability to set a wait interval between batches. It also has the ability to render a pause/resume button along with a progress bar.

== Code Update - 2011-09-27 ==
<pre>
!!! IMPORTANT: UPDATE MAY BREAK CURRENT SCHEDULER IMPLEMENTATIONS !!!
</pre>

Scheduler_1_0 Modifications:

application.schedule:
#The variable scope 'application.schedule' has been removed
#'application.schedule' has been replaced with the variable scope 'application.ADFscheduler'

application.ADFscheduler:
#The Scheduler LIB now creates a persistent variable name that can be identified as a variable that was created by a component of the ADF.
#Reduces the risk of conflicting with other custom code
#Added a getSchedulerVars() method

Now to access the task information stored within the 'application.ADFscheduler' variable from within your Apps and/or Site code it is a '''best practice''' to call this Scheduler LIB method: application.ADF.scheduler.getSchedulerVars();

<pre>
NOTE: Using the getSchedulerVars() method call from within Apps and Site Code will insure
that your code remains compatible even if this variable name changes or is moved in the future.
</pre>


*It is recommended that you update any App code that uses the Scheduler to reflect these changes before the ADF 1.5 truck code is updated with these updates.

*When the ADF 1.5 trunk is updated to include these changes it is also recommended that you update any Customers that use the Scheduler components in Apps or in Site code to reflect these updates.

== Usage ==
The scheduler can be used to call URLS directly or can run commands using ADF.utils.runCommand style arguments.

To schedule a process call the scheduleProcess command with the following arguments:
* scheduleName - Required - which we use later, if you use a duplicate name the existing schedule gets overriden and stops wherever it was running.
* commands - Required - Array of URL's or array of structures
** If using structures the layout looks like so:
<pre>
scheduleItem = StructNew();
scheduleItem.bean = "csContent";
scheduleItem.method = "populateContent";
scheduleItem.args.elementName = "My Test Element";
scheduleItem.args.data.fieldName = "fieldValue";
</pre>
* scheduleParams - Optional - Structure of parameters to override.
<pre>
scheduleParams = StructNew();//Default Values
scheduleParams.delay = 5; //minutes till next schedule item
scheduleParams.tasksPerBatch = 1; //how many tasks to do per iteration
scheduleParams.scheduleStart = 1; //Where in the command list to start processing
scheduleParams.scheduleStop = ArrayLen(commands); //When to stop processing (say stop at position 11)
</pre>
* startProcessNow - Optional - By default the process will run its first step immediately in the current request, for faster response time to the scheduler simply change this value to false.

Now that you have the parameters that you need to know, see an example of a schedule to call http://www.google.com 4 times. You would typically have this hit a URL that does some sort of processing.

<pre>
commands = ArrayNew(1);
commands[1] = "http://www.google.com";
commands[2] = "http://www.google.com";
commands[3] = "http://www.google.com";
commands[4] = "http://www.google.com";
application.ADF.scheduler.scheduleProcess("Call Google",commands);
</pre>

We can also have it call a custom function:
<pre>
commands = ArrayNew(1);
commands[1] = StructNew();
commands[1].bean = "myCustomBean";
commands[1].method = "myCustomMethod";
commands[1].args = StructNew();
commands[1].args.argName1 = "argValue1";
commands[2] = StructNew();
commands[2].bean = "myCustomBean";
commands[2].method = "myCustomMethod";
commands[2].args = StructNew();
commands[2].args.argName1 = "argValue1";
application.ADF.scheduler.scheduleProcess("Call Custom Command",commands);
</pre>

Now that is all fine and dandy, however, how do you get a response that allows you to monitor the process? Simply add this to your output:
<pre>
#application.ADF.scheduler.getScheduleHTML("Call Google")#
</pre>

It will render a progress bar and give you the ability to pause/resume the process.

Scheduler

2011-09-27T14:49:32Z

Rkahn: /* Usage */

__NOTOC__

Attention: Do not change any text in the description, properties, and functions sections.

Return to [[Library|Library (API)]]

== Usage ==
The scheduler can be used to call URLS directly or can run commands using ADF.utils.runCommand style arguments.

To schedule a process call the scheduleProcess command with the following arguments:
* scheduleName - Required - which we use later, if you use a duplicate name the existing schedule gets overriden and stops wherever it was running.
* commands - Required - Array of URL's or array of structures
** If using structures the layout looks like so:
<pre>
scheduleItem = StructNew();
scheduleItem.bean = "csContent";
scheduleItem.method = "populateContent";
scheduleItem.args.elementName = "My Test Element";
scheduleItem.args.data.fieldName = "fieldValue";
</pre>
* scheduleParams - Optional - Structure of parameters to override.
<pre>
scheduleParams = StructNew();//Default Values
scheduleParams.delay = 5; //minutes till next schedule item
scheduleParams.tasksPerBatch = 1; //how many tasks to do per iteration
scheduleParams.scheduleStart = 1; //Where in the command list to start processing
scheduleParams.scheduleStop = ArrayLen(commands); //When to stop processing (say stop at position 11)
</pre>
* startProcessNow - Optional - By default the process will run its first step immediately in the current request, for faster response time to the scheduler simply change this value to false.

Now that you have the parameters that you need to know, see an example of a schedule to call http://www.google.com 4 times. You would typically have this hit a URL that does some sort of processing.

<pre>
commands = ArrayNew(1);
commands[1] = "http://www.google.com";
commands[2] = "http://www.google.com";
commands[3] = "http://www.google.com";
commands[4] = "http://www.google.com";
application.ADF.scheduler.scheduleProcess("Call Google",commands);
</pre>

We can also have it call a custom function:
<pre>
commands = ArrayNew(1);
commands[1] = StructNew();
commands[1].bean = "myCustomBean";
commands[1].method = "myCustomMethod";
commands[1].args = StructNew();
commands[1].args.argName1 = "argValue1";
commands[2] = StructNew();
commands[2].bean = "myCustomBean";
commands[2].method = "myCustomMethod";
commands[2].args = StructNew();
commands[2].args.argName1 = "argValue1";
application.ADF.scheduler.scheduleProcess("Call Custom Command",commands);
</pre>

Now that is all fine and dandy, however, how do you get a response that allows you to monitor the process? Simply add this to your output:
<pre>
#application.ADF.scheduler.getScheduleHTML("Call Google")#
</pre>

It will render a progress bar and give you the ability to pause/resume the process.

== Description ==

== Properties ==

== Functions ==
<div id='library-api'>
</div>

Scheduler

2011-09-27T14:46:28Z

Rkahn: /* Usage */

__NOTOC__

Attention: Do not change any text in the description, properties, and functions sections.

Return to [[Library|Library (API)]]

== Usage ==
The scheduler can be used to call URLS directly or can run commands using ADF.utils.runCommand style arguments.

To schedule a process call the scheduleProcess command with the following arguments:
* scheduleName - Required - which we use later, if you use a duplicate name the existing schedule gets overriden and stops wherever it was running.
* commands - Required - Array of URL's or array of structures
** If using structures the layout looks like so:
<pre>
scheduleItem = StructNew();
scheduleItem.bean = "csContent";
scheduleItem.method = "populateContent";
scheduleItem.args.elementName = "My Test Element";
scheduleItem.args.data.fieldName = "fieldValue";
</pre>
* scheduleParams - Optional - Structure of parameters to override.
<pre>
scheduleParams = StructNew();//Default Values
scheduleParams.delay = 5; //minutes till next schedule item
scheduleParams.tasksPerBatch = 1; //how many tasks to do per iteration
scheduleParams.scheduleStart = 1; //Where in the command list to start processing
scheduleParams.scheduleStop = ArrayLen(commands); //When to stop processing (say stop at position 11)
</pre>
* startProcessNow - Optional - By default the process will run its first step immediately in the current request, for faster response time to the scheduler simply change this value to false.

Now that you have the parameters that you need to know, see an example of a schedule to call http://www.google.com 4 times. You would typically have this hit a URL that does some sort of processing.

<pre>
commands = ArrayNew(1);
commands[1] = "http://www.google.com";
commands[2] = "http://www.google.com";
commands[3] = "http://www.google.com";
commands[4] = "http://www.google.com";
application.ADF.scheduler.scheduleProcess("Call Google",commands);
</pre>

Now that is all fine and dandy, however, how do you get a response that allows you to monitor the process? Simply add this to your output:
<pre>
#application.ADF.scheduler.getScheduleHTML("Call Google")#
</pre>

It will render a progress bar and give you the ability to pause/resume the process.

== Description ==

== Properties ==

== Functions ==
<div id='library-api'>
</div>

Scheduler

2011-09-27T14:26:30Z

Rkahn: /* Usage */

Scheduler

2011-09-27T14:24:09Z

Rkahn: Created page with '__NOTOC__ Attention: Do not change any text in the description, properties, and functions sections. Return to Library (API) == Usage == == Description == == Pro…'

__NOTOC__

Attention: Do not change any text in the description, properties, and functions sections.

Return to [[Library|Library (API)]]

== Usage ==

== Description ==

== Properties ==

== Functions ==
<div id='library-api'>
</div>

Library

2011-09-27T14:22:45Z

Rkahn:

__NOTOC__

== CCAPI ==
[[CCAPI]]

Content Creation API component for working with the CCAPI.

[[CSContent_1_0]]

Wrapper for the CCAPI ADF component for the populateContent CCAPI function.

[[CSPage_1_0]]

Wrapper for the CCAPI ADF component for the createPage and deletePage CCAPI function.

[[CSSubsite_1_0]]

Wrapper for the CCAPI ADF component for the createSubsite CCAPI function. Additional function to build the subsites for a specific path.

[[CSUpload_1_0]]

Wrapper for the CCAPI ADF component for the uploadImage and uploadDocument CCAPI function.

== CEData ==
[[CEData_1_0]]

Designed to work with Custom Element data records. Functions exist to return custom element data records, filtering/sorting operations for custom element records, and functions to work directly with custom elements.

== CSData ==
[[CSData_1_0]]

CommonSpot data component to connect with the CommonSpot site, subsite, page, metadata, uploaded files, and user data.

== CSSecurity ==
[[CSSecurity_1_0]]

Security functions based on CommonSpot user roles and permissions for a CommonSpot site.

== Data ==
[[Data_1_0]]

Data utility functions for sorting, filtering, and searching with simple and complex ColdFusion data types. Specific ColdFusion functions that are not connected to CommonSpot data.

== Date ==
[[Date_1_0]]

Date utility functions for working with ColdFusion date data types. Functions contains operations for returning first/last day of the week, first/last day of the month, and formatting date for CommonSpot date format.

== Forms ==
[[Forms_1_0]]

Designed to open add/edit/delete forms for custom elements and manipulating simple forms.

== Scheduler==
[[Scheduler_1_0]]

A tool to schedule a series of processes to run as separate requests.

== Scripts ==
[[Scripts_1_0]]

Tools to load third party JavaScripts scripts and ADF Lightbox framework into CommonSpot pages. Provides function to load jquery, jquery UI, SWF Object, and many JavaScript functions.

[[ScriptsService_1_0]]

Service component for the Scripts to handle the monitoring of the loaded scripts.

== Taxonomy ==
[[Taxonomy_1_0]]

Component to provide a layer for the CommonSpot Taxonomy API. Easily create a taxonomy object for querying the CommonSpot sites taxonomy.

== Utils ==
[[Utils_1_0]]

Utility functions for debugging, managing ColdFusion scheduled tasks, working with CommonSpot field types, and building pagination for rendering.

PT Import Content Import

2011-06-21T21:19:41Z

Rkahn: /* Import */

== Import ==

Create a new element category called "PT Import Content Elements".
Import Custom Elements in this order:

# Subsite Mapping
# Page Mapping
# Document Mapping
# Image Mapping
# Import Job
# Import Job Type
# Template Mapping

[[Category:PT Import Content]]

PT Link Builder Configuration

2011-02-09T18:53:41Z

Rkahn: /* Page Creation */

== Site Configuration ==
* Make sure the ADF is setup and running on the site. If the ADF is not setup, then follow the instructions for ADF [[Installation]].
* Open the sites 'ADF.cfc' ([[Site Configuration (ADF.cfc) | See Site Configuration (ADF.cfc) for more info]]) file in a text editor. Locate the ''Load the ADF Application into application space'' comment in the file. Add the following command under the comment section:
<source lang="java">
loadApp("ptLinkBuilder");
</source>
* [[Reset ADF|Reset the ADF]] for the server and site.

== Element Import ==
* Import the Link-Builder-Data-Custom-Element.zip

== Custom Field Type Import ==
* Navigate to the CommonSpot administrator and open the Manage Custom Field Types dialog.
* Import the Link Builder custom field type (link_builder/Link-Builder-Custom-Field-Type.zip).
* Edit the properties and check the explicit module paths. If the paths are not correct for unlock the field type and edit the explicit paths to use “/ADF/extensions/…”.

== Implementing the Link Builder Custom Field ==
* When implementing the link builder field, the properties need to be setup for the field in the custom element.
* Locate the link builder field in the custom element and edit the field.
* Open the Properties and enter the URL to the Link Builder Actions page that was created.

== Rendering Link Builder Data ==
# In the render handler for the element containing the link builder field, this code is required to return the data from the Link Builder Data custom element.
# Add the following code into your render handler when looping over the render handler data array:
## // Get the Link Builder Data for the UUID's
## linkDataArray = application.ADF.ceData.getCEData("Link Builder Data", "uuid", items[i].Values.LINKS);
### Where “items[i].Values.LINKS” is the link builder field in the custom element.

[[Category:Link Builder]]

PT Page Rating Version 1.0 Install

2011-02-04T22:37:26Z

Rkahn:

== Site Configuration ==
* Make sure the ADF is setup and running on the site. If the ADF is not setup, then follow the instructions for ADF [[Installation]].
* Open the sites 'ADF.cfc' ([[Site Configuration (ADF.cfc) | See Site Configuration (ADF.cfc) for more info]]) file in a text editor. Locate the ''Load the ADF Application into application space'' comment in the file. Add the following command under the comment section:
<source lang="java">
loadApp("ptPageRating");
</source>
* [[Reset ADF|Reset the ADF]] for the server and site.

== Element Import ==
* Import the following elements from the /ADF/apps/pt_page_rating/exported-objects/ folder:
** PT-Page-Rating-Custom-Element.zip

== CCAPI Configuration ==
ccapi.cfm configuration
# Navigate to your ccapi.cfm page (or create one)
# Add the PT Page Rating Element to the page
# Click on the More under the PT Page Rating Element and select name
# enter the name: ptPageRating
# Submit the page

XML Configuration
# Open the _cs_apps/config/ccapi.xml (or cfm) document
# add the following:
<pre>
<ptPageRating>
<pageID>[ccapi.cfm page ID]</pageID>
<subsiteID>[subsite ID ccapi.cfm lies in]</subsiteID>
<elementType>custom</elementType>
<controlName>ptPageRating</controlName>
</ptPageRating>
</pre>

== Adding rating to your page ==
# Navigate to your page
# Add a custom script to the page (under Miscellaneous)
# Specify the location of the custom script to be:
#* /ADF/apps/pt_page_rating/customcf/pageRating.cfm
# Submit the page. You now have the app installed and running.

[[Category:Page Rating]]

PT Page Rating Version 1.0 Install

2011-02-04T22:37:06Z

Rkahn: Created page with '== Site Configuration == * Make sure the ADF is setup and running on the site. If the ADF is not setup, then follow the instructions for ADF Installation. * Open the sites 'A…'

== Site Configuration ==
* Make sure the ADF is setup and running on the site. If the ADF is not setup, then follow the instructions for ADF [[Installation]].
* Open the sites 'ADF.cfc' ([[Site Configuration (ADF.cfc) | See Site Configuration (ADF.cfc) for more info]]) file in a text editor. Locate the ''Load the ADF Application into application space'' comment in the file. Add the following command under the comment section:
<source lang="java">
loadApp("ptPageRating");
</source>
* [[Reset ADF|Reset the ADF]] for the server and site.

== Element Import ==
* Import the following elements from the /ADF/apps/pt_page_rating/exported-objects/ folder:
** PT-Page-Rating-Custom-Element.zip

== CCAPI Configuration ==
ccapi.cfm configuration
# Navigate to your ccapi.cfm page (or create one)
# Add the PT Page Rating Element to the page
# Click on the More under the PT Page Rating Element and select name
# enter the name: ptPageRating
# Submit the page

XML Configuration
# Open the _cs_apps/config/ccapi.xml (or cfm) document
# add the following:
<pre>
<ptPageRating>
<pageID>[ccapi.cfm page ID]</pageID>
<subsiteID>[subsite ID ccapi.cfm lies in]</subsiteID>
<elementType>custom</elementType>
<controlName>ptPageRating</controlName>
</ptPageRating>
</pre>

== Adding rating to your page ==
# Navigate to your page
# Add a custom script to the page (under Miscellaneous)
# Specify the location of the custom script to be:
#* /ADF/apps/pt_page_rating/customcf/pageRating.cfm
# Submit the page. You now have the app installed and running.

[[Category:Poll]]

PT Page Rating

2011-02-04T22:32:42Z

Rkahn: Created page with '== Overview == The ADF Page Rating Application is built in the Application Development Framework (ADF). This application provides the ability for your site visito…'

== Overview ==
The ADF Page Rating Application is built in the [[Overview|Application Development Framework (ADF)]].

This application provides the ability for your site visitors to rate the usefulness of your page.

== Requirements ==
ADF Version 1.5

ADF must be configured correctly for your site. [[Site Configuration (ADF.cfc)]] has instructions for configuration.

== Pre-installation Considerations ==
[[Overview|Application Development Framework (ADF)]] must be setup and configured on the server for the site. For detailed instructions, see the [[Overview|Application Development Framework (ADF)]] wiki page for Site Configurations.

== Installation/Setup ==
Each of the following steps should be completed fully and in the order presented:

# [[PT_Page_Rating_Extract|Extract Application]]
# [[PT_Page_Rating_Configuration|Configuration]]

[[Category:Project]]
[[Category:Page Rating]]

View All

2011-02-04T22:31:44Z

Rkahn: /* All Projects */

PT Comments Going Further

2011-02-03T21:54:52Z

Rkahn: Created page with '== Going Further == As you have seen you can add comments to a basic page. But lets say you want to add comments to a certain element or other item. The comments app is designed …'

== Going Further ==
As you have seen you can add comments to a basic page. But lets say you want to add comments to a certain element or other item. The comments app is designed to allow you to do just that! Remember when setting up our page we used the pageComments.cfm file as a script before our comments element? Open that script, it is located in /ADF/apps/pt_comments/customcf/pageComments.cfm

In this file we set the request.params.comments.contentDataPageID parameter to the existing page id, to bind a comment to just your element or other item enter the unique identifier for that element instead of request.page.id and save the file to your /_cs_apps/pt_comments/customcf directory with a unique descriptive title.

Instead of specifying the pageComments.cfm when adding the comments app to the page specify your script instead. No other changes are necessary.

PT Comments

2011-02-03T21:50:56Z

Rkahn:

== About Comments App ==
The Comments application is built in the [[Overview|Application Development Framework (ADF)]].

== Overview ==
The Comments application provides the flexibility to add comments to any custom element within the CommonSpot site. Functionality to dynamically add a comments block to news articles, publications, etc.

== Requirements ==
ADF Library components that are required for the Photo Gallery:
* CCAPI
* ceData_1_0
* scripts_1_0

ADF must be configured correctly for your site. [[Site Configuration (ADF.cfc)]] has instructions for configuration.

== Contents ==
The Comments Application contains the following:
* '''Custom Elements:'''
** [[PT_Comments_Custom_Element|Comment]] - Custom Element

Note: Elements may contain one or more: Render Handlers, Display Templates, or Custom Field Types

== Pre-installation Considerations ==
[[Overview|Application Development Framework (ADF)]] must be setup and configured on the server for the site. For detailed instructions, see the [[Overview|Application Development Framework (ADF)]] wiki page for Site Configurations.

This installation guide assumes that you have no Custom Elements/Metadata Forms with the names above. Before the installation of CS Photo Gallery, remove any Custom Elements/Metadata Forms with the names contained in the "Contents" section above. (If you do not remove existing elements with these names, you may have difficulties during the installation.)

The CCAPI must be configured for the site. Follow the steps to set up the [[CCAPI Config|CCAPI Config]] file for the site.

== Installation/Setup ==
Each of the following steps should be completed fully and in the order presented:

# [[PT_Comments_Extract|Extract Comments Application]]
# [[PT_Comments_ADF_Configuration|ADF Configuration]]
# [[PT_Comments_Import|Import Element]]
# [[PT_Comments_Site_Configuration|Site Configuration]]

== Going Further ==
* [[PT_Comments_Going_Further|Going Further]] - Guide to using comments for more than just a page.

[[Category:Project]]
[[Category:Comments]]

PT Comments

2011-02-03T21:50:07Z

Rkahn: /* Installation/Setup */

== About Comments App ==
The Comments application is built in the [[Overview|Application Development Framework (ADF)]].

== Overview ==
The Comments application provides the flexibility to add comments to any custom element within the CommonSpot site. Functionality to dynamically add a comments block to news articles, publications, etc.

== Requirements ==
ADF Library components that are required for the Photo Gallery:
* CCAPI
* ceData_1_0
* scripts_1_0

ADF must be configured correctly for your site. [[Site Configuration (ADF.cfc)]] has instructions for configuration.

== Contents ==
The Comments Application contains the following:
* '''Custom Elements:'''
** [[PT_Comments_Custom_Element|Comment]] - Custom Element

Note: Elements may contain one or more: Render Handlers, Display Templates, or Custom Field Types

== Pre-installation Considerations ==
[[Overview|Application Development Framework (ADF)]] must be setup and configured on the server for the site. For detailed instructions, see the [[Overview|Application Development Framework (ADF)]] wiki page for Site Configurations.

This installation guide assumes that you have no Custom Elements/Metadata Forms with the names above. Before the installation of CS Photo Gallery, remove any Custom Elements/Metadata Forms with the names contained in the "Contents" section above. (If you do not remove existing elements with these names, you may have difficulties during the installation.)

The CCAPI must be configured for the site. Follow the steps to set up the [[CCAPI Config|CCAPI Config]] file for the site.

== Installation/Setup ==
Each of the following steps should be completed fully and in the order presented:

# [[PT_Comments_Extract|Extract Comments Application]]
# [[PT_Comments_ADF_Configuration|ADF Configuration]]
# [[PT_Comments_Import|Import Element]]
# [[PT_Comments_Site_Configuration|Site Configuration]]

== Getting Started ==
* [[PT_Photo_Gallery_Getting_Started|Getting Started]] - Guide to set up the photo sizes and categories.

[[Category:Project]]
[[Category:Comments]]

PT Mobile Extract

2011-02-02T16:12:05Z

Rkahn: /* Steps */

== Steps ==
# Download the PT Mobile application from the the|commons projects SVN (http://community.paperthin.com/svn/pt_mobile/trunk/).
# Extract the zip file and place the directory in the "/ADF/Apps/pt_mobile/" directory.

[[Category:Project]]
[[Category:Mobile]]

PT Link Builder Extract

2011-02-02T16:11:40Z

Rkahn: /* Steps */

== Steps ==
# Download the PT Link Builder application from the the|commons projects SVN (http://community.paperthin.com/svn/pt_link_builder/tags/1.0/).
# Extract the zip file and place the directory in the "/ADF/Apps/pt_link_builder/" directory.

PT Poll

2011-02-02T16:10:29Z

Rkahn:

== Overview ==
The ADF Poll Application is built in the [[Overview|Application Development Framework (ADF)]].

This application provides the ability to query your visitors in an easy to use manner. It also allows exporting of poll data.

== Requirements ==
ADF Version 1.5

ADF must be configured correctly for your site. [[Site Configuration (ADF.cfc)]] has instructions for configuration.

== Pre-installation Considerations ==
[[Overview|Application Development Framework (ADF)]] must be setup and configured on the server for the site. For detailed instructions, see the [[Overview|Application Development Framework (ADF)]] wiki page for Site Configurations.

== Installation/Setup ==
Each of the following steps should be completed fully and in the order presented:

# [[PT_Poll_Extract|Extract Application]]
# [[PT_Poll_Configuration|Configuration]]

== Poll Element Defaults ==
* [[PT_Poll_question|Poll Question]]
* [[PT_Poll_question_gallery|Poll Question Gallery]]
* [[PT_Poll_vote|Poll Vote]]

[[Category:Project]]
[[Category:Poll]]

PT Poll vote

2011-02-02T16:09:09Z

Rkahn: Created page with '== Fields == <h3>Tab #1: Poll Vote</h3> <table id="ce-fields"> <tr class="header"> <td>Field Name/Label</td> <td>Field ID</td> <td>Field Type</td> <td>Required?</td> <…'

== Fields ==

<h3>Tab #1: Poll Vote</h3>
<table id="ce-fields">
<tr class="header">
<td>Field Name/Label</td>
<td>Field ID</td>
<td>Field Type</td>
<td>Required?</td>
<td>Properties</td>
</tr>

<tr>
<td>ID</td>
<td>ID</td>
<td>hidden</td>
<td>No</td>
<td>
Defaultvalue: createUUID()<br/>

</td>
</tr>

<tr>
<td>UserID</td>
<td>UserID</td>
<td>hidden</td>
<td>No</td>
<td>
Defaultvalue: session.user.community.userid<br/>

</td>
</tr>

<tr>
<td>questionID</td>
<td>questionID</td>
<td>hidden</td>
<td>No</td>
<td>
Defaultvalue: 0<br/>

</td>
</tr>

<tr>
<td>vote</td>
<td>vote</td>
<td>hidden</td>
<td>No</td>
<td>
Defaultvalue: 0<br/>

</td>
</tr>

<tr>
<td>date</td>
<td>date</td>
<td>hidden</td>
<td>No</td>
<td>
Defaultvalue: request.formattedtimestamp<br/>

</td>
</tr>

</table>

PT Poll question gallery

2011-02-02T16:08:52Z

Rkahn: Created page with '== Fields == <h3>Tab #1: Poll Question Gallery</h3> <table id="ce-fields"> <tr class="header"> <td>Field Name/Label</td> <td>Field ID</td> <td>Field Type</td> <td>Requir…'

== Fields ==

<h3>Tab #1: Poll Question Gallery</h3>
<table id="ce-fields">
<tr class="header">
<td>Field Name/Label</td>
<td>Field ID</td>
<td>Field Type</td>
<td>Required?</td>
<td>Properties</td>
</tr>

<tr>
<td>Poll Question to Render</td>
<td>pollQuestionID</td>
<td>General Chooser</td>
<td>No</td>
<td>

</td>
</tr>

</table>

PT Poll

2011-02-02T16:08:45Z

Rkahn: /* Poll Element Defaults */

PT Poll

2011-02-02T16:08:20Z

Rkahn: /* Poll Element Defaults */

== Overview ==
The ADF Poll Application is built in the [[Overview|Application Development Framework (ADF)]].

This application provides the ability to query your visitors in an easy to use manner. It also allows exporting of poll data.

== Requirements ==
ADF Version 1.5

ADF must be configured correctly for your site. [[Site Configuration (ADF.cfc)]] has instructions for configuration.

== Pre-installation Considerations ==
[[Overview|Application Development Framework (ADF)]] must be setup and configured on the server for the site. For detailed instructions, see the [[Overview|Application Development Framework (ADF)]] wiki page for Site Configurations.

== Installation/Setup ==
Each of the following steps should be completed fully and in the order presented:

# [[PT_Poll_Extract|Extract Application]]
# [[PT_Poll_Configuration|Configuration]]

== Poll Element Defaults ==
* [[PT_Poll_question|Poll Question]]
* [[PT_Poll_question|Poll Question Gallery]]
* [[PT_Poll_question|Poll Vote]]

[[Category:Project]]
[[Category:Link Builder]]

PT Poll question

2011-02-02T16:08:02Z

Rkahn: Created page with '== Fields == <h3>Tab #1: Poll Question</h3> <table id="ce-fields"> <tr class="header"> <td>Field Name/Label</td> <td>Field ID</td> <td>Field Type</td> <td>Required?</td>…'

== Fields ==

<h3>Tab #1: Poll Question</h3>
<table id="ce-fields">
<tr class="header">
<td>Field Name/Label</td>
<td>Field ID</td>
<td>Field Type</td>
<td>Required?</td>
<td>Properties</td>
</tr>

<tr>
<td>ID</td>
<td>ID</td>
<td>hidden</td>
<td>No</td>
<td>
Defaultvalue: createUUID()<br/>

</td>
</tr>

<tr>
<td>Title</td>
<td>title</td>
<td>text</td>
<td>Yes</td>
<td>
Maxlength: 255<br/>
Size: 50<br/>

</td>
</tr>

<tr>
<td>Question</td>
<td>question</td>
<td>small_textarea</td>
<td>Yes</td>
<td>
Rows: 4<br/>
Maxlength: 255<br/>
Size: 40<br/>

</td>
</tr>

<tr>
<td>Type</td>
<td>type</td>
<td>select</td>
<td>No</td>
<td>
Optionlist: Radio Buttons,Selection List<br/>
Optionlistsource: Value List<br/>
Size: 1<br/>

</td>
</tr>

<tr>
<td>Is Question Active?</td>
<td>active</td>
<td>checkbox</td>
<td>No</td>
<td>
Defaultvalue: 1<br/>
Value: 1<br/>

</td>
</tr>

<tr>
<td>date</td>
<td>date</td>
<td>hidden</td>
<td>No</td>
<td>
Defaultvalue: request.formattedtimestamp<br/>

</td>
</tr>

</table>

<h3>Tab #2: Options</h3>
<table id="ce-fields">
<tr class="header">
<td>Field Name/Label</td>
<td>Field ID</td>
<td>Field Type</td>
<td>Required?</td>
<td>Properties</td>
</tr>

<tr>
<td>Vote Options</td>
<td>voteOptions</td>
<td>Vote Options</td>
<td>Yes</td>
<td>

</td>
</tr>

</table>

PT Poll

2011-02-02T16:07:52Z

Rkahn: Created page with '== Overview == The ADF Poll Application is built in the Application Development Framework (ADF). This application provides the ability to query your visitors in a…'

== Overview ==
The ADF Poll Application is built in the [[Overview|Application Development Framework (ADF)]].

This application provides the ability to query your visitors in an easy to use manner. It also allows exporting of poll data.

== Requirements ==
ADF Version 1.5

ADF must be configured correctly for your site. [[Site Configuration (ADF.cfc)]] has instructions for configuration.

== Pre-installation Considerations ==
[[Overview|Application Development Framework (ADF)]] must be setup and configured on the server for the site. For detailed instructions, see the [[Overview|Application Development Framework (ADF)]] wiki page for Site Configurations.

== Installation/Setup ==
Each of the following steps should be completed fully and in the order presented:

# [[PT_Poll_Extract|Extract Application]]
# [[PT_Poll_Configuration|Configuration]]

== Poll Element Defaults ==
[[PT_Poll_question|Poll Question]]
[[PT_Poll_question|Poll Question Gallery]]
[[PT_Poll_question|Poll Vote]]

[[Category:Project]]
[[Category:Link Builder]]

View All

2011-02-02T16:05:35Z

Rkahn:

PT Mobile Getting Started

2011-02-01T18:55:08Z

Rkahn: /* Customizing the transform */

== Getting Started ==
So you have the app installed and running. Now what?

== Understanding What the App Does ==
Before you can begin to make your mobile site you need to understand what this apps job is. This app will allow you to run a custom XSL transform on the xml output of your pages. XSL+XPATH are programming languages unto themselves and I recommend you read up on the W3C site about how to use it properly before continuing further.

== Customizing the transform ==
As you will quickly notice many of your pages are not the same as far as layout of custom elements and data. You will need to implement a transform that can handle the specific set of data it gets from the page you are "mobilifying"

To set what transform gets called on what page go to your _cs_apps/pt_mobile/components/mobileController.cfm and edit the getXSLPath function, there will be an example that is commented out called "Set XSL path for HOME.". The code below it takes the pageID you want to customize for and sets the XSLPath to the custom transform of your choice. There is another example "Set XSL path for NEWS." that shows how to do this dynamic choice based upon a subsiteID.

== Getting Sample Data ==
As you customize your transform you will probably want to see what data it is transforming right? Well to do this you simply add ?xml=1 to the end of the url and it will spit out the XML that is being transformed.

PT Mobile Getting Started

2011-02-01T18:53:58Z

Rkahn: Created page with '== Getting Started == So you have the app installed and running. Now what? == Understanding What the App Does == Before you can begin to make your mobile site you need to unders…'

== Getting Started ==
So you have the app installed and running. Now what?

== Understanding What the App Does ==
Before you can begin to make your mobile site you need to understand what this apps job is. This app will allow you to run a custom XSL transform on the xml output of your pages. XSL+XPATH are programming languages unto themselves and I recommend you read up on the W3C site about how to use it properly before continuing further.

== Customizing the transform ==
As you will quickly notice many of your pages are not the same as far as layout of custom elements and data. You will need to implement a transform that can handle the specific set of data it gets from the page you are "mobilifying"

To set what transform gets called on what page go to your _cs_apps/pt_mobile/components/mobileController.cfm and edit the getXSLPath function, there will be an example that is commented out called "Set XSL path for HOME." the code below it takes the pageID you want to customize for and sets the XSLPath to the custom transform of your choice.

== Getting Sample Data ==
As you customize your transform you will probably want to see what data it is transforming right? Well to do this you simply add ?xml=1 to the end of the url and it will spit out the XML that is being transformed.

PT Mobile

2011-02-01T18:42:38Z

Rkahn: /* Installation/Setup */

== Overview ==
The ADF Link Builder Application is built in the [[Overview|Application Development Framework (ADF)]].

This application provides the ability to present your website to mobile devices with a different style.

== Requirements ==
ADF Version 1.5

ADF must be configured correctly for your site. [[Site Configuration (ADF.cfc)]] has instructions for configuration.

== Pre-installation Considerations ==
[[Overview|Application Development Framework (ADF)]] must be setup and configured on the server for the site. For detailed instructions, see the [[Overview|Application Development Framework (ADF)]] wiki page for Site Configurations.

== Installation/Setup ==
Each of the following steps should be completed fully and in the order presented:

# [[PT_Mobile_Extract|Extract Application]]
# [[PT_Mobile_Configuration|Configuration]]
# [[PT_Mobile_Getting_Started|Getting Started]]

[[Category:Project]]
[[Category:Mobile]]

PT Mobile Extract

2011-02-01T17:16:45Z

Rkahn:

== Steps ==
# Download the PT ADF Dashboard application from the the|commons projects SVN (http://community.paperthin.com/svn/pt_mobile/trunk/).
# Extract the zip file and place the directory in the "/ADF/Apps/pt_mobile/" directory.

[[Category:Project]]
[[Category:Mobile]]

PT Mobile Configuration

2011-02-01T17:16:15Z

Rkahn:

PT Mobile Configuration

2011-02-01T17:15:32Z

Rkahn:

PT Mobile Configuration

2011-02-01T17:15:01Z

Rkahn:

PT Mobile Configuration

2011-02-01T17:14:29Z

PT Mobile Extract

2011-02-01T17:08:13Z

Rkahn: Created page with '== Steps == # Download the PT ADF Dashboard application from the the|commons projects SVN (http://community.paperthin.com/svn/pt_mobile/trunk/). # Extract the zip file and place …'

PT Mobile

2011-02-01T17:07:29Z

Rkahn: Created page with '== Overview == The ADF Link Builder Application is built in the Application Development Framework (ADF). This application provides the ability to present your web…'

View All

2011-02-01T17:06:34Z

Rkahn:

PT Link Builder

2011-01-28T16:26:05Z

Rkahn:

== Overview ==
The ADF Link Builder Application is built in the [[Overview|Application Development Framework (ADF)]].

This application provides the ability to add and manage links pointing to both commonspot pages and external links.

== Requirements ==
ADF Version 1.5

ADF must be configured correctly for your site. [[Site Configuration (ADF.cfc)]] has instructions for configuration.

== Pre-installation Considerations ==
[[Overview|Application Development Framework (ADF)]] must be setup and configured on the server for the site. For detailed instructions, see the [[Overview|Application Development Framework (ADF)]] wiki page for Site Configurations.

== Installation/Setup ==
Each of the following steps should be completed fully and in the order presented:

# [[PT_Link_Builder_Extract|Extract Application]]
# [[PT_Link_Builder_Configuration|Configuration]]

== Link Builder Data Element ==

<table id="ce-fields">
<tr class="header">
<td>Field Name/Label</td>
<td>Field ID</td>
<td>Field Type</td>
<td>Required?</td>
<td>Properties</td>
</tr>

<tr>
<td>uuid</td>
<td>uuid</td>
<td>hidden</td>
<td>No</td>
<td>
Defaultvalue: request.params.linkBuilderUUID<br/>

</td>
</tr>

<tr>
<td>Link Title</td>
<td>title</td>
<td>formatted_text_block</td>
<td>No</td>
<td>
Height: 200<br/>
Width: 250<br/>

</td>
</tr>

<tr>
<td>Page</td>
<td>csPage</td>
<td>cs_url</td>
<td>No</td>
<td>

</td>
</tr>

<tr>
<td>URL</td>
<td>extPage</td>
<td>url</td>
<td>No</td>
<td>
Maxlength: 255<br/>
Size: 40<br/>

</td>
</tr>

<tr>
<td>New Window?</td>
<td>newWindow</td>
<td>checkbox</td>
<td>No</td>
<td>
Value: 1<br/>

</td>
</tr>

<tr>
<td>Height</td>
<td>newWinHeight</td>
<td>text</td>
<td>No</td>
<td>
Maxlength: 5<br/>
Size: 5<br/>

</td>
</tr>

<tr>
<td>Width</td>
<td>newWinWidth</td>
<td>text</td>
<td>No</td>
<td>
Maxlength: 5<br/>
Size: 5<br/>

</td>
</tr>

</table>

[[Category:Project]]
[[Category:Link Builder]]

PT Link Builder Configuration

2011-01-28T16:19:58Z

Rkahn:

== Site Configuration ==
* Make sure the ADF is setup and running on the site. If the ADF is not setup, then follow the instructions for ADF [[Installation]].
* Open the sites 'ADF.cfc' ([[Site Configuration (ADF.cfc) | See Site Configuration (ADF.cfc) for more info]]) file in a text editor. Locate the ''Load the ADF Application into application space'' comment in the file. Add the following command under the comment section:
<source lang="java">
loadApp("ptLinkBuilder");
</source>
* [[Reset ADF|Reset the ADF]] for the server and site.

== Element Import ==
* Import the Link-Builder-Data-Custom-Element.zip

== Custom Field Type Import ==
* Navigate to the CommonSpot administrator and open the Manage Custom Field Types dialog.
* Import the Link Builder custom field type (link_builder/Link-Builder-Custom-Field-Type.zip).
* Edit the properties and check the explicit module paths. If the paths are not correct for unlock the field type and edit the explicit paths to use “/ADF/extensions/…”.

== Page Creation ==
* Create a new page called “Link Builder Act ions” from the Blank Template.
* Insert a Custom Script module onto the page.
* Edit the Custom Script module and enter the explicit path:
** /ADF/extensions/customfields/link_builder/link_builder_actions.cfm
* Publish this page.

== Implementing the Link Builder Custom Field ==
* When implementing the link builder field, the properties need to be setup for the field in the custom element.
* Locate the link builder field in the custom element and edit the field.
* Open the Properties and enter the URL to the Link Builder Actions page that was created.

== Rendering Link Builder Data ==
# In the render handler for the element containing the link builder field, this code is required to return the data from the Link Builder Data custom element.
# Add the following code into your render handler when looping over the render handler data array:
## // Get the Link Builder Data for the UUID's
## linkDataArray = application.ADF.ceData.getCEData("Link Builder Data", "uuid", items[i].Values.LINKS);
### Where “items[i].Values.LINKS” is the link builder field in the custom element.

[[Category:Link Builder]]

PT Link Builder Configuration

2011-01-28T16:18:11Z

Rkahn: /* Rendering Link Builder Data */

== Site Configuration ==
* Make sure the ADF is setup and running on the site. If the ADF is not setup, then follow the instructions for ADF [[Installation]].
* Open the sites 'ADF.cfc' ([[Site Configuration (ADF.cfc) | See Site Configuration (ADF.cfc) for more info]]) file in a text editor. Locate the ''Load the ADF Application into application space'' comment in the file. Add the following command under the comment section:
<source lang="java">
loadApp("ptLinkBuilder");
</source>
* [[Reset ADF|Reset the ADF]] for the server and site.

== Element Import ==
* Import the Link-Builder-Data-Custom-Element.zip

== Custom Field Type Import ==
* Navigate to the CommonSpot administrator and open the Manage Custom Field Types dialog.
* Import the Link Builder custom field type (link_builder/Link-Builder-Custom-Field-Type.zip).
* Edit the properties and check the explicit module paths. If the paths are not correct for unlock the field type and edit the explicit paths to use “/ADF/extensions/…”.

== Page Creation ==
* Create a new page called “Link Builder Act ions” from the Blank Template.
* Insert a Custom Script module onto the page.
* Edit the Custom Script module and enter the explicit path:
** /ADF/extensions/customfields/link_builder/link_builder_actions.cfm
* Publish this page.

== Implementing the Link Builder Custom Field ==
* When implementing the link builder field, the properties need to be setup for the field in the custom element.
* Locate the link builder field in the custom element and edit the field.
* Open the Properties and enter the URL to the Link Builder Actions page that was created.

== Rendering Link Builder Data ==
# In the render handler for the element containing the link builder field, this code is required to return the data from the Link Builder Data custom element.
# Add the following code into your render handler when looping over the render handler data array:
## // Get the Link Builder Data for the UUID's
## linkDataArray = application.ADF.ceData.getCEData("Link Builder Data", "uuid", items[i].Values.LINKS);
### Where “items[i].Values.LINKS” is the link builder field in the custom element.

[[Category:Blogs]]

PT Link Builder Configuration

2011-01-28T16:17:49Z

Rkahn:

== Site Configuration ==
* Make sure the ADF is setup and running on the site. If the ADF is not setup, then follow the instructions for ADF [[Installation]].
* Open the sites 'ADF.cfc' ([[Site Configuration (ADF.cfc) | See Site Configuration (ADF.cfc) for more info]]) file in a text editor. Locate the ''Load the ADF Application into application space'' comment in the file. Add the following command under the comment section:
<source lang="java">
loadApp("ptLinkBuilder");
</source>
* [[Reset ADF|Reset the ADF]] for the server and site.

== Element Import ==
* Import the Link-Builder-Data-Custom-Element.zip

== Custom Field Type Import ==
* Navigate to the CommonSpot administrator and open the Manage Custom Field Types dialog.
* Import the Link Builder custom field type (link_builder/Link-Builder-Custom-Field-Type.zip).
* Edit the properties and check the explicit module paths. If the paths are not correct for unlock the field type and edit the explicit paths to use “/ADF/extensions/…”.

== Page Creation ==
* Create a new page called “Link Builder Act ions” from the Blank Template.
* Insert a Custom Script module onto the page.
* Edit the Custom Script module and enter the explicit path:
** /ADF/extensions/customfields/link_builder/link_builder_actions.cfm
* Publish this page.

== Implementing the Link Builder Custom Field ==
* When implementing the link builder field, the properties need to be setup for the field in the custom element.
* Locate the link builder field in the custom element and edit the field.
* Open the Properties and enter the URL to the Link Builder Actions page that was created.

== Rendering Link Builder Data ==
# In the render handler for the element containing the link builder field, this code is required to return the data from the Link Builder Data custom element.
# Add the following code into your render handler when looping over the render handler data array:
## // Get the Link Builder Data for the UUID's
## linkDataArray = application.articleEditor.ceData.getCEData("Link Builder Data", "uuid", items[i].Values.LINKS);
### Where “items[i].Values.LINKS” is the link builder field in the custom element.

[[Category:Blogs]]

PT Link Builder Configuration

2011-01-28T16:12:45Z

Rkahn:

== Site Configuration ==
* Make sure the ADF is setup and running on the site. If the ADF is not setup, then follow the instructions for ADF [[Installation]].
* Open the sites 'ADF.cfc' ([[Site Configuration (ADF.cfc) | See Site Configuration (ADF.cfc) for more info]]) file in a text editor. Locate the ''Load the ADF Application into application space'' comment in the file. Add the following command under the comment section:
<source lang="java">
loadApp("ptLinkBuilder");
</source>
* [[Reset ADF|Reset the ADF]] for the server and site.

== Element Import ==
* Import the Link-Builder-Data-Custom-Element.zip

== Custom Field Type Import ==
* Navigate to the CommonSpot administrator and open the Manage Custom Field Types dialog.
* Import the Link Builder custom field type (link_builder/Link-Builder-Custom-Field-Type.zip).
* Edit the properties and check the explicit module paths. If the paths are not correct for unlock the field type and edit the explicit paths to use “/ADF/extensions/…”.

== Page Creation ==
* Create a new page called “Link Builder Act ions” from the Blank Template.
* Insert a Custom Script module onto the page.
* Edit the Custom Script module and enter the explicit path:
** /ADF/extensions/customfields/link_builder/link_builder_actions.cfm
* Publish this page.

== Implementing the Link Builder Custom Field ==
* When implementing the link builder field, the properties need to be setup for the field in the custom element.
* Locate the link builder field in the custom element and edit the field.
* Open the Properties and enter the URL to the Link Builder Actions page that was created.

[[Category:Blogs]]

PT Link Builder Configuration

2011-01-28T16:11:23Z

Rkahn:

PT Link Builder Configuration

2011-01-28T16:08:53Z

Rkahn:

PT Link Builder Configuration

2011-01-28T16:01:22Z

PT Link Builder

2011-01-28T15:59:01Z

Rkahn:

== Overview ==
The ADF Link Builder Application is built in the [[Overview|Application Development Framework (ADF)]].

This application provides the ability to add and manage links pointing to both commonspot pages and external links.

== Requirements ==
ADF Version 1.5

ADF must be configured correctly for your site. [[Site Configuration (ADF.cfc)]] has instructions for configuration.

== Pre-installation Considerations ==
[[Overview|Application Development Framework (ADF)]] must be setup and configured on the server for the site. For detailed instructions, see the [[Overview|Application Development Framework (ADF)]] wiki page for Site Configurations.

== Installation/Setup ==
Each of the following steps should be completed fully and in the order presented:

# [[PT_Link_Builder_Extract|Extract Application]]
# [[PT_Link_Builder_Configuration|Configuration]]

== Getting Started ==
* [[PT_Link_Builder_Getting_Started|Getting Started]] - Guide to work with the Link Builder.

== Link Builder Data Element ==

<table id="ce-fields">
<tr class="header">
<td>Field Name/Label</td>
<td>Field ID</td>
<td>Field Type</td>
<td>Required?</td>
<td>Properties</td>
</tr>

<tr>
<td>uuid</td>
<td>uuid</td>
<td>hidden</td>
<td>No</td>
<td>
Defaultvalue: request.params.linkBuilderUUID<br/>

</td>
</tr>

<tr>
<td>Link Title</td>
<td>title</td>
<td>formatted_text_block</td>
<td>No</td>
<td>
Height: 200<br/>
Width: 250<br/>

</td>
</tr>

<tr>
<td>Page</td>
<td>csPage</td>
<td>cs_url</td>
<td>No</td>
<td>

</td>
</tr>

<tr>
<td>URL</td>
<td>extPage</td>
<td>url</td>
<td>No</td>
<td>
Maxlength: 255<br/>
Size: 40<br/>

</td>
</tr>

<tr>
<td>New Window?</td>
<td>newWindow</td>
<td>checkbox</td>
<td>No</td>
<td>
Value: 1<br/>

</td>
</tr>

<tr>
<td>Height</td>
<td>newWinHeight</td>
<td>text</td>
<td>No</td>
<td>
Maxlength: 5<br/>
Size: 5<br/>

</td>
</tr>

<tr>
<td>Width</td>
<td>newWinWidth</td>
<td>text</td>
<td>No</td>
<td>
Maxlength: 5<br/>
Size: 5<br/>

</td>
</tr>

</table>

[[Category:Project]]
[[Category:Link Builder]]

PT Link Builder

2011-01-28T15:58:34Z

Rkahn: /* Link Builder Data */