Editing Document Properties in the Knowledge Directory Using IDK Remote APIs

To edit properties for existing documents in the ALI Knowledge Directory from a remote application, use the IDocumentManager interface in the IDK.

To edit an existing document, follow the steps below.

Create a session with the portal. For details, see Initiating a PRC Session to Use IDK Remote APIs.
Retrieve an IDocumentManager object by calling IRemoteSession.getDocumentManager.
Edit the document, as shown in the sample code below.

This example demonstrates how to edit the document name, title, description and last modified date for an existing Web Link document (HTML page).

Note: This example uses integers to set properties on the document, in contrast with the ObjectProperty parameters used to retrieve information about general objects. This is because document properties can contain custom properties defined in the portal, for which there are no standard ObjectProperty parameters. To retrieve property IDs to use for this API, use the standard object querying method with ObjectClass.Property, and use the ID on the object returned to query for the properties you need.

Java

public static void editWebLinkDocument(IDocumentManager documentManager, int documentID)
throws PortalException, RemoteException
{
	IDocumentProperties documentProperties = documentManager.queryDocumentProperties(documentID);
	
	documentProperties.setStringValue(1, "IDK Document EDITED"); // 1 = name
	documentProperties.setStringValue(105, "IDK Document Title EDITED"); // 105 = title
	documentProperties.setStringValue(2, "Edited in IDK example "); // 2 = description
	documentProperties.setDateValue(112, newDate()); // 112 = last modified date

	documentManager.updateDocumentProperties(documentID, documentProperties);
}

.NET (C#)

public static void EditWebLinkDocument(IDocumentManager documentManager, int documentID)
{
	IDocumentProperties documentProperties = documentManager.QueryDocumentProperties(documentID);

	documentProperties.SetStringValue(1, "IDK Document EDITED"); // 1 = name
	documentProperties.SetStringValue(105, "IDK Document Title EDITED"); // 105 = title
	documentProperties.SetStringValue(2, "Edited in IDK example "); // 2 = description
	documentProperties.SetDateValue(112, newDateTime()); // 112 = last modified date

	documentManager.UpdateDocumentProperties(documentID, documentProperties);
}

.NET (VB)

Public Shared Sub EditWebLinkDocument(ByVal documentManager As IDocumentManager,
ByVal folderID As Integer)

Dim documentProperties As IDocumentProperties = documentManager.QueryDocumentProperties(documentID)

	documentProperties.SetStringValue(1, "IDK Document EDITED")' 1 = name
	documentProperties.SetStringValue(105, "IDK Document Title EDITED") ' 105 = title
	documentProperties.SetStringValue(2, "Edited in IDK example ") ' 2 = description
	documentProperties.SetDateValue(112, NewDateTime()) ' 112 = last modified date

	documentManager.UpdateDocumentProperties(documentID, documentProperties)

EndSub

Parent topic: About Remote Knowledge Directory Operations

AquaLogic User Interaction Development Guide

Editing Document Properties in the Knowledge Directory Using IDK Remote APIs