Class FinalizeDocumentAction

Finalizes an in-progress document: renders it to a binary file, saves to MJStorage, and outputs the FileOutput param for automatic artifact creation.

After finalization, the document handle is disposed and cannot be used again.

Parameters:

Handle (required): the document handle
FileName (optional): override the filename set at creation
StorageAccountName (optional): name of the storage account to use
StoragePath (optional): custom storage path prefix

Output:

FileOutput: { fileName, mimeType, sizeBytes, fileId }

Hierarchy

BaseFileHandlerAction
- FinalizeDocumentAction

Index

Constructors

constructor

Methods

getBooleanParam getFileContent getNumericParam getParamValue InternalRunAction Run saveToMJStorage

Constructors

constructor

new FinalizeDocumentAction(): FinalizeDocumentAction
Returns FinalizeDocumentAction
Inherited from BaseFileHandlerAction.constructor

Methods

`Protected`getBooleanParam

getBooleanParam(
    params: RunActionParams,
    paramName: string,
    defaultValue?: boolean,
): boolean
Get boolean parameter value with default
Parameters
- params: RunActionParams
- paramName: string
- defaultValue: boolean = false
Returns boolean
Inherited from BaseFileHandlerAction.getBooleanParam
- Defined in Actions/CoreActions/src/custom/utilities/base-file-handler.ts:251

`Protected`getFileContent

getFileContent(
    params: RunActionParams,
    dataParamName: string,
    fileParamName?: string,
    urlParamName?: string,
): Promise<
    {
        content: string
        | Buffer;
        fileName?: string;
        mimeType?: string;
        source: "url" | "storage" | "direct";
    },
>
Get file content from various sources based on parameters Priority: FileID > FileURL > Data parameter
Parameters
- params: RunActionParams
  Action parameters
- dataParamName: string
  Name of the parameter containing direct data
- fileParamName: string = 'FileID'
  Name of the parameter containing file ID (default: 'FileID')
- urlParamName: string = 'FileURL'
  Name of the parameter containing file URL (default: 'FileURL')
Returns Promise<
    {
        content: string
        | Buffer;
        fileName?: string;
        mimeType?: string;
        source: "url" | "storage" | "direct";
    },
>
Object with content and metadata
Inherited from BaseFileHandlerAction.getFileContent
- Defined in Actions/CoreActions/src/custom/utilities/base-file-handler.ts:25

`Protected`getNumericParam

getNumericParam(
    params: RunActionParams,
    paramName: string,
    defaultValue?: number,
): number
Get numeric parameter value with default
Parameters
- params: RunActionParams
- paramName: string
- defaultValue: number = 0
Returns number
Inherited from BaseFileHandlerAction.getNumericParam
- Defined in Actions/CoreActions/src/custom/utilities/base-file-handler.ts:260

`Protected`getParamValue

getParamValue(params: RunActionParams, paramName: string): any
Extract parameter value by name (case-insensitive)
Parameters
- params: RunActionParams
- paramName: string
Returns any
Inherited from BaseFileHandlerAction.getParamValue
- Defined in Actions/CoreActions/src/custom/utilities/base-file-handler.ts:243

`Protected`InternalRunAction

InternalRunAction(params: RunActionParams): Promise<ActionResultSimple>
Internal method that must be implemented by derived action classes. This is where the actual action logic should be implemented.
Parameters
- params: RunActionParams
  The action execution parameters including typed context
Returns Promise<ActionResultSimple>
Promise resolving to the action result
Overrides BaseFileHandlerAction.InternalRunAction
- Defined in Actions/CoreActions/src/custom/files/finalize-document.action.ts:25

Run

Run(params: RunActionParams): Promise<ActionResultSimple>
Executes the action with the provided parameters.
Parameters
- params: RunActionParams
  The action execution parameters including context
Returns Promise<ActionResultSimple>
Promise resolving to the action result
Inherited from BaseFileHandlerAction.Run
- Defined in Actions/Engine/dist/generic/BaseAction.d.ts:37

`Protected`saveToMJStorage

saveToMJStorage(
    content: string | Buffer,
    fileName: string,
    mimeType: string,
    params: RunActionParams,
    storageAccountName?: string,
    storagePath?: string,
): Promise<string>
Save file to MJ Storage. Uploads the content to a FileStorageAccount and creates the corresponding MJ: Files entity record.
Parameters
- content: string | Buffer
  File content as string or Buffer
- fileName: string
  Name for the file
- mimeType: string
  MIME type of the file
- params: RunActionParams
  Action parameters (for contextUser)
- OptionalstorageAccountName: string
  Optional: name of the storage account to use (falls back to first active)
- OptionalstoragePath: string
  Optional: custom storage path prefix (falls back to artifacts/{date}/{uuid}/)
Returns Promise<string>
The ID of the newly created MJ: Files record
Inherited from BaseFileHandlerAction.saveToMJStorage
- Defined in Actions/CoreActions/src/custom/utilities/base-file-handler.ts:160

Class FinalizeDocumentAction

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns FinalizeDocumentAction

Methods

`Protected`getBooleanParam

Parameters

Returns boolean

`Protected`getFileContent

Parameters

Returns Promise<
    {
        content: string
        | Buffer;
        fileName?: string;
        mimeType?: string;
        source: "url" | "storage" | "direct";
    },
>

`Protected`getNumericParam

Parameters

Returns number

`Protected`getParamValue

Parameters

Returns any

`Protected`InternalRunAction

Parameters

Returns Promise<ActionResultSimple>

Run

Parameters

Returns Promise<ActionResultSimple>

`Protected`saveToMJStorage

Parameters

Returns Promise<string>

Settings

On This Page

Class FinalizeDocumentAction

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns FinalizeDocumentAction

Methods

ProtectedgetBooleanParam

Parameters

Returns boolean

ProtectedgetFileContent

Parameters

Returns Promise< { content: string | Buffer; fileName?: string; mimeType?: string; source: "url" | "storage" | "direct"; },>

ProtectedgetNumericParam

Parameters

Returns number

ProtectedgetParamValue

Parameters

Returns any

ProtectedInternalRunAction

Parameters

Returns Promise<ActionResultSimple>

Run

Parameters

Returns Promise<ActionResultSimple>

ProtectedsaveToMJStorage

Parameters

Returns Promise<string>

Settings

On This Page

`Protected`getBooleanParam

`Protected`getFileContent

Returns Promise<
{
content: string
| Buffer;
fileName?: string;
mimeType?: string;
source: "url" | "storage" | "direct";
},
>

`Protected`getNumericParam

`Protected`getParamValue

`Protected`InternalRunAction

`Protected`saveToMJStorage