Payload

Payloads are documents exchanged across HephIA product services and leverage actions, a regular use case is the one were a customer wants to execute an HephIA workflow and as most workflows they required arguments to specify the number of clusters in a clustering algorithm for example. Payloads carry both customer inputs and also metadata which will help him and us to render a better user experience.

All active payloads are register in a referential, this last contains a set of identifiers for every available processing.

This section gathers every payload between services of HephIA product.

Go to paylaod list.

Payload exchange schema

Payload exchange schema

(mandotory_payload)=

Mandotory payload

Payload may differ from one to another, but they share at least each keys of this dictionary, it can be either a single JSON or multiple ones. Let call this common part the mandatory payload, and it includes following keys :

  • _id : MongoId which is generated when Client send the payload which is stored in MongoDB which create this key.
  • processingKeyword or visualisationKeyword : Identifier of the processing, key name depends on nature of jobs.
  • customer : Customer name.
  • name : Name of the payload.
  • startTS: Creation date as a TS.
  • latestUpdateTS: Update data as a TS.
  • status: Integer value which means status state.
  • processingContext : It is a dictionary containing 4 sub keys :
    • processingId: Long value identifying the processing.
    • processingName: Name of the processing.
    • callingContext : Calling context.
    • editionContext : Edition context information.
    • view: It is a dictionary containing 2 sub keys.
      • id: Unique view identifier as a String.
      • name: View name (view_TS).
    • processingName : User defined name of the process.
    • dataset : It is a dictionary describing used dataset which contains 2 sub keys :
      • name : Dataset name.
      • collection : Mongo collection where is store the Dataset object.
    • project: It is a dictionary containing 2 sub keys
      • id : Unique project identifier as a Long.
      • name : Project name.
{
  "processingKeyword": "distinct_processing_name_to_leverage_exec",
  "customer": "username",
  "name": "user defined name of the representation",
  "creationTS": 17267393322,
  "latestUpdateTS": 17267393344,
  "status": 1,
  "processingContext": {
    "processingName": "user define name, ex SOM",
    "editionContext": "user",
    "callingContext": "hephIA-solution",
    "view": {
      "id": "637ce534dd85c10875c4fe26",
      "name": "view_11-22-2022_15:05:24"
    },
    "dataset": {
      "name": "my_dataset",
      "collection": "datasets"
    },
    "project": {
      "id": 2,
      "name": "SOM"
    }
  }
}

Optional payload keys

  • dataLocations : Dictionary where keys are named accordingly with data nature and values are the dataLocationIds.
  • hyperParameters : It is a dictionary process specific dictionary.

(payload_list)=

Payload list