RICADO Gen 4 API JS Client

RICADO Gen 4 API JS Client

Class

ShiftHourlyEntryController

Controller Class for Shift Hourly Entrys

Constructor

new ShiftHourlyEntryController()

Source

Methods

static

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

Create a Shift Hourly Entry [POST /packhouse/sites/{siteId}/shift-hourly-entries]

Parameters

  • siteId number

    The Site ID

  • createData ShiftHourlyEntryController.CreateData

    The Shift Hourly Entry Create Data

Returns

  • Promise.<ShiftHourlyEntryModel>

Source

static

createComment(siteId, id, content) → {Promise.<ShiftHourlyEntryController.CommentItem>}

Create a Comment [POST /packhouse/sites/{siteId}/shift-hourly-entries/{id}/comments]

Create a Comment for a Shift Hourly Entry

Parameters

  • siteId number

    The Site ID

  • id string

    The Shift Hourly Entry ID

  • content string

    The Content of the New Comment

Returns

  • Promise.<ShiftHourlyEntryController.CommentItem>

Source

static

deleteOneComment(siteId, id, commentId) → {Promise.<boolean>}

Delete a Comment [DELETE /packhouse/sites/{siteId}/shift-hourly-entries/{id}/comments/{commentId}]

Delete a Comment for a Shift Hourly Entry

Parameters

  • siteId number

    The Site ID

  • id string

    The Shift Hourly Entry ID

  • commentId string

    The Comment ID

Returns

  • Promise.<boolean>

Source

static

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

List all Shift Hourly Entrys [GET /packhouse/sites/{siteId}/shift-hourly-entries]

Parameters

  • siteId number

    The Site ID

  • queryParameters ShiftHourlyEntryController.GetAllQueryParameters <optional>

    The Optional Query Parameters

Returns

  • Promise.<Array.<ShiftHourlyEntryModel>>

Source

static

getComments(siteId, id) → {Promise.<Array.<ShiftHourlyEntryController.CommentItem>>}

Retrieve Comments [GET /packhouse/sites/{siteId}/shift-hourly-entries/{id}/comments]

Retrieves Comments for a Shift Hourly Entry

Parameters

  • siteId number

    The Site ID

  • id string

    The Shift Hourly Entry ID

Returns

  • Promise.<Array.<ShiftHourlyEntryController.CommentItem>>

Source

static

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

