Skip to main content

Import documents in FA

FA supports two types of document imports:

  • Importing attached documents from forms.

  • Importing generated JSReport documents.

Import attached documents

You can import the documents the user uploaded via forms linked in the process. To do so, first, check out Import user-uploaded files with file component, then follow the step below:

  1. Add a new Service task to the process.

  2. In component properties, define the Delegate expression to be ${files}.

  3. Add the class fields. In each class field, insert the following parameters in the Name field. To define a variable that provides the value, insert it in the Expression field. If you wish to hardcode a value, insert it in the String value field.

    Parameters in the Name field:

    • fieldName: This parameter points to the property name of the file component where documents are uploaded in forms. The value should be placed in the Expression field.

    • contactId [optional]: the contact ID if you want to store the document under the given contact. You can define the value for the expression field with a variable from the process, for example: ${import.c_contactId}. The contactId parameter overrides the documentFolder class field if both are given. The contact ID can be either the "Contact ID" defined for the contact or its internal database ID.

    • documentFolder [optional]: the folder in the FA document library to upload the documents. Enter a path in the String value field, for example: Folder/report. Note that this parameter value should not be prefixed with /.

    • documentTag [optional]: the document tags. The value can be a comma-separated list of tags for the uploaded documents. For example, this value can be used to tag documents for signing.

Import generated reports

Once a report is generated during a process, you can store it under contacts, portfolios, transactions, trade orders, securities, or FA document libraries and add tags to it. To do so, follow these steps:

  1. Add Service task to the process.

  2. In the component properties, define Delegate expression to be ${reports}.

  3. Define its class fields with Name as the following parameters and Expression as the key to grab specific data or String if you wish to hardcode a value:

    • documentName [optional]: the document name if you want the process to pick up a specific generated report. Otherwise, all generated reports are uploaded.

    • contactId [optional]: the contact ID if you want to store the document under the given contact. The default expression value can be defined using a variable from a process, for example, ${import.c_contactId}. The contactId parameter overrides the documentFolder class field if both are given. The contact ID can be either the "Contact ID" defined for the contact or its internal database ID.

    • portfolioId [optional]: the portfolio ID if you want to store the document under the given portfolio. The default expression value can be defined using a variable from a process, e.g., ${import.p_shortName}. The portfolio ID can be either the "Portfolio ID" defined for the portfolio or its internal database ID.

    • transactionId [optional]: the transaction ID if you want to store the document under the given transaction. The transaction ID is its internal database ID.

    • tradeOrderId [optional]: the trade order ID if you want to store the document under the given trade order. The trade order id is its internal database ID.

    • securityId [optional]: the security ID if you want to store the document under the given security. The security ID can be either the "Security code" defined for the security or its internal database ID. If you provide multiple security IDs, the first ID in this security ID list takes effect only.

    • documentFolder [optional]: the folder in the FA document library to upload the documents. Enter a path in the string value field, for example: Folder/report. Note that this parameter value should have a prefixed with /.

    • documentTag [optional]: the document tags. The value can be a comma-separated list of tags for the uploaded documents. For example, this value can be used to tag documents for signing.

In this section: