You've written an App, but now you need to register it with Eloqua! Before you can start sharing your App with Eloqua users, you'll need to register as a Provider of Apps in your Eloqua development instance, and register each App you create along with any associated Services. You can also test your Apps within your instance to make sure they work as expected. When you register as a Provider, your Eloqua instance stores the public information about your company so that users can contact you about your Apps.
Step 1: Register as a Provider
To register as a Provider, log in to your Eloqua instance, and navigate to the Setup menu, then choose AppCloud Developer.
Then, click Create a Provider, which brings you to the AppCloud Developer "Edit Provider Details" page.
Fill out your company's information:
- id: your unique Provider id. This is the only field you cannotedit once you click Save. You will be prompted to choose an alternate id if the one you provide already exists.
- Icon URL: the URL of the icon Eloqua should display with your Provider information. You might want to use your company logo.
- Name: your Provider name. You might want to use your company name.
- Website URL: your company website.
- Support email address: the email address users should use to contact you if there are issues with your app.
- Support phone number: the phone number where you can be contacted if there are problems with your app.
Click Save, and you're all set up as a provider! You can easily edit this information by selecting the Provider tab within the AppCloud Developer section of Eloqua, and clicking Edit.
Step 2: Register Your App
You're more than half way there: you've registered as a provider and developed an app, but you still need to tell Eloqua where to find it and what it does.
To register your app, select the Apps tab in the AppCloud Developer section of Eloqua
If you have not yet registered any Apps, you will see a "No apps have been defined" message, and the "Create new App" button. If you have already registered an App, it will be listed, alongside the "Create new App" button. To register your App, click Create new App.
The Create App screen prompts you to fill in a number of fields that describe your App: the App's name and description, URL of its icon, etc.:
Details
These fields are general information about your App.
- Icon URL:
- Name:
- Description:
- Short Description:
Lifecycle
The Lifecycle fields
- Enable URL: the URL called when the App is first installed or when it is reconfigured
- Status URL: the URL called to check the App's status. See: How To: Respond when Eloqua calls out to check the status of your App for more about calls to the Status URL.
OAuth
Apps for the AppCloud™ use OAuth for authentication. For more information about configuring OAuth, see: OAuth and Eloqua.
- Client ID (App id): Eloqua creates and assigns the App ID when you save your App.
- Client Secret: Eloqua generates the secret access token when you save your App. Click Show to view it.
- Callback URL: the URL that the users should be redirected to after installing the app and authenticating with Eloqua.
When you've filled in all fields, click Save, and your App will be listed on the Apps tab of the AppCloud Developer area and on the AppCloud Developer landing page.
Step 3: Add Services (if your App has services)
Finally, you should register any services your app uses. The AppCloud Developer Platform currently supports five services: AppCloud Menu, Firehose, AppCloud Content, AppCloud Actions, and AppCloud Decisions.
Apps can include zero services, as in the case of a a portal app, or integration not directly tied to one of the service types, for instance, or many services. If you are implementing services as part of your app, you need to define them within Eloqua by clicking Add Services on the App Details page.
A modal window opens listing the types of services Eloqua currently supports: select the service type you've implemented.
Then, fill out the service's details: you will have different information you need to supply depending on the service you are implementing. For an AppCloud Menu, you need to provide the Action URL, specify the areas it supports and how Eloqua should present it, and provide the service's icon URL, name, and description. For AppCloud Content, you will need to fill out instance configuration details, as well as configure content and notification settings, as well as the general service details. The following documents describe the service configuration page for each service type:
When you are done configuring your service, click Save. A green alert message will appear at the top of the page indicating the Service has been successfully saved.
Step 4: View your App!
You can view the App information by clicking its name in the list, in this example AppCloud Docs Example App, which brings up the App Details page.
The App Page shows all of the App information, including Services, and now includes Publish and Catalog sections, which are used to grant access to the App. When you register an App, it immediately becomes available in your instance of Eloqua so you can test it before releasing it to any other prospective users. When you're ready to release your App, or just to share it with a select few, check out the App installation tutorial.