CWCM FTP fact sheet
This document describes how you should use the CWCM FTP service.
Setting up a client
First you will need to configure an FTP client to connect to the FTP server.
The FTP server can be used with different FTP client applications.... if not yet done, ask your IRM Team to install one FTP client on your workstation.
Set connection information as follow in your FTP client software.
|Port :||7021 (wcmcom)|
You should set the mode to Active, otherwise the connection will fail.
The timeout should be set to 300 seconds.
Every user can only use one connection at a time, so you should configure your client not to use more than one connection for transfers and you should not launch transfers in the background.
You should not use any keep alive mechanism since this will prevent other users from connecting to the service! The session timeouts are long enough for normal usage.
Use your CWCM credentials to connect.
Please do not store your password in the FTP client since this poses a major security risk.
Using FTP in the CWCM
This section describes how to use the FTP interface and how it differs from the normal web-based interface.
It is important to realize that FTP interface can be only be used for file transfer; there are no functions to promote or expire and you can not change the properties of documents.
This means that it does not replace the web-based interface; you will need to use the web interface to actually publish the transferred content, to change the properties and all other operations.
The main use of the FTP interface is to export your subsite in case you want a local copy and to import content if you have a lot of files to process.
The FTP interface follows the same rules as the web-based interface.
- You need to have sufficient permissions to import the content
- Subsite restrictions on type and language are enforced
- Translations are recognized
- When importing a new version of a WIP or Staging document, it will create a minor version change
- When importing a new version of an Active document, it will create a major version change
- An imported file will be regenerated and/or published immediately (in WIP)
- You can only delete documents which highest state is WIP or Expired
- You can not delete original files when there exist translations
Checked out files
Some things work a little different than using the normal interface.
When you import a document that was checked out by you, the new version will be checked out too. Note that if the file was checked out by someone else you don't have the permission to create a new version.
Each file is treated separately; when one file has an error, this has no effect on the other files.
Therefore you should always check the output of your FTP client to make sure there were no failed transfers
Access to the parallel structure (XSL files)
You can only export and import the XSL files; the prototype files have no content and can not be treated.
When you import over an existing file, it will create a minor version change.
Difference with Site Packaging
The Site Packaging module is much smarter than the FTP interface; it was meant to export and import a complete site including the XSL files, Linkgroups, Menus, Categories etc. and manage all relations between them.
The FTP interface can only export and import single files.
The Site Packaging is also more restrictive and checks the validity of the XML before importing.
The FTP interface works like the web-based import and only checks if the XML is well-formed.
When you login you will see four root folders:
- internet, the internet websites
- intracomm, the intracomm websites
- presentations, the parallel structure
- xsl-common, the common XSL files
If you do not use your connection for some time, it will be closed by the server automatically.
Note that you can not log in twice at the same time. If your client is not closed properly, you might have to wait a few minutes for the server to close the idle connection before you can login again.
It is easy to export files. Your FTP client is smart enough to retrieve a complete subsite structure with one command.
Note that since some parts of XML content files are updated on export the exact size between the local file and the file on the server might differ some bytes.
If your FTP client is configured to do parallel transfers you will get error messages that the maximum login limit has been reached. To avoid this configure your client to not open more than one connection and do not do any transfers in the background.
When you import files your FTP client will warn you when you are about to overwrite existing content.
You need to be at least an author in the selected site to import a file.
You can also create new subsites, but you need to be a webmaster for that.
Things can go wrong while importing when you don't have sufficient privileges, the file is checked out by a colleague, the subsite forbids the type or the language or when your content file is invalid.
As with the export, make sure your FTP client does not try to open multiple connections at the same time.
To delete files you simply select them and click Delete.
However, original files can not be deleted before their translations, so when you remove an entire subsite you will probably have to do the delete twice.
Renaming files is not supported through the FTP interface
What to do when
You can not connect
Check that entered the correct address and port and make sure you configured the Active mode.
You try to connect but you get a reply that the maximum login limit has been reached
Wait a few minutes until the server cleans up the idle connection. Make sure your FTP client is configured to not open multiple connections at a time.
A file transfer failed
Unfortunately the error messages do not reveal much; you can try to import the file using the web-based interface to learn more about why the transfer failed.
The file names should be in lower-case. Ideally the names should not contain spaces.
In a batch, a lot of transfers fail
Make sure the FTP client does not try to open multiple connections at the same time
The downloaded XML file has a different size than shown on the server
Because some of the content in the file is replaced when the file is exported the exact size might differ some bytes.