API Documentation Github Example Application - Finished Goods Traceability

Namespace

Commands

Commands

Defines the strategies for the KeySSI's for each DSU Type

View Source commands/index.js, line 1

Methods

# static createBatchSSI(data, domain) → {ArraySSI}

Defines how to create the keyssi for a batch dsu

.

Defines how to create the keyssi for a batch dsu

Parameters:
Name Type Description
data object

necessary properties:

  • gtin - the gtin of the batch
  • batch - the batch number
  • (optional) openDSU#constants#BRICKS_DOMAIN_KEY - the subDomain to store the bricks in. Will be concatenated like 'domain.subDomain'
domain string

the anchoring domain

View Source commands/setBatchSSI.js, line 14

ArraySSI

# static createIndividualProductSSI(data, domain) → {ArraySSI}

Defines how to create the keyssi for a Product dsu

.

Defines how to create the keyssi for a Product dsu

Parameters:
Name Type Description
data object

necessary properties:

  • gtin - the gtin of the product
  • (optional) openDSU#constants#BRICKS_DOMAIN_KEY - the subDomain to store the bricks in. Will be concatenated like 'domain.subDomain'
domain string

the anchoring domain

View Source commands/setIndividualProductSSI.js, line 12

ArraySSI

# static createOrderLineSSI(data, domain) → {ArraySSI}

Defines how to create the keyssi for an orderLine dsu

.

Defines how to create the keyssi for an orderLine dsu

Parameters:
Name Type Description
data object

necessary properties:

  • data
    • the specific string to be used as input
  • (optional) openDSU#constants#BRICKS_DOMAIN_KEY - the subDomain to store the bricks in. Will be concatenated like 'domain.subDomain'
domain string

the anchoring domain

View Source commands/setOrderLineSSI.js, line 12

ArraySSI

# static createOrderSSI(data, domain) → {ArraySSI}

Defines how to create the keyssi for an Order dsu

.

Defines how to create the keyssi for an Order dsu

Parameters:
Name Type Description
data object

necessary properties:

  • data
    • the specific string
  • (optional) openDSU#constants#BRICKS_DOMAIN_KEY - the subDomain to store the bricks in. Will be concatenated like 'domain.subDomain'
domain string

the anchoring domain

View Source commands/setOrderSSI.js, line 12

ArraySSI

# static createParticipantSSI(participant, domain:) → {SeedSSI}

Creates a seedSSI meant to contain participant 'participant' data.

Creates a seedSSI meant to contain participant 'participant' data. could be used as an identity

Parameters:
Name Type Description
participant Participant
domain: string

anchoring domain

View Source commands/setParticipantSSI.js, line 9

(template)

SeedSSI

# static createProductSSI(data, domain) → {ArraySSI}

Defines how to create the keyssi for a Product dsu

.

Defines how to create the keyssi for a Product dsu

Parameters:
Name Type Description
data object

necessary properties:

  • gtin - the gtin of the product
  • (optional) openDSU#constants#BRICKS_DOMAIN_KEY - the subDomain to store the bricks in. Will be concatenated like 'domain.subDomain'
domain string

the anchoring domain

View Source commands/setProductSSI.js, line 12

ArraySSI

# static createSaleSSI(data, domain)

Defines how to create the keyssi for a Receipt dsu

.

Defines how to create the keyssi for a Receipt dsu

Parameters:
Name Type Description
data object

necessary properties:

  • data
    • the specific string
  • (optional) openDSU#constants#BRICKS_DOMAIN_KEY - the subDomain to store the bricks in. Will be concatenated like 'domain.subDomain'
domain string

the anchoring domain

View Source commands/setSaleSSI.js, line 11

# static createShipmentCodeSSI(data, domain)

Defines how to create the keyssi for a ShipmentLine dsu

.

Defines how to create the keyssi for a ShipmentLine dsu

Parameters:
Name Type Description
data object

necessary properties:

  • data
    • the specific string
  • (optional) openDSU#constants#BRICKS_DOMAIN_KEY - the subDomain to store the bricks in. Will be concatenated like 'domain.subDomain'
domain string

the anchoring domain

View Source commands/setShipmentCodeSSI.js, line 11

# static createShipmentLineSSI(data, domain)

Defines how to create the keyssi for a ShipmentLine dsu

.

Defines how to create the keyssi for a ShipmentLine dsu

Parameters:
Name Type Description
data object

necessary properties:

  • data
    • the specific string
  • (optional) openDSU#constants#BRICKS_DOMAIN_KEY - the subDomain to store the bricks in. Will be concatenated like 'domain.subDomain'
domain string

the anchoring domain

View Source commands/setShipmentLineSSI.js, line 11

# static createShipmentSSI(data, domain)

Defines how to create the keyssi for a Shipment dsu

.

Defines how to create the keyssi for a Shipment dsu

Parameters:
Name Type Description
data object

necessary properties:

  • data
    • the specific string
  • (optional) openDSU#constants#BRICKS_DOMAIN_KEY - the subDomain to store the bricks in. Will be concatenated like 'domain.subDomain'
domain string

the anchoring domain

View Source commands/setShipmentSSI.js, line 11

# static createStatusSSI(domain)

Defines how to create the keyssi for a orderLine dsu

.

Defines how to create the keyssi for a orderLine dsu

Parameters:
Name Type Description
status. OrderStatus | ShipmentStatus

if status has the properties:

  • (optional) openDSU#constants#BRICKS_DOMAIN_KEY - the subDomain to store the bricks in. Will be concatenated like 'domain.subDomain'
domain string

the anchoring domain

View Source commands/setStatusSSI.js, line 10