Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated to English

...

This How to article focuses on adding documents and its metadata to a case, the same way you can add an uploaded file to a case. When opening the case, you want to see all the files belonging to that case. For displaying the files an AQ_InstanceList container is used:

Image RemovedImage Added

UI Text Box
typetip

In this situation, a case is represented as an Aggregate, see Designing cases using aggregates

...

In this example a Blueriq Document will be stored in a Document instance, which is related to a case (in this case a permit, in Dutch 'vergunning'). This ERD describes the relation:

Image RemovedImage Added

First step is to create the file from the Document and store it on the filesystem, second step is to get all necessary metadata to display in the list. This results in this flow: 

Image Added

 

UI Text Box
typeinfo

The first servicecall is of type 'AQ_Document_Generate', the second of type 'AQ_File_GetMetaData'.

...

  • CreateInstance
    Because the document/file has to appear in an instancelist, I have to create a new instance. In this example a 'Document' instance is created, based in on the entity mentioned in the FileID parameter.
  • Relation
    The new Document instance will be added to the Case.Documents relation, because in my example the instancelist only contains 'Case' documents.
  • Connection
     
    The connection is set to 'filesystemconnection', to make sure the file is stored and can be kept permanently. See also How to setup a connection.
  • Persistence
    Persistence has to be permanent - in this example on the filesystem - because the file has to be kept in storage due to audittrails. Temporary persistence in memory isn't a suitable solution, because the file will be gone when restarting the Runtime for example.

...