Document list - DocumentList

List of generated documents

Component properties

Eximee Designer property	Attribute name in the Source	Description
Document list	items	List of documents to display
Download all documents (section Basic properties)	allowDownloadingOfAllDocuments	An option that allows all documents to be downloaded. Default value is "false". Availability of the feature depends on the license and may not be available in all deployments.
Displaying the loader while generating a document (section Basic properties)	async	An option that displays the loader while generating a document. Default value is "false". Availability of functionality depends on the license and may not be available in all deployments.
Collapsible document list (Other section)	GesDocumentList.foldable	The document list display is hidden in a collapsible section. Availability of the feature depends on the license and may not be available in all deployments

More information about component properties: Common component properties

Figure 1. Example appearance of the component on the application

After adding the component from the palette, the remaining configuration (regarding the list of displayed documents) should be set in the tab Source. Example configuration for the component:

<p1:GesDocumentList id="GesDocumentList1" mid="GesDocumentList1" labelKey="GesDocumentList1.label" ariaLabelKey="GesDocumentList1.ariaLabel" ariaDescriptionKey="GesDocumentList1.ariaDescription" documentsAreNotReadyMessageKey="GesDocumentList1.documentsAreNotReadyMessage">
    <data:ListeningOn>
        <data:ListenField id="currentPageMid"/>
    </data:ListeningOn>
    <data:ClearOn/>
    <p1:GesDocumentList.layoutData>
        <ns6:GridData horizontalAlignment="FILL" horizontalSpan="16" verticalAlignment="CENTER"/>
    </p1:GesDocumentList.layoutData>
    <data:DocumentGeneratorItems>
        <data:DocumentGeneratorItem generatorName="fop" fileName="my_file.pdf" documentTemplate="my_template.xsl-*"/>
    </data:DocumentGeneratorItems>
    <data:GesDocumentList.foldable enabled="false"/>
</p1:GesDocumentList>

The most important thing in the above configuration is to set:

• fileName="my_file.pdf" - in quotes, provide the name of the document displayed on the template.
• documentTemplate="my_template.xsl-*" - in quotes, provide the xsl template name in the format name-*, where the asterisk denotes the highest version of the component.

If the artifact attached in the Document List component is fed with data from the application, you need to add listening on the DocumentList component, e.g. on currentPageMid (or another element that changes on the application when moving between pages). This will avoid a situation where data changes are not reflected in the printout.

If the generated document is to be saved to DMS, on the last page before submitting the application you need to add this document to the document generator (more here: Document Generator - Document Generator), providing the document in 'items'.

---

Configuring the items property to feed the document list with a PDF printout generated using an XSL template

Eximee Designer property	Attribute name in the Source	Description
Generator name	Generator name	"fop" - if the data feeding the printout comes from the application. "fopFromVariable" - if the data feeding the printout is generated from a variable xmlDocument (then the component must also listen to this variable!)
Document name	File name	the document name displayed on the template
Artifact name	Document template	component name in the format name-* where the asterisk denotes the highest version of the component (there is also the possibility of specifying a specific version)

Feeding the document list with data from a service

The component can be fed with data from the service attached either on the component or on the page.

Feeding the document list with links from a service (external links)

Availability of functionality depends on the license and may not be available in all deployments.

Demo application: demoWebview

We attach the service to the component standardly via EXTERNAL DATA SOURCE (External Data Source). It should return (endpoint names are bolded):

• documentLink — a list of links or document identifiers that we want to display,
• fileName — the name of the file to download,
• documentLabel — optionally the label displayed next to the file (if there is none, the file name is displayed),
• source — source type (values: "externalWeb" or "internalDoc"), a constant that tells the platform whether the source system is cms ("externalWeb") or nemo ("internalDoc").

Remember that if the document list is to be displayed in channels other than native, the service must return values correlated with the current channel. For example, returning document identifiers makes no sense for the desktop channel.

Example service code (Java, OSGI/Charon component):

@Component
@Service(AbstractServiceProxy.class)
public class DemoDocumentLinkServiceProxy extends AbstractServiceProxy {
    static final String INPUT_LINK_LIST = "linkList";
    static final String INPUT_IS_EXTERNAL = "isExternalSource";
    static final String OUTPUT_SOURCE = "source";
    static final String OUTPUT_LINK = "link";
    static final String OUTPUT_FILE_NAME = "fileName";
    static final String EXTERNAL_WEB_SOURCE = "externalWeb";
    static final String INTERNAL_DOC = "internalDoc";

    private static final Logger LOGGER = LoggerFactory.getLogger(DemoDocumentLinkServiceProxy.class);
    private static final Logger SENSITIVE_LOGGER = SensitiveLoggerFactory.getSensitiveLogger(DemoDocumentLinkServiceProxy.class);

