RICADO Gen 4 API JS Client

RICADO Gen 4 API JS Client

Class

PackingLineController

Controller Class for Packing Lines

Constructor

new PackingLineController()

Source

Methods

static

create(siteId, createData) → {Promise.<PackingLineModel>}

Create a Packing Line [POST /packhouse/sites/{siteId}/packing-lines]

Parameters

  • siteId number

    The Site ID

  • createData PackingLineController.CreateData

    The Packing Line Create Data

Returns

  • Promise.<PackingLineModel>

Source

static

getAll(siteId, queryParametersopt) → {Promise.<Array.<PackingLineModel>>}

List all Packing Lines [GET /packhouse/sites/{siteId}/packing-lines]

Parameters

  • siteId number

    The Site ID

  • queryParameters PackingLineController.GetAllQueryParameters <optional>

    The Optional Query Parameters

Returns

  • Promise.<Array.<PackingLineModel>>

Source

static

getOne(siteId, id) → {Promise.<PackingLineModel>}

Retrieve a Packing Line [GET /packhouse/sites/{siteId}/packing-lines/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Packing Line ID

Returns

  • Promise.<PackingLineModel>

Source

static

update(siteId, id, updateData) → {Promise.<PackingLineModel>}

Update a Packing Line [PATCH /packhouse/sites/{siteId}/packing-lines/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Packing Line ID

  • updateData PackingLineController.UpdateData

    The Packing Line Update Data

Returns

  • Promise.<PackingLineModel>

Source

Type Definitions

AdvancedPackrunManagement

A AdvancedPackrunManagement Type

Type

  • Object

Properties

  • points Object

    The Points used for Advanced Packrun Management

  • steps Array.<(PackingLineController.ManualStep|PackingLineController.ClearSizersStep|PackingLineController.CreateSizerBatchesStep|PackingLineController.CheckFruitSizeProfileStep|PackingLineController.AutoMAFActionStep|PackingLineController.ManualMAFActionStep)>

    An Array of Steps that define the Advanced Packrun Management process

  • enabled boolean

    Whether Advanced Packrun Managed is Enabled on this Packing Line

Source

AutoControlGroup

A AutoControlGroup Type

Type

  • Object

Properties

  • id string

    A Unique ID for this Auto Control Group

  • name string

    Name for this Auto Control Group

  • points Object

    The Points used for this Auto Control Group

  • startDelay number <optional>
    <nullable>

    An Optional Start Delay for this Auto Control Group specified in Milliseconds

  • userStartWithoutDependencies boolean <optional>

    Whether the User can Start this Auto Control Group individually without relying on Downstream and Neighbour Dependencies

  • startSequences Array.<PackingLineController.StartSequence>

    An Array of Start Sequence Steps for this Auto Control Group

  • downstreamDependencyGroups Array.<string>

    An Array of other Auto Control Groups that are directly Downstream of this Auto Control Group

  • neighbourDependencyGroups Array.<string>

    An Array of other Auto Control Groups that are direct Neighbours of this Auto Control Group

  • shutdownAlarms Array.<string>

    An Array of Alarms that will Shutdown this Auto Control Group

Source

AutoMAFActionStep

A AutoMAFActionStep Type

Type

  • Object

Properties

  • index number

    An Index used to Order Steps and compare with the Current Step Point value

  • type string

    The Type of Step

  • title string

    A Title for this Auto MAF Action Step

  • subtitle string <nullable>

    An Optional Subtitle for this Auto MAF Action Step

  • description string

    A Description for this Auto MAF Action Step

  • actionType string

    Type of MAF Action to be performed

  • trigger string

    When this Action should be performed. 'begin' performed once when this Step becomes Active. 'end' performed once when this Step is no longer Active. 'always' performed constantly while this Step is Active

  • actionReference any <nullable>

    An Optional Reference for this Action (e.g. The Internal MAF Name of a Sizer or Numeric Sizer ID

Source

Automation

A Automation Type

Type

  • Object

Properties

  • points Object

    The Points used for Automation

  • autoControlGroups Array.<PackingLineController.AutoControlGroup>

    An Array of Auto Control Groups

  • autoSpeedGroups Array.<PackingLineController.AutoSpeedGroup>

    An Array of Auto Speed Groups

  • autoTargets Array.<PackingLineController.AutoTarget>

    An Array of Auto Targets

  • vsds Array.<PackingLineController.VsdReference>

    An Array of VSD References that are Automated by this Packing Line

  • contactors Array.<PackingLineController.ContactorReference>

    An Array of Contactor References that are Automated by this Packing Line

  • basicControls Array.<PackingLineController.BasicControl>

    An Array of Basic Controls that are Automated by this Packing Line

  • shutdownAlarms Array.<string>

    An Array of Alarms that will Shutdown the Automation for this Packing Line

  • lightControls Array.<PackingLineController.LightControl>

    An Optional Array of Light Controls for this Packing Line

  • infeedManagement Array.<PackingLineController.InfeedManagementItem>

    An Optional Array of Infeed Management Definitions for this Packing Line

  • autoSpeedSections Array.<PackingLineController.AutoSpeedSection>

    An Array of Sections that organize Auto Speed Groups for this Packing Line

  • configurationGroups Array.<PackingLineController.ConfigurationGroup>

    An Array of Groups that provide Configuration Options for this Packing Line

  • configurationSections Array.<PackingLineController.ConfigurationSection>

    An Array of Sections that organize Configuration Groups for this Packing Line

  • momentaryControlGroups Array.<PackingLineController.MomentaryControlGroup>

    An Array of Momentary Controls for User Interaction on this Packing Line

Source

AutoSpeedGroup

A AutoSpeedGroup Type

Type

  • Object

Properties

  • id string

    A Unique ID for this Auto Speed Group

  • name string

    Name for this Auto Speed Group

  • vsds Array.<string>

    An Array of VSD Objects that have their Speed Automated by this Auto Speed Group

  • points Object

    The Points used for this Auto Speed Group

  • sectionId string

    ID of the Auto Speed Section this Auto Speed Group should be displayed under

  • displayOrder number

    Display Order of this Auto Speed Group

  • supportsAutoMode boolean <optional>

    Whether this Auto Speed Group can be Managed by an Auto Target when Override Mode is not Active

Source

AutoSpeedSection

A AutoSpeedSection Type

Type

  • Object

Properties

  • id string

    A Unique ID for this Auto Speed Section

  • name string

    Name for this Auto Speed Section

  • displayOrder number

    Display Order of this Auto Speed Section

  • buttonControls Array.<PackingLineController.ButtonControl> <optional>

    An Optional Array of Button Controls for this Auto Speed Section

  • splitGroupId string <optional>
    <nullable>

    Optional ID shared between two Auto Speed Sections that should be displayed side-by-side

  • splitGroupPosition string <optional>
    <nullable>

    Optional Position for this Auto Speed Section when displaying two side-by-side

Source

AutoTarget

A AutoTarget Type

Type

  • Object

Properties

  • id string

    A Unique ID for this Auto Target

  • name string

    Name for this Auto Target

  • description string

    Description for this Auto Target

  • type string

    The Type of Auto Target

  • units string <nullable>

    Optional Units for this Auto Target

  • minValue number

    The Minimum Value for this Auto Target

  • maxValue number

    The Maximum Value for this Auto Target

  • points Object

    The Points used for this Auto Target

Source

ButtonControl

A ButtonControl Type

Type

  • Object

Properties

  • icon string

    The Icon to be displayed within this Button

  • name string

    Name of this Button Control

  • type string

    Type of this Button Control

  • points Object

    The Points used for this Button Control

  • resetDelay number

    Delay in milliseconds between setting the Control Point to true and then false

  • displayOrder number

    Display Order of this Button Control

Source

CheckFruitSizeProfileStep

A CheckFruitSizeProfileStep Type

Type

  • Object

Properties

  • index number

    An Index used to Order Steps and compare with the Current Step Point value

  • type string

    The Type of Step

  • sizerId string

    ID of the Sizer to be included in this Step

Source

ClassTypeRejectCategory

A ClassTypeRejectCategory Type

Type

  • Object

Properties

  • classType string

    A Class Type that is already defined on this Packing Line

  • rejectCategoryId number

    The FreshPack Reject Category ID that should be associated with the Class Type

Source

ClearSizersStep

A ClearSizersStep Type

Type

  • Object

Properties

  • index number

    An Index used to Order Steps and compare with the Current Step Point value

  • type string

    The Type of Step

  • sizerIds Array.<string>

    An Array of Sizer IDs to be included in this Step

Source

ConfigurationGroup

A ConfigurationGroup Type

Type

  • Object

Properties

  • id string

    A Unique ID for this Configuration Group

  • name string

    Name for this Configuration Group

  • sectionId string

    ID of the Configuration Section this Configuration Group should be displayed under

  • displayOrder number

    Display Order of this Configuration Group

  • configurationPoints Array.<(PackingLineController.ConfigurationPoint|PackingLineController.ConfigurationPoint)>

    An Array of Configuration Points to be displayed in this Configuration Group

Source

ConfigurationPoint

A ConfigurationPoint Type

Type

  • Object

Properties

  • name string

    Name of this Configuration Point

  • type string

    The Type of Configuration Point

  • point number

    ID of the Boolean Point to be Configurable

  • units string <nullable>

    Optional Units for this Configuration Point

  • minValue number

    The Minimum Value for this Configuration Point

  • maxValue number

    The Maximum Value for this Configuration Point

Source

ConfigurationSection

A ConfigurationSection Type

Type

  • Object

Properties

  • id string

    A Unique ID for this Configuration Section

  • name string

    Name for this Configuration Section

  • displayOrder number

    Display Order of this Configuration Section

Source

CreateData

The Create Data for a Packing Line

Type

  • Object

Properties

  • rtuId number <optional>
    <nullable>

    The RTU this Packing Line belongs to

  • name string

    The Packing Line Name

  • shortName string <optional>

    A Short Name for the Packing Line Name. Typically used in Reports and Tables showing multiple Packing Lines

  • points Object

    The Points used by this Packing Line

  • sizers Array.<PackingLineController.SizerReference> <optional>

    The Sizer Objects that belong to this Packing Line

  • binTips Array.<PackingLineController.BinTipReference> <optional>

    The Bin Tip Objects that belong to this this Packing Line

  • rejectBinScales Array.<PackingLineController.RejectBinScaleReference> <optional>

    The Reject Bin Scale Objects that belong to this Packing Line

  • secondaryPackingLine PackingLineController.SecondaryPackingLineReference <optional>
    <nullable>

    An Optional Secondary Packing Line Reference

  • automation PackingLineController.Automation <optional>
    <nullable>

    The Automation Object for this Packing Line

  • alarmGroups Array.<string> <optional>

    The Alarm Groups that are used by this Packing Line

  • classTypes Array.<PackingLineController.ClassType> <optional>

    The Class Types that are defined for this Packing Line

  • shiftManagement PackingLineController.ShiftManagement <optional>
    <nullable>

    The Optional Shift Management Object for this Packing Line

  • advancedPackrunManagement PackingLineController.AdvancedPackrunManagement <optional>
    <nullable>

    The Advanced Packrun Management Configuration for this Packing Line

  • mafIntegration PackingLineController.MafIntegration <optional>
    <nullable>

    The MAF Integration Configuration for this Packing Line

  • freshPackIntegration PackingLineController.FreshPackIntegration <optional>
    <nullable>

    The FreshPack Integration Configuration for this Packing Line

  • freshQualityIntegration PackingLineController.FreshQualityIntegration <optional>
    <nullable>

    The FreshQuality Integration Configuration for this Packing Line

Source

CreateSizerBatchesStep

A CreateSizerBatchesStep Type

Type

  • Object

Properties

  • index number

    An Index used to Order Steps and compare with the Current Step Point value

  • type string

    The Type of Step

  • sizerIds Array.<string>

    An Array of Sizer IDs to be included in this Step

Source

FreshPackIntegration

A FreshPackIntegration Type

Type

  • Object

Properties

  • points Object

    The Points used for this FreshPack Integration

  • enabled boolean

    Whether the FreshPack Integration is Enabled on this Packing Line

  • graderIds Array.<number>

    An Array of FreshPack Grader IDs that relate to this Packing Line

  • apiBaseUrl string

    Base URL of the FreshPack Web Portal API

  • computerName string

    A Computer Name to use when Performing Actions on the FreshPack API

  • productionFacilityId number

    FreshPack Production Facility ID this Packing Line is associated with

  • classTypeRejectCategoryIds Array.<PackingLineController.ClassTypeRejectCategory> <optional>
    <nullable>

    An Array of FreshPack Reject Category IDs that relate to Class Types on this Packing Line

  • packrunSourceTrayClassTypes Array.<string> <optional>
    <nullable>

    An Optional Array of Class Types that should be collected from FreshPack Tray Totals on this Packing Line

Source

FreshQualityIntegration

A FreshQualityIntegration Type

Type

  • Object

Properties

  • points Object

    The Points used for this FreshQuality Integration

  • enabled boolean

    Whether the FreshQuality Integration is Enabled on this Packing Line

  • username string

    Username for Authenticating with the FreshQuality API

  • password string

    Password for Authenticating with the FreshQuality API

  • apiBaseUrl string

    Base URL of the FreshQuality API

  • sampleTypeIds Array.<number>

    An Array of FreshQuality Sample Type IDs that are used for Class 1 R600 on this Packing Line

  • rejectAnalysisSampleTypeIds Array.<number>

    An Array of FreshQuality Sample Type IDs that are used for Reject Analysis on this Packing Line

  • maturityAreaSampleTypeIds Array.<number>

    An Array of FreshQuality Sample Type IDs that should be fetched for Maturity Area Samples on this Packing Line

Source

InfeedManagementItem

A InfeedManagementItem Type

Type

  • Object

Properties

  • id string

    A Unique ID for this Infeed Management Item

  • name string

    Name for this Infeed Management Item

  • points Object

    The Points used for this Infeed Management Item

  • riserCount number

    Number of Risers that are part of this Infeed Management Item

  • displayOrder number

    Display Order of this Infeed Management Item

  • riser1AutoControlGroupId string <optional>
    <nullable>

    ID of the Auto Control Group for the first Riser. Only applies if riserCount >= 1

  • riser2AutoControlGroupId string <optional>
    <nullable>

    ID of the Auto Control Group for the second Riser. Only applies if riserCount >= 2

Source

MafIntegration

A MafIntegration Type

Type

  • Object

Properties

  • points Object

    The Points used for this MAF Integration

  • enabled boolean

    Whether the MAF Integration is Enabled on this Packing Line

  • tracAddress string

    The IP Address or Server Name of the MAF TRAC PC

Source

ManualMAFActionStep

A ManualMAFActionStep Type

Type

  • Object

Properties

  • index number

    An Index used to Order Steps and compare with the Current Step Point value

  • type string

    The Type of Step

  • title string

    A Title for this Manual MAF Action Step

  • subtitle string <nullable>

    An Optional Subtitle for this Manual MAF Action Step

  • description string

    A Description for this Manual MAF Action Step

  • actionType string

    Type of MAF Action to be performed

  • trigger string

    When this Action should be performed. 'begin' performed once when this Step becomes Active. 'end' performed once when this Step is no longer Active. 'always' performed constantly while this Step is Active

  • actionReference any <nullable>

    An Optional Reference for this Action (e.g. The Internal MAF Name of a Sizer or Numeric Sizer ID

Source

ManualStep

A ManualStep Type

Type

  • Object

Properties

  • index number

    An Index used to Order Steps and compare with the Current Step Point value

  • type string

    The Type of Step

  • title string

    A Title for this Manual Step

  • subtitle string <nullable>

    An Optional Subtitle for this Manual Step

  • description string

    A Description for this Manual Step

  • pointActions Array.<PackingLineController.ManualStepPointAction> <optional>

    An Optional Array of Actions that should be performed on Points by setting them to a predefined Value based on a Trigger

  • autoControlGroupActions Array.<PackingLineController.ManualStepAutoControlGroupAction> <optional>

Source

ManualStepAutoControlGroupAction

A ManualStepAutoControlGroupAction Type

Type

  • Object

Properties

  • trigger string

    When this Action should be performed. 'begin' performed once when this Step becomes Active. 'end' performed once when this Step is no longer Active. 'always' performed constantly while this Step is Active

  • groupId string

    ID of an Automation Auto Control Group

  • action string

    The Action to be performed on the Auto Control Group

Source

ManualStepPointAction

A ManualStepPointAction Type

Type

  • Object

Properties

  • trigger string

    When this Action should be performed. 'begin' performed once when this Step becomes Active. 'end' performed once when this Step is no longer Active. 'always' performed constantly while this Step is Active

  • pointId number

    The Point ID to be written to

  • value any

    Value to be written to the Point

Source

MomentaryControl

A MomentaryControl Type

Type

  • Object

Properties

  • name string

    Name of this Momentary Control

  • points Array.<PackingLineController.MomentaryControlPoint>

    An Array of Points used by this Momentary Control

  • displayOrder number

    Display Order of this Momentary Control

Source

MomentaryControlGroup

A MomentaryControlGroup Type

Type

  • Object

Properties

  • name string

    Name of this Momentary Control Group

  • momentaryControls Array.<PackingLineController.MomentaryControl>

    An Array of Momentary Controls for this Momentary Control Group

Source

ShiftManagement

A ShiftManagement Type

Type

  • Object

Properties

  • points Object

    The Points used for Shift Management

  • customQualityConfiguration Array.<{id: string, name: string, type: string, points: {currentShiftCustomQualityTarget: number, currentShiftCustomQualityValue: number, currentShiftCustomQualityAverageValue: ?number, customQualityTargets: number, customQualityScoreWeighting: number}}>

    An Optional Array of Configuration Data for Custom Qualities in Shift Management

  • enabled boolean

    Whether Shift Management is Enabled on this Packing Line

  • taskDefinitions Array.<PackingLineController.ShiftTaskDefinition>

    An Array of Shift Task Types for this Packing Line

  • manningUsesTeams boolean

    Whether Manning is tracked at the Team Level on this Packing Line

  • useDefaultManningAtShiftStart boolean <nullable>

    Whether the Default Manning Target should be used to Auto Populate the first Hourly Entry of a Shift on this Packing Line

Source

SizerReference

A SizerReference Type

Type

  • Object

Properties

  • id string

    ID of a Sizer Object

  • displayOrder number

    Display Order of the Sizer

  • ownedBySecondaryPackingLine boolean <optional>

    Whether this Sizer is Owned and Managed by a Secondary Packing Line

Source

StartSequence

A StartSequence Type

Type

  • Object

Properties

  • startDelay number

    The Start Delay for this Start Sequence Step specified in Milliseconds

  • startOrder number

    The Start Order for this Start Sequence Step

  • vsds Array.<string>

    An Array of VSD Objects that are Automated by this Auto Control Group

  • contactors Array.<string>

    An Array of Contactor Objects that are Automated by this Auto Control Group

  • basicControls Array.<PackingLineController.AutoControlGroupBasicControl>

    An Array of Basic Controls that are Automated by this Auto Control Group

Source

UpdateData

The Update Data for a Packing Line

Type

  • Object

Properties

  • name string <optional>

    The Packing Line Name

  • shortName string <optional>

    A Short Name for the Packing Line Name. Typically used in Reports and Tables showing multiple Packing Lines

  • points Object <optional>

    The Points used by this Packing Line

  • sizers Array.<PackingLineController.SizerReference> <optional>

    The Sizer Objects that belong to this Packing Line

  • binTips Array.<PackingLineController.BinTipReference> <optional>

    The Bin Tip Objects that belong to this this Packing Line

  • rejectBinScales Array.<PackingLineController.RejectBinScaleReference> <optional>

    The Reject Bin Scale Objects that belong to this Packing Line

  • secondaryPackingLine PackingLineController.SecondaryPackingLineReference <optional>
    <nullable>

    An Optional Secondary Packing Line Reference

  • automation PackingLineController.Automation <optional>
    <nullable>

    The Automation Object for this Packing Line

  • alarmGroups Array.<string> <optional>

    The Alarm Groups that are used by this Packing Line

  • classTypes Array.<PackingLineController.ClassType> <optional>

    The Class Types that are defined for this Packing Line

  • shiftManagement PackingLineController.ShiftManagement <optional>
    <nullable>

    The Optional Shift Management Object for this Packing Line

  • advancedPackrunManagement PackingLineController.AdvancedPackrunManagement <optional>
    <nullable>

    The Advanced Packrun Management Configuration for this Packing Line

  • mafIntegration PackingLineController.MafIntegration <optional>
    <nullable>

    The MAF Integration Configuration for this Packing Line

  • freshPackIntegration PackingLineController.FreshPackIntegration <optional>
    <nullable>

    The FreshPack Integration Configuration for this Packing Line

  • freshQualityIntegration PackingLineController.FreshQualityIntegration <optional>
    <nullable>

    The FreshQuality Integration Configuration for this Packing Line

Source