A Cloud Component Provider must expose a series of endpoints that the Eloqua Cloud Components framework calls out to.  One of these endpoints is called "configurationUrl".

 

The configurationUrl endpoint points to the configuration page for the component from the external or "cloud" system.

 

(Note: Although referred to as an "Endpoint", the configurationUrl is simply a url in your provider's service definition, that points to the configuration page for the component.)

 

Here is an example of what a configurationUrl in the Provider could look like:

 

https://mycompany.com/ccpservice/components/configure/myComponentConfig.aspx?{Id}

 

Now, Let's look at how this is used by the Cloud Component framework.

 

CCPframework-configurationUrl.png

 

When a marketer double-clicks on a Cloud Component in the Eloqua Landing Page editor, the configurationUrl endpoint is called.  When the endpoint is called:

  1. A GUID is passed though the parameter “{Id}” along with the call.  The provider must be able to accept this GUID, and use it to render the configuration page for the given component.
  2. The framework then displays the page to the marketer for configuration.

 

The Configuration page is used to gather information required by your component.  This information could be credentials to external systems, dimensions and styling, or Eloqua API credentials if using personalization features.  This Configuration information is then stored in the Provider's data store.

 

Now the component has been configured, it's time to preview it.