Difference between revisions of "PT Import Content CCAPI Configuration"

From ADF Docs
Jump to: navigation, search
(Created page with '== Overview == The PT Import Content Application uses the ADF CCAPI to populate custom elements and text blocks, and create subsites and pages. The CCAPI needs to be c…')
 
Line 2: Line 2:
 
The PT Import Content Application uses the [[CCAPI|ADF CCAPI]] to populate custom elements and text blocks, and create subsites and pages.  The CCAPI needs to be configured for the site and PT Import Content application.
 
The PT Import Content Application uses the [[CCAPI|ADF CCAPI]] to populate custom elements and text blocks, and create subsites and pages.  The CCAPI needs to be configured for the site and PT Import Content application.
  
−
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 Photo Gallery application.  Make sure to update the ''wsVars'' section with the correct URLs and username/password.
+
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 Import Content application.  Make sure to update the ''wsVars'' section with the correct URLs and username/password.
  
−
== Setup ==
+
== Subsite Mapping ==
−
# Create a new page called 'ccapiPhoto'. Recommend creating this page in the ''/webadmin/photogallery/'' subsite.  
+
# Create a new page called 'ccapi'. Recommend creating this page in the root of the site.  
−
# Add the 'Photo' element to the page.
+
# Add the 'Subsite Mapping' element to the page.
−
# Select the 'Photo' element indicator and go to 'more...'.  Select 'Name' from the menu.
+
# Select the 'Subsite Mapping' element indicator and go to 'more...'.  Select 'Name' from the menu.
−
# In the Element Name field, enter the text 'ccapiPhotoElement'.
+
# In the Element Name field, enter the text 'subsiteMapElement'.
 
# Publish this page and view in read mode.
 
# 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:
+
# Edit the 'ccapi.cfm' file for the site and add the following xml block into the <elements> section:
 
<source lang="xml">
 
<source lang="xml">
−
<Photo>
+
<subsiteMap>
 
   <pageID>#####</pageID>
 
   <pageID>#####</pageID>
 
   <subsiteID>##</subsiteID>
 
   <subsiteID>##</subsiteID>
 
   <elementType>custom</elementType>
 
   <elementType>custom</elementType>
−
   <controlName>ccapiPhotoElement</controlName>
+
   <controlName>subsiteMapElement</controlName>
−
</Photo>
+
</subsiteMap>
 
</source>
 
</source>
  
−
To populate the <pageID> and <subsiteID> tags, view the source code for the 'ccapiPhoto' page that was just created.  
+
== Page Mapping ==
 +
# On the 'ccapi' page created, add the 'Page Mapping' element to the page.
 +
# Select the 'Page Mapping' element indicator and go to 'more...'.  Select 'Name' from the menu.
 +
# In the Element Name field, enter the text 'pageMapElement'.
 +
# Publish this page and view in read mode.
 +
# Edit the 'ccapi.cfm' file for the site and add the following xml block into the <elements> section:
 +
<source lang="xml">
 +
<pageMap>
 +
  <pageID>#####</pageID>
 +
  <subsiteID>##</subsiteID>
 +
  <elementType>custom</elementType>
 +
  <controlName>pageMapElement</controlName>
 +
</pageMap>
 +
</source>
 +
 
 +
== Document Mapping ==
 +
# On the 'ccapi' page created, add the 'Document Mapping' element to the page.
 +
# Select the 'Document Mapping' element indicator and go to 'more...'.  Select 'Name' from the menu.
 +
# In the Element Name field, enter the text 'documentMapElement'.
 +
# Publish this page and view in read mode.
 +
# Edit the 'ccapi.cfm' file for the site and add the following xml block into the <elements> section:
 +
<source lang="xml">
 +
<documentMap>
 +
  <pageID>#####</pageID>
 +
  <subsiteID>##</subsiteID>
 +
  <elementType>custom</elementType>
 +
  <controlName>documentMapElement</controlName>
 +
</documentMap>
 +
</source>
 +
 
 +
== Image Mapping ==
 +
# On the 'ccapi' page created, add the 'Image Mapping' element to the page.
 +
# Select the 'Image Mapping' element indicator and go to 'more...'.  Select 'Name' from the menu.
 +
# In the Element Name field, enter the text 'imageMapElement'.
 +
# Publish this page and view in read mode.
 +
# Edit the 'ccapi.cfm' file for the site and add the following xml block into the <elements> section:
 +
<source lang="xml">
 +
<imageMap>
 +
  <pageID>#####</pageID>
 +
  <subsiteID>##</subsiteID>
 +
  <elementType>custom</elementType>
 +
  <controlName>imageMapElement</controlName>
 +
</imageMap>
 +
</source>
 +
 
 +
== Image Mapping ==
 +
# On the 'ccapi' page created, add the 'Image Mapping' element to the page.
 +
# Select the 'Image Mapping' element indicator and go to 'more...'.  Select 'Name' from the menu.
 +
# In the Element Name field, enter the text 'imageMapElement'.
 +
# Publish this page and view in read mode.
 +
# Edit the 'ccapi.cfm' file for the site and add the following xml block into the <elements> section:
 +
<source lang="xml">
 +
<imageMap>
 +
  <pageID>#####</pageID>
 +
  <subsiteID>##</subsiteID>
 +
  <elementType>custom</elementType>
 +
  <controlName>imageMapElement</controlName>
 +
</imageMap>
 +
</source>
 +
 
 +
== Import Job ==
 +
# On the 'ccapi' page created, add the 'Import Job' element to the page.
 +
