How Do I Add Additional Archive Paths in Autoform DM 10 or Later?

This article will explain how to add additional Archive Paths to Autoform DM version 10 or later. We suggest you use this guide if your current storage is becoming full and you want to start archiving images to a new location.

Open the REST API Documentation

1. Log into Autoform DM.

2. Click the Information button shown in the following image.

3. Select REST API documentation, which will open the swagger documentation in a new tab.

4. Scroll down through the document until you reach a section where you can execute the REST API commands.

REST API Commands

The recommended REST API commands:

A: Archive Paths are managed using the /archive-paths resource:

B: Review what archive paths are present in the system by using GET /archive-paths/paths:

This will return archive paths in JSON format, for example:

[ 

  { 

    "name": "file-path-1", 

    "type": "DIRECTORY", 

    "path": "c:/archive" 

  }, 

  { 

    "name": "file-path-2", 

    "type": "DIRECTORY", 

    "path": "c:/archive/chunks"; 

  } 

] 

This lists all archive paths in the system, hence including the documents and chunks paths.

C: To identify which path is currently set as either the document or chunks paths use the following operations:

These will return the name of the archive path set for each purpose, for instance, file-path-1.

D: To add a new archive path in addition to the existing one, use POST /archive-paths/paths.

For example, adding a new path called “my-new-path” in the location c:\other-archive you would use:

When executing this, ensure you see a 200 OK response.

To confirm that the path has been added, use the GET operation in command B. The added path should be listed in the response.

E: The new archive path is now ready for use and can be set as the new document or chunk path as desired using:

For example, to set the newly added path my-new-path as the document path, use the first option from above and set the body to the new archive path name:

Note

1. The above example shows the use of a forward slash “/” in the path because a single “\” backslash is treated as an escape character. However, for UNC path eg \\efspdm-02\e$\archive. Please use a double backslash for each single back slash for example:

"path" : \\\\efspdm-02\\f$\\archive

2. This process will not create a new folder. To do that use Windows File Explorer.

3. After setting this up, all new images will be archived to the new location, but searches for older documents will still pull images from the old location.