Skip navigation FileNet logo
  Open Client Developer's Guide
  Search  |  Index  |  Glossary   |  
Open menu Overview
Close menu Open Client Architecture
  Project Directory Structure
  Open menu Developing ASPX Pages
  Open menu User Interface Controls
  Close menu Data Provider
    Open Client Guidelines
    Major Components
    Data Store Caching
Open menu Developing for Process
Open menu Error and Exception Handling
Open menu Customizing the Framework
Globalization / Localization
Open menu General Information
   

Open Client Guidelines

  • Each data provider must define the data format(s) that it is returning as output.
  • The returned data format should be based on XML / XML serializable objects to conform to industry open standards and to provide extensibility.
  • The XML data should have a namespace definition.
  • XML Schema should be used to define the XML data format. This enables the use of the .NET XSD.EXE tool to generate XML serializable objects. The user control can then be configured to accept either XML data and/or XML serializable objects.
  • The data providers should focus on providing an accurate representation of the business data model, and not make any assumptions about data consumers.

Programming Guidelines

  • Minimize COM traffic for better performance.
  • XSL transformation should be performed on XML data from data provider navigation components to generate another XML format.
  • The .NET XSD.EXE tool should be used to deserialize XML data provider property components into .NET Classes.
  • Supporting XML allows data providers to easily be exposed as Web services in future.
  • Call the Dispose() in classes where COM objects are used as class attributes and use the Marshal.RelaseCOMObject() to release these COM objects in the Dispose().
  • Classes having IDM COM object should have a Dispose() method (Method of IDisposable interface). After using the instance of above specified class, the Dispose() method should be called to clean up resources held by IDM COM object. The Dispose() method should use the “Marshal.ReleaseCOMObject()” to clean up resources held by IDM COM objects. For cases where IDM COM objects are directly used in methods, the “Marshal.ReleaseCOMObject()” can be used to free resources held by IDM COM object.