Corporate LinX - Documentation Library
Accessing Workflow Designer
The workflow designer is accessed via the Business Processes page. Expanding a Business Process will display the workflows that are attached to it, to view the workflow designer for the workflow you wish to edit, you click on the "Edit" button on the row corresponding to it.
The UI
When you access the workflow designer, you're greeted with something that looks like this:
This UI is quite complex and does require quite a high-level knowledge of our system to use. This is where the workflows are set up and it’s what ensures that transactions import and offer generation is possible.
Left-Hand Menu
The left-hand menu breaks down any possible tasks that our system can carry out within a workflow process.
Api
When you click on the Api section, this is how it is broken down:
This table breaks down each of them further, allowing you to understand their purpose. Clicking on any that have a + icon next to them will add it to the workspace on the right hand side.
| ApiDelete | Allows the workflow to remove something from the database. |
| ApiGet | Enables the workflow to retrieve necessary information from the database. |
| ApiGetCollection | Allows the workflow to retrieve collections of necessary data. |
| ApiPost | Allows the workflow to create a new item in the database. |
| ApiPostBatch | Enables the workflow to create multiple new items in the database |
| ApiPut | Allows to workflow to update an existing item in the database. |
| Authenticate | The app’s overview, including the applications configuration. |
B2B
When you click on the B2B section, this is how it is broken down:
This table breaks down each of them further, allowing you to understand their purpose. Clicking on any that have a + icon next to them will add it to the workspace on the right hand side.
| CompanyImport | Ensures that the workflow can be used to import companies. |
| Demo | Allows the workflow to create and import transactional data that is used for demonstration purposes. |
| GenerateOfferParams | This determines the parameters for the offer generation in the system, considering things like, the expiry time, Cut-off dates for example. |
Transformation
When you click on the Transformation section, this is how it is broken down:
This table breaks down each of them further, allowing you to understand their purpose. Clicking on any that have a + icon next to them will add it to the workspace on the right hand side.
| Convert | Allows the workflow to convert to one file format to another. |
| CsvXsl | Converts a given CSV file to XSL file format. |
| DynamicDataFlatten | Converts complex, hierarchical data into a flat tabular format. Breaking out the nested structure into separate columns or fields. |
| JsonXsl | Converts a given Json file to XSL file format. |
| XmlXsl | Converts a given XML file to |
| Xsl | Allows the workflow to convert from a given file format to XSL. |
DMS
When you click on the DMS (Document Management System) section, this is how it is broken down:
| CsvFile | Allows the workflow to create CSV files in a specified location in DMS. |
| CSVFolderContent | Ensure the workflow can retrieve the content from the CSV files from a given folder in DMS. |
| DMSCreateBinaryFiles | Ensures the workflow can Create Binary Files in DMS. |
| DMSCreateTextFiles | Enables the workflow to create Text Files in DMS. |
| DMSDelete | Allows the workflow to delete a file, files or folder from DMS. |
| FolderImport | Enables the workflow to import a provided folder to DMS. |
| JsonFile | Allows the workflow to create a Json file at a location in DMS. |
| JsonFolderContent | Ensure the workflow can retrieve the content from the Json files from a given folder in DMS. |
| Move | Allows the workflow to move a file from one location in DMS to another location. |
| MoveAll | Allows the workflow to move all of the files from one folder in DMS to another folder in DMS. |
| TextFileContent | Ensure the workflow can retrieve the contents from a text file. |
| XmlFile | Allows the workflow to create an XML file in a location in DMS. |
| XmlFolderContent | Ensure the workflow can retrieve the content from the XML files from a given folder in DMS. |
Log
When you click on the Log section, this is how it is broken down:
This table breaks down each of them further, allowing you to understand their purpose. Clicking on any that have a + icon next to them will add it to the workspace on the right hand side.
| Debug | Allows the workflow to output a log Debug messages. |
| Error | Enables the workflow to output a log of Error messages. |
| Info | Allows the workflow to output a log of Info messages. |
| Warning | Allows the workflow to output a log of Warning messages. |
Demo
When you click on the Demo section, this is how it is broken down:
This table breaks down each of them further, allowing you to understand their purpose. Clicking on any that have a + icon next to them will add it to the workspace on the right hand side.
| DemoTransactionGenerator | Allows the workflow to generate transactional data for demonstration purposes. |
Activity
When you click on the Activity section, this is how it is broken down:
This table breaks down each of them further, allowing you to understand their purpose. Clicking on any that have a + icon next to them will add it to the workspace on the right hand side.
| Discord | Allows the workflow to post a message to Discord. |
| EventTrigger | Allows the workflow to trigger an event, this could be kicking off a workflow to generate offers for example. |
| FormSubmission | Enables the workflow to submit a form which will create new rows in the database. |
Discord
When you click on the Discord section, this is how it is broken down:
This table breaks down each of them further, allowing you to understand their purpose. Clicking on any that have a + icon next to them will add it to the workspace on the right hand side.
| Discord Send Attachment to Channel | Enables the workflow to send a message with an attachment to a discord channel. |
| Discord Send Message to Channel | Enables the workflow to send a message to a discord channel. |
Core
When you click on the Core section, this is how it is broken down:
This table breaks down each of them further, allowing you to understand their purpose. Clicking on any that have a + icon next to them will add it to the workspace on the right hand side.
| ExecuteFlow | Enables the workflow to execute another workflow. |
| QueueBackgroundJob | Allows the workflow to queue a process that will run in the background, one example is transactions import. |
| Start | Allows the workflow to start a new workflow, for example automatically generating offers after transactions have been imported. |
Generate Offer Params
When you click on the GenerateOfferParams section, this is how it is broken down:
This table breaks down each of them further, allowing you to understand their purpose. Clicking on any that have a + icon next to them will add it to the workspace on the right hand side.
| GenerateOffers | Allows the workflow to generate offers in the system, taking into account the funding details in the system. |
Templating
When you click on the Templating section, this is how it is broken down:
This table breaks down each of them further, allowing you to understand their purpose. Clicking on any that have a + icon next to them will add it to the workspace on the right hand side.
| PageBuilder | Allows the workflow to build out a page, based on the parameters given. |
| SendEmail | Enables the workflow to send out an email, to the current user or a specified account, typically a support account. |
Sftp
When you click on the Sftp section, this is how it is broken down:
| SftpCreateBinaryFiles | Allows the workflow to create binary files on the SFTP server. |
| SftpCreateTextFiles | Allows the workflow to create text files on the SFTP server. |
| SftpDelete | Allows the workflow to delete a file or folder from the SFTP server. |
| SftpFetch | Allows the workflow to retrieve any necessary files/data it requires from the SFTP server |
| SftpMove | Ensures the workflow can move files from one location to another on the SFTP server. |
Right-Hand Workspace
This is where you can set up your workflow, the green lines attach tasks together and they define the order of events. For ease of use, the boxes that contain the tasks can be dragged around. This allows you to rearrange them and re-order them quite easily.
When you add things to your workflow from the left-hand menu, they will be added to the workspace on the right-hand side. Each and every thing on the left-hand menu is unique and will require its own unique configuration to work. This documentation covers a basic example of the different things that need configuring to ensure that they work. This is where in-depth knowledge of the technicalities of the CLeX platform is beneficial as it will allow you to understand how workflows work and their setup.
Green Connections
As briefly explained above, this is how you connect the events of a workflow to one another, of course, the results of one task need to be used by succeeding tasks within the workflow. The green dot in-between each task can be interacted with. When you click this green dot, it brings up a dialog that contains a code editor that looks something like this:
This is the green dot from the screenshot that lies between the “Queue Background Job” task and the “Move Processed Files” tasks. The first thing defined, is the file’s destination folder. When the files are moved from the received folder, they are moved to this location. The “files” variable gets all of the files from the received folder. The “files.Add” takes the files and transforms them to a json file and puts them into the “transformed” folder. To confirm any changes you’ve made in the dialog, you click the submit button in the dialog.
Edit Button
This button is responsible for different things, depending on the task you wish the workflow to carry out. Clicking on the “Edit” button will bring up a dialog that looks something like this:
The “Type” determines where in the api the task is defined, the “Ref” is the reference to the task you wish to carry out. Here, you can define the “Path” as the path at which you want the file to be moved to. The “AppId” is the Id of the application you wish to move the files within. The “AuthToken” and the “AuthToken” are filled in by the system when the workflow is run. “BaseUrl” for example looks something like this “demo.dev.corporatelinx.com/api”, it just means the base url for the application’s api. You can confirm these changes by clicking the submit button in the dialog.
The Close Button
Each activity has a close button in the top right-hand corner, when this is clicked, it removes the activity from the workspace in the right hand side.
Left-Hand Toolbar
This is where the basic functions are for the workflow, “Settings”, “Run” and “Save”.
Settings
Clicking the “Settings” button brings up a dialog that looks something like this:
The settings here determine who in the system can run the workflows. Typically this is an administrator only process as a lot of the workflows are responsible for things like, processing transactions or generating offers. These tasks can only be carried out by admins.
Run
This button can be used to run the workflow that you’re currently looking at. Having this button here allows you to quickly run things once things have been adjusted or set up. It’s also useful if there are any issues to debug as you don’t need to venture to another part of the UI to run the workflow.
Settings
This saves any changes you’ve made in the right hand side workspace will be saved with this button, whether that’s removing an activity or altering its settings. They will not be saved until this button is pressed.