If you are not familiar with Workflows, we suggest you start with The Workflow
article to gain a better understanding of the different workflow types and screen structures.
FBO One also has an Invoicing API that can be used to interface with your chosen accounting system. For more information please contact the team for more information.
Contents:
SendEntry transition action
The SendEntry action sends the entry file directly into the Accounting server via FTP or Email, preventing the manual transfer of the file and any related issues such as forgetting to upload the file in the accounting software after export or manually editing the export file prior to the upload.
Procedure:
- The user would create the entry in the usual manner.
- Prior to marking the files as "Processed", send the file using the SendEntry transition action
- After having successfully sent the file the user should check that they are present on the FTP server (in case of FTP)
- In the event the files are not present or in case of a thrown error, the user can resend them.
- Once the imported files are present on the FTP server the entries can be marked as being processed ("Mark entry as imported into accounting system")
Created to Sent Transition:
Sent to Resend or Processed Transition
Configuration details
In order to send the export files via FTP to the accounting system or to send them via Email, a few configuration details must be entered in the applicable Workflow state transition fields.
- The fields that need data are the configuration string fields.
- FBO One distinguishes 2 types of configuration strings, for live and test environments:
Live environment uses:
- Configuration string
- Additional encrypted configuration string fragment
Local dev and usertest uses:
- Test mode configuration string
- Test mode encrypted config string fragment
"Configuration string" / "Test mode configuration string" details:
- Scheme = (default=SFTP) The scheme to be used when building a proper host URI. If scheme SFTP is used, the system will upload using SFTP protocol
- Host = The host URI
- Username = Username used for authenticating on to the SFTP server
- Password = Password used for authenticating on to the SFTP server (for safety reasons please enter the values into the "additional encrypted configuration string fragment" field, were it will be automatically encrypted upon saving) Please enter this detail as Password=your password
- Path = The path on the SFTP server where to upload the export files
- Port = (default=21) The port to use in order to establish proper connection with the SFTP server. Use Port=22 for SFTP
- UseSSL = (true/false, default=false) Flag that states whether to use or not SSL encryption while file transfer . Not relevant if SFTP is used.
- EnableEmail = (true/false, default=false) As an alternative to FTP the export files can be sent via email. In order to that this field must be set to "true"
- EmailTo = Email addresses to which to email the export files. One or many emails addresses can be specified, but in case of many these must be delimited by ",". In case of being in a dev or usertest environment an extra field is shown in the transition screen where the default EmailTo values (the ones specified in the config string) can be overwritten.
- EmailSubject = The email subject e.g. EmailSubject=FBO One Entries ~EntryNumber~ (Were ~EntryNumber~ will be filled automatically)
- EmailBody = (default="") The email body
- ExportDocumentType = (Compressed/Expanded/Both, default=Compressed) Because some entry exporters export document files in the compressed format or in the expanded one, or even both it is possible to specify which file to send via FTP or Email
"Additional encrypted configuration string fragment" / "Test mode encrypted config string fragment" details:
- the password can be entered and stored (and automatically encrypted) in this field (store the entire string: Password=myPassword
NOTE: On Usertest environments, emails are sent out only to the recipients mentioned in the Test mode configuration string, not those in the application setting TestEmailList.
Comments
0 comments
Please sign in to leave a comment.