Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Executing the Quik! Forms Engine

Setting up and executing the Quik! Forms Engine follows the following guidelines. A full set of sample code for calling the Quik! software is available at the end of this section (see Sample Code Explanation for your environment).

  1. Set a reference to the QuikFormsEngine.dll
  2. Create the Quik! Forms Engine object
  3. Populate the required parameters
    1. QuikUsername, QuikPassword, QuikCustID
    2. Form IDs
    3. Error page
    4. Output path (if writing output files to disk)
    5. E-Sign URL (if e-signing)
  4. Populate fields you wish to pre-fill
  5. Run the Execute command
  6. Serve the HTML file to the user's browser as a response


Parameters

The Quik! Forms Engine requires the following parameters in order to generate a form. For a detailed explanation of these parameters, please see their respective property definition.

QuikUsername (string)

The QuikUsername is a string value containing the username for your corporate account with Quik!.

QuikPassword (string)

The QuikPassword is a string value containing the password for your corporate account with Quik!.

QuikCustID (string)

The QuikCustID is a string value containing the Customer ID assigned by Quik! in your master customer account record in the Quik! customer database.

QuikFormID (string)

The FormID is the unique identifier used by the Quik! database to identify a form. You can pass one FormID or multiple FormIDs when running the software.

OutputPath (string) – OPTIONAL

The OutputPath is a string containing the full path location for where you want Quik! output files to be saved. For example, "c:\windows\temp\".

OutputFileName (string) - OPTIONAL

The OutputFileName is an optional string parameter allowing you to name the output file according to your own file naming convention – you do not need to add any file name extension (e.g. ".html" is not required). If left empty, Quik! will generate a file name by default.

OutputTempFiles (Boolean) – OPTIONAL

When set to true, the output file will be a temp file generated by Microsoft Windows.

WriteErrorLogToDisk - OPTIONAL

To help debug your implementation of the Quik! software you can turn on error logging and write the values to disk.

SignURL - OPTIONAL

If turning on electronic signature with a supported e-sign vendor (e.g. DocuSign), then provide the URL value that points to the QuikESignTransport project's QuikSignTransport.aspx page hosted on your domain.

  • No labels