Skip navigation  
Glossary  |  General Information  
   Content Services User Administration API
     Search in CS User Admin API Overview   |   API Classes   |   Enumeration Constants   |   Status Codes  
Level 1 Overview
Level 2 Terminology
Level 2 Installation Requirements
Level 2 Usage Restrictions
Level 2 Using the API Documentation
Level 1 API Classes
Level 1 Enumeration Constants
Level 1 Status Codes
Level 1 General Information
   

FileNet Content Services User Administration API Overview

The FileNet Content Services User Administration Application Program Interface (CS User Admin API) is a packaged version of existing Saros Programming Interfaces exposed through the Visual Basic Administrative Toolkit, and the Content Services Administration Tool Suite. The API enables the development of administrative applications for Content Services using Visual Basic, and supplies additional functionality to that available in the standard API.

Terminology

The following terms and concepts are discussed in this document:

Session handle — represents an active user session to a CS library
    and is initialized when the mezSession.Login() method is called.
    The session handle usually appears as a method parameter.
Object number — a unique number that describes the type of an object.
    For example, objects of type "Item" have an object number of 256. For a
    complete listing of object numbers, see the FileNet Content Services API
    Manual, release 5 series documentation on the FileNet website.
Object key — a unique identifier used to signify a specific object,
    generated when the object is created.

For more information about terms and concepts related to administering user and group objects, see the FileNet Content Services API Manual, release 5 series documentation on the FileNet website.

Installation Requirements

The CS User Admin API does not include an installer program and must be installed on a system that is configured with the FileNet Content Services libraries version 5.5 or later. However, the CS User Admin API should not be installed on a system where the CS Admin Tools or Web Admin Tools are already present.

CAUTION: Potential conflicts may arise when the CS User Admin API is installed on a system where the CS Admin Tools or Web Admin Tools are already present!

Before you begin to develop with the interfaces, you must perform the following steps:

  1. Stop any Content Services that are running.
  2. Run setup.exe to install the FileNet Content Services 5.5.0 client
    library files (if not already installed). For more information about installing
    the client libraries, see the FileNet Content Services API Manual,
    release 5 series
    documentation on the FileNet website.
  3. Copy the .dlls from the \CSUserAPI directory on
    the CS Admin Tools CD to your development system.
  4. Place dssatvba.dll in a location specified in your PATH environment variable.
    For example, place the library in your \WINNT\System32 directory.
  5. Place dssatapi.dll and dssatres.dll in any location on your system,
    and register them using the regsvr32 utility.

To access the CS User Admin API from Microsoft Visual Basic:

  1. Open the Visual Basic Project>References dialog.
  2. Check the entry labeled "FileNet Content Services Admin API".
  3. Click OK.

Usage Restrictions

The CS User Admin API has the following support restrictions:

Functionality applies to Content Services only, not Image Services
Only user and group administration is supported
Only Visual Basic 6.0 is supported, not Visual C++ 6.0 or Visual Basic.NET

Using the CS User Admin API Documentation

To the left is a table of contents. Click on any topic to jump to that page. When you click on a bold topic, you will see a list of subtopics in that category. You can also click any of the words in the color bar above to jump to the main categories.

At the upper left in the color bar is a Search button. Use this to search for one or more words in the Help text. See the Tips on the search page for help in constructing your search criteria. When you select a page in the search results, use your browser's Find command to quickly find the text on the page.

See the General information topics for information about contacting FileNet, the license agreement, and a glossary. If you encounter a word in the Help text that you don't understand, click Glossary at the top of the page. Then click the alphabetic grouping that contains the word's first letter to jump to that part of the alphabet