Retrieve a Shift Hourly Entry [GET /packhouse/sites/{siteId}/shift-hourly-entries/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Shift Hourly Entry ID

Returns

  • Promise.<ShiftHourlyEntryModel>

Source

static

getOneComment(siteId, id, commentId) → {Promise.<ShiftHourlyEntryController.CommentItem>}

Retrieve a Comment [GET /packhouse/sites/{siteId}/shift-hourly-entries/{id}/comments/{commentId}]

Retrieves Comments for a Shift Hourly Entry

Parameters

  • siteId number

    The Site ID

  • id string

    The Shift Hourly Entry ID

  • commentId string

    The Comment ID

Returns

  • Promise.<ShiftHourlyEntryController.CommentItem>

Source

static

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

Update a Shift Hourly Entry [PATCH /packhouse/sites/{siteId}/shift-hourly-entries/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Shift Hourly Entry ID

  • updateData ShiftHourlyEntryController.UpdateData

    The Shift Hourly Entry Update Data

Returns

  • Promise.<ShiftHourlyEntryModel>

Source

static

updateOneComment(siteId, id, commentId, content) → {Promise.<ShiftHourlyEntryController.CommentItem>}

Update a Comment [PATCH /packhouse/sites/{siteId}/shift-hourly-entries/{id}/comments/{commentId}]

Update a Comment for a Shift Hourly Entry

Parameters

  • siteId number

    The Site ID

  • id string

    The Shift Hourly Entry ID

  • commentId string

    The Comment ID

  • content string

    The Updated Content for the Comment

Returns

  • Promise.<ShiftHourlyEntryController.CommentItem>

Source

Type Definitions

CommentItem

A CommentItem Type

Type

  • Object

Properties

  • id string

    The Comment ID

  • userAccount ShiftHourlyEntryController.UserAccount
  • content string <nullable>

    The Content of the Comment

  • createdTimestamp Date <nullable>

    When the Comment was Created

  • updatedTimestamp Date <nullable>

    When the Comment was last Updated

Source

CreateData

The Create Data for a Shift Hourly Entry

Type

  • Object

Properties

  • packingLineId string

    The Packing Line ID this Hourly Entry is associated with

  • shiftId string <optional>

    The Shift ID this Hourly Entry is asssociated with

  • createdTimestamp Date <optional>

    When this Hourly Entry was Created

  • startTimestamp Date

    The Start Timestamp of this Hourly Entry

  • endTimestamp Date

    The End Timestamp of this Hourly Entry

  • class1Manning number <optional>
    <nullable>

    The Number of People working in all Areas except Class 2 for this Hour

  • class2Manning number <optional>
    <nullable>

    The Number of People working in the Class 2 Area for this Hour

  • averageManningTarget number <optional>
    <nullable>

    The Average Target Number of People that should be working for this Hour

  • averageClass1ManningTarget number <optional>
    <nullable>

    The Average Target Number of People that should be working in all Areas except Class 2 for this Hour

  • averageClass2ManningTarget number <optional>
    <nullable>

    The Average Target Number of People that should be working in the Class 2 Area for this Hour

  • manningTeams Array.<ShiftHourlyEntryController.ManningTeam> <optional>
    <nullable>

    An Array of Manning Teams and their Headcounts for this Hour. Only Applies when manningUsesTeams is true

  • manningUsesTeams boolean <optional>
    <nullable>

    Whether Manning is tracked at the Team Level for this Hour

  • averageCostPerManningUnit number <optional>
    <nullable>

    The Average Cost per Person working in all Areas for this Hour

  • layeredTrayPercentage number <optional>
    <nullable>

    The Actual Percentage of Total Tray Equivalents that are Layered for this Hour

  • layeredTrayPercentageTarget number <optional>
    <nullable>

    The Target Percentage of Total Tray Equivalents that should be Layered for this Hour

  • averageClass1Percentage number <optional>
    <nullable>

    The Average Class 1 Percentage for this Hour

  • qualityR600IdealSamplesPercentage number <optional>
    <nullable>

    The Number of Quality R600 Samples that were Ideal for this Hour

  • averageQualityR600IdealSamplesTarget number <optional>
    <nullable>

    The Average Target Number of Quality R600 Samples that should be Ideal for this Hour

  • customQualityData Array.<ShiftHourlyEntryController.CustomQualityDataItem> <optional>

    An Array of Custom Quality Data Items for this Hour

  • totalBinsTipped number <optional>

    The Total Number of Bins Tipped for this Hour

  • binsTippedTarget number <optional>

    The Target Number of Bins to Tip for this Hour

  • totalDowntime number <optional>

    The Total Downtime for this Hour expressed in Seconds

  • totalProductionTime number <optional>

    The Total Time that could be Utilized for Packing Fruit (excludes Planned Downtime such as Smoko Breaks) for this Hour expressed in Seconds

  • totalClass1Trays number <optional>

    The Total Number of Class 1 Tray Equivalents Packed for this Hour

  • totalClass2Trays number <optional>

    The Total Number of Class 2 Tray Equivalents Packed for this Hour

  • class1TraysPerHourExcludingDowntimeTarget number <optional>

    The Target Number of Class 1 Tray Equivalents that should be Packed excluding all Downtime for this Hour

  • averageClass1TraysPerHourAdjustedTarget number <optional>
    <nullable>

    The Target Number of Class 1 Tray Equivalents that should be Packed after Adjustment (Manning %) for this Hour

  • averageCostPerTray number <optional>
    <nullable>

    The Average Cost per Tray Equivalent for this Hour

  • averageCostPerTrayTarget number <optional>
    <nullable>

    The Average Cost per Tray Equivalent Target after Adjustment (Class 1 %, Soft-Sort %) for this Hour

  • primaryIssueCategory string <optional>
    <nullable>

    The Primary Issue Category for this Hourly Entry

  • primaryIssueTag string <optional>
    <nullable>

    The Primary Issue Tag for this Hourly Entry

  • primaryIssuePercentage number <optional>
    <nullable>

    A Percentage between 0% and 100% indicating how much the Primary Issue impacted Throughput for this Hourly Entry

  • secondaryIssueCategory string <optional>
    <nullable>

    The Secondary Issue Category for this Hourly Entry

  • secondaryIssueTag string <optional>
    <nullable>

    The Secondary Issue Tag for this Hourly Entry

  • secondaryIssuePercentage number <optional>
    <nullable>

    A Percentage between 0% and 100% indicating how much the Secondary Issue impacted Throughput for this Hourly Entry

  • nextHourFocus string <optional>
    <nullable>

    An Optional Focus for the Next Hour

  • satisfactionRating number <optional>
    <nullable>

    An Optional Rating between 1 and 10 on how Satisfied the Line Manager was with this Hour

  • status string <optional>

    The Status of this Hourly Entry

Source

CustomQualityDataItem

A CustomQualityDataItem Type

Type

  • Object

Properties

  • id string

    The ID of this Custom Quality Data Item

  • name string

    The Name of this Custom Quality Data Item

  • type string

    The Display Type for this Custom Quality Data Item

  • value number

    The Number Value for this Custom Quality Data Item

  • averageTarget number <nullable>

    The Average Target for this Custom Quality Data Item

Source

GetAllQueryParameters

The Optional Query Parameters for the getAll Function

Type

  • Object

Properties

  • packingLineId string <optional>

    The Packing Line ID this Hourly Entry is associated with

  • shiftId string <optional>

    The Shift ID this Hourly Entry is asssociated with

  • primaryIssueCategory string <optional>
    <nullable>

    The Primary Issue Category for this Hourly Entry

  • primaryIssueTag string <optional>
    <nullable>

    The Primary Issue Tag for this Hourly Entry

  • secondaryIssueCategory string <optional>
    <nullable>

    The Secondary Issue Category for this Hourly Entry

  • secondaryIssueTag string <optional>
    <nullable>

    The Secondary Issue Tag for this Hourly Entry

  • status string <optional>

    The Status of this Hourly Entry

  • createdTimestampBegin Date <optional>

    Filter by the Timestamp when Hourly Entries were Created. Results Greater than or Equal to Timestamp

  • createdTimestampEnd Date <optional>

    Filter by the Timestamp when Hourly Entries were Created. Results Less than or Equal to Timestamp

  • startTimestampBegin Date <optional>

    Filter by the Start Timestamp of Hourly Entries. Results Greater than or Equal to Timestamp

  • startTimestampEnd Date <optional>

    Filter by the Start Timestamp of Hourly Entries. Results Less than or Equal to Timestamp

  • endTimestampBegin Date <optional>

    Filter by the End Timestamp of Hourly Entries. Results Greater than or Equal to Timestamp

  • endTimestampEnd Date <optional>

    Filter by the End Timestamp of Hourly Entries. Results Less than or Equal to Timestamp

  • updateTimestampBegin Date <optional>

    Filter by the Timestamp when Hourly Entries were last Updated. Results Greater than or Equal to Timestamp

  • updateTimestampEnd Date <optional>

    Filter by the Timestamp when Hourly Entries were last Updated. Results Less than or Equal to Timestamp

Source

UpdateData

The Update Data for a Shift Hourly Entry

Type

  • Object

Properties

  • packingLineId string <optional>

    The Packing Line ID this Hourly Entry is associated with

  • createdTimestamp Date <optional>

    When this Hourly Entry was Created

  • startTimestamp Date <optional>

    The Start Timestamp of this Hourly Entry

  • endTimestamp Date <optional>

    The End Timestamp of this Hourly Entry

  • class1Manning number <optional>
    <nullable>

    The Number of People working in all Areas except Class 2 for this Hour

  • class2Manning number <optional>
    <nullable>

    The Number of People working in the Class 2 Area for this Hour

  • averageManningTarget number <optional>
    <nullable>

    The Average Target Number of People that should be working for this Hour

  • averageClass1ManningTarget number <optional>
    <nullable>

    The Average Target Number of People that should be working in all Areas except Class 2 for this Hour

  • averageClass2ManningTarget number <optional>
    <nullable>

    The Average Target Number of People that should be working in the Class 2 Area for this Hour

  • manningTeams Array.<ShiftHourlyEntryController.ManningTeam> <optional>
    <nullable>

    An Array of Manning Teams and their Headcounts for this Hour. Only Applies when manningUsesTeams is true

  • manningUsesTeams boolean <optional>
    <nullable>

    Whether Manning is tracked at the Team Level for this Hour

  • averageCostPerManningUnit number <optional>
    <nullable>

    The Average Cost per Person working in all Areas for this Hour

  • layeredTrayPercentage number <optional>
    <nullable>

    The Actual Percentage of Total Tray Equivalents that are Layered for this Hour

  • layeredTrayPercentageTarget number <optional>
    <nullable>

    The Target Percentage of Total Tray Equivalents that should be Layered for this Hour

  • averageClass1Percentage number <optional>
    <nullable>

    The Average Class 1 Percentage for this Hour

  • qualityR600IdealSamplesPercentage number <optional>
    <nullable>

    The Number of Quality R600 Samples that were Ideal for this Hour

  • averageQualityR600IdealSamplesTarget number <optional>
    <nullable>

    The Average Target Number of Quality R600 Samples that should be Ideal for this Hour

  • customQualityData Array.<ShiftHourlyEntryController.CustomQualityDataItem> <optional>

    An Array of Custom Quality Data Items for this Hour

  • totalBinsTipped number <optional>

    The Total Number of Bins Tipped for this Hour

  • binsTippedTarget number <optional>

    The Target Number of Bins to Tip for this Hour

  • totalDowntime number <optional>

    The Total Downtime for this Hour expressed in Seconds

  • totalProductionTime number <optional>

    The Total Time that could be Utilized for Packing Fruit (excludes Planned Downtime such as Smoko Breaks) for this Hour expressed in Seconds

  • totalClass1Trays number <optional>

    The Total Number of Class 1 Tray Equivalents Packed for this Hour

  • totalClass2Trays number <optional>

    The Total Number of Class 2 Tray Equivalents Packed for this Hour

  • class1TraysPerHourExcludingDowntimeTarget number <optional>

    The Target Number of Class 1 Tray Equivalents that should be Packed excluding all Downtime for this Hour

  • averageClass1TraysPerHourAdjustedTarget number <optional>
    <nullable>

    The Target Number of Class 1 Tray Equivalents that should be Packed after Adjustment (Manning %) for this Hour

  • averageCostPerTray number <optional>
    <nullable>

    The Average Cost per Tray Equivalent for this Hour

  • averageCostPerTrayTarget number <optional>
    <nullable>

    The Average Cost per Tray Equivalent Target after Adjustment (Class 1 %, Soft-Sort %) for this Hour

  • primaryIssueCategory string <optional>
    <nullable>

    The Primary Issue Category for this Hourly Entry

  • primaryIssueTag string <optional>
    <nullable>

    The Primary Issue Tag for this Hourly Entry

  • primaryIssuePercentage number <optional>
    <nullable>

    A Percentage between 0% and 100% indicating how much the Primary Issue impacted Throughput for this Hourly Entry

  • secondaryIssueCategory string <optional>
    <nullable>

    The Secondary Issue Category for this Hourly Entry

  • secondaryIssueTag string <optional>
    <nullable>

    The Secondary Issue Tag for this Hourly Entry

  • secondaryIssuePercentage number <optional>
    <nullable>

    A Percentage between 0% and 100% indicating how much the Secondary Issue impacted Throughput for this Hourly Entry

  • nextHourFocus string <optional>
    <nullable>

    An Optional Focus for the Next Hour

  • satisfactionRating number <optional>
    <nullable>

    An Optional Rating between 1 and 10 on how Satisfied the Line Manager was with this Hour

  • status string <optional>

    The Status of this Hourly Entry

Source