Acodis IDP Platform
      Back to home
      1. Support Center
      2. User Guide
      3. Acodis IDP Platform

      How do I set up automated import & export channels?

      You can easily customize and automate how you import/export your documents into the Acodis IDP Platform.

      1. To access your Workflow's import and export channels' automation options:

      • Choose the Workflow you want to customize by clicking the Workflows Vector Workflows tab on the upper left and then selecting the desired Workflow.
      • Click the Menu button IDP Menu Button on the top right corner, then click setting Settings.
      • Click either the Import or Export tab.

      2. To customize and automate your import channels:

      • In the Import tab, you can automate up to 3 import channels at once. (API, Email, and FTP or FTPS protocols). To automate your export channels, scroll to step 3.

        • To automate your document imports through an API:

          • Click the Enable API Channel tab and turn the toggle switch on.
          • Use the API URL provided in the API URL slot to connect your application to Acodis. 
          • Finally, note the auto-generated Workflow ID and Workflow Key. The workflow key automatically disappears when you exit the automated import page for security reasons, so make sure to note it down. 

      Please Note:

      If you forget the key or want to generate a new one, click on the Generate New Password button. The same credentials are also being used for automated API export.

        • To automate your document imports through Email:

          • Click the Enable E-mail Channel tab and turn the toggle switch on.
          • An auto-generated email address will appear in the Email-address field.
          • Note this email address and send your documents as email attachments to it to use it as one of your automated import channels.

      Important:

      • please send your documents as an attachment,
      • please attach no more than 10 documents per email,
      • please make sure the documents are not compressed (e.g in a .zip format),
      • please make sure the documents are in a supported file format,
      • there is a limit of 100 characters in the recipient field. If you have entered multiple mail addresses, please make sure that the one from Acodis is listed first so that it doesn’t get trimmed.

        • To automate your document imports through an FTP server:

          • Click the Enable FTP Channel tab and turn the toggle switch on.
          • Click the Protocol drop-down menu and select your company's protocol FTP or FTPS.
          • Enter your company's FTP(S) server/path in the Server and Path field.
          • Enter the FTP(S) port number in the Port field.
          • Enter your company's FTP username and password in the Username and Password fields.
          • Click the Pull Interval drop-down menu in the Configuration section and select your desired pull interval.
          • (Optional): If you wish to leave documents on the server, turn the Leave Documents on Server toggle switch on.
          • Finally, click the blue Test Connection button.

      Important:

      The server/path you enter should include the server address and folder path.

      Example: server1.customerdomain.com/documents/for_processing

       

      3. To customize and automate your data export channels:

      • In the Export tab,  turn the Activate Automated Export toggle switch on.
        You can choose to automate your document exports through one of three channels: (API, Email, or FTP).

        • To automate your document imports through an API:

          • Click the Channel drop-down menu in the Export Channel section and choose API.
          • Use the API URL provided in the API URL slot to connect your application to Acodis.  

      Please Note:

      • If you have already set up an automated API Import Channel, the Username and Password are the same as the import channel's Workflow ID and Workflow Key. The Workflow Key automatically disappears when you exit the automated export page for security reasons, so make sure to note it down. 
      • If you forget the key or want to generate a new one, click on the Generate New Password button. The same credentials are also being used for automated API import.

        • To automate your document exports through Email:

          • Click the Channel drop-down menu in the Export Channel section and choose Email.
          • (Optional): In the Email Subject section within the Configuration section, you can customize the export email's subject by selecting Define Your Own Subject and entering your desired subject.
          • Otherwise, select the Use Export File Name option, and the export email will use the export file name as its subject line.
          • Enter the Email Address you want exports sent to in the Email Address slot.
          • Click the Export Format drop-down menu in the Configuration section and select your desired export format.
          • Click the Send Verification Email button.
          • Finally, open the verification email sent to the provided email address and click the Verify Email Address button.

        • To automate your document exports through an FTP server:

          • Click the Channel drop-down menu in the Export Channel section and choose FTP.
          • Click the Protocol drop-down menu and select your company's protocol FTP or FTPS.
          • Enter your company's FTP(S) server/path address in the Server and Path field.
          • Enter the port number in the Port field.
          • Enter your company's FTP(S) username and password in the Username and Password fields.
          • Click the Export Format drop-down menu in the Configuration section and select your desired export format.
          • Finally, click the Test and Activate button.

      Important:

      The FTP server/path you enter should include the server address and folder path.

      Example: server1.customerdomain.com/documents/for_processing