File Transfer Builder
Compose Enterprise is going through a design update. The illustrations on this page might be of the old design, but the information is up to date. Thank you for your patience during this update!
The file transfer builder allows you to create and configure export agents. An export agent is a concept that allows for transfer of sets of files. Each file set has a unique ID in relation to the export agent and all files in a file set are uniquely named. An export agent can e.g. be used for transferring XML and PDF documents generated in a workflow for off-site handling. The builder consists of three sections; Edit, Published and Files pending.
Drafts and publishing
File transfers have a published version and a draft (just like validations). Changes are done on the draft. By publishing the draft, the published version is replaced by the draft. At the time of publishing, the changes are validated and you will be prevented from publishing anything that does not work. In addition to the save and publish buttons there are also buttons for reverting back to the last published and also a button for dropping the current draft. Dropping the draft means you have only the published version. You switch between the published and the draft version by navigating between the Edit and the Published sections.
Properties
Properties | |
|---|---|
URL Path Name | A URL which can be associated the file transfer. |
Avoid files with the same filename | Since there may be file name collisions when creating a file set, choose between Add number before extension and Add number before name strategy. This will ensure that any files with same names in the same file set will be renamed to have unique names. The order of the files will determine which get renamed and which don't. If two files have the same name, then only the last will be renamed according to the selected strategy. Note that this handles only file name collisions within a file set. It does not handle collisions due to e.g. multiple file set being downloaded to the same directory on the client side. |
Type | Only one type is currently supported: FlowRemote version 2. |
FlowRemote settings
FlowRemote Settings | |
|---|---|
Time between each file transfer (seconds) | Configures clients to pull for changes in the given interval. This is used mainly if the client is running as a service on a remote server. Too frequent pulling by many FlowRemote clients can cause performance degradation on the Compose server. In other words, this needs to be set to a high enough value not to cause denial of service kind of issues. See here for more information about such issues. |
Client ID | This is an ID identifying the FlowRemote export agent instance on the Compose system. It is unique and may not be modified once created. |
Client Code Suffix | Set the client code suffix that will be used by the remote client when it registers itself and gets the configuration from the FlowRemote web service. Note the full client code is a concatenation of the workspace name and this suffix separated with a dot. If the workspace is named e.g. myWorkspace and the suffix is set to myClientCode, then the client code will be: myWorkspace.myClientCode. This code suffix is actually the most sensitive information besides possible encryption that FlowRemote relies on. This field, and also user name and password, has a button for showing and hiding in case there is a risk of someone unauthorized seeing the entered value while changes are being done. Note that client code suffix must be unique for the whole workspace where the file transfer is created. Aka. you can't have two published file transfers using the same client code suffix. |
User Name | Sets which user name that will be used for communication once the FlowRemote client has gotten the configuration from the server. Note that this user name is not in any way connected to users in Compose, but instead it should just be viewed as part of a passphrase together with the password. For this same reason it has been made into a password field. |
Password | Sets which password will be used together with the user name when communicating after the client has gotten the FlowRemote configuration. Note that this password is stored in clear text also for this same reason. |
Client IP Address | Restricts which IP-address may connect to this export agent. |
Prevent client from setting key | This restricts how the client may change the encryption key used for storing received files. The options are Never, Once set and Always. Never means the client can change the encryption key any time it likes. Once set means the client can't change the key once it is set - note that it may initially not be set. Always means the client is never allowed to change the key - it does not matter if it is set or not. Default here is Once set, since changing the key if it has already been set may lead to unreadable data on the FlowRemote client side, if the key is changed without having first downloaded all pending file sets. |
Additional logging | Description coming |
Type | Description coming |
Key | Description coming |
Add key | This allows you to add the key to use for encryption. Currently only PGP encryption is supported. |
See the Drafts and publishing section above for the below buttons | |
Drop Draft | Remove all settings, so you’re only left with the published version of the file transfer. |
Publish | Publish the draft in order to overwrite the existing the published file transfer. |
Revert to Publish | Overwrite the settings of the draft with the settings of the published file transfer. |
Files pending section
The section displays the pending files which are to be transferred. The section lists the file sets with the delivery ID, date created, file count and folder destination (send to folder). By clicking the arrow left of the file set entry, you can see the name of the workflow, the workflow version and the files in the file set. These files can be downloaded with the Download File button to the right.
The entries can also be cleared with the red X icon in the right-most column.
Example FlowRemote client configuration
Here is an example of what the FlowRemote client configuration can look like:
flowremote.ini
runonce=true
trustallcerts=false
endpointurl=https://playground.usecompose.com/cng/web.services/FlowRemote2/RemoteClient?wsdl
keydirectory=
clientcode=myWorkspace.myClientCode
registered=true
debug=false |
As can be seen the client code is for a workspace called myWorkspace and the client code suffix is myClientCode. Also note how the endpoint URL is configured for this Compose installation running on https://playground.usecompose.com/cng. You can expect the same URL-suffix (/web.services/FlowRemote2/RemoteClient?wsdl) to work for any Compose installation. Note also that in this instance the FlowRemote client is configured to run only once - in this way you can have FlowRemote run via e.g. Cron instead of running it as a service.