Start Issuance

Issuance can be started from the WebApp or via the Workflow Scheduler API.

Issuance Page

The system will require us to specify:

Configuration

This are required parameters. Define what the machine will print (the Job Template) and how it will do it (the Workflow)

Workflow

The workflow defines the sequence of actions that will be performed by the machine for each card that it will process. On almost every system this option will not be selectable, and can be left with default value (which varies from system to system).

Startup Options

Startup options let us set some parameters that will change the behavior of the system at runtime. This is useful for testing before going on production. Available options are:

Disable Laser Source

Turns off the laser source. The red spot will be visible and the scan head will move as if it was marking. We can use this option to test/validate our setup.

Stop after N cards

Tells the system to automatically stop after the specified number of cards were processed.

Skip Entity Updates

Bypasses the database. Templates are printed without replacing entities values

Scheduler API

The webapp uses the scheduler API to start/stop issuance. The StartWorkflowScheduler endpoint accepts a WorkflowSchedulerStartupParamsDto object as a parameter. The first 6 fields of WorkflowSchedulerStartupParamsDto map 1-to-1 with what we've seen in the form above.

Task Allocation Strategy

Tells the system which strategy it should use to balance mark jobs across available laser modules.

Disable Red Pointer

Turns off the red-pointer. This is useful for testing workflows that require XY Auto-Positioning with the laser source disabled.

Angular

  import { WorkflowSchedulerService } from '@ixla/aida-sdk-angular';
  ...
  constructor(private readonly scheduler: WorkflowSchedulerService) {}
  ... 
  const schedulerState = await this.scheduler.StartWorkflowScheduler({
    workflowSchedulerStartupParamsDto: {
      WorkflowTypeName : "BOX",
      StopAfter : -1, // infinite
      JobTemplateId : 1,  // the id we of the job template we want to use
      DryRun : false,  // false = laser source disabled
      TaskAllocationStrategy : null,  // default value. On modular sistes (BOx)
      NoReset : false,
      DisableRedPointer : false,
      SkipEntityUpdates : false
    }
  }).toPromise();
  ...

C#

  using IXLA.AIDA.Sdk;
  ...
  private readonly WorkflowSchedulerService _scheduler; 
  ... 
  WorkflowSchedulerStateDto schedulerSate = await _scheduler.StartWorkflowScheduler(new WorkflowSchedulerStartupParamsDto {
    WorkflowTypeName = "BOX",
    StopAfter = -1, 
    JobTemplateId = 1,
    DryRun = false, 
    TaskAllocationStrategy = null, 
    NoReset = false,
    DisableRedPointer = false,
    SkipEntityUpdates = false
  });
  ...

HTTP

POST /AIDA/v1/workflow-scheduler/start
Host: $BOX_IP_ADDRESS:5000
Accept: application/json

{
    "jobTemplateId": 1,
    "workflowTypeName": "BOX",
    "dryRun": true,
    "stopAfter" : -1,
    "skipEntityUpdates": true,
    "noReset": false,
    "taskAllocationStrategy": "batch", 
    "disableRedPointer": false
}

Response Body

{
  "status": "Starting",
  "queueSize": 0,
  "errorDetails": "string",
  "lastLoadedItemId": 0,
  "upTimeSeconds": 0,
  "currentJobTemplate": {
      ...
  }
}