Member Junction
    Preparing search index...

    Main orchestrator for archive operations. Singleton that coordinates loading configurations, initializing storage, processing entities, and recording run results.

    Usage:

    const result = await ArchiveEngine.Instance.RunArchive(configId, contextUser);
    

    Hierarchy (View Summary)

    Index

    Constructors

    Accessors

    • get GlobalKey(): string

      Returns string

    Methods

    • The Global Object Store is a place to store global objects that need to be shared across the application. Depending on the execution environment, this could be the window object in a browser, or the global object in a node environment, or something else in other contexts. The key here is that in some cases static variables are not truly shared because it is possible that a given class might have copies of its code in multiple paths in a deployed application. This approach ensures that no matter how many code copies might exist, there is only one instance of the object in question by using the Global Object Store.

      Returns GlobalObjectStore

    • Executes a complete archive run for the given configuration.

      Steps:

      1. Validates the configuration is active and not already running
      2. Loads the ArchiveConfiguration and its entity configurations (by Priority)
      3. For a Purge configuration, refuses entities that cannot be purged safely
      4. Creates an ArchiveRun record carrying the configuration's StorageMode
      5. Initializes the storage driver (Store only)
      6. Processes each entity via ArchiveProcessor
      7. Updates the ArchiveRun with final totals

      A thrown error after step 4 marks the ArchiveRun Failed with the message in ErrorLog and the totals of the entities processed before the error.

      Parameters

      • configId: string

        ID of the ArchiveConfiguration to execute

      • contextUser: UserInfo

        User context for authorization and database operations

      Returns Promise<ArchiveRunResult>

      Summary result of the archive run

    • Returns the singleton instance of the class. If the instance does not exist, it is created and stored in the Global Object Store. If className is provided it will be used as part of the key in the Global Object Store, otherwise the actual class name will be used. NOTE: the class name used by default is the lowest level of the object hierarchy, so if you have a class that extends another class, the lowest level class name will be used.

      Type Parameters

      Parameters

      • this: new () => T
      • OptionalclassName: string

      Returns T