Push Form Data

Owned by Damith Samarakoon
Dec 11, 2024
2 min read

The Push Form Data utility, accessible under Configure > Utilities, enables users to efficiently transfer correspondence forms between projects.

Key Features:

Utility Overview:

  • Found under Configure > Utilities > Push Form Data.

  • Allows users to select a form type (e.g., ITP), specific forms, and a single destination project.

image-20241211-000747.png

 

Form Type and Destination Support:

  • Applies only to correspondence form types (e.g., ITP, NCR).

  • Not applicable to TX, DTX, or CA forms.

 

image-20241211-000848.png

 

Customisable Options:

  • Switch Options:

    • Generate New Reference (default: enabled): Automatically assigns new references in the destination project.

    • Include Comments (default: disabled): Transfers comments, excluding internal comments.

    • Include Attachments (default: disabled): Transfers form attachments.

    • Use Default Status: Applies the default status configuration for the destination project.

 

Form Reference Handling:

  • Automatically checks the reference register in the destination project to assign the next available reference number.

    • Example: If the latest reference in the destination project is ITP#0004 and you push ITP#0001, it will become ITP#0005.

Form Data Mapping:

  • Comments: Included only if the option is enabled. Ensure users within comments are available in the desitnation project.

  • User Fields: Transfers only user fields with valid configurations in the destination project (e.g., matched options for select fields).

Technical Implementation:

  • Retrieves forms via the REST API (Document/GetById).

  • Pushes forms using the REST API (Document/Import) for each document.