PT Sync CCAPI Configuration - Revision history

Mcarroll: /* Setup */

2011-10-10T18:23:39Z

‎Setup

Mcarroll: /* Setup */

2011-08-21T15:59:13Z

‎Setup

Mcarroll at 14:16, 21 August 2011

2011-08-21T14:16:26Z

Mcarroll: Created page with '== Overview == The PT Sync Application uses the ADF CCAPI to populate custom element records on the destination site. The CCAPI needs to be configured for the source a…'

2011-08-21T13:24:29Z

Created page with '== Overview == The PT Sync Application uses the ADF CCAPI to populate custom element records on the destination site. The CCAPI needs to be configured for the source a…'

New page

== Overview ==
The PT Sync Application uses the [[CCAPI|ADF CCAPI]] to populate custom element records on the destination site. The CCAPI needs to be configured for the source and destination site.

First, follow the steps to set up the [[CCAPI Config|CCAPI Config]] file for the site. Once that configuration is complete, follow the steps below to set up the CCAPI config for the PT Sync application. Make sure to update the ''wsVars'' section with the correct URLs and username/password.

== Setup ==
# Create a new page called 'ccapi'. Recommend creating this page in the root subsite.
# Add the 'Photo' element to the page.
# Select the 'Photo' element indicator and go to 'more...'. Select 'Name' from the menu.
# In the Element Name field, enter the text 'ccapiPhotoElement'.
# Publish this page and view in read mode.
# Edit the 'ccapi.xml' file for the site and add the following xml block into the <elements> section:
<source lang="xml">
<Photo>
<pageID>#####</pageID>
<subsiteID>##</subsiteID>
<elementType>custom</elementType>
<controlName>ccapiPhotoElement</controlName>
</Photo>
</source>

To populate the <pageID> and <subsiteID> tags, view the source code for the 'ccapiPhoto' page that was just created.

Identify the following line in the source code and enter this numeric value into the <subsiteID> tag:
<source lang="java">
var jsSubSiteID = ##;
</source>

Identify the following line in the source code and enter this numeric value into the <pageID> tag:
<source lang="java">
var jsPageID = ####;
</source>

[[Reset ADF|Reset the ADF]] for the server and site.

[[Category:Photo Gallery]]

@@ Line 21: / Line 21: @@
 </Sync_Test_Element>
 </source>
-# '''The tag name must match the custom element name with replacing spaces with underscores.''' In this example, the custom element name is "Sync Test Element", therefore the tag name will be "Sync_Test_Element".
+# '''The tag name must match the custom element name with replacing spaces with underscores and delete special any non-alphanumeric characters.''' In this example, the custom element name is "Sync Test Element", therefore the tag name will be "Sync_Test_Element".  Another example is the custom element name "Sync Test Element (Again)", needs to be "Sync_Test_Element_Again" in the config.
 To populate the <pageID> and <subsiteID> tags, view the source code for the 'ccapi' page that was just created.

@@ Line 8: / Line 8: @@
 == Setup ==
 # Create a new page called 'ccapi'. Recommend creating this page in the root subsite.  This page may already exist if you have installed other ADF apps.
-# Add the 'Sync Test' element to the page.
+# Add the 'Sync Test Element' element to the page.
-# Select the 'Sync Test' element indicator and go to 'more...'.  Select 'Name' from the menu.
+# Select the 'Sync Test Element' element indicator and go to 'more...'.  Select 'Name' from the menu.
 # In the Element Name field, enter the text 'ccapiSyncTest'.
 # Publish this page and view in read mode.
 # Edit the 'ccapi.xml' file for the site and add the following xml block into the <elements> section:
 <source lang="xml">
-<Sync-Test>
+<Sync_Test_Element>
    <pageID>1000</pageID>
    <subsiteID>1</subsiteID>
    <elementType>custom</elementType>
    <controlName>ccapiSyncTest</controlName>
-</Sync-Test>
+</Sync_Test_Element>
 </source>
-# '''The tag name must match the custom element name with replacing spaces with hyphens.''' In this example, the custom element name is "Sync Test", therefore the tag name will be "Sync-Test".
+# '''The tag name must match the custom element name with replacing spaces with underscores.''' In this example, the custom element name is "Sync Test Element", therefore the tag name will be "Sync_Test_Element".
 To populate the <pageID> and <subsiteID> tags, view the source code for the 'ccapi' page that was just created.