Manager iPart Configuration

Add a Document Reference Field

Document Valet uses a Document Reference Field (an integer field which is added to your data source) for two key purposes:
  1. Linkage – the Document Reference Field and its Data Source, combined with the identity of the Selected User uniquely defines which set of documents to display and retrieve.
  2. Reporting – the Document Reference Field field is incremented and decremented each time a document is added or removed. This provides current information for reporting purposes to show how many documents are available and/or have been submitted.

Configure the Repository Records

Document Valet supports multiple document repositories. Each repository is a unique combination of:
  • Storage technology (e.g. Sharepoint, Box, Azure, iMIS)
  • Folder location (e.g. /Membership/Applications)
The key values which need to be configured include:
  • REPOSITORY_TYPE – Base technology (e.g. SharePoint, Azure, iMIS)
  • TOKEN_REQUEST_URL – the URL of the token request endpoint if required
  • CLIENT_ID – Encrypted value of the Client ID
  • CLIENT_SECRET_KEY – Encrypted value of the Client Secret Key
  • TARGET_FOLDER – The Target folder where documents are to be stored
See the appendix for detailed instructions for configuration of repositories.

Configure the iPart

The following configuration options are available:
  • Name – Name of the iPart for display when editing the content record
  • Title – Section title that will appear above the document control (optional)
  • Do not render in design mode – normally checked, this hides coding when you are updating the page
  • iPart CSS class – Available to adjust the overall display of this iPart
  • Display a border around this content (optional)
  • Display content within a collapsible panel (optional)
  • Display on screen sizes (for responsive themes only) – deselect to suppress display on specific screen sizes
  • Repository – Dropdown list of available repositories as defined in the General Lookup Table "VADM_REPOSITORY". The "Verify" option will use the parameter settings to connect to the repository to confirm access.
  • Data Source – the single or multi-instance table that holds the Document Index field. If a multi-instance data source is detected this is indicated by the Multi-instance Type checkbox.
  • Document Ref Field – the specific index field that is to be used with this iPart. Note that only integer fields are shown based on the data source selected.
  • MI Key Alias – For multi-instance tables, this specifies the URL parameter that should be used to identify the specific record being addressed. For iMIS 2017 this defaults to SEQN but other values such as "SubmissionID" or "AppID" can be substituted if required. iMIS Cloud will use the value "Ordinal" for this field.
  • Allow changes – this setting enables the ability to upload and/or delete documents. If this is not checked then only the download of existing documents is permitted.
  • Min No of documents – this setting enables a validation check on the minimum number of documents uploaded. You can choose to enter a specific value which will apply in all cases or you can identify a "Minimum number of documents" field on your data source which should be respected. If a user submits a form on the page without this condition being met then the Validation Message is displayed.
  • Max no of documents – this setting restricts the system from uploading more than a specified number of documents to a maximum of 99. You can choose to enter a specific value which will apply in all cases or you can identify a "Minimum number of documents" field on your data source which should be respected. If the maximum number of documents have been uploaded then a document must be deleted before another one can be uploaded. 
  • Document types – specific list of document types allowed for the specified Repository / Data Source / Document Index field combination. Document types are specified with a "." and separated by a comma (e.g. .pdf,.xls,.xlsx).
  • Maximum File Size – maximum size of an individual file in MB. Your target repository may impose additional limits.
  • Target Location id – DIV identifier which defines where the iPart should automatically relocate itself to upon page load. Using this feature allows you to embed the document iPart inline with a Form Builder form or other HTML content on your page.
  • Show date – option to display the file date
  • Show size – option to display the file size (in MB)
  • No document message – default message to show prior to any document being uploaded
  • Validation message – message to display when the minimum number of documents condition is not met
  • Validate Settings – use this option to ensure that your settings are complete and correct prior to publishing your page.