Creating Digital Documents

Use Custom Logic when working with one fillable PDF document, which is a PDF with interactive form fields, such as text boxes, drop-down menus, and so on. The PDF is uploaded in Studio and from there you can fill it and add options to be displayed in drop-down fields, fields names, and so on. However, you cannot add fields that are not present. There are also Server SDK methods that can be used for PDFs with interactive form fields:

• ftos.files.pdf.form.getFields: Reads all form fields from a fillable PDF and returns them as a key, where value is the actual value set on the field.

• ftos.files.pdf.form.setFields: Updates multiple form fields and persists the edited PDF under a new name.

• ftos.files.pdf.form.setFieldsReadOnly: Toggles the read-only flag for all fields in a PDF and saves the result to a new file.

Custom Logic data source can only be used with PDF document, not other types, such as Word or Excel.

Prerequisites

• You need a PDF file with interactive fields.

Add a PDF Form with Custom Logic

1. Open FintechOS Studio.

2. Click the Main Menu icon at the top left corner.
3. Click Automation Blocks > Digital Documents. The Digital Documents List page is displayed.
4. At the top-right corner of the page, click Insert. The Add Digital Document page is displayed.
5. Enter a Name for the digital document.
6. From the Data Source Type drop-down pick Custom Logic.
7. Add a stored procedure, if needed, and pick the Date and Numeric Formatting from the drop-down.
8. In the Template section, upload your PDF file with interactive fields.
9. Click Save and Reload.
10. The Server Automation Code Sample section is displayed, containing source code sample for how to generate the report, with the payload specific to editable fields contained in this template. To modify, add the sample code to an automation script part of an automation script library or a business service component, in the business logic section.
    IMPORTANT!  
    Make sure the fields in your scripts match the ones in the pdf. To check, click the Edit pdf button and navigate to the main menu on the left > Form Editor. The field names displayed here correspond to the ones in the code sample.
    
    

The document is created based on the template attached while gathering the source data for a SQL procedure, batch of statements grouped as a logical unit and stored in the database with parameters or one at all.

Prerequisites

• You should have created the SQL procedure that you want to use when creating the report document.
• The SQL procedure should control the Date and Numeric formatting (culture specific).

Add a digital document using SQL Procedure

1. Open FintechOS Studio.

2. Click the Main Menu icon at the top left corner.
3. Click Automation Blocks > Digital Documents. The Digital Documents List page is displayed.
4. At the top-right corner of the page, click Insert. The Add Digital Document page is displayed.
5. Enter a Name for the digital document.
6. By default, the selected Data Source Type is Stored SQL Procedure.
7. In the Stored procedure field, provide the name of the SQL procedure following this convention: procedure_name_as_stored_in_DB .
8. In the Template field, upload the document template to be used. The word document will be uploaded into the system and linked to the current digital document. The uploaded document template is saved into the "DocumentReportTemplates" folder which is a sub-folder of "UploadEbs".
9. Click the Save and Close button at the top right corner of the page.

 

The document is created based on the template attached while gathering the source data for an entity and its attributes.

1. Open FintechOS Studio.

2. Click the Main Menu icon at the top left corner.

3. Click Automation Blocks > Digital Documents. The Digital Documents List page is displayed.
4. At the top-right corner of the page, click the Insert icon. The Add Digital Document page is displayed.
5. Enter a Name for the digital document.
6. From the Data Source Typefield, select Entity.
7. Optionally, from the Date and Numeric Formatting field, select the culture that will apply to dates and numbers.
8. In the Template field, upload the document template to be used. The word document will be uploaded into the system and linked to the current digital document.



The uploaded document template is saved into the "DocumentReportTemplates" folder which is a sub-folder of "UploadEbs".

9. Click the Save and Close button at the top right corner of the page.

The document is created based on the template attached while gathering the source data using Fetch Designer, a FintechOS Studio feature which pulls data in a no-code manner. It can join entities while adding conditions with the operands ''AND'' and ''OR''.

Add a Digital Document

1. Open FintechOS Studio.

2. Click the Main Menu icon at the top left corner.

3. Click Automation Blocks > Digital Documents. The Digital Documents List page is displayed.
4. At the top-right corner of the page, click the Insert icon. The Add Digital Document page is displayed.
5. Enter a Name for the digital document.
6. From the Data Source Type field, select Fetch collection.
7. Optionally, from the Date and Numeric Formatting field, select the culture that will apply to dates and numbers.
8. In the Template field, upload the template to be used. The MS Word or Excel document will be uploaded into the system and linked to the current digital document.



The uploaded document template is saved into the "DocumentReportTemplates" folder which is a sub-folder of "UploadEbs".

9. Click the Save and Reload button at the top right corner of the page. The Edit Digital Document page is displayed.

The digital document will get its data from the entity record that is opened when generating the document.

Define Fetches

Prerequisites

• Make sure that there are at least two entities in the system.
• Create relationships between the entities on which you do the fetch.
• Add custom attributes to each entity for which you do the fetch; the attributes that you will use when defining the fetch.

For more information on entities, attributes and relationships, see the Data Model Explorer.

To define a fetch, follow these steps:

1. In the Edit Digital Document page, scroll-down to the Fetch Collection section and click the Insert button. The Add Fetch Definition page is displayed.
2. Enter a Name for the digital document.
3. In the Fetch definition field, fetch the data which will be used for generating the report.

To retrieve the value of a document parameter when the document is generated, use the getParameter function.

Example: Retrieve the value of document parameter param1

Copy

var p1 = getParameter("param1");
return {
    "entity": {
        "alias": "base",
        "name": "entity",
        "attributelist": [
                    {
                        "name": "displayName",
                        "alias": "",
                        "attributeType": 3
                    },
                    {
                        "name": "name",
                        "alias": "",
                        "attributeType": 3
        }
    ]
    },
    "where": {
        "type": "and",
        "conditionlist": [
                    {
                        "first": "base.tableName",
                        "type": "equals",
                        "second": "val(" + p1+ ")"
                    }
        ]
    }
}

You can also define a fetch by using the Fetch Designer (clicking the Show Fetch Designer button). For information on how to use the Fetch Designer, see Data Views.
4. The fetch definition is saved into the system and it displays in the Fetch Collection section.

The following fetch parameters are automatically mapped to specific values, as described in the table below.

Parameter	Value mapped to
Id	The record ID of the entity item that has the Report linked to the Report Document.
EntityName	The name of the entity that has the Report linked to the Report Document;
UserId	The ID of the user that runs the Report linked to the Report Document.

Set the fetch collection execution order

If you have multiple fetches defined in the Fetch Collection, you can set their execution order by drag and dropping rows in the Fetch Collection section, whereas the first fetch has the order index 1, that is, will be executed first.

The placeholders in the document template (Word document) will be replaced following these rules:

1. The first fetch (with order index 1), will always return one record which is used to define the Headers.
• If the fetch attribute does not have an alias, then the placeholder name is based on entity alias and fetch attribute name. The format is {entityalias_attributename};
• If the fetch attribute has an alias then the placeholder is the alias, {alias};

Using the example above: for the “name” attribute the placeholder should be {base_name} and for “entityid“ attribute the placeholder should be {exampleAlias}.

2. Fetches other then the first one (with order index higher than 1) will be used to populate tables; therefore, they might return many records.
• If the fetch attribute does not have an alias then the placeholder name is based on fetch name, entity alias and fetch attribute name. The format is {fetchname.entityalias_attributename};
• If the fetch attribute has an alias then the placeholder name is based on fetch name and attribute alias, {fetchname.alias};