    public DemoDocumentLinkServiceProxy() {
        this.name = "DemoDocumentLinkServiceProxy";
        this.description = "Returns the provided list of links to the DocumentList component. Sets the source to externalWeb or internalDoc depending on the passed isExternalSource";
        this.inputFields.add(new ServiceProxyField(INPUT_LINK_LIST));
        this.inputFields.add(new ServiceProxyField(INPUT_IS_EXTERNAL));
        this.outputFields.add(new ServiceProxyField(OUTPUT_SOURCE));
        this.outputFields.add(new ServiceProxyField(OUTPUT_LINK));
        this.outputFields.add(new ServiceProxyField(OUTPUT_FILE_NAME));
    }

    @Override
    public List<Map<String, String>> callService(Map<String, List<String>> values) throws ServiceProxyException {
        LOGGER.info(">> Service called with values: {}", values);
        SENSITIVE_LOGGER.info(">> Service called with values: {}", values);
        List<Map<String, String>> result = new ArrayList<>();
        final Boolean isExternal = getBooleanValue(values, INPUT_IS_EXTERNAL, true);
        final String source = isExternal ? EXTERNAL_WEB_SOURCE : INTERNAL_DOC;
        final List<String> inputLinkList = values.get(INPUT_LINK_LIST);
        for (String inputLink : inputLinkList) {
            result.add(createEntry(inputLink, source));
        }
        LOGGER.info("<< Service finished with result: {}", result);
        SENSITIVE_LOGGER.info("<< Service finished with result: {}", result);
        return result;
    }

    private Map<String, String> createEntry(final String link, final String source) {
        Map<String, String> entry = new HashMap<>();
        entry.put(OUTPUT_SOURCE, source);
        entry.put(OUTPUT_LINK, link);
        entry.put(OUTPUT_FILE_NAME, (isNotBlank(link) && link.contains("/")) ? substringAfterLast(link, "/") : link);
        return entry;
    }
}

Feeding the document list with data from two services

For the functionality to work, the flag server.features.externalDocumentResourceProviderEnabled=true must be set in webforms.xml

The service below will return two documents for us - one encoded in Base64 and one fetched from an external URL:

• document_list_example1 - the script reads the input parameter fileName from the application and returns two documents:

  • the first document has the parameter set source to externalDocument — the file content will be fetched from the source specified in the documentServiceName script (in this case it is the script document_list_example2.js, which returns the file contents in Base64).
  • the second document has the parameter set source to externalWeb — the file content will be fetched directly from the given external URL.
• document_list_example2 - script defined for the purpose of being called in the document_list_example1 script - it reads parameters passed from the first script and returns the file content in Base64.

The first service is attached to the component standardly via EXTERNAL DATA SOURCE (External Data Source). It should return (endpoint names are bolded):

• fileName - file name to download,
• fileMimeType - file type to download,
• documentLabel - optional label displayed next to the file (if there is none, the file name is displayed),
• fileContent - should be added if we want to support more than 1 file - it lets us set the file identifier and distinguish files from one another,
• source - type of source for the attached file. Possible values:

  • externalDocument — the file comes from an external data source,
  • externalWeb — the file comes from an external URL,
• documentServiceName - the name of the second service that is called to fetch the file content (filled in when source=externalDocument). If it is a script service, add the prefix script: (without this prefix the system will look for a Charon/OSGI service),
• documentServiceParams - optional parameters that we want to pass to the service fetching the file content. They take the form parameter1=value&parameter2=value...
• documentLink - external URL (filled in when source=externalWeb)

Figure 1. Binding output parameters

Example code of script services:

document_list_example1.js

function callService(context) {
  var fileName = context.getFirstParameter('fileName');

  return [
    {
      'fileName': fileName,
      'fileMimeType': 'application/pdf',
      'source': 'externalDocument', 
      'documentServiceName': 'script:document_list_example2',
      'documentServiceParams': 'parameter1=value1&parameter2=value2'
    },
    {
      'fileName': 'fileFromUrl.pdf',
      'mimeType': 'text/plain',
      'source': 'externalWeb',
      'link': 'https://example.com/example_file_from_url.pdf',
    }
  ];
}

document_list_example2.js

