Table Description
External Citizen Message: A message that can be displayed to a citizen, originating from an external system (and normally created via a web service). Along with Participant Message, used to display messages to citizens in Citizen Self Service. Messages are displayed in the citizen account in order to predict why the citizen has logged in, for example, a message is displayed to let them know what their last payment was and when their next payment is due. Messages can also be displayed to inform the user of activities they are scheduled to participate in or meetings they are due to attend. This entity stores the details of these messages where they originate in an external system. See also ParticipantMessage entity.

Example

James Smith logs into the citizen account and sees message on the citizen account home page indicating 'Your latest payment of $140 was due on 2010-06-14. Click here to view the payment details. Your next payment is due on 2010-12-12. Click My Payments to view your payment history.' This entity is used to store this message if it originated in an external system.
Relationship Diagram
Click the diagram to manipulate and zoom. Traverse the diagram using Click-and-Drag motions.
Model Details
Location in Model: Logical View::MetaModel::Curam::WorkspaceServices::Entity::ExternalCitizenMessage::ExternalCitizenMessage
Controlling File: WorkspaceServices\model\Packages\Entity\ExternalCitizenMessage\ExternalCitizenMessage.efx
Attributes (12)
AttributeStereotypeNullableDescriptionDomain DefinitionCodetableDDL Type
messageIDkeynoUnique identifier for this message record. Generated on insert.INTERNAL_ID SVR_INT64
citizenWorkspaceAccountIDdetailsnoUnique reference number of the client with whom the messages relates.INTAKE_CLIENT_ID SVR_INT64
messageTitledetailsnoThe title of the message.EXTERNAL_CITIZEN_MESSAGE_TITLE SVR_STRING<128>
relatedIDdetailsyesThe unique identifier of the record that is related to this message, on the remote system that pushed this message to Citizen Workspace.REMOTE_ID SVR_STRING<128>
remoteSystemIDdetailsnoThe external system which sent this message.INTERNAL_ID SVR_INT64
messageBodydetailsnoThe message body text for this message.EXTERNAL_CITIZEN_MESSAGE_BODY SVR_STRING<512>
effectiveDatedetailsnoThe effective date of this message i.e. when it is displayed to the citizen. If omitted on input, it is set to today.CURAM_DATE SVR_DATE
expiryDatedetailsyesThe expiry date of this message i.e. when the message disappears from the citizen account home page. If omitted on input it is set to the zero date. A zero date implies "never".CURAM_DATE SVR_DATE
createdDateTimedetailsnoThe date time that this record was created. Set to the current date and time by the Curam system when a message is created.CURAM_DATETIME SVR_DATETIME
messageTypedetailsnoThe external citizen message type, taken from the ExternalCitizenMessageType codetable.PARTICIPANT_MESSAGE_CODEParticipantMessageTypeSVR_STRING<10>
prioritydetails Priority of the message - true for higher priority, false for lower priority.CURAM_INDICATOR SVR_BOOLEAN
cityIndustryTypedetailsyesCode table to denote the type of industry that this message has originitated from.CITY_INDUSTRY_TYPECityIndustrySVR_STRING<10>
Foreign Keys (2)
ChildParent
ExternalCitizenMessage.citizenWorkspaceAccountIDIntakeClient.intakeClientID
ExternalCitizenMessage.remoteSystemIDRemoteSystem.remoteSystemID
Indices (3)
Index NameAttributes
IND_1901918406citizenWorkspaceAccountID
IND__442679087relatedID
IND_931143301remoteSystemID
Operations (6)
OperationStereotypeOptionsDescriptionSQL
insertinsertAUTO_ID: messageID
Standard insert. 
readread Standard read. 
removeremove Standard remove. 
searchByCWAccountIDreadmulti Retrieves a list of Citizen Messages by Citizen Workspace account. 
readByTypeRelatedIDRemoteSystemnsread Retrieve a message based on its message type, related ID, and the external system that sent it to Curam. 
searchPertinentByCWAccountIDreadmultiWHERE: effectiveDate <= :currentDate AND ((expiryDate >= :currentDate) OR (expiryDate is null)) AND citizenWorkspaceAccountID = :citizenWorkspaceAccountID
  
Related Pages (0)