The AquaLogic Interaction Development Kit (IDK), formerly the EDK, enables developers to rapidly build, deliver and improve user-centric composite applications through AquaLogic Interaction.
The IDK's portlet API allows portlets to access information and dynamic functionality from AquaLogic Interaction components. Integration Web Services APIs for authentication, profile, crawler, and search allow you to integrate resources from enterprise systems into AquaLogic Interaction. The IDK also provides SOAP-based remote APIs to expose portal, search, Collaboration, and Publisher features.
This page provides instructions for setting up and deploying a generic custom IDK project in Visual Studio, and discusses next steps for IDK development.
For an introduction to portlet development, see IDK Quickstart: Hello World Portlet and IDK Quickstart: Hello World Pagelet. For details on downloading and installing the IDK, see the IDK Product Documentation.
The steps below are for the Visual Studio .NET IDE.
Start Visual Studio and click File | New Project | C# Projects | ASP.NET Web Service. Type an intuitive name in the Location field.
Delete Service1.asmx and Web.config.
In the new project, click File | Add Existing Item.
Browse to the \idk\6.0\devkit folder in the IDK installation directory.
In the File Types mask, click All Files.
Select all the .asmx files and Web.config. Do not select the \bin directory.
Click Open. You will be prompted to create a class file for each .asmx file; click No for each file.
Add the IDK assemblies by following the steps below.
In the Solution Explorer (usually in the upper right), you should see the project you created in Step 1.
Right-click References and click Add Reference.
Browse to the \idk\6.0\devkit\bin folder in the IDK installation directory.
Select the assemblies to add to the bin directory:
If you are using the standard (un-signed) version of the IDK, select all the .dll files (Ctrl+A).
If you are using the signed dll version of the IDK, select only Plumtree.openlog-framework_signed.dll. (You must deploy the other assemblies in the GAC as described in step f below.)
Click Open | OK. In the Solution Explorer References, you should see the IDK assemblies.
If you are using the signed dll version of the IDK, deploy the following assemblies in the GAC:
Plumtree.EDK_signed.dll
OpenFoundation_signed.dll
Plumtree.openkernel_signed.dll
Plumtree.openlog-framework_signed.dll
Plumtree.pmb_signed.dll
Plumtree.RAT_signed.dll
Click File | Add New Item to create new classes and complete your project.
The IDK APIs and SCI require that you implement an interface and deploy your implementation so it can be accessed by the portal.
Note: These steps are for IDK (EDK) version 5.2 and above. Previous versions of the IDK used the Deploy Servlet to generate a server-config.wsdd file. For instructions, see the version 5 developer documentation. If you are using an old version of the server-config.wsdd file, the service endpoints below might be different.
After Visual Studio is set up for development against the .NET IDK as described above, follow the steps below to deploy new services.
Compile the class that implements the interface.
Content Services, Identity
Services and SCI pages require additional configuration. Update the web.config
file in your project: add the class and the assembly that contains it
to the appropriate *Assembly and *Impl keys. (See Impl
and Assembly Names below for a list of keys.)
For some services, the file must be updated in two places. For
example, for an Authentication Source, add your assembly to AuthProviderAssembly
and your class to AuthProviderImpl as shown below.
...
<appSettings>
<add key="AuthProviderAssembly" value="dotnetauthsample"
/>
<add key="AuthProviderImpl" value="dotnetauthsample.AuthSample"
/>
</appSettings>
...
Note: When you create a new project, Visual Studio sets the
Root namespace to the name of the project. This name is prepended
to any namespace you define in the project. The *Impl key in the
web.config file must reference the full namespace. (To view the Root namespace,
right-click the project name in Solution Explorer and click Properties. If
you clear the Root namespace field, the change will not be reflected until
the project is rebuilt.)
If you do not already have a virtual directory in IIS for your services, add one using the steps below:
Click Start | Settings | Control Panel | Administrative Tools | Internet Services Manager (Internet Information Services).
Select Default Web Site.
Click Action | New | Virtual Directory and type the name of your Visual Studio Location. Click Next twice. Type the path to the home directory for the IDK: <installdir>\idk\6.0\devkit\dotnet.
Check both the Read and Run Scripts checkboxes if they are cleared (they should be checked by default). Click Next, then click Finish.
Test the directory by
opening the following page in a Web browser: http://<server>/<virtualdir>/<servicetype>ProviderSoapBinding.asmx
For example, http://localhost/myedktest/AuthProviderSoapBinding.asmx. The
browser should display the following message: "The following operations
are supported." This is information about the SOAP binding.
Note: For Federated Search, use SearchService.asmx. For SCI,
use SCIProviderSoapBinding.asmx (XUIService.asmx is deprecated).
Copy the compiled class files to the \bin folder in the <installdir>\idk\6.0\devkit\dotnet directory.
See Next Steps at the bottom of this page for links to additional information and sample code.
To deploy a service, you must enter the qualified class name in the web.config file for your project. The list that follows provides the required *Impl and *Assembly parameters and associated service types.
*Impl
|
Service Type |
*Impl Parameters |
|
Authentication Source |
AuthProviderImpl |
|
Content Crawler |
ContainerProviderImpl |
|
Profile Source |
ProfileProviderImpl |
|
Federated Search |
SearchImpl |
|
Service Configuration Interface (SCI) |
SciImpl |
*Assembly
|
Service Type |
*Impl Parameters |
|
Authentication Source |
AuthProviderAssembly |
|
Content Crawler |
ContainerProviderAssembly |
|
Profile Source |
ProfileProviderAssembly |
|
Federated Search |
SearchProviderAssembly |
|
Service Configuration Interface (SCI) |
AdminEditorAssembly |
After you create a new service, you must configure it for use in the portal. Follow the directions below to configure a custom service in the portal.
Open the portal in a browser and navigate to the Administration folder where you want the new service to be stored.
Click Create Object... and choose the appropriate Web Service type from the menu.
On the Main Page of the Web Service Editor, enter the service provider URL(s) from Step 4 in the deployment instructions above. For SCI pages, enter the Service Configuration page URL(s) on the Advanced URLs page of the Web Service Editor. (URLs are relative to the Remote Server.)
For details on portal configuration settings, refer to the appropriate section (Portlets, Pagelets, Crawlers, Search Services, Authentication Services, or Profile Services) and see the portal online help.
For more information on creating web services, including sample code using the IDK, see one of the examples below.