function callService(context) {
    const content = "JVBERi0xLjMNCiXi48/TDQoNCjEgMCBvYmoNCjw8DQovVHlwZSAvQ2F0YWxvZw0KL091dGxpbmVzIDIgMCBSDQovUGFnZXMgMyAwIFINCj4+DQplbmRvYmoNCg0KMiAwIG9iag0KPDwNCi9UeXBlIC9PdXRsaW5lcw0KL0NvdW50IDANCj4+DQplbmRvYmoNCg0KMyAwIG9iag0KPDwNCi9UeXBlIC9QYWdlcw0KL0NvdW50IDINCi9LaWRzIFsgNCAwIFIgNiAwIFIgXSANCj4+DQplbmRvYmoNCg0KNCAwIG9iag0KPDwNCi9UeXBlIC9QYWdlDQovUGFyZW50IDMgMCBSDQovUmVzb3VyY2VzIDw8DQovRm9udCA8PA0KL0YxIDkgMCBSIA0KPj4NCi9Qcm9jU2V0IDggMCBSDQo+Pg0KL01lZGlhQm94IFswIDAgNjEyLjAwMDAgNzkyLjAwMDBdDQovQ29udGVudHMgNSAwIFINCj4+DQplbmRvYmoNCg0KNSAwIG9iag0KPDwgL0xlbmd0aCAxMDc0ID4+DQpzdHJlYW0NCjIgSg0KQlQNCjAgMCAwIHJnDQovRjEgMDAyNyBUZg0KNTcuMzc1MCA3MjIuMjgwMCBUZA0KKCBBIFNpbXBsZSBQREYgRmlsZSApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY4OC42MDgwIFRkDQooIFRoaXMgaXMgYSBzbWFsbCBkZW1vbnN0cmF0aW9uIC5wZGYgZmlsZSAtICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNjY0LjcwNDAgVGQNCigganVzdCBmb3IgdXNlIGluIHRoZSBWaXJ0dWFsIE1lY2hhbmljcyB0dXRvcmlhbHMuIE1vcmUgdGV4dC4gQW5kIG1vcmUgKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA2NTIuNzUyMCBUZA0KKCB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDYyOC44NDgwIFRkDQooIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNTY5LjA4ODAgVGQNCiggQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA1NTcuMTM2MCBUZA0KKCB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBFdmVuIG1vcmUuIENvbnRpbnVlZCBvbiBwYWdlIDIgLi4uKSBUag0KRVQNCmVuZHN0cmVhbQ0KZW5kb2JqDQoNCjYgMCBvYmoNCjw8DQovVHlwZSAvUGFnZQ0KL1BhcmVudCAzIDAgUg0KL1Jlc291cmNlcyA8PA0KL0ZvbnQgPDwNCi9GMSA5IDAgUiANCj4+DQovUHJvY1NldCA4IDAgUg0KPj4NCi9NZWRpYUJveCBbMCAwIDYxMi4wMDAwIDc5Mi4wMDAwXQ0KL0NvbnRlbnRzIDcgMCBSDQo+Pg0KZW5kb2JqDQoNCjcgMCBvYmoNCjw8IC9MZW5ndGggNjc2ID4+DQpzdHJlYW0NCjIgSg0KQlQNCjAgMCAwIHJnDQovRjEgMDAyNyBUZg0KNTcuMzc1MCA3MjIuMjgwMCBUZA0KKCBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY3Ni42NTYwIFRkDQooIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNjY0LjcwNDAgVGQNCiggIHRleHQuIE9oLCBob3cgYm9yaW5nIHR5cGluZyB0aGlzIHN0dWZmLiAgQnV0IG5vdCBhcyBib3JpbmcgYXMgd2F0Y2hpbmcgKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA2NTIuNzUyMCBUZA0KKCBwYWludCBkcnkuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNjQwLjgwMDAgVGQNCiggQm9yaW5nLiAgTW9yZSwgYSBsaXR0bGUgbW9yZSB0ZXh0LiBUaGUgZW5kLCBhbmQganVzdCBhcyB3ZWxsLiAgKSBUag0KRVQNCmVuZHN0cmVhbQ0KZW5kb2JqDQoNCjggMCBvYmoNCi9bL1BERiAvVGV4dF0NCmVuZG9iag0KDQo5IDAgb2JqDQo8PA0KL1R5cGUgL0ZvbnQNCi9TdWJ0eXBlIC9UeXBlMQ0KL05hbWUgL0YxDQovQmFzZUZvbnQgL0hlbHZldGljYQ0KL0VuY29kaW5nIC9XaW5BbnNpRW5jb2RpbmcNCj4+DQplbmRvYmoNCg0KMTAgMCBvYmoNCjw8DQovQ3JlYXRvciAoUmF2ZSBcKGh0dHA6Ly93d3cubmV2cm9uYS5jb20vcmF2ZVwpKQ0KL1Byb2R1Y2VyIChOZXZyb25hIERlc2lnbnMpDQovQ3JlYXRpb25EYXRlIChEOjIwMDYwMzAxMDcyODI2KQ0KPj4NCmVuZG9iag0KDQp4cmVmDQo0IDExDQowMDAwMDAwMDAwIDY1NTM1IGYNCjAwMDAwMDAwMTkgMDAwMDAgbg0KMDAwMDAwMDA5MyAwMDAwMCBuDQowMDAwMDAwMTQ3IDAwMDAwIG4NCjAwMDAwMDAyMjIgMDAwMDAgbg0KMDAwMDAwMDM5MCAwMDAwMCBuDQowMDAwMDAxNTIyIDAwMDAwIG4NCjAwMDAwMDE2OTAgMDAwMDAgbg0KMDAwMDAwMjQyMyAwMDAwMCBuDQowMDAwMDAyNDU2IDAwMDAwIG4NCjAwMDAwMDI1NzQgMDAwMDAgbg0KDQp0cmFpbGVyDQo8PA0KL1NpemUgMTENCi9Sb290IDEgMCBSDQovSW5mbyAxMCAwIFINCj4+DQoNCnN0YXJ0eHJlZg0KMjcxNA0KJSVFT0YNCg==";
    return [{ output: content }];
}

The file content itself must be encoded in base64 and returned under a parameter named output. Otherwise, the document list will not fetch the attachment.

Demo application: demoDocuments