Installation Guide for the Plumtree Enterprise Development Kit (EDK) 5.3 .NET

This page provides information on EDK installation and deployment. For additional documentation and related resources, see the index.

EDK Installation

Before installing the EDK, confirm that your system meets the requirements listed in the Release Notes. Extra steps are required to support the Logging API, explained below.

Extract the edk_dotnet.zip file into the root Plumtree folder, typically C:\Program Files\plumtree. The following subfolders will be created in the \ptedk folder:

- \devkit includes the asmx files, Web.config, and dlls required to build Web Applications. Create the Web Application or Web Service using Visual Studio.NET. Click Add Reference to include edk.dll and the other EDK assemblies. For portlets and services, click Add Existing Item to add Web.config. For services you will also need to include the asmx files; see Deployment below for detailed instructions.
- \documentation includes the API documentation (NDocs). For the latest EDK API documentation, see the Plumtree Developer Center.

Note: To support APIs that use binary upload or download (for example, Plumtree.Remote.Prc.Collaboration.Document.IDocumentManager.InsertNewDocument), you must install WSE 2.0 (http://msdn.microsoft.com/webservices/building/wse/).

EDK Upgrade

Upgrading your EDK version allows your application to take advantage of new APIs. See the Logging API section to learn about upgrading your existing EDK-based applications to take advantage of Plumtree's logging framework.

EDK 5.2 and above include different dependencies than previous releases. Copying the new edk.dll will not result in a full installation. Make sure to copy the files located in the /bin folder and overwrite your existing EDK assemblies to add new dependencies and updated versions of old dependencies.

Logging API (Plumtree Logging Toolkit)

EDK 5.2 and above includes a remote logging API for use with Plumtree Logging Utilities. To support this feature, you must download and install the Plumtree Logging Utilities package from the Plumtree Developer Center.

To enable logging in the EDK when run as a Web application, edit the Web.config file provided with the .NET EDK distribution. Look for the following settings at the end of the <appSettings> block.

> <add key="ptedk.LoggingApplicationName" value="" />
> <add key="ptedk.LogToNetwork" value="false" />
> <add key="ptedk.VerboseLogging" value="false" />

- EDK logging is disabled if the value of ptedk.LoggingApplicationName is empty or the key is absent. To enable sending log messages, set its value to a string of 1-32 characters (ASCII letters and numbers plus space, hyphen, underscore, and period). To receive log messages, use this same value to configure the Plumtree Logger or Plumtree Logging Spy from the Plumtree Logging Utilities. (For details, see Configuring Logging Receivers on the Developer Center.)
- If ptedk.LogToNetwork is left at its default "false" value, only log receivers running on the same machine as the EDK will be able to receive log messages. Set this to "true" to pick up logs on the local network.
- If ptedk.VerboseLogging is left at its default "false" value, the Portlet API and Integration Web Services (Authentication, Crawler, Profile, and Search) will provide tracing of remote method calls and exceptions but will not log parameters and return values. Set it to "true" to log parameters and return values of remote method calls.

If you are upgrading and wish to use your existing Web.config file, insert the three configuration lines above before the closing </appSettings> tag in Web.config and set their values as appropriate.

To activate logging outside a Web application context, refer to the API documentation for the Plumtree.Remote.Logging namespace.

Deployment

Follow the steps below to deploy the .NET version of the EDK by setting up the EDK in your development environment (VisualStudio.NET).

1. Start Visual Studio and click File | New Project | Visual Basic Projects | ASP.NET Web Service. Type an intuitive name in the Location field (for example, dotnetauthsample). Make a note of the name; you will need it later.
2. Delete Service1.asmx.
3. In the new project, click File | Add Existing Item.
4. Browse to the <installdir>\ptedk\<version #>\devkit folder in the EDK installation directory.
5. In the File Types mask, click All Files.
6. Select all the *.asmx files and Web.config. Do not select the \bin directory.
7. Click Open. You will be prompted to create a class file for each .asmx file; click No for each file.
8. Add the EDK assemblies:
   1. In the Solution Explorer (usually in the upper right), you should see the project you created in Step 1 (for example, dotnetauthsample).
   2. Right-click References and click Add Reference.
   3. Browse to the \ptedk\<version#>\devkit\bin folder in the EDK installation directory.
   4. Select all the .dll files (Ctrl+A). These are the assemblies that resolve the references in the *.asmx files.
   5. Click Open | OK.
   6. In the Solution Explorer References, you should now see dotnetauthimpl, dotnetcrawlerimpl, and so forth.
9. Click File | Add New Item.
10. Select Class and enter the name of the class (that is, AuthSample), and click Open.
11. Add the correct Imports statement to the top of the class file. For example, for an authentication service:
    Imports Plumtree.Remote.Auth
    Imports Plumtree.Remote.Util
    // On the line following the class name, add the Implements statement:
    Public Class AuthSample
    Implements IAuthProvider, ISyncProvider, Igroup
    // ...
    End Class
12. View the Visual Studio Task List (View | Other Windows | Task List) to determine what needs to be implemented for the class. For each item in the Task List, add the corresponding routine to your class.
13. Build your project.

After you have completed the steps above, Visual Studio is set up for development against the .NET EDK. For details on deploying services, see Deploying EDK Services on the Developer Center. For links to additional documentation and related resources, see the index.