Frequently Asked Questions

1. How do I upload a document to FormKiQ?

The recommended method for uploading a document is to use the GET /documents/upload endpoint, which provides a pre-signed URL for securely uploading the file to Amazon S3. After uploading, use a POST or PATCH request to associate the document's ID with the appropriate case or folder.

While the POST /documents endpoint can also upload documents, it is not recommended for production environments, especially for large files.

Step-by-Step Instructions:

1. Generate a Pre-Signed URL:
   • Use the GET /documents/upload endpoint to generate a pre-signed S3 URL.
2. Upload the Document:
   • Upload the document using the pre-signed URL you received.
3. Associate the Document:
   • Use a POST or PATCH request to associate the uploaded document's ID with the relevant case or folder.

For more information on uploading documents using signed URLs, check out the FormKiQ Upload Tutorial.

2. How do I move files to a folder?

To move files within FormKiQ, use the POST /indices/folder/move endpoint. This API call allows you to update an index by supplying the current path as the source and a new destination path for the file.

• No Document ID Required: You do not need to specify the document ID.
• Specify Paths: Use the file’s current location (source path) and the desired new location (destination path).

For more details, refer to the FormKiQ API Documentation.

3. How do I connect to the FormKiQ API using an API Key?

Step 1: Generate a FormKiQ API Key

• Log in to the FormKiQ Console.
• Navigate to the Integrations section and create an API key.
• Specify the permissions for the API key: Read, Write, or Delete.
• Important: Once the key is generated, copy it immediately, as you will not be able to view it in its entirety again.

Step 2: Retrieve the Key Authentication API URL

• Open the CloudFormation Outputs in your AWS console (if you're using AWS deployment).
• Look for the FormKiQ Key Authentication API URL in the Outputs section.

Step 3: Use the API Key in Your Application

• Store your API key and the Key Auth API URL in your application code. For example, in a Node.js app:

  const apiKey = "<YOUR_API_KEY>";
  const keyApiUrl = "<YOUR_KEY_API_URL>";
  

  Replace <YOUR_API_KEY> and <YOUR_KEY_API_URL> with your actual values.

• Include the API key in the Authorization header for each API request:

  const axiosConfig = {
    headers: {
      'Authorization': `${apiKey}`,
      'Content-Type': 'application/json',
    },
  };
  
  // Example of making a GET request
  axios.get(`${keyApiUrl}/documents`, axiosConfig)
    .then(response => {
      console.log(response.data);
    })
    .catch(error => {
      console.error('Error fetching documents:', error);
    });
  

Step 4: Test the Connection

• Run your application to confirm that the API key is working and that your requests are authenticated.
• If successful, you should receive a response from FormKiQ's API.

4. Why did I receive a new template with the same URL?

If you received a template with the same URL, it might be a beta version of FormKiQ. Beta versions do not include numbered version updates. If you're unsure, you can confirm with the FormKiQ technical team to verify whether the template was sent in error or as part of a beta release.

5. What is the difference between "ADMIN" and "GOVERN" permissions?

• ADMIN Permissions:
  • Control access at the user, group, and site levels.
  • Manage who has access to certain documents or actions.
• GOVERN Permissions:
  • Focus on document control and data governance.
  • Allow users to make changes at the document or metadata level, potentially affecting access to specific documents and their associated data.

6. I'm getting a "413 Payload Too Large" error when uploading a file. How can I fix this?

The 413 error indicates that your file exceeds the size limits of API Gateway (10 MB). To handle larger files, you should use Amazon S3:

1. Generate a Pre-Signed S3 URL:
   • Use FormKiQ's /documents/upload API to obtain a pre-signed URL.
2. Upload Directly to S3:
   • Upload your file directly to S3 using the pre-signed URL.
3. Reference the File in FormKiQ:
   • After uploading, reference the file in your FormKiQ resource.

This method bypasses the API Gateway limitations and allows you to efficiently handle large files. For a detailed guide, see the FormKiQ Upload Tutorial.

7. How can I download the FileSync CLI?

To provide you with the correct FileSync CLI download, please provide:

• Your Operating System: Windows, Mac, or Linux.
• Your Version of FormKiQ: For example, v16.0.0.

After receiving this information, we will send you a temporary download link.

Note: The FileSync CLI is part of our commercial offering; please contact us for more information on your current license.

8. How do I capture the request and response details when uploading a document via the FormKiQ Console?

To gather detailed request and response data for troubleshooting:

Open Developer Tools in Your Browser:

• Chrome: Right-click the page and select Inspect or press Ctrl + Shift + I (Windows/Linux) or Cmd + Option + I (Mac).
• Navigate to the Network tab.

Start the Document Upload Process:

• Begin uploading a document using the FormKiQ Console.
• The Network tab will capture all network requests.

Locate the POST /documents/upload Request:

• Find the POST request.
• Inspect its Headers for request payload details.
• Check the Response for the pre-signed S3 URL.

Inspect the PUT Request to S3:

• After the POST request completes, locate the PUT request that uploads the file to S3.
• Check the PUT request’s Headers and Response to confirm if the upload was successful.

9. How do I delete my FormKiQ CloudFormation stack?

Step 1: Delete Documents in Your S3 Bucket

Before deleting the stack, you need to manually empty the S3 bucket that contains your documents:

• Open the AWS S3 Console.
• Navigate to the bucket used by your FormKiQ instance.
• Delete all files and folders inside the bucket.

Step 2: Delete the Stack via CloudFormation

• Go to the AWS CloudFormation Console.
• In the Stacks list, locate and select your FormKiQ stack.
• Click Delete and confirm the action.
• CloudFormation will attempt to delete all resources created by the stack.

Step 3: Verify Deletion

• Check the CloudFormation Console for a successful deletion status.
• Ensure that all AWS resources (S3 buckets, DynamoDB tables, etc.) have been removed.
• If any resources fail to delete, check the Events tab for error messages and troubleshoot accordingly.

10. Can I use an existing Cognito User Pool with FormKiQ?

Yes, it's possible to configure FormKiQ to use an existing Cognito User Pool.

Setting up the configuration is usually done with support from the FormKiQ team. Please contact us for more information.

11. Can I use an existing OpenSearch cluster with FormKiQ?

Yes, it's possible to configure FormKiQ to use an existing OpenSearch cluster.

FormKiQ Advanced and Enterprise customers can use a new or existing OpenSearch cluster, with both options providing the same document and metadata synchronization and search functionality. Setting up the configuration and security is usually done with support from the FormKiQ team. Please contact us for more information.

12. How do I install my commercially-licensed edition of FormKiQ to a new AWS Account?

All commercially-licensed editions of FormKiQ are tied to specific AWS account numbers.

The FormKiQ team can adjust which AWS accounts are able to access your FormKiQ CloudFormation templates; please contact us if you would like to make an adjustment.

Note: your specific license will have a set number of production-level AWS accounts and instances available; there is no limit to non-production accounts or instances. 

13. Where can I find documentation on FormKiQ?

You can find full API documentation, guides, and tutorials on the official FormKiQ Documentation Site.