Skip to main content
Version: Next

SDK and client libraries

To facilitate extension development and integration with external systems, APS provides several .NET libraries (SDK) that encapsulate business logic and data access.

Core Libraries​

These DLLs are located in the server's Bin directory and are essential for any custom development:

Avanteam.Kernel.dll​

This is the foundation of the solution. It contains:

  • SqlHelper: For data access.
  • LogManager: For centralized logging.
  • Cryptography: For encrypting sensitive data.
  • ObjectMapping: For ORM mapping.

Avanteam.Documents.dll​

Manages the entire document lifecycle:

  • DocumentManagerWrapper: Main class for creating, reading and modifying documents.
  • DocumentDocHelper: Object representing a document and its fields.

Avanteam.Workflow.dll​

Process engine:

  • WorkflowClientRuntime: Allows programmatic control of workflow instances.
  • Instance: Represents an active step of a process.

SDK Installation​

To use these libraries in your Visual Studio project:

  1. Retrieve the DLLs from the development/production server.
  2. Add them as References in your project.
  3. Set the Copy Local property to False to avoid deploying APS system DLLs with your extension.

SDK Usage Example​

using Avanteam.Documents.DataSource;
using Avanteam.Documents;

public void ModifierPriorite(string idDoc, int nouvellePriorite)
{
    var mng = new DocumentManagerWrapper();
    var doc = mng.GetDocument(idDoc);
    
    if (doc != null)
    {
        doc.SetValues("priority", nouvellePriorite);
        mng.SaveDocument(doc);
    }
}

JavaScript Libraries​

For frontend development (forms), APS automatically injects useful libraries:

  • jQuery: DOM manipulations.
  • Knockout.js / React: Data binding.
  • APS JS API: Global functions like APS_GetValue, APS_SetValue available in the global namespace or through the form manager.