import BulkExecutionBuilder from 'opengate-js/src/provision/bulk/BulkExecutionBuilder.js'

public class | source

BulkExecutionBuilder

Extends:

BaseProvision → BulkExecutionBuilder

This builder give you the necessary tools to create a bulk executions using our OpenGate REST

Constructor Summary

Public Constructor
public	constructor(ogapi: InternalOpenGateAPI, organization: string, processorId: string, timeout: number) Constructor

Method Summary

Public Methods
public	bulk(rawFile: string \| File, extension: string): * Do a bulk using specific Provision Processor.
public	plan(rawFile: string \| File, extension: string, numberOfEntriesToProcess: number): * Instead of creating a bulk process, return the provision process planning for specified entries.

Inherited Summary

From class BaseProvision
public	create(): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function create a entity of provision
public	delete(body: *): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function deletes a entity of provision
public	update(): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function updates a entity of provision

Public Constructors

public constructor(ogapi: InternalOpenGateAPI, organization: string, processorId: string, timeout: number) source

Constructor

Override:

BaseProvision#constructor

Params:

Name	Type	Attribute	Description
ogapi	InternalOpenGateAPI		required field. This is ogapi instance
organization	string		required field. This is the organization name
processorId	string		required field. This is the provision processor use for bulk provision
timeout	number	optional	timeout in millisecons. The request will have a specific time out if it will be exceeded then the promise throw an exception

Public Methods

public bulk(rawFile: string | File, extension: string): * source

Do a bulk using specific Provision Processor.

Params:

Name	Type	Attribute	Description
rawFile	string \| File		String with path of file or File (Blob)
extension	string	optional	File format

Return:

Example:

 ogapi.bulkExecutionBuilder('orgname', 'processorId', 10000).bulk(rawFile, extension)

public plan(rawFile: string | File, extension: string, numberOfEntriesToProcess: number): * source

Instead of creating a bulk process, return the provision process planning for specified entries. This is is synch process that does not cause changes in the database

Params:

Name	Type	Attribute	Description
rawFile	string \| File		String with path of file or File (Blob)
extension	string	optional	File format
numberOfEntriesToProcess	number	optional	Number of entries to be processed.

Return:

Example:

 ogapi.bulkExecutionBuilder('orgname', 'processorId', 10000).plan(rawFile, extension)
 ogapi.bulkExecutionBuilder('orgname', 'processorId', 10000).plan(rawFile, extension, numberOfEntriesToProcess)