DOCSEARCHbyAlgolia
Submit Docs

Pam API Documentation

website·Indexed 31 days ago

https://serviceportal.hs.ag/docs/inPoint.Web

C# API reference for Pam, featuring namespaces such as Pam.Utils, Pam.Config, Pam.API, and Pam.Filtering.Config. The documentation covers utility classes like TriState, Crc32, and PathHelper, as well as configuration elements and filtering conditions within the Point.Enterprise framework.

Tokens
4.5M
Snippets
18.5K
Records
33.8K
Agent score
36%

What's inside Pam

  1. Overview of Pam.Archive Plugins

    Pam.Archive.Plugins allow developers to add custom features and behavior to the Pam.Archive component, enabling the modification of documents before they are written to or read from the archive. Plugins are implemented as custom libraries (DLLs) that attach to archive system events. A plugin consists of a primary library containing the custom class, optional dependency files (referenced DLLs, images, data files), and an optional configuration file. Plugin contents are stored in a central database and downloaded to the file system upon loading.

  2. Overview of ExtraAttributes Classification Plugin

    The ExtraAttributes and ExtraDocAttributes plugins implement the IClassification interface to extend standard forms. They support an unlimited number of attributes, multiple editor types (EditorControls), various data sources, field validators, and expressions for ReadOnly or Required flags. They can be used for either Folders (ExtraAttributes) or Documents (ExtraDocAttributes) and support custom layouts including groups, tabs, and columns.

  3. Overview of inPoint Template Engines

    inPoint provides two template engines for creating documents. The Tokenizer engine supports simple predefined patterns, while the Scriban engine supports complex patterns and code blocks for calculating values.

    Key distinctions:

    • File Name Calculation: The Tokenizer engine is always used to calculate the file name for a document created from a template.
    • Document Content: Both engines can be used for the content of the template document itself.
    • Naming: Tokenizer templates require distinct names to be located. Scriban templates use internal IDs, allowing identical names without technical conflict.

  4. Overview of inPoint.Archive Plugins

    inPoint.Archive.Plugins allow developers to add custom features and behavior to the inPoint.Archive component, enabling the modification of documents before they are written to or read from the archive. Plugins are implemented as custom libraries (DLLs) that attach to archive system events. A plugin consists of a primary library containing the custom class, optional dependency files (referenced DLLs, images, data files), and an optional configuration file. Plugin contents are stored in a central database and downloaded to the file system upon loading.

  5. Overview of inPoint.Core Public REST API

    inPoint.Core provides a Public REST API accessible via HTTPS. The API is based on ASP.NET Core 2.1, runs on Windows OS, and uses the HTTP.Sys kernel Web Server instead of IIS. By default, the service returns RAW values (e.g., FileSize as a Number rather than a formatted String); formatted captions and types can be obtained via the /format endpoint. Most methods support multiple output formats: JSON, YAML, CSV, XML, and GeoJSON.
    # Swagger contract (API v1)
http://localhost:8081/swagger/v1/swagger.json

# Online tester
https://localhost:8081/swagger

  6. Overview of inPoint.Enterprise Framework Architecture

    inPoint is a multi-layered framework consisting of a Server Module Layer (WCF Service hosted on IIS) and multiple Windows-based Clients (Office/Windows Integration, Standalone Client, etc.).

    Clients are composed of:

    • Front-End Core: The glue layer (WPF for Standalone via inPoint.Forms.dll, VSTO for Office via inPoint.Outlook.dll, and LogicNP NamespaceExtensions for Explorer via inPoint.Shell.dll).
    • Middleware Service Layer (HierarchyProvider): Handles communication with the Server Layer via WCF (inPoint.API.dll).
    • Extension Plugins: Features implemented as extension points for custom functionality or prototyping.

  7. Overview of inPoint.Web offline capabilities

    inPoint.Web provides offline functionality to handle short connectivity issues (resilience) or complete lack of internet connection. It utilizes PWA, ServiceWorkers, Browser Cache, and IndexedDb to allow the application to start offline, detect network status in real-time, and support editing operations. Key supported features include pre-cached application files, marking folders as 'Available Offline', editing Folder/Document Classifications offline, and creating new Folders or Documents.

  8. Overview of inPoint.Web Offline Capabilities

    inPoint.Web provides offline functionality to handle short connectivity issues (resilience) or complete lack of internet access. It utilizes PWA, ServiceWorkers, Browser Cache, and IndexedDb to ensure the application can start offline, detect network status in real-time, and allow editing of pre-defined items. Key supported features include pre-cached application files, marking folders as 'Available Offline', offline editing of Folder/Document Classifications, and the creation of new folders and documents while offline.

  9. Overview of the Mailbox Consistency tool

    The Mailbox Consistency tool is a command-line utility used to identify and repair data inconsistencies between contentAccess and inPoint mails. It can create reports on inconsistencies without modifying productive data, or it can be used to repair the data based on those reports. The tool is located in the DBConsistency\MailboxConsistency subfolder of the inPoint_Tools_<version>_<suffix>.zip package.
    MailboxConsistency.exe ?

  10. Overview of ExtraAttributes Classification Plugin

    The ExtraAttributes and ExtraDocAttributes plugins implement the inPoint IClassification Plugin to extend standard Forms. They can be used for Folders (ExtraAttributes) or Documents (ExtraDocAttributes) and support an unlimited number of attributes with customizable editor controls, data sources, validators, and expressions for ReadOnly or Required flags. Note: When archiving multiple documents, the 'Apply-To-All' checkbox in the classification window only fills standard inPoint fields; ExtraAttribute fields are not automatically filled due to plugin API restrictions.