Bulk Execution Builder

BulkExecutionBuilder

BulkExecutionBuilder Objects

class BulkExecutionBuilder()

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

constructor
function constructor()

Constructor

Arguments:

  • 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
bulk
function bulk(rawFile: string,File,extension: string) -> '*'

Do a bulk using specific Provision Processor.

Arguments:

  • rawFile string,File - String with path of file or File (Blob)
  • extension string (optional) - File format

Returns:

  • *

Example:

 ogapi.bulkExecutionBuilder('orgname', 'processorId', 10000).bulk(rawFile, extension)
plan
function plan(rawFile: string,File,extension: string,numberOfEntriesToProcess: number) -> '*'

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

Arguments:

  • 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.

Returns:

  • *

Example:

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