Difference between revisions of "CCAPI Conduit Page Pool"

From ADF Docs
Jump to: navigation, search
(→‎Setup the CCAPI Conduit Page Pool)
Line 5: Line 5:
 
The new CCAPI API Conduit Page Pool is made up of a group of multiple pages.  These Conduit Pages no longer need to be configured with “Named” Elements. The are just blank Conduit Pages whose CommonSpot Page IDs are added to the “Pool”. When simultaneous ADF wrappered CCAPI calls are made these pages are requested, used and then released back into the pool in a round-robin fashion and are not specific to any specific App or Global Custom Element.
 
The new CCAPI API Conduit Page Pool is made up of a group of multiple pages.  These Conduit Pages no longer need to be configured with “Named” Elements. The are just blank Conduit Pages whose CommonSpot Page IDs are added to the “Pool”. When simultaneous ADF wrappered CCAPI calls are made these pages are requested, used and then released back into the pool in a round-robin fashion and are not specific to any specific App or Global Custom Element.
  
−
=Setup the CCAPI Conduit Page Pool=
+
 
 +
== Setup the CCAPI Conduit Page Pool ==
 +
 
Create multiple pages in a subsite in your site to be used as the CCAPI Conduit Page Pool. You can have just one page in your pool but we recommend starting with around 3 to 5 pages. More pages can be added to your Conduit Page Pool as needed.
 
Create multiple pages in a subsite in your site to be used as the CCAPI Conduit Page Pool. You can have just one page in your pool but we recommend starting with around 3 to 5 pages. More pages can be added to your Conduit Page Pool as needed.
 +
 +
#Create a subsite for your Conduit Page Pool
 +
##For this example we will create a subsite in the “webadmin” subsite called: “ccapi-page-pool”
 +
##Only contributor users can access our “webadmin” subsite so our new subsite will inherit those permissions.
 +
#Create one new CommonSpot Page in the “ccapi-page-pool” Subsite using the “Blank Layout Template”.
 +
##For this example we will create a page called “ccapiPoolPage1”.
 +
##Also, disable the “Include in: Page Indexes and Full Text and Search Element Results” options in this new page’s “Standard Properties”.
 +
#Activate the new “ccapiPoolPage1” page.
 +
#Find and Record the page ID of the new CommonSpot Page, we will need this value later.
 +
#Copy this newly created page and repeat steps 2-4 for the number of Conduit Pages desired.
 +
##Remember to give each new page a unique name.
 +
##For this example we incremented each new page name with a number by one:
 +
ccapiPoolPage2, ccapiPoolPage3, etc.
 +
 +
Remember:
 +
#These pages must be “Activated”.
 +
#You must exit out of “Edit Mode” for each page in the pool.
 +
#Using the Out-of-the Box CommonSpot “Blank Layout Template” will help to enhance the performance of CCAPI populateCustomElement calls.
 +
#Pages that contain Local Custom Elements CAN NOT be configured to use the CCAPI Conduit Page Pool

Revision as of 00:58, 13 October 2014

New functionality for the ADF 1.8.0 release has been added to enhance the performance of creating and updating Global Custom Element records via the CCAPI. These enhancements will also help streamline the manual CCAPI setup and configuration when using ADF library methods to programmatically populate Global Custom Elements.

Traditionally, when using the CCAPI to populate the Global Custom Elements, each element would be placed on a single “CCAPI Conduit Page” or in some cases one “CCAPI Conduit Page” would be created for each installed ADF App. This single page (or set of pages) would all use a single CommonSpot user. Also, each element placed on these pages would need to be manually assigned a unique “Name” (a Named Element Instance) via the CommonSpot UI. When simultaneous CCAPI requests were made by multiple users these requests would need to “stand in line” and wait while each request was processed in order.

The new CCAPI API Conduit Page Pool is made up of a group of multiple pages. These Conduit Pages no longer need to be configured with “Named” Elements. The are just blank Conduit Pages whose CommonSpot Page IDs are added to the “Pool”. When simultaneous ADF wrappered CCAPI calls are made these pages are requested, used and then released back into the pool in a round-robin fashion and are not specific to any specific App or Global Custom Element.


Setup the CCAPI Conduit Page Pool

Create multiple pages in a subsite in your site to be used as the CCAPI Conduit Page Pool. You can have just one page in your pool but we recommend starting with around 3 to 5 pages. More pages can be added to your Conduit Page Pool as needed.

  1. Create a subsite for your Conduit Page Pool
    1. For this example we will create a subsite in the “webadmin” subsite called: “ccapi-page-pool”
    2. Only contributor users can access our “webadmin” subsite so our new subsite will inherit those permissions.
  2. Create one new CommonSpot Page in the “ccapi-page-pool” Subsite using the “Blank Layout Template”.
    1. For this example we will create a page called “ccapiPoolPage1”.
    2. Also, disable the “Include in: Page Indexes and Full Text and Search Element Results” options in this new page’s “Standard Properties”.
  3. Activate the new “ccapiPoolPage1” page.
  4. Find and Record the page ID of the new CommonSpot Page, we will need this value later.
  5. Copy this newly created page and repeat steps 2-4 for the number of Conduit Pages desired.
    1. Remember to give each new page a unique name.
    2. For this example we incremented each new page name with a number by one:

ccapiPoolPage2, ccapiPoolPage3, etc. 

Remember:
#These pages must be “Activated”.
#You must exit out of “Edit Mode” for each page in the pool.
#Using the Out-of-the Box CommonSpot “Blank Layout Template” will help to enhance the performance of CCAPI populateCustomElement calls.
#Pages that contain Local Custom Elements CAN NOT be configured to use the CCAPI Conduit Page Pool
Retrieved from "http://community.paperthin.com/adf-docs/index.php?title=CCAPI_Conduit_Page_Pool&oldid=6872"