The Companies house Document Generator for generating documents

In order to build document-generator locally you will need the following:

• Java 8
• Maven
• Git

1. Run make
2. Run ./start.sh

The supported environmental variables have been categorised by use case and are as follows.

The following are the modules that exist within document generator.

The document-generator-api module is a sub module within document-generator, it holds the api controller which is called passing resourceUri and mimeType to uri /private/documents/generate. The api deals with requesting the data to be rendered through the document-generator-interface, as well as making the call to the render service to generate a document. The details of the api request and response can be seen within document-generator-api/swagger-2.0/models

The document-generator-interface module is a sub module within document-generator, it holds the interface DocumentInfoService that contains the methods to getDocumentInfo in order to return the DocumentInfo model. Which will contain String data, String templateName, String assetId, String path, String descriptionIdentifier and a Map<String, String> description Values.

The document-generator-accounts module is a sub module within document-generator, it holds the accounts specific implementation of the DocumentInfoService that contains the method getDocumentInfo. Which returns the DocumentInfo model which will contain String data, String templateName, String assetId, String path, String descriptionIdentifier and a Map<String, String> description Values.

The document-generator-prosecution module is a sub module within document-generator, which is the prosecution implementation of the DocumentInfoService that contains the method getDocumentInfo. Which returns the DocumentInfo model which will contain String data, String templateName, String assetId, String path, String descriptionIdentifier and a Map<String, String> description Values for Ultimatum and SJP letters.