Class ReporterBatchPlugin
ReporterBatchPlugin will create reports in the batch system.
Implements
Inherited Members
Namespace: SuperOffice.CRM.BatchProcessing.Plugins
Assembly: SoBatchProcessing.dll
Syntax
[BatchTask("ReporterBatchPlugin")]
public class ReporterBatchPlugin : BatchTaskBase, IBatchTaskRemarks
Reports are created in the document temp area. The reporter process can be set to impersonate the document archive user in the config file: BatchService/ImpersonateReporterPlugin = true
Reporter executable is launched and it is expected to create a file at a given location. The executable to run can be set using the config file: BatchService.ReporterPath The report file is saved to a blob, and the client must retrieve the result from the blob.Constructors
ReporterBatchPlugin()
ReporterBatchPlugin will create reports in the batch system.
Declaration
public ReporterBatchPlugin()Remarks
Reports are created in the document temp area. The reporter process can be set to impersonate the document archive user in the config file: BatchService/ImpersonateReporterPlugin = true
Reporter executable is launched and it is expected to create a file at a given location. The executable to run can be set using the config file: BatchService.ReporterPath The report file is saved to a blob, and the client must retrieve the result from the blob.Fields
PluginName
ReporterBatchPlugin will create reports in the batch system.
Declaration
public const string PluginName = "ReporterBatchPlugin"Field Value
| Type | Description |
|---|---|
| string |
Remarks
Reports are created in the document temp area. The reporter process can be set to impersonate the document archive user in the config file: BatchService/ImpersonateReporterPlugin = true
Reporter executable is launched and it is expected to create a file at a given location. The executable to run can be set using the config file: BatchService.ReporterPath The report file is saved to a blob, and the client must retrieve the result from the blob.Methods
Run(string, string)
Create the report with the parameters supplied in ParameterObject.
Declaration
protected override bool Run(string name, string context)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Task name - unused |
| string | context | Context name - unused |
Returns
| Type | Description |
|---|---|
| bool | true if the report succeeded |
Overrides
Remarks
Reports are created in the document temp area. The reporter process can be set to impersonate the document archive user in the config file: BatchService/ImpersonateReporterPlugin = true
Reporter executable is launched and it is expected to create a file at a given location. The executable to run can be set using the config file: BatchService.ReporterPath The report file is saved to a blob, and the client must retrieve the result from the blob.