# Select the 'Import Job' element indicator and go to 'more...'.  Select 'Name' from the menu.
 +
# In the Element Name field, enter the text 'ccapiImportJob'.
 +
# Publish this page and view in read mode.
 +
# Edit the 'ccapi.cfm' file for the site and add the following xml block into the <elements> section:
 +
<source lang="xml">
 +
<importJob>
 +
  <pageID>#####</pageID>
 +
  <subsiteID>##</subsiteID>
 +
  <elementType>custom</elementType>
 +
  <controlName>ccapiImportJob</controlName>
 +
</importJob>
 +
</source>
 +
 
 +
== Page ID and Subsite ID ==
 +
To populate the <pageID> and <subsiteID> tags, view the source code for the 'ccapi' page that was just created.  
 
   
 
   
 
Identify the following line in the source code and enter this numeric value into the <subsiteID> tag:
 
Identify the following line in the source code and enter this numeric value into the <subsiteID> tag:
Line 34: Line 110:
 
[[Reset ADF|Reset the ADF]] for the server and site.
 
[[Reset ADF|Reset the ADF]] for the server and site.
  
−
[[Category:Photo Gallery]]
+
[[Category:PT Import Content]]

Revision as of 12:13, 31 March 2011

Overview

The PT Import Content Application uses the ADF CCAPI to populate custom elements and text blocks, and create subsites and pages. The CCAPI needs to be configured for the site and PT Import Content application.

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

Subsite Mapping

  1. Create a new page called 'ccapi'. Recommend creating this page in the root of the site.
  2. Add the 'Subsite Mapping' element to the page.
  3. Select the 'Subsite Mapping' element indicator and go to 'more...'. Select 'Name' from the menu.
  4. In the Element Name field, enter the text 'subsiteMapElement'.
  5. Publish this page and view in read mode.
  6. Edit the 'ccapi.cfm' file for the site and add the following xml block into the <elements> section:
<subsiteMap>
  <pageID>#####</pageID>
  <subsiteID>##</subsiteID>
  <elementType>custom</elementType>
  <controlName>subsiteMapElement</controlName>
</subsiteMap>

Page Mapping

  1. On the 'ccapi' page created, add the 'Page Mapping' element to the page.
  2. Select the 'Page Mapping' element indicator and go to 'more...'. Select 'Name' from the menu.
  3. In the Element Name field, enter the text 'pageMapElement'.
  4. Publish this page and view in read mode.
  5. Edit the 'ccapi.cfm' file for the site and add the following xml block into the <elements> section:
<pageMap>
  <pageID>#####</pageID>
  <subsiteID>##</subsiteID>
  <elementType>custom</elementType>
  <controlName>pageMapElement</controlName>
</pageMap>

Document Mapping

  1. On the 'ccapi' page created, add the 'Document Mapping' element to the page.
  2. Select the 'Document Mapping' element indicator and go to 'more...'. Select 'Name' from the menu.
  3. In the Element Name field, enter the text 'documentMapElement'.
  4. Publish this page and view in read mode.
  5. Edit the 'ccapi.cfm' file for the site and add the following xml block into the <elements> section:
<documentMap>
  <pageID>#####</pageID>
  <subsiteID>##</subsiteID>
  <elementType>custom</elementType>
  <controlName>documentMapElement</controlName>
</documentMap>

Image Mapping

  1. On the 'ccapi' page created, add the 'Image Mapping' element to the page.
  2. Select the 'Image Mapping' element indicator and go to 'more...'. Select 'Name' from the menu.
  3. In the Element Name field, enter the text 'imageMapElement'.
  4. Publish this page and view in read mode.
  5. Edit the 'ccapi.cfm' file for the site and add the following xml block into the <elements> section:
<imageMap>
  <pageID>#####</pageID>
  <subsiteID>##</subsiteID>
  <elementType>custom</elementType>
  <controlName>imageMapElement</controlName>
</imageMap>

Image Mapping

  1. On the 'ccapi' page created, add the 'Image Mapping' element to the page.
  2. Select the 'Image Mapping' element indicator and go to 'more...'. Select 'Name' from the menu.
  3. In the Element Name field, enter the text 'imageMapElement'.
  4. Publish this page and view in read mode.
  5. Edit the 'ccapi.cfm' file for the site and add the following xml block into the <elements> section:
<imageMap>
  <pageID>#####</pageID>
  <subsiteID>##</subsiteID>
  <elementType>custom</elementType>
  <controlName>imageMapElement</controlName>
</imageMap>

Import Job

  1. On the 'ccapi' page created, add the 'Import Job' element to the page.
  2. Select the 'Import Job' element indicator and go to 'more...'. Select 'Name' from the menu.
  3. In the Element Name field, enter the text 'ccapiImportJob'.
  4. Publish this page and view in read mode.
  5. Edit the 'ccapi.cfm' file for the site and add the following xml block into the <elements> section:
<importJob>
  <pageID>#####</pageID>
  <subsiteID>##</subsiteID>
  <elementType>custom</elementType>
  <controlName>ccapiImportJob</controlName>
</importJob>

Page ID and Subsite ID

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

Identify the following line in the source code and enter this numeric value into the <subsiteID> tag: 

var jsSubSiteID = ##;

Identify the following line in the source code and enter this numeric value into the <pageID> tag: 

var jsPageID = ####;

Reset the ADF for the server and site.

Retrieved from "http://community.paperthin.com/adf-docs/index.php?title=PT_Import_Content_CCAPI_Configuration&oldid=4675"