Skip to content

Latest commit

 

History

History
43 lines (30 loc) · 2.67 KB

README.md

File metadata and controls

43 lines (30 loc) · 2.67 KB
Raw

CloudConvert Integration

Description

File conversion using the CloudConvert API and Linx.

Installation

CloudConvert Setup

  • First you will need to register on https://cloudconvert.com/
  • Once registered, go onto your CloudConvert Dashboard, and select "API v2" --> "Authorization" on the left menu
  • Select "Create New API Key" and select the scopes (at a minimum you'll need tasks.read and tasks.write)
  • Save the API key

Linx Setup

  • Install Linx Designer from https://linx.software
  • Using Linx Designer, open the solution file "CloudConvert.lsoz"
  • Select "Settings" and set up your details:
    • APIKey: The key you just created in CloudConvert
    • APIKeyName: As you've defined it in CloudConvert. Not used in Linx, but good for referencing back to which key you are using.
    • CCPassword: Again, not used in Linx
    • CCUrl: Can keep as is
    • CCUsername: For your reference, you can save your CloudConvert username here
    • TempTaskFolder: The folder this example with use to place your .tasks files in.

Usage

This example includes two different flows to demonstrate the CloudConvert Process. Because CloudConvert uses the principle of tasks and jobs, there are many different ways you can perform the Conversions. However, in this example, Linx is only using Tasks, and keeping track of them. The two flows in this example are:

  • Task Manager Using Sleeps: In this flow, there is a singular straight down process which keeps looping and checking the status of a task, until it's complete, and then go onto the next. This is not recommended as you could easily go into an infinite loop, however, this is the easiest way to understand how CloudConvert tasks work.
  • Tasks Manager Using TXT Files: This is a TXT-based database illustrating how you could set up your tasks and then go through the phases of the convertion flow.

The actuall calls to CloudConvert are done in the APICalls folder

For "TaskManagerUsingSleeps" run the "StartTaskUsingSleeps" function. Remember to provide Debug with the starting values:

  • OriginalFileFullPath: The full path of the file you want to convert (i.e C:\temp\mytext.txt)
  • DestinationFullPath: A path and filename for where you want to save the converted file (i.e. C:\temp\mypdf.pdf)
  • FromType: The type of file you are converting from (i.e. txt or xls)
  • ToType: The type of file you want to convert to (i.e. pdf or xlsx)

For "TasksManagerUsingTXTFiles" run the "StartTaskUsingTXTFiles" function to initiate the tasks. You will then also need to allow the timer "TaskTimer" to run. For every minute the timer runs, it takes the tasks to the next status. Again, remember to provide the starting values when you run "StartTaskUsingTXTFiles"