Shipment Dialogue¶
Shipment dialogue table stores information about communication happened inside specific shipment between all the users who has shipment access.
Attributes¶
shipmentDialogueId: Primary key for the table.
orgId: Foreign key of Organisation table. This field stores the information of the organisation whose shipment is being used to send message.
shipmentId: Foreign key of Shipment table. This field stores the information of the shipment where dialogue is added.
subject: Subject of the message used to send the message through email.
dialogueByName: Name of the user who sent the message/dialogue.
dialogueByEmail: Email id of the user who sent the message/dialogue.
commentOnlyFor: Email id of the user who can see the message/dialogue. This is only available if message is not public.
commentOnlyForName: Name of the user who can see the message/dialogue. This is only available if message is not public.
isPublic: Boolean value indicating whether the dialogue is public or not. If set to true, this dialogue will be visible to all users who has access to this shipment.
isDeleted: Boolean value indicating whether the dialogue is deleted by the user or not. It's always soft delete.
isPinned: Boolean value indicating whether the dialogue is pinned or not in shipment chat window.
dialogueType: Type of event that caused the dialogue creation event.
Possible values
- SYSTEM_TRIGGERED_TRANSACTIONAL
- SYSTEM_TRIGGERED_USERDRIVEN
- PO_EVENT
- INVOICE_EVENT
- OTHER_DOCUMENT_EVENT
- EXTERNAL_EVENT
- API_EVENT
- CRON_EVENT
- BULK_EVENT
- EXTERNAL_USER_EVENT
- USER_COMMENT
- USER_EMAIL_COMMENT
- FINANCING_EVENT
comment: Actual shipment dialogue/message.
commentTitle: Title of the message/dialogue.
Example
- Shipment linked.
- Shipment Unlinked.
- Email Sent etc.
meta: JSON object to stores information about other meta data.
Associations¶
Organisation¶
Shipment dialogue always belongs any one Organisation.
Shipment¶
Shipment dialogue always belongs any one Shipment.