TIBCO® Managed File Transfer CommandCenterCommand Line Utilities GuideSoftware Release 8.0May 2016
Two-Second Advantage®
Important Information
SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCHEMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (ORPROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THEEMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANYOTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.
USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS ANDCONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTEDSOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THECLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOADOR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE)OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USERLICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THESOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, ANDYOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BEBOUND BY THE SAME.
This document contains confidential information that is subject to U.S. and international copyright lawsand treaties. No part of this document may be reproduced in any form without the writtenauthorization of TIBCO Software Inc.
TIBCO, Two-Second Advantage, TIBCO Managed File Transfer, TIBCO Managed File TransferCommand Center, TIBCO Managed File Transfer Internet Server, TIBCO Managed File TransferPlatform Server, TIBCO Managed File Transfer Platform Server Agent, and TIBCO Slingshot are eitherregistered trademarks or trademarks of TIBCO Software Inc. or its subsidiaries in the United Statesand/or other countries.
All other product and company names and marks mentioned in this document are the property of theirrespective owners and are mentioned for identification purposes only.
THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOTALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASEDAT THE SAME TIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWAREVERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM.
THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSOR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICALERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESECHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCOSOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S)AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.
THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY ORINDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE,INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.
Copyright ©2003-2016 TIBCO Software Inc. All rights reserved.
TIBCO Software Inc. Confidential Information
2
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Contents
TIBCO Documentation and Support Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6
Command-Line Utilities Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Preparing to Install Command-Line Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Clearing Java Cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8
Installing and Configuring Command-Line Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Installation Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Admin Client Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12
Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12
Audit Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
GetAudit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
RemoveAudit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14
SearchForAudits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15
Department Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19
AddDepartment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
GetDepartment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20
RemoveDepartment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
RetrieveAllDepartments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
UpdateDepartment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Group Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
AddGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
AddUserToGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22
GetGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
RemoveGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23
RetrieveAllGroups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
RetrieveAllGroupsForUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
RetrieveAllUsersInGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
RemoveUserFromGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24
Role Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
AddUserToRole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
GetRole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
RetrieveAllRoles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27
RetrieveAllRolesForUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28
RetrieveAllUsersInRole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
RemoveUserFromRole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Server Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
AddServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
3
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
GetServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
RetrieveAllServers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38
RemoveServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
UpdateServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Session Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
DeleteSessionId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47
DeleteExpiredSessionIds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
GetExpiredSessionIds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
ListActiveSessionIds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48
Transfer Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
AddTransfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
DeleteExpiredTransfers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
GetTransfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
RetrieveAllTransfers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
RetrieveAllTransfersForUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
RemoveTransfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
SearchForTransfers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .61
UpdateTransfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
User Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74
AddAdminUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
AddTransferUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
ChangePassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .81
GetUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .82
RemoveUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
RetrieveAllUsers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
UpdateUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
User Profile Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .86
AddUserProfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
GetUserProfiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
RetrieveAllUserProfiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
RemoveUserProfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .90
UpdateUserProfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .91
Miscellaneous Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
GetCopyrightInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
GetProductNameVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Action File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .94
Shortcuts Usage in the Action File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .95
XML Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
4
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Platform Transfer Client Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
AddTransferToBank . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
ExecuteFromBank . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
GetCopyrightInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
GetProductNameVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .112
GetTransferFromBank . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .113
ListTransferBankRecords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
ReceiveFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .113
RemoveTransferFromBank . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .122
SendCommand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .122
SendFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
UpdateTransferFromBank . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Action File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Shortcuts Usage in the Action File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
XML Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Command Line Manual Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Administrator Global Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .150
File Transfer Global Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .151
Java Keystores Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
The Java Trusted Authority Certificate File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .152
The Java Certificate File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
The SSH Java Certificate Keystore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .155
Environment Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .156
5
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
TIBCO Documentation and Support Services
Documentation for this and other TIBCO products is available on the TIBCO Documentation site. Thissite is updated more frequently than any documentation that might be included with the product. Toensure that you are accessing the latest available help topics, please visit:
https://docs.tibco.com
Product-Specific Documentation
Documentation for TIBCO products is not bundled with the software. Instead, it is available on theTIBCO Documentation site at https://docs.tibco.com/products/tibco-managed-file-transfer-command-center.
The following documents for this product can be found on the TIBCO Documentation site:
● TIBCO Managed File Transfer Command Center Installation
● TIBCO Managed File Transfer Command Center Quick Start Guide
● TIBCO Managed File Transfer Command Center User's Guide
● TIBCO Managed File Transfer Command Center Command Line Utilities Guide
● TIBCO Managed File Transfer Command Center API Guide
● TIBCO Managed File Transfer Command Center Release Notes
How to Contact TIBCO Support
For comments or problems with this manual or the software it addresses, contact TIBCO Support:
● For an overview of TIBCO Support, and information about getting started with TIBCO Support,visit this site:
http://www.tibco.com/services/support
● If you already have a valid maintenance or support contract, visit this site:
https://support.tibco.com
Entry to this site requires a user name and password. If you do not have a user name, you canrequest one.
How to Join TIBCOmmunity
TIBCOmmunity is an online destination for TIBCO customers, partners, and resident experts. It is aplace to share and access the collective experience of the TIBCO community. TIBCOmmunity offersforums, blogs, and access to a variety of resources. To register, go to the following web address:
https://www.tibcommunity.com
6
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Command-Line Utilities Overview
TIBCO® Managed File Transfer Commend Center provides two command-line utilities that can beinvoked from a batch file, a UNIX script, as well as executed in unattended mode by a job scheduler forease of use.
The installation of MFTCC creates the <MFTCC_install>\distribution directory that contains AdminClient Utility and Platform Transfer Client Utility.
● The Command Center Command Line Client (as known as Admin Client Utility) is designed for theadministrator to conduct administrative operations through the command line on Windows andUNIX platforms.
● The Platform Server Command Line Client (as known as Platform Transfer Client Utility) isdesigned for the end user to perform Platform Server transfers via MFTCC through the commandline on Windows and UNIX platforms.
In TIBCO Managed File Transfer (MFT) Command Center documentation set, MFTCC is used torepresent TIBCO MFT Command Center.
7
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Preparing to Install Command-Line Utilities
Before installing and using the command-line utilities, ensure that you have installed JRE version 1.8 orlater on the client.
It is a good practice to clear JAVA cache on your machine before installing Java. See Clearing Java Cachefor more details.
Procedure
1. Download Java JRE from Oracle's web page http://www.oracle.com/.
2. Install Java JRE.
3. Add the Java bin directory to the PATH environment variable on your computer.On Windows, the default Java bin directory is C:\Program Files\Java\jre_version\bin.
4. Add the JRE_HOME environment variable to your system environment variables.For example, JRE_HOME=C:\Program Files\Java\jre1.8
Clearing Java CacheIt is a good practice to clear Java cache. Clearing Java cache forces browsers to load the latest version ofJava applets and applications.
Procedure
1. Navigate to Control Panel and double-click the Java icon.
2. In the Java Control Panel window, select the General tab.
3. In the Temporary Internet Files section, click Settings.
4. In the Temporary Files Settings window, clear the Keep temporary files on my computer check box.Click OK.
5. Click OK to close the Java Control Panel window.
8
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Installing and Configuring Command-Line Utilities
To use the utilities, you must configure the utilities as required.
Procedure
1. Download the stub jar file and appropriate utility file to a new folder. You must obtain thecommand-line utility from the <MFT_install>\distribution\PlatformTransfer and<MFT_install>\distribution\AdminClient directories.If you are installing Admin Client Utility on a Windows, the following two files are required:
● ClientCommon.jar
● AdminClient.zip
If you are installing Admin Client Utility on a UNIX, the following two files are required:
● ClientCommon.jar
● AdminClient.tar
Admin Client Utility contains three files in the directory, a stub jar file (.jar) and a utility for eithera Windows or a UNIX operating system. See Installation Files for more details.
2. Extract the .zip file or the .tar file into the same directory where you obtain the files from Step 1.For example, run the following command on the UNIX platform to extract the .tar file:
tar –xvf InternetTransferClient.tar
If you want to use more than one utility on the same machine, ensure that you extract theutility files into their own directories.
3. Open a command line and navigate to the folder where the files are extracted, and then run thefollowing command to set up the class path for the program:
● On Windows: run setutilcp● On UNIX: run . ./setutilcp.sh
4. When the setup is completed, run java cfcc.Config and respond to prompt to configure theserver and certficate information.
The following information is required during the configuration:
● The user ID to connect to MFTCC.● The password for the user ID.● The name of the Java trusted keystore.
This file can be located in either the Java or directory. If the file does not exist, you willbe asked whether you want to create the file.
● The password for the trusted keystore.● The IP name or IP address of the MFTCC server.● The IP port of the MFTCC server.● The MFTCC server context.
Result
When the configuration is completed, the program connects to MFTCC and sets up the necessarycertificate files. With the provided information, the program performs the following functions duringthe configuration:
9
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
● Encrypting all passwords.
● Updating the Global.xml file.
● Validating the certificate and, if necessary, adding the certificate to the Java trusted keystore.
● Testing the connection to the MFTCC server.
Installation FilesYou must use the utility files shipped with the MFTCC installation to install the utilities.
The command-line utilities must be obtained from the following directories:
● <MFT_install>\distribution\AdminClient
● <MFT_install>\distribution\PlatformTransfer
Admin Client Utility
Admin Client Utility contains three files in the directory, a stub jar file (.jar) and a utility for either aWindows or a UNIX operating system. Distribute the stub jar file and appropriate utility file for theoperating system you will be working on into a new folder.
The following table lists the 3 files in the <MFT_install>\distribution\AdminClient directory:
File Name For Use On
ClientCommon.jar Windows and UNIX
AdminClient.zip Windows
AdminClient.tar UNIX
Platform Transfer Client Utility
Platform Transfer Client Utility contains three files in the directory, a stub jar file (.jar) and a utility foreither a Windows or a UNIX operating system.
The following table lists the three files in the <MFT_install>\distribution\PlatformTransferdirectory:
File Name For Use On
ClientCommon.jar Windows and UNIX
PlatformTransferClient.zip Windows
PlatformTransferClient.tar UNIX
If you are installing Admin Client Utility on a Windows, the following two files are required:
● ClientCommon.jar
● AdminClient.zip
If you are installing Admin Client Utility on a UNIX, the following two files are required:
● ClientCommon.jar
10
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
● AdminClient.tar
11
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Admin Client Utility
The Admin Client Utility program is designed for the administrator to conduct administrativeoperations through the command prompt on Windows and UNIX platforms.
Admin Client Utility is run from the same directory where the three .jar files are unpacked.
CommandsThe commands of Admin Client Utility are used to define, list, update, and delete the definition recordsin the MFTCC system.
CFAdmin will accept the following commands after the action parameter (a:).
Command Groups Commands
Audit Commands GetAudit
RemoveAudit
SearchForAudits
Department Commands AddDepartment
GetDepartment
RemoveDepartment
RetrieveAllDepartments
UpdateDepartment
Group Commands AddGroup
AddUserToGroup
GetGroup
RemoveGroup
RetrieveAllGroups
RetrieveAllGroupsForUser
RetrieveAllUsersInGroup
RemoveUserFromGroup
Role Commands AddUserToRole
GetRole
RetrieveAllRoles
12
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Command Groups Commands
RetrieveAllRolesForUser
RetrieveAllUsersInRole
RemoveUserFromRole
Server Commands AddServer
GetServer
RetrieveAllServers
RemoveServer
UpdateServer
Session Commands DeleteSessionId
DeleteExpiredSessionIds
GetExpiredSessionIds
ListActiveSessionIds
Transfer Commands AddTransfer
DeleteExpiredTransfers
GetTransfer
RetrieveAllTransfers
RetrieveAllTransfersForUser
RemoveTransfer
SearchForTransfers
UpdateTransfer
User Commands AddAdminUser
AddTransferUser
ChangePassword
GetUser
RetrieveAllUsers
RemoveUser
13
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Command Groups Commands
UpdateUser
User Profile Commands AddUserProfile
GetUserProfiles
RetrieveAllUserProfiles
RemoveUserProfile
UpdateUserProfile
Miscellaneous Commands GetCopyrightInfo
GetProductNameVersion
Help
Audit CommandsThe audit commands are used to list and delete audit records in the MFTCC system.
Action Description
GetAudit Displays a specific audit record.
RemoveAudit Removes an audit record.
SearchForAudits Searches for audit records.
GetAudit
The GetAudit command action is used to display a specific audit record.
To use the GetAudit action command, you must have AdministratorRight. For more information onthis right, see AddUserToRole.
Parameter Description Default Required
AuditId Specifies the 12 character MFTCC audit ID of thetransfer you want to display.
None Yes
Sample GetAudit Command
This command displays the information for the file transfers for the audit ID given.java cfcc.CFAdmin a:GetAudit AuditId:A51450000142
RemoveAudit
The RemoveAudit command action is used to delete the specific audit records from the MFTCC system.
The RemoveAudit command action deletes audit records in two ways:
14
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
● You can specify the number of days to keep audit records. All audit records written before the oldestday will be purged.
● You can specify a purge date. All records written before that date will be purged.
To use the RemoveAudit action command, you must have AdministratorRight. For more information onthis right, see AddUserToRole.
Parameter Description Default Required
AuditId Specifies the 12 character MFTCC audit ID of thetransfer you want to display.
None No
Days Specifies the number of days of audit records thatshould be saved.
None Either theDays orPurgeDate
parametermust bespecified.
PurgeDate Specifies the purge date. Any audit record writtenbefore the purge date will be deleted.
The purge date format is YYYY/MM/DD.
None Either theDays orPurgeDate
parametermust bespecified.
ServerType Specifies the server type.
The valid values are as follows:
● I: Internet server
● P: Platform server
● B: Both
None No
Sample RemoveAudit Command
This command keeps audit records written within 30 days. Any audit record written before 30 days willbe purged.java cfcc.CFAdmin a:RemoveAudit Days:30
SearchForAudits
The SearchForAudits command action is used to search for all audit records that match the definedselection criteria.
You can use the percent sign (%) as a wildcard character in defined parameters to select file recordsbased on a partial key.
The detailed information will be displayed for all audit records that match the selection criteria.
To use the SearchForAudits action command, you must have AdministratorRight. For moreinformation on this right, see AddUserToRole.
15
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
AuditId Specifies the 12 character audit ID that wasassigned when the audit record was added.
This parameter supports wildcard characters.
None No
AuthGroupId Specifies the 1 to 64 character MFTCC group IDthat is authorized to transfer this file.
A transfer can be authorized to a user or a group.See also the UserId parameter.
This parameter supports wildcard characters.
None No
ClientFileName Specifies the 1 to 256 character file name orlocation on the client machine.
If the file name or location contains embeddedspaces, the entire file name must be enclosed indouble quotation marks (").
This parameter supports wildcard characters.
None No
Days Specifies the number of days that will be searched.
The way that the Days parameter is used dependson whether the FromDate and ToDate parametersare defined:
● Both the FromDate and ToDate parametersdefined: the Days parameter is ignored.
● Only the FromDate parameter defined: theDays parameter defines the number of daysafter the defined FromDate parameter that willbe searched.
● Only the ToDate parameter defined: the Daysparameter defines the number of days beforethe defined ToDate parameter that will besearched.
● Neither the FromDate nor ToDate parametersdefined: the Days parameter defines thenumber of days before the current date thatwill be searched.
● The FromDate, ToDate and Days parametersnot defined: MFTCC will search for the auditrecords of today only.
The Days parameter gives the totalnumber of days that will be searched.
For example, If you specify the FromDateparameter as 2004/12/01, and the Days parameteras 10, then MFTCC will search a total of 10 daysfrom 1 December 2014 until 10 December 2014.
This parameter supports wildcard characters.
None No
16
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
Department Specifies the department that the audit was set for. None No
FileId
(Transfer ID)
Specifies the 12 character transfer ID that wasassigned when the file definition was added.
None No
FromDate Specifies the start date for your audit inquiry.
This parameter can be combined with either theToDate or Days parameter to define the dates thatwill be returned.
The format of the FromDate parameter isYYYY/MM/DD.
This parameter does not support wildcardcharacters.
None No
FromTime Specifies the start time for your audit inquiry.
This time is relative to the start date only. Thesearch will start from the defined FromTimeparameter on the defined FromDate parameter,and extend to the defined ToTime parameter on thedefined ToDate parameter.
The format of the FromTime parameter is HHMM,and the time is defined using military time from0000 to 2359.
This parameter does not support wildcardcharacters.
None No
LocalTransactio
nId
Specifies the 10 character MFT local transaction IDthat was assigned by MFTCC when the file transferstarted.
This parameter supports wildcard characters.
None No
ServerFileName Specifies the 1 to 256 character file name orlocation of the server machine.
If the node name is *LOCAL, the server file namewill be located on the MFTCC server.
If the file name or location contains embeddedspaces, the entire file name must be enclosed indouble quotation marks (").
This parameter supports wildcard characters.
None No
ServerType
(as known as AuditType)
Specifies the server type.
The valid values are as follows:
● I: Internet server
● P: Platform server
● B: Both
None No
17
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
ToDate Specifies the end date for your audit inquiry.
This can be combined with either the FromDate orDays parameter to define the dates that will bereturned.
The format of the ToDate parameter isYYYY/MM/DD.
The value of the ToDate parameter must be greaterthan the value of the FromDate parameter.
None No
ToTime Specifies the end time for your audit inquiry.
This time is relative to the end date only. Thesearch will start from the defined FromTimeparameter on the defined FromDate parameter,and extend to the defined ToTime parameter on thedefined ToDate parameter.
The format of the ToTime parameter is HHMM,and the time is defined using military time from0000 to 2359.
This parameter does not support wildcardcharacters.
None No
TransferStatus Specifies whether you want to extract successfultransfers, failed transfers, or both.
The valid values are as follows:
● S: successful transfers will be returned.
● F: failed transfers will be returned.
If you want both successful and failed transfers tobe returned, you must omit this field.
This parameter does not support wildcardcharacters.
None
Returnsbothsuccessfuland failedtransfers.
No
TransferUserId Specifies the 1 to 32 characters MFT user ID thatMFTCC used to initiate the file transfer requestwith MFT.
The MFT user IDs can be defined in the file record,node records, or by the user profile record.
This parameter supports wildcard characters.
None No
UserId Specifies the 1 to 64 character MFTCC user ID ofthe user who is authorized to transfer this file.
A transfer can be authorized to a user or a group.See also the AuthGroupId parameter.
This parameter supports wildcard characters.
None No
18
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Sample SearchForAudits Command
This command searches for all audit records that match the selection criteria. It will search for all failedtransfers with the NYNode1 node within the past 5 days.java cfcc.CFAdmin a:SearchForAudits NodeName:NYNode TransferStatus:F Days:5
Department CommandsThe department commands are used to define, list, update, and delete department definition records inthe MFTCC system.
Action Description
AddDepartment Adds a department definition to MFTCC.
GetDepartment Lists a specific department definition.
RemoveDepartment Deletes an MFTCC department definition.
RetrieveAllDepartments Lists all department definitions.
UpdateDepartment Alters an MFTCC department definition.
AddDepartment
The AddDepartment command action is used to define a department.
The delegated administration offers an MFTCC administrator the ability to divide the system intosmaller units which can be managed independently of one another. The departments can be all users ata specific location, business unit, or whatever grouping you chose.
To use the AddDepartment action command, you must to be a super administrator. For moreinformation on this right, see "Delegated Administration" of TIBCO Managed File Transfer CommandCenter User's Guide.
Parameter Description Default Required
Description Specifies the 1 to 64 character description of thisgroup.
If the description contains embedded spaces, theentire description must be enclosed in doublequotation marks (").
None No
Name Specifies the 1 to 64 character department name. None Yes
Sample AddDepartment Command
This command adds a department.java cfcc.CFAdmin a:AddDepartmentName:Shoes Description:"Womens Shoe Department"
19
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
GetDepartment
The GetDepartment command action is used to display a department in the MFTCC system.
To use the GetDepartment action command, you must be a super administrator. For more informationon this right, see "Delegated Administration" of TIBCO Managed File Transfer Command Center User'sGuide.
Parameter Description Default Required
Name Specifies the 1 to 64 character department name. None Yes
Sample GetDepartment Command
This command displays the parameters for the NorthEast department.
java cfcc.CFAdmin a:GetDepartmentName:NorthEast
RemoveDepartment
The RemoveDepartment command action is used to delete a department from the MFTCC system.
To use the RemoveDepartment action command, you must be a super administrator. For moreinformation on this right, see "Delegated Administration" of TIBCO Managed File Transfer CommandCenter User's Guide.
Parameter Description Default Required
Name Specifies the 1 to 64 character department name. None Yes
Sample RemoveDepartment Command
This command removes the GM426 department from the MFTCC database.
java cfcc.CFAdmin a:RemoveDepartment DepartmentId:GM426
RetrieveAllDepartments
The RetrieveAllDepartments command action is used to display all departments defined to theMFTCC system.
To use the RetrieveAllDepartments action command, you must be a super administrator. For moreinformation on this right, see "Delegated Administration" of TIBCO Managed File Transfer CommandCenter User's Guide.
No parameters are supported for this command action.
Sample RetrieveAllDepartments Command
This command displays all parameters for all departments defined to the MFTCC database.
java cfcc.CFAdmin a:RetrieveAllDepartments
UpdateDepartment
The UpdateDepartment command action is used to update a department in the MFTCC system.
To use the UpdateDepartment action command, you must be a super administrator. For moreinformation on this right, see "Delegated Administration" of TIBCO Managed File Transfer CommandCenter User's Guide.
20
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
Description Specifies the 1 to 64 character description of this group.
If the description contains embedded spaces, the entiredescription must be enclosed in double quotation marks(").
None No
Name Specifies the 1 to 64 character department name. None Yes
Sample UpdateDepartment Command
This command updates the GM426 department in the MFTCC database.java cfcc.CFAdmin a:UpdateDepartment Name:GA426 Description:”General Administration
– section 426”
Group CommandsThe group commands are used to define, list, update, delete, and assign membership of group recordsin the MFTCC system.
Action Description
AddGroup Defines a group.
AddUserToGroup Adds a user to a group.
GetGroup Displays a group.
RemoveGroup Deletes a group.
RetrieveAllGroups Displays all groups.
RetrieveAllGroupsForUser Displays groups that the user is a member of.
RetrieveAllUsersInGroup Displays all users in a group.
RemoveUserFromGroup Deletes a user from a group.
AddGroup
The AddGroup command action is used to define a group.
MFTCC has a facility to group user IDs together. These groups can be all users at a specific location,business unit, or whatever grouping you chose. Before users can be grouped together, a group has to becreated.
To use the AddGroup action command, you must have UpdateGroupRight. For more information onthis right, see AddUserToRole.
Parameter Description Default Required
Department Specifies the department of this group. This valueis ignored for department administrators.
None No
21
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
Description Specifies the 1 to 64 character description of thisgroup.
If the description contains embedded spaces, theentire description must be enclosed in doublequotation marks (").
None No
GroupId Specifies the 1 to 64 character group ID. None Yes
Visibility The visibility of this group.
The valid values are as follows:
● public
● private
private Yes
Sample AddGroup Command
This command adds a group.java cfcc.CFAdmin a:AddGroup GroupId:Store68 Description:”68 – Plano, TX”
AddUserToGroup
The AddUserToGroup command action is used to add an MFTCC user to a group.
To use the AddUserToGroup action command, you must have UpdateGroupRight. For moreinformation on this right, see AddUserToRole.
Parameter Description Default Required
GroupId Specifies the 1 to 64 character group ID. None Yes
UserId Specifies the 1 to 64 character MFTCC user ID of theuser to be assigned to this group.
None Yes
Sample AddUserToGroup Command
This command adds the user Marketing008 to the Marketing group.java cfcc.CFAdmin a:AddUserToGroup GroupId:Marketing UserId:Marketing008
GetGroup
The GetGroup command action is used to display a group defined to the MFTCC system.
To use the GetGroup action command, you must have UpdateGroupRight. For more information onthis right, see AddUserToRole.
Parameter Description Default Required
GroupId Specifies the 1 to 64 character group ID. None Yes
Sample GetGroup Command
This command displays the parameters for the TRANSFER01 group.
22
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
java cfcc.CFAdmin a:GetGroup GroupId:TRANSFER01
RemoveGroup
The RemoveGroup command action is used to delete a group from the MFTCC system.
To use the RemoveGroup action command, you must have UpdateGroupRight. For more information onthis right, see AddUserToRole.
Parameter Description Default Required
GroupId Specifies the 1 to 64 character group ID. None Yes
Sample RemoveGroup Command
This command removes the GM426 group from the MFTCC database.
java cfcc.CFAdmin a:RemoveGroup GroupId:GM426
RetrieveAllGroups
The RetrieveAllGroups command action is used to display all groups defined to the MFTCC system.
To use the RetrieveAllGroups action command, you must have UpdateGroupRight. For moreinformation on this right, see AddUserToRole.
No parameters are supported for this command action.
Sample RetrieveAllGroups Command
This command displays all parameters for all groups defined to the MFTCC database.
java cfcc.CFAdmin a:RetrieveAllGroups
RetrieveAllGroupsForUser
The RetrieveAllGroupsForUser command action is used to display a list of all the groups that aspecific user ID is a member of.
To use the RetrieveAllGroupsForUser action command, you must have UpdateGroupRight. For moreinformation on this right, see AddUserToRole.
Parameter Description Default Required
UserId Specifies the 1 to 64 character MFTCC user ID of theuser whose group memberships are to bedisplayed.
None Yes
Sample RetrieveAllGroupsForUser Command
This command displays the parameters for each group where the specified user is defined.
java cfcc.CFAdmin a:RetrieveAllGroupsForUser UserId:FT61825
RetrieveAllUsersInGroup
The RetrieveAllUsersInGroup command action is used to display a list of all users that are a memberof a specific group.
To use the RetrieveAllUsersInGroup action command, you must have UpdateGroupRight. For moreinformation on this right, see AddUserToRole.
23
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
GroupId Specifies the 1 to 64 character group ID. None Yes
Sample RetrieveAllUsersInGroup Command
This command displays all the parameters for each user in the specified group.java cfcc.CFAdmin a:RetrieveAllUsersInGroup GroupId:TeleSales
RemoveUserFromGroup
The RemoveUserFromGroup command action is used to remove an MFTCC user from a group.
To use the RemoveUserFromGroup action command, you must have UpdateGroupRight. For moreinformation on this right, see AddUserToRole.
Parameter Description Default Required
GroupId Specifies the 1 to 64 character group ID. None Yes
UserId Specifies the 1 to 64 character MFTCC user ID ofthe user to be removed from the group.
None Yes
Sample RemoveUserFromGroup Command
This command removes the user Investor248 from the Stockholders group.java cfcc.CFAdmin a:RemoveUserFromGroup GroupId:Stockholders UserId:Investor248
Role CommandsThe role commands are used to define, list, delete, and assign rights to users in the MFTCC system.
Action Description
AddUserToRole Adds a right to a user.
GetRole Displays a right.
RetrieveAllRoles Displays all rights.
RetrieveAllRolesForUser Displays the rights assigned to a user.
RetrieveAllUsersInRole Displays users that have a specific right.
RemoveUserFromRole Removes a right from a user.
AddUserToRole
The AddUserToRole command action is used to assign a user to an MFTCC role.
The MFTCC roles define the rights that an MFTCC user has to perform file transfers and administrativefunctions.
The word role in this section is referred to as right in the rest of the manual.
To use the AddUserToRole action command, you must have UpdateTransferUserRight.
24
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
RoleId Specifies the right to be given to the user as definedin the table below.
None Yes
UserId Specifies the 1 to 64 character user ID.
This is the name of the user to whom you want toassign rights.
None Yes
The following table lists the roles and their supported functions:
Right DescriptionDescription for Using DelegatedAdministration
AdministratorRight
With this right, you can perform alladministrative functions within theMFTCC system.
This right does not includeTransferRight or FTTransferRight orany functions that correspond to theserights.
With this right, you can perform alladministrative functions within yourdepartment and within the departmentsthat you can manage.
The departments that adepartment administrator canmanage are defined in theManage Departments field inthe Optional User Propertiessection in the user definition.
This right does not include TransferRightor FTTransferRight or any functions thatcorrespond to these rights. Departmentadministrators cannot update server orserver credentials unless givenUpdateServerRight andUpdateServerCredentialRight.
DBReportRight With this right, you can log in, view,and generate MFTCC databasereports through the Reports >Database Reports option.
With this right, you can log in, view, andgenerate MFTCC database reportsthrough the Reports > Database Reportsoption.
DeleteAuditRight
With this right, you can delete auditrecords.
With this right, you can delete auditrecords. Department checking will notbe done.
FTAdminRight With this right, you can view andupdate menu items through theManagement > Platform Transfersoption; however, you cannot executePlatform transfers.
If this right is assigned along withViewServerRight, you can also viewand update all the items in theManagement > Manage PlatformFunctions option.
With this right, you can view and updatemenu items from the Management >Platform Transfers option; however, youcannot execute Platform transfers.
If this right is assigned along withViewServerRight, you can also view andupdate all the items in the Management> Manage Platform Functions option.
25
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Right DescriptionDescription for Using DelegatedAdministration
FTTransferRight
With this right, you can view andexecute menu items from theManagement > Platform Transfersoption; however, you cannot updatePlatform transfers.
With this right, you can view andexecute menu items from theManagement > Platform Transfersoption; however, you cannot updatePlatform transfers.
HelpDeskRight With this right, you can changeanother user’s password, turn on andoff the disable flag for a user, and turnon and off the lock flag for a user.
With this right, you can change anotheruser’s password, turn on and off thedisable flag for a user, and turn on andoff the lock flag for a user.
TransferRight With this right, you can execute MFTInternet transfers.
With this right, you can execute MFTInternet transfers.
UpdateAlertRight
With this right, you can update alertrecords and view alerts occurred.
With this right, you can update alertrecords and view alerts occurred.
UpdateSystemKeyRight
With this right, you can add andmanage the configurations of AS2,FTP, SFTP, Platform Server SSL,HTTPS, and SAML system keysthrough the Administration >Protocol Keys > System Keys option,and manage KeyTab files through theAdministration > Protocol Keys >Kerberos KeyTabs option.
With this right, you can add and managethe configurations of AS2, FTP, SFTP,Platform Server SSL, HTTPS, and SAMLsystem keys through the Administration> Protocol Keys > System Keys option,and manage KeyTab files through theAdministration > Protocol Keys >Kerberos KeyTabs option.
UpdatePublicKeyRight
With this right, you can add andmanage the configurations of FTPS,SFTP, Platform Server, and HTTPSpublic keys.
With this right, you can add and managethe configurations of FTPS, SFTP,Platform Server, and HTTPS public keys.
UpdateFTTransferRight
With this right, you can updatePlatform transfers defined underManagement > Platform Transfers >Manage Platform Transfers;however, you cannot execute Platformtransfers.
With this right, you can update Platformtransfers defined under Management >Platform Transfers > Manage PlatformTransfers; however, you cannot executePlatform transfers.
UpdateGroupRight
With this right, you can view andupdate MFT group records.
With this right, you can view and updateMFT group records.
UpdatePGPKeyRight
With this right, you can add andmanage the configurations of PGPpublic keys.
With this right, you can add and managethe configurations of PGP public keys.
UpdatePGPSystemKeyRight
With this right, you can add andmanage the configurations of PGPsystem keys.
With this right, you can add and managethe configurations of PGP system keys.
UpdateServerCredentialRight
With this right, you can view orupdate MFT server credential records.
With this right, you can view or updateMFT server credential records.
26
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Right DescriptionDescription for Using DelegatedAdministration
UpdateServerRight
With this right, you can view orupdate MFT server records.
With this right, you can view or updateMFT server records in your owndepartment; however, you cannot addnew servers.
UpdateSessionRight
With this right, you can view anddelete active user sessions.
With this right, you can view and deleteactive user sessions.
Sample AddUserToRole Command
This command gives the user mftuser1 the TransferRight role.java cfcc.CFAdmin a:AddUserToRole UserId:mftuser1 RoleId:TransferRight
GetRole
The GetRole command action is used to display information about a role.
The MFTCC roles define the rights that an MFTCC user has to perform file transfers and administrativefunctions.
To use the GetRole action command, you must have UpdateTransferUserRight. For more informationon this right, see AddUserToRole.
Parameter Description Default Required
RoleId Specifies the 1 to 64 character role name. This is thename of the role that you want to display.
None Yes
Sample GetRole Command
This command displays the information about the TransferRight role.java cfcc.CFAdmin a:GetRole RoleId:TransferRight
RetrieveAllRoles
The RetrieveAllRoles command action is used to display a list of all roles that have been defined.
The MFTCC roles define the rights that an MFTCC user has to perform file transfers and administrativefunctions.
To use the RetrieveAllRoles action command, you must have UpdateTransferUserRight. For moreinformation on this right, see AddUserToRole.
No parameters are supported for this command action.
Sample RetrieveAllRoles Command
This command displays the information about all defined roles.java cfcc.CFAdmin a:RetrieveAllRoles
27
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
RetrieveAllRolesForUser
The RetrieveAllRolesForUser command action is used to display a list of all roles that a user hasbeen granted access to.
The MFTCC roles define the rights that an MFTCC user has to perform file transfers and administrativefunctions.
To use the RetrieveAllRolesForUser action command, you must have UpdateTransferUserRight. Formore information on this right, see AddUserToRole.
Parameter Description Default Required
UserId Specifies the 1 to 64 character user ID. This is thename of the user that you want to display roles for.
None Yes
Sample RetrieveAllRolesForUser Command
This command displays the information about all roles defined for a user.java cfcc.CFAdmin a:RetrieveAllRolesForUser UserId:user1
RetrieveAllUsersInRole
The RetrieveAllUsersInRole command action is used to display a list of all users granted rights to arole.
The MFTCC roles define the rights that an MFTCC user has to perform file transfers and administrativefunctions.
To use the RetrieveAllUsersInRole action command, you must have UpdateTransferUserRight. Formore information on this right, see AddUserToRole.
Parameter Description Default Required
RoleId Specifies the 1 to 64 character role name. This is thename of the role that you want to display all usersgranted access to.
None Yes
Sample RetrieveAllUsersInRole Command
This command displays the user definition for all users with rights to the TransferRight role.java cfcc.CFAdmin a:RetrieveAllUsersInRole RoleId:TransferRight
RemoveUserFromRole
The RemoveUserFromRole command action is used to remove a user from an MFTCC role.
The MFTCC roles define the rights that an MFTCC user has to perform file transfers and administrativefunctions.
To use the RemoveUserFromRole action command, you must have UpdateTransferUserRight. For moreinformation on this right, see AddUserToRole.
28
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
RoleId Specifies the 1 to 64 character role name. This is thename of the role that you want to remove the userrights to.
None Yes
UserId Specifies the 1 to 64 character user ID. This is thename of the user that you want to remove rightsfrom a role.
None Yes
Sample RemoveUserFromRole Command
This command removes the user mftuser1 from the UpdateTransferDefinitionRight role.java cfcc.CFAdmin a:RemoveUserFromRole UserId:mftuser1 RoleId:TransferRight
Server CommandsThe server commands are used to define, list, update, and delete MFT Server definitions in the MFTCCsystem.
Action Description
AddServer Creates a server.
GetServer Displays a server.
RetrieveAllServers Displays all servers.
RemoveServer Deletes a server.
UpdateServer Updates a server.
AddServer
The AddServer command action is used to add a node definition to MFTCC.
The node definition contains information about the remote system. You only have to define nodedefinitions when you are connecting to a remote system. If you are storing files locally, you do not haveto define node definitions.
To use the AddServer action command, you must have UpdateServerRight. For more information onthis right, see AddUserToRole.
Parameter Description Default Required
CheckServerSta
tus (cstat)
Specifies whether to check the server status.
The valid values are as follows:
● Y
● N
N No
29
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
CollectInterva
l
Specifies the collection interval in minutes.
This parameter is for TIBCO® Managed FileTransfer Platform Server only.
None No
CollectType Specifies the type of collection that needs to bedone.
The valid values are as follows:
● I: initiator
● R: responder
● B: both
None No
CollectionFlag Specifies whether to collect data from TIBCOManaged File Transfer (MFT) Platform Server.
The valid values are as follows:
● Y
● N
N No
CompressType Specifies the default compression that will beperformed between the web client and theMFTCC server.
The valid values are as follows:
● N: no compression
● Y: use compression
This parameter specifies the compressionbetween the web client and the MFTCC server,and not between the MFTCC server and MFTPlatform Server. At this time, no compression issupported between the MFTCC server andMFT Platform Server.
If this parameter is not defined, thecompression flag defined in the MFTCCconfiguration will be used.
None No
30
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
ConnectionSecu
rityType
Specifies the security that will be used whenusing a connection type of FTP.
The valid values are as follows:
● None: FTP connection is insecure.
● Explicit SSL: an insecure connection ismade to the remote FTP node, followed bya negotiation for SSL security.
The remote server must be listening on aninsecure port.
● Implicit SSL: an SSL connection is madeto the remote FTP node.
The remote server must be listening on anSSL port.
None No
DataConnection
Type
Specifies the connection type for FTP transfers.
The valid values are as follows:
● PORT: FTP client listens for all dataconnections.
● PASV: FTP server listens for all dataconnections.
PORT No
DefaultEncrypt
Type
Specifies the default encryption that will beperformed between the MFTCC server and thetarget Platform Server node.
The valid values are as follows:
● N: no encryption
● D: for DES encryption (56 bit key)
● R: for Rijndael encryption (256 bit key)
This encryption is for MFTCC to PlatformServer target node only.
All communication between the web client andMFTCC is encrypted using SSL encryption.
If you want to encrypt data between TIBCOMFT Command Center and TIBCO MFTPlatform Server, it is good practice to useRijndael encryption, because Rijndael is astronger encryption and is far more efficient.
Default No
31
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
DefaultLTTable Specifies the 1 to 256 byte default local translatetable that MFTCC uses when performing datatranslation.
This parameter must point to the fullyqualified translation table file name.
This parameter is typically used for ASCII toEBCDIC translation when communicating withTIBCO MFT Platform Server for z/OS andIBMi.
If the file record has theLocalTranslationTable parameter defined,this parameter will be used instead.
None No
DefaultPass Specifies the 1 to 32 byte default password thatwill be used when communicating with thetarget Platform Server node.
This parameter will not be used if there is auser profile defined for the server definition oruser that performs the file transfer. Likewise,this parameter is overridden by theDefaultUser parameter on the file record.
When this parameter is defined, theDefaultUser parameter must be defined aswell.
None No
DefaultRTTable Specifies the 1 to 256 byte default remotetranslate table that the target Platform Serversystem uses when performing data translation.
This parameter must point to the name of thetranslation table on the remote Platform Serversystem.
This parameter will not be used if the filerecord has the RemoteTranslationTableparameter defined.
When communicating with TIBCO MFTPlatform Server for z/OS, this table can be from1 to 8 characters long and must be enabled atthe time the transfer runs.
None No
32
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
DefaultUser Specifies the 1 to 32 byte default user that willbe used when communicating with the targetPlatform Server node.
This parameter will not be used if there is auser profile defined for the server definition oruser that performs the file transfer. Likewise,this parameter is overridden by theDefaultServerUserID parameter on the filerecord.
When this parameter is defined, theDefaultPass parameter must be defined aswell.
None No
DefaultWinDoma
in
Specifies the 1 to 256 byte default NT domainthat will be used when communicating withthe target TIBCO MFT Platform Server forWindows node.
This parameter will not be used if there is auser profile defined for the server definition oruser that performs the file transfer. Likewise,this parameter is overridden by theDefaultWinDomain parameter on the filerecord.
When this parameter is defined, theDefaultUser and DefaultPass parametersmust be defined as well.
This parameter is only used whencommunicating with a Windows environmentand defines the domain where the user isdefined.
None No
Department Specifies the nodes department. None No
Description Describes this node. None No
DisableFlag Specifies whether to disable the serverdefinition. When a server is disabled, it is notavailable for use by TIBCO MFT CommandCenter or TIBCO MFT Internet Server.
The valid values are as follows:
● N: the server is not disabled.
● Y: the server is disabled.
None No
33
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
INETServerType Specifies the Internet Server type.
The valid values are as follows:
● C: the server is Platform Server.
● F: the server is FTP.
● L: the server is the local MFTCC server.
● S: the server is SSH.
C No
IPName Specifies the 1 to 64 character IP name. Thisparameter can be either a machine name or anIP address.
This parameter defines the TCP informationnecessary to establish communication with theremote Platform Server node.
If this parameter is defined incorrectly, MFTCCwill be unable to connect to the remotePlatform Server node.
None No
IPPort Specifies the TCP port number that the targetserver is listening on for incoming connections.
This parameter can be any number between1025 and 65535.
This parameter must match the IP port that theremote server (SFTP, FTP, Platform Server) islistening to for incoming connections.
If this parameter is defined incorrectly, MFTCCwill be unable to connect to the remote server.
None No
ManageCFServer
Flag
Specifies whether to manage TIBCO MFTPlatform Server from TIBCO MFT CommandCenter.
The valid values are as follows:
● Y
● N
N No
PGPASCII
(pascii)
Specifies whether to use ASCII armoredformat.
The valid values are as follows:
● Y
● N
N No
34
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
PGPCompression
(pcomp)
Specifies the type of compression to be used.
The valid values are as follows:
● default
● none
● zip
● zlib
default No
PGPEnabled
(pena)
Specifies whether PGP is enabled on this serverdefinition.
The valid values are as follows:
● Y
● N
N No
PGPEncryptAlgo
rithm (pea)
Specifies the algorithm to be used to encryptthe PGP file.
The valid values are as follows:
● 3des
● default
● cast5
● blowfish
● aes128
● aes192
● aes256
default Yes
PGPHashAlgorit
hm (phash)
Specifies the hash algorithm to be used toencrypt the PGP file.
The valid values are as follows:
● default
● md2
● md5
● ripemd
● sha1
default Yes
PGPPrivateKey
(pkey)
Specifies the 1 to 64 character private key. None No
35
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
PGPSign
(psign)
Specifies whether to sign the PGP file transfer.
The valid values are as follows:
● Y
● N
N No
PGPVerifySigna
ture (pver)
Specifies whether to verify the signature of thePGP key.
The valid values are as follows:
● Y
● N
N No
PGPVerifyServe
rSignature
(puver)
Specifies whether to verify the signature of theserver in the defined file definition.
The valid values are as follows:
● Y
● N
N No
ServerFileName
Prefix
Specifies the server file name prefix.
This parameter is only valid for L node type.
None No
ServerName Specifies the 1 to 32 character node name.
This parameter is the name that TIBCO MFTPlatform Server is known as within the MFTCCsystem.
If the server name contains embedded spaces,the entire server name must be enclosed indouble quotation marks (").
This value must point to an existingserver definition, and as such theserver name cannot be changed.
None Yes
36
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
ServerPlatform Specifies the server platform.
If the server type is TIBCO MFT PlatformServer, the server platform is the operatingsystem of the defined node. If the server type isFTP or SSH, the server platform is thepreferred file system emulation of the node.
For most SSH (SFTP) and FTPservers, the server platform shouldbe defined as UNIX, even whenexecuting on Windows.
The valid values are as follows:
● IBMi
● zOS
● UNIX
● Unspecified
● WINDOWS
Unspecified No
TraceLevelFlag This flag must only be set under instructionfrom TIBCO technical support.
0 No
Visibility Specifies the visibility of the node.
The valid values are as follows:
● PUB: public
● PRI: private
None No
Sample AddServer Command
This command adds a Platform Server node called NYNode1, assigns an IP address and IP port to theNYNode1 node, and sets some default values for the server. By specifying the DisableFlag parameteras N, the server definition will become immediately available after it is successfully added.java cfcc.CFAdmin a:AddServer ServerName:NYNode1 IPName:192.192.100.1 IPPort:46464
DefaultEncryptType:N CompressType:Y DisableFlag:N
GetServer
The GetServer command action is used to display configuration parameters from a single nodedefinition in the MFTCC node definition table.
To use the GetServer action command, you must have UpdateServerRight. For more information onthis right, see AddUserToRole.
When this command is executed successfully, the defined MFTCC will be displayed along with theconfiguration parameters for the defined server definition. If the node that you want to display is notdefined, you will receive an error.
37
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
ServerName Specifies the 1 to 32 character node name.
This parameter is the name that TIBCO MFTPlatform Server is known as within MFTCC.
If the server name contains embedded spaces, theentire server name must be enclosed in doublequotation marks (“).
This value must point to an existingserver definition. If the node that youwant to update is not defined, you willreceive an error.
None Yes
Sample GetServer Command
This command displays parameters defined for the NYNode1 server. The server name is required forthe GetServer command action.java cfcc.CFAdmin a:GetServer ServerName:NYNode1
RetrieveAllServers
The RetrieveAllServers command action is used to display configuration parameters from all nodedefinitions from the MFTCC node definition table.
To use the RetrieveAllServers action command, you must have UpdateServerRight. For moreinformation on this right, see AddUserToRole.
When this command is executed successfully, each node that is in the MFTCC server table will bedisplayed along with the configuration parameters defined for each server definition.
No parameters are supported for this command action.
Sample RetrieveAllServers Command
This command displays parameters defined for all MFTCC server definitions.java cfcc.CFAdmin a:RetrieveAllServers
RemoveServer
The RemoveServer command action is used to delete a node definition from MFTCC node definitiontable.
To use the RemoveServer action command, you must have UpdateServerRight. For more informationon this right, see AddUserToRole.
When this command is executed successfully, the server will be removed from the server definitiontable.
38
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
ServerName Specifies the 1 to 32 character node name.
This is the name that TIBCO MFT PlatformServer is known as within MFTCC.
If the server name contains embedded spaces, theentire server name must be enclosed in doublequotation marks (“).
This parameter must point to anexisting server definition. If the nodethat you want to update is not defined,you will receive an error.
None Yes
Sample RemoveServer Command
This command deletes the NYNode1 server. The server name is required for the RemoveServercommand action.java cfcc.CFAdmin a:RemoveServer ServerName:NYNode1
UpdateServer
The UpdateServer command action is used to update an existing MFTCC node definition.
The node definition contains information about the remote Platform Server system. You must definenode definitions when you are connecting to a remote TIBCO MFT Platform Server. If you are storingfiles locally, you do not have to define node definitions.
To use the UpdateServer action command, you must have UpdateServerRight. For more informationon this right, see AddUserToRole.
Parameter Description Default Required
CheckServerSta
tus (cstat)
Specifies whether to check the server status.
The valid values are as follows:
● Y
● N
N No
CollectInterva
l
Specifies the collection interval in minutes.
This parameter is for TIBCO MFT PlatformServer only.
None No
CollectType Specifies the type of collection that needs to bedone.
The valid values are as follows:
● I: initiator
● R: responder
● B: both
None No
39
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
CollectionFlag Specifies whether to collect data from TIBCOMFT Platform Server.
The valid values are as follows:
● Y
● N
N No
CompressType Specifies the default compression that will beperformed between the web client and theMFTCC server.
The valid values are as follows:
● N: no compression
● Y: use compression
This parameter specifies the compressionbetween the web client and the MFTCC server,and not between the MFTCC server and MFTPlatform Server. At this time, no compressionis supported between the MFTCC server andMFT Platform Server.
If this parameter is not defined, thecompression flag defined in the MFTCCconfiguration will be used.
None No
ConnectionSecu
rityType
Specifies the security that will be used whenusing a connection type of FTP.
The valid values are as follows:
● None: FTP connection is insecure.
● Explicit SSL: an insecure connection ismade to the remote FTP node, followed bya negotiation for SSL security.
The remote server must be listening on aninsecure port.
● Implicit SSL: an SSL connection is madeto the remote FTP node.
The remote server must be listening on anSSL port.
None:indicates thatFTPconnection isinsecure.
No
DataConnection
Type
Specifies the connection type for FTP transfers.
The valid values are as follows:
● PORT: FTP client listens for all dataconnections.
● PASV: FTP server listens for all dataconnections.
PORT No
40
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
DefaultEncrypt
Type
Specifies the default encryption that will beperformed between the MFTCC server and thetarget Platform Server node.
The valid values are as follows:
● N: no encryption
● D: for DES encryption (56 bit key)
● R: for Rijndael encryption (256 bit key)
This encryption is for MFTCC to PlatformServer target node only.
All communication between the web client andMFTCC is encrypted using SSL encryption.
If you want to encrypt data between TIBCOMFT Command Center and TIBCO MFTPlatform Server, it is good practice to useRijndael encryption, because Rijndael is astronger encryption and is far more efficient.
N No
DefaultLTTable Specifies the 1 to 256 byte default localtranslate table that MFTCC uses whenperforming data translation.
This parameter must point to the fullyqualified translation table file name.
This parameter is typically used for ASCII toEBCDIC translation when communicatingwith TIBCO MFT Platform Server for z/OS andIBMi.
If the file record has theLocalTranslationTable parameter defined,this parameter will be used instead.
None No
DefaultPass Specifies the 1 to 32 byte default password thatwill be used when communicating with thetarget Platform Server node.
This parameter will not be used if a userprofile is defined for the server definition oruser that performs the file transfer. Likewise,this parameter is overridden by theDefaultUser parameter on the file record.
When this parameter is defined, theDefaultUser parameter must be defined aswell.
None No
41
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
DefaultRTTable Specifies the 1 to 256 byte default remotetranslate table that the target Platform Serversystem uses when performing data translation.
This parameter must point to the name of thetranslation table on the remote Platform Serversystem.
This parameter will not be used if the filerecord has the RemoteTranslationTableparameter defined.
When communicating with TIBCO MFTPlatform Server for z/OS, this table can be from1 to 8 characters long and must be enabled atthe time the transfer runs.
None No
DefaultUser Specifies the 1 to 32 byte default user that willbe used when communicating with the targetPlatform Server node.
This parameter will not be used if a userprofile is defined for the server definition oruser that performs the file transfer. Likewise,this parameter is overridden by theDefaultServerUserID parameter on the filerecord.
When this parameter is defined, theDefaultPass parameter must be defined aswell.
None No
DefaultWinDoma
in
Specifies the 1 to 256 byte default NT domainthat will be used when communicating withthe target TIBCO MFT Platform Server forWindows node.
This parameter will not be used if a userprofile is defined for the server definition oruser that performs the file transfer. Likewise,this parameter is overridden by theDefaultWinDomain parameter on the filerecord.
When this parameter is defined, theDefaultUser and DefaultPass parametersmust be defined as well.
This parameter is only used whencommunicating with a Windows environmentand defines the domain where the user isdefined.
None No
Department Specifies the nodes department. None No
Description Describes this node. None No
42
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
DisableFlag Specifies whether to disable the serverdefinition. When a server is disabled, it is notavailable for use by TIBCO MFT CommandCenter or TIBCO MFT Internet Server.
The valid values are as follows:
● N: the server is not disabled.
● Y: the server is disabled.
None No
INETServerType Specifies the Internet Server type.
The valid values are as follows:
● C: the server is Platform Server.
● F: the server is FTP.
● L: the server is the local MFTCC server.
● S: the server is SSH.
C No
IPName Specifies the 1 to 64 character IP name. Thisparameter can be either a machine name or anIP address.
This parameter defines the TCP informationnecessary to establish communication with theremote Platform Server node.
If this parameter is defined incorrectly, MFTCCwill be unable to connect to the remotePlatform Server node.
None No
IPPort Specifies the TCP port number that the targetserver is listening on for incoming connections.
This parameter can be any number between1025 and 65535.
This parameter must match the IP port that theremote server (SFTP, FTP, Platform Server) islistening to for incoming connections.
If this parameter is defined incorrectly, MFTCCwill be unable to connect to the remote server.
None No
ManageCFServer
Flag
Specifies whether to manage TIBCO MFTPlatform Server from MFTCC.
The valid values are as follows:
● Y
● N
N No
43
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
PGPASCII
(pascii)
Specifies whether to use ASCII armoredformat.
The valid values are as follows:
● Y
● N
N No
PGPCompression
(pcomp)
Specifies the type of compression.
The valid values are as follows:
● default
● none
● zip
● zlib
default No
PGPEnabled
(pena)
Specifies whether PGP is enabled on this serverdefinition.
The valid values are as follows:
● Y
● N
N No
PGPEncryptAlgo
rithm (pea)
Specifies the algorithm to be used to encryptthe PGP file.
The valid values are as follows:
● 3des
● default
● cast5
● blowfish
● aes128
● aes192
● aes256
default Yes
44
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
PGPHashAlgorit
hm (phash)
Specifies the hash algorithm to be used toencrypt the PGP file.
The valid values are as follows:
● default
● md2
● md5
● ripemd
● sha1
default Yes
PGPPrivateKey
(pkey)
Specifies the 1 to 64 character private key. None No
PGPSign
(psign)
Specifies whether to sign the PGP file transfer.
The valid values are as follows:
● Y
● N
N No
PGPVerifySigna
ture (pver)
Specifies whether to verify the signature of thePGP key.
The valid values are as follows:
● Y
● N
N No
PGPVerifyServe
rSignature
(puver)
Specifies whether to verify the server that isdefine in the file definition.
The valid values are as follows:
● Y
● N
N No
ServerFileName
Prefix
Specifies the server file name prefix.
This parameter is only valid for L node type.
None No
45
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
ServerName Specifies the 1 to 32 character node name.
This parameter is the name that TIBCO MFTPlatform Server is known as within theMFTCC system.
If the server name contains embedded spaces,the entire server name must be enclosed indouble quotation marks (“).
This value must point to an existingserver definition, and as such theserver name cannot be changed.
None Yes
ServerPlatform Specifies the server platform.
If the server type is TIBCO MFT PlatformServer, the server platform is the operatingsystem of the defined node; if the server type isFTP or SSH, the server platform is thepreferred file system emulation of the node.
For most SSH (SFTP) and FTPservers, the server platform shouldbe defined as UNIX, even whenexecuting on Windows.
The valid values are as follows:
● IBMi
● zOS
● UNIX
● Unspecified
● WINDOWS
Unspecified No
TraceLevelFlag This flag must only be set under instructionfrom TIBCO technical support.
0 No
Visibility Specifies the visibility of the node.
The valid values are as follows:
● PUB: Public
● PRI: Private
None No
Sample UpdateServer Command
This command updates the NYNode1 server. The server name is required for the UpdateServercommand action. This command updates the DefaultEncryptType, CompressType, and DisableFlagparameters.java cfcc.CFAdmin a:UpdateServer ServerName:NYNode1 DefaultEncryptType:R
CompressType:Y DisableFlag:N
46
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Session CommandsThe session commands are used to list and delete MFTCC sessions.
Action Description
DeleteSessionId Deletes an MFTCC session ID.
DeleteExpiredSessionIds Deletes all expired session IDs.
GetExpiredSessionIds Lists expired session IDs.
ListActiveSessionIds Lists active session IDs.
DeleteSessionId
The DeleteSessionId command action is used to delete an MFTCC session ID.
The session IDs are used to regulate the amount of time that a user can remain inactive whenprocessing the MFTCC requests. This command can only be used when requested by TIBCO technicalsupport.
To use the DeleteSessionId action command, you must have UpdateSessionRight. For moreinformation on this right, see AddUserToRole.
If the session ID is not found, the action will fail and an error message will be displayed.
Parameter Description Default Required
SessionID Specifies the 1 to 64 character session ID.
This information is typically extracted from the ListActiveSessionIds or GetExpiredSessionIdsaction command.
None Yes
Sample DeleteSessionId Command
This command deletes the MFTCC sessions with the defined session ID.
java cfcc.CFAdmin a:DeleteSessionId SessionID:583def%6abdeef%7b30
DeleteExpiredSessionIds
The DeleteExpiredSessionIds command action is used to delete all MFTCC session IDs that are onthe session database but have expired.
The session IDs are used to regulate the amount of time that a user can remain inactive whenprocessing the MFTCC requests. This command can only be used when requested by TIBCO technicalsupport.
To use the DeleteExpiredSessionIds action command, you must have UpdateSessionRight. For moreinformation on this right, see AddUserToRole.
No parameters are supported for this command action.
Sample DeleteExpiredSessionIds Command
This command deletes all expired MFTCC sessions.
java cfcc.CFAdmin a:DeleteExpiredSessionIds
47
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
GetExpiredSessionIds
The GetExpiredSessionIds command action is used to display a list of all MFTCC session IDs that areon the session database but have expired.
The session IDs are used to regulate the amount of time that a user can remain inactive whenprocessing the MFTCC requests. This command can only be used when requested by TIBCO technicalsupport.
To use the GetExpiredSessionIds action command, you must have UpdateSessionRight. For moreinformation on this right, see AddUserToRole.
No parameters are supported for this command action.
Sample GetExpiredSessionIds Command
This command lists all expired MFTCC sessions.java cfcc.CFAdmin a:GetExpiredSessionIds
ListActiveSessionIds
The ListActiveSessionIds command action is used to display a list of all MFTCC session IDs that arecurrently active.
The session IDs are used to regulate the amount of time that a user can remain inactive whenprocessing the MFTCC requests. This command can only be used when requested by TIBCO technicalsupport.
To use the ListActiveSessionIds action command, you must have UpdateSessionRight. For moreinformation on this right, see AddUserToRole.
No parameters are supported for this command action.
Sample ListActiveSessionIds Command
This command lists all active MFTCC sessions.java cfcc.CFAdmin a:ListActiveSessionIds
Transfer CommandsThe transfer commands are used to define, list, update, and delete transfer definition records in theMFTCC system.
Action Description
AddTransfer Adds a transfer definition to MFTCC.
DeleteExpiredTransfers Deletes expired transfer records.
GetTransfer Lists a specific transfer definition.
RetrieveAllTransfers Lists all transfer definitions.
RetrieveAllTransfersForUser Lists all transfer definitions for a user.
RemoveTransfer Deletes an MFTCC transfer definition.
SearchForTransfers Searches for transfer records.
48
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Action Description
UpdateTransfer Alters an MFTCC transfer definition.
AddTransfer
The AddTransfer command action is used to add a file definition to MFTCC.
The file definition contains information about where the file is located, who can access the file, andcharacteristics of the file.
To use the AddTransfer action command, you must have UpdateTransferDefinitionRight. For moreinformation on this right, see AddUserToRole.
Parameter Description Default Required
AllowDelete Specifies whether MFT will allow the FTPclient to issue the delete command for a filedefined by this transfer definition.
No No
AllowMakeDirec
tory
Specifies whether MFT will allow the FTPclient to create a directory within the directorystructure defined by this transfer definition.
No No
AllowRemoveDir
ectory
Specifies whether MFT will allow the FTPclient to remove a directory within thedirectory structure defined by this transferdefinition.
No No
AllowRename Specifies whether MFT will allow the FTPclient to issue the rename command for a filedefined by this transfer definition.
No No
AllowableProto
col (apl)
Specifies the protocol to be used for thistransfer.
The valid values are as follows:
● FTP
● Secure FTP: referred as SECUREFTP
● HTTPS
● Secure
● CF: for TIBCO MFT Platform Server
● AS2
● All: includes all listed protocols
All Yes
AuthGroupId Specifies the 1 to 64 character MFTCC groupID that is authorized to transfer this file.
A transfer can be authorized to a user ID or agroup. See also the UserId parameter.
None Either theUserId orAuthGroupId
parametermust bespecified.
49
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
AvailableDate Specifies the date this file will be available fortransfer.
The format is YYYY/MM/DD.
The date range is 2000/01/01 to 2099/12/31.
The date oftoday.
No
CRLF Specifies how the records will be delimited.
The valid values are as follows:
● Y: delimited by carriage return line feed(CRLF).
● L: delimited by line feed (LF).
● N: there are no delimiters.
Y: if datatype is text.
N: for anyother datatype.
No
ChkptInterval Specifies the checkpoint interval in minutes.The max value is 59.
5 No
ChkptRestartFl
ag
Specifies whether checkpoint restart issupported.
The valid values are as follows:
● Y
● N
Y No
ClientCompress
Flag
Specifies whether to use compression whentransferring this file.
The valid values are as follows:
● Y
● N
Y No
ClientFileName Specifies the 1 to 256 character file name orlocation on the client machine.
If the file name or location contains embeddedspaces, the entire file name must be enclosedin double quotation marks (“).
None No
DataType Specifies the type of data being transferred.
The valid values are as follows:
● B: binary
● T: text
B No
50
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
DefaultNodePwd Specifies the password to be used with theDefaultNodeUserId parameter.
Certain target nodes might havecase sensitive passwords.
None No
DefaultNodeUse
rId
Specifies the 1 to 20 character user ID to beused to authenticate the file transfer.
This authentication takes place at the serverspecified in the ServerName parameter.
None No
DefaultWinDoma
in
Specifies the Windows domain to be usedwith the DefaultNodeUserid andDefaultNodePwd parameter.
This parameter only applies for Windows-based target systems.
None No
Department Specifies the department of file definition. None No
Description Specifies the 1 to 256 character description ofthis file. This description will be presented tothe client user to describe the contents of thefile.
The entire description must be enclosed indouble quotation marks (“).
None No
DirectoryTrans
fer
Specifies whether this transfer definition is adirectory transfer.
The valid values are as follows:
● Y
● N
No No
DisableFlag Specifies whether to disable this transferdefinition.
The valid values are as follows:
● Y
● N
None Yes
DownloadUpload
Flag
Specifies the direction of the transfer.
This direction is from the end user'sperspective.
The valid values are as follows:
● U: user will upload a file.
● D: user will download a file.
None No
51
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
EmailFailureTe
mplate
Specifies the email template on the MFTCCserver to use for a failed transfer email.
This email template must reside on theMFTCC server.
None No
EmailNotifyTem
plate
Specifies the email template on the MFTCCserver to use to notify the end user that a filehas been added.
None No
EmailSuccessTe
mplate
Specifies the email template on the MFTCCserver to use for a successful transfer email.
None No
EncryptFlag Specifies the level of encryption to be usedwith this transfer.
The valid values are as follows:
● N: none
● D: DES encryption
● R: Rijndael encryption
Uses theencryptionfrom theserverdefinition.
No
ExpirationDate Specifies the date when this transfer willexpire.
The valid values are as follows:
● never: the transfer will not expire.
● +n: n days after the available date.
● date: actual date in YYYY/MM/DD formatbetween 2000/01/01 and 2099/12/31.
never No
FTPAlias Specifies the file name or directory that will bedisplayed when a client accesses this filerecord.
The valid length is up to 256 characters.
When the file record is defined as a directory,the FTP alias is displayed to the user as adirectory. When the file record is defined as afile, the FTP alias is displayed to the user as afile.
If a client accesses this file record and thisparameter is not defined, the transfer ID willbe used as the FTP alias.
The transferIDassociatedwith the filerecord.
No
LocalTranslati
onTable
Specifies the location of the MFTCC charactertranslation table on the MFTCC server.
None No
NotifyEmailTem
plate
Specifies the email template on the MFTCCserver to use for a notification email.
None No
52
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
NotifyFileAvai
lable
Specifies whether to send an email to the enduser when a file is available.
If the file is added for a group, all themembers of that group will be notified.
The email address used for this notification isspecified during the AddUser commandaction.
The valid values are as follows:
● Y
● N
None No
OneTimeFlag Specifies what happens to the file record afterthe transfer has been completed successfully.
The valid values are as follows:
● Y: deletes the record.
● N: keeps the record.
● K: keeps the record, but hide it from theuser or group.
Y No
PGPASCII
(pascii)
Specifies whether to use ASCII armoredformat.
The valid values are as follows:
● Y
● N
N No
PGPCompression
(pcomp)
Specifies the type of compression.
The valid values are as follows:
● default
● none
● zip
● zlib
default No
PGPDecrypt
(pde)
Specifies whether to decrypt the file when itarrives at the remote location.
The valid values are as follows:
● Y
● N
N No
53
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
PGPEncypt
(pen)
Specifies whether to encrypt the file when itarrives at the remote location.
The valid values are as follows:
● Y
● N
N No
PGPEncryptAlgo
rithm (pea)
Specifies the algorithm to be used to encryptthe PGP file.
The valid values are as follows:
● 3des
● default
● cast5
● blowfish
● aes128
● aes192
● aes256
default Yes
PGPHashAlgorit
hm (phash)
Specifies the hash algorithm to be used toencrypt the PGP file.
The valid values are as follows:
● default
● md2
● md5
● ripemd
● sha1
default Yes
PGPPrivateKey
(pkey)
Specifies the 1 to 64 character private key. None No
PGPSign
(psign)
Specifies whether to sign the PGP file transfer.
The valid values are as follows:
● Y
● N
N No
54
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
PGPVerifySigna
ture (pver)
Specifies whether to verify the signature of thePGP key.
The valid values are as follows:
● Y
● N
N No
PGPVerifyUserS
ignature
(puver)
Specifies whether to verify the signature of theuser in the defined file definition.
The valid values are as follows:
● Y
● N
N No
PostActionType
1-4
Specifies the type of post processing action tobe performed when the conditions of thePostActionFlag parameter have been met.
The valid values are as follows:
● CALLPGM: calls a z/OS program withprogram to program parameter linkage.
● CALLJCL: calls a z/OS program with JCL toprogram parameter linkage.
● COMMAND: issues a command at the nodespecified in node name.
● SUBMIT: submits a job at the node specifiedin node name.
None No
PostActionData
1-4
Specifies the data passed to the specified typeof post processing action when the conditionsspecified in the PostActionFlag parameterhave been met.
The data with embedded spaces must beenclosed in double quotation marks (“).
None No
55
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
PostActionFlag
1-4
Specifies the conditions when a postprocessing action must occur.
The post processing action will be performedat the server defined in the ServerNameparameter.
This parameter is used in conjunction with thePostActionType and PostActionDataparameter.
The valid values are as follows:
● S: transfer successfully.
● F: transfer failed.
None No
RemoteTranslat
ionTable
Specifies the location of the MFTCC charactertranslation table on the client machine.
None No
RemoveTrailing
Blanks
Specifies whether to remove any trailingspaces.
This parameter is used only with text typetransfers, and it is only valid when TIBCOMFT Platform Server for z/OS is sending thefile.
The valid values are as follows:
● Y
● N
None No
ServerFileName Specifies the 1 to 256 character file name orlocation of the server machine.
If the node name is *LOCAL, the server filename will be located on the MFTCC server.
If the file name or location contains embeddedspaces, the entire file name must be enclosedin double quotation marks (“).
None No
ServerName Specifies the 1 to 64 character name of theTIBCO MFT Platform Server within yournetwork.
An MFTCC node is a target destination that isrunning TIBCO MFT Platform Server that cansend or receive files.
The server name might also be specified as*LOCAL, this refers to the MFTCC serverwhich does not have to be running the TIBCOMFT Platform Server.
None No
56
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
ToEmailAddrFai
lure
Specifies the email address to be used when atransfer fails.
You must configure your email server detailsin system configurations to use this function.
None No
ToEmailAddrSuc
cess
Specifies the email address to be used when atransfer is successful.
You must configure your email server detailsin system configurations to use this function.
None No
TraceLevelFlag This flag can only be set under the instructionfrom TIBCO technical support.
0 No
UserId Specifies the 1 to 64 character MFTCC user IDto transfer this file.
A transfer can be authorized to a user or agroup. See also the AuthGroupId parameter.
None Either theUserId orAuthGroupId
parametermust bespecified.
ValidDays Specifies the 7 character day of week patternwhen this file can be accessed. For example,Sunday is the first character, Monday is thesecond one, and so on. Each character can beY or N.
YYYYYYY No
ValidStartTime Specifies the start time in military formatHHMM when this file can be accessed.
0000 No
ValidEndTime Specifies the end time in military formatHHMM when this file can be accessed.
2359 No
57
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
WriteMode Specifies the options used when opening theoutput file on the target system.
The valid values are as follows:
● C: creates the file.
If the file already exists, the transfer willfail.
● CR: creates the file if the file does not exist;replaces the file if the file already exists.
● R: replaces the file.
If the file does not exist, the transfer willfail.
● A: appends to the file.
If the file does not exist, the transfer willfail.
● CA: creates the file if the file does not exist;appends to the file if the file already exists.
● CRN: the same as the CR option, butTIBCO® Managed File Transfer InternetServer will also create the directorystructure, if it does not already exist.
CRN No
zOSAllocPri Specifies the primary allocation value in unitsof the zOSAllocType parameter.
Only for transfers to z/OS.
None No
zOSAllocSec Specifies the secondary allocation value inunits of the zOSAllocType parameter.
Only for transfers to z/OS.
None No
zOSAllocType Specifies the allocation type to be used whentransferring files to a z/OS system.
The valid values are as follows:
● T: tracks
● B: blocks
● C: cylinders
● K: kilobytes
● M: megabytes
None No
zOSBlockSize Specifies the block size to be used for filebeing transferred to a z/OS system.
None No
58
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
zOSDataClass Specifies the valid data class used whentransferring files to a z/OS system.
The valid values are 1 to 8 character data classnames defined by storage administrator.
None No
zOSLRECL Specifies the logical record length for filesbeing transferred to a z/OS system.
None No
zOSMgtClass Specifies the valid management class usedwhen transferring files to a z/OS system.
The valid values are 1 to 8 charactermanagement class names defined by storageadministrator.
None No
zOSRECFM Specifies the record format for files beingtransferred to a z/OS system.
The valid values are as follows:
● F: fixed
● FA: fixed ASA
● FB: fixed block
● FBA: fixed blocked ASA
● FBM: fixed blocked machine
● FBS: fixed block standard
● FM: fixed machine
● FS: fixed standard
● V: variable
● VA: variable ASA
● VB: variable blocked
● VBA: variable blocked ASA
● VBM: variable blocked machine
● VBS: variable blocked spanned
● VM: variable machine
● VS: variable spanned
● U: undefined
None No
zOSStorClass Specifies the valid storage class used whentransferring files to a z/OS system.
The valid values are 1 to 8 character storageclass names defined by storage administrator.
None No
59
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
zOSUnit Specifies the device type for a file beingtransferred to a z/OS system.
The valid values are any device types definedto your z/OS system.
None No
zOSVolume Specifies the volume serial number fortransferring files to a z/OS system.
The valid values are any 1 to 6 charactervolume serial numbers on your z/OS system.
None No
Sample AddTransfer Command
This command adds a file to the MFTCC database.java cfcc.CFAdmin a:AddTransfer ClientFileName:"C:\TEMP 001\24.jpg"
ServerFileName:”C:\24.jpg” ServerName:ARTDEPT DisableFlag:N ValidStartTime:0000
ValidEndTime:2359 ValidDays:YYYYYYY OneTimeFlag:K EncryptFlag:D WriteMode:C CRLF:N
Description:"Corporate Logo JPG format" NotifyFileAvailable:Y ExpirationDate:+1
AuthGroupId:PRINTERS DataType:B DownloadUploadFlag:D
DeleteExpiredTransfers
The DeleteExpiredTransfers command action is used to delete all file definitions that have expired.
A file definition has expired when the current date is greater than the date defined by theExpirationDate parameter.
To use the DeleteExpiredTransfers action command, you must have UpdateTransferDefinitionRight.For more information on this right, see AddUserToRole.
No parameters are supported for this command action.
Sample DeleteExpiredTransfers Command
This command deletes all expired file definitions.java cfcc.CFAdmin a:DeleteExpiredTransfers
GetTransfer
The GetTransfer command action is used to display detailed information about one specific filedefinition in the MFTCC system.
To use the GetTransfer action command, you must have UpdateTransferDefinitionRight. For moreinformation on this right, see AddUserToRole.
Parameter Description Default Required
TransferId Specifies the 12 character transfer ID that wasassigned when the file definition was added.
None Yes
Sample GetTransfer Command
This command displays all the parameters defined for the transfer ID specified.java cfcc.CFAdmin a:GetTransfer TransferId:F60930000127
60
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
RetrieveAllTransfers
The RetrieveAllTransfers command action is used to list all file definitions within the MFTCCsystem.
To use the RetrieveAllTransfers action command, you must have UpdateTransferDefinitionRight.For more information on this right, see AddUserToRole.
No parameters are supported for this command action.
Sample RetrieveAllTransfers Command
This command displays the parameters for all the files defined to the MFTCC database.java cfcc.CFAdmin a:RetrieveAllTransfers
RetrieveAllTransfersForUser
The RetrieveAllTransfersForUser command action is used to display a list of all file definitions thathave been defined for a user ID.
To use the RetrieveAllTransfersForUser action command, you must haveViewTransferDefinitionRight and ViewGroupRight. For more information on these rights, see AddUserToRole.
Parameter Description Default Required
UserId Specifies the 1 to 64 character MFTCC user ID ofthe user you want to inquire on.
None Yes
Sample RetrieveAllTransfersForUser Command
This command displays all the information for each file definition defined for this user.java cfcc.CFAdmin a:RetrieveAllTransfersForUser UserId:Accounting001
RemoveTransfer
The RemoveTransfer command action is used to delete a file definition from the MFTCC system.
To use the RemoveTransfer action command, you must have UpdateTransferDefinitionRight. For moreinformation on this right, see AddUserToRole.
Parameter Description Default Required
TransferId Specifies the 12 character transfer ID that wasassigned when the file definition was added.
None Yes
Sample RemoveTransfer Command
This command removes a file definition from the MFTCC database.java cfcc.CFAdmin a:RemoveTransfer TransferId:F21530000818
SearchForTransfers
The SearchForTransfers command action is used to search for all file definitions that match thedefined selection criteria.
You can use the percent sign (%) as a wildcard character in all parameters to select file definitions basedon a partial key.
61
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
To use the SearchForTransfers action command, you must have UpdateTransferDefinitionRight. Formore information on this right, see AddUserToRole.
Parameter Description Default Required
AuthGroupId Specifies the 1 to 64 character MFTCC group IDthat is authorized to transfer this file.
A transfer can be authorized to a user or a group.See also the UserId parameter.
All No
ClientFileName Specifies the 1 to 256 character file name orlocation on the client machine.
If the file name or location contains embeddedspaces, the entire file name must be enclosed indouble quotation marks (“).
None No
Description Specifies the 1 to 256 character description of thisfile. This description will be presented to theclient user to describe the contents of the file.
If the description contains embedded spaces, theentire description must be enclosed in doublequotation marks (").
None No
TransferId Specifies the 12 character transfer ID that wasassigned when the file definition was added.
None No
ServerFileName Specifies the 1 to 256 character file name orlocation of the server machine.
If the server name is *LOCAL, the server file namewill be located on the MFTCC server.
If the file name or location contains embeddedspaces, the entire file name must be enclosed indouble quotation marks (“).
None No
ServerName Specifies the 1 to 64 character name of theMFTCC node within your network.
A MFTCC node is a target destination that isrunning TIBCO MFT Platform Server that cansend or receive files.The server name might also be specified as*LOCAL, which refers to the MFTCC server. TheMFTCC server does not have to be runningTIBCO MFT Platform Server.
None No
UserId Specifies the 1 to 64 character MFTCC user ID ofthe user who is authorized to transfer this file.
A transfer can be authorized to a user or a group.See also the AuthGroupId parameter.
None No
Sample SearchForTransfers Command
This command searches for all file definitions that match the selection criteria.
62
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Note that the ClientFileName and ServerFileName parameters use the wildcard character to matchbased on a partial key, while the ServerName parameter must exactly match the value in the file record.java cfcc.CFAdmin a:SearchForTransfers ClientFileName:”C:\Program Files\%”
ServerFileName:/tmp/% ServerName:NYNode1
UpdateTransfer
The UpdateTransfer command action is used to update a file definition to the MFTCC system.
The file definition contains information about where the file is located, who has access to the file, andthe characteristics of the file.
To use the UpdateTransfer action command, you must have UpdateTransferDefinitionRight. For moreinformation on this right, see AddUserToRole.
Parameter Description Default Required
AuthGroupId Specifies the 1 to 64 character MFTCC group IDthat is authorized to transfer this file.
A transfer can be authorized to a user ID or agroup. See also the UserId parameter.
All Either theUserId orAuthGroupId
parametermust bespecified.
AvailableDate Specifies the date when this file will beavailable for transfer.
The format is YYYY/MM/DD.
The date range is 2000/01/01 to 2099/12/31.
Enter Date No
AllowableProto
col (apl)
Specifies the protocol to be used for thistransfer.
The valid values are as follows:
● FTP
● Secure FTP: referred as SECUREFTP
● HTTPS
● Secure
● CF: for TIBCO MFT Platform Server
● AS2
● All: includes all listed protocols
All Yes
ChkptInterval Specifies the checkpoint interval in minutes.The max value is 59.
5 No
ChkptRestartFl
ag
Specifies whether checkpoint restart issupported.
The valid values are as follows:
● Y
● N
Y No
63
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
ClientCompress
Flag
Specifies whether to use compression whentransferring this file.
The valid values are as follows:
● Y
● N
Y No
ClientFileName Specifies the 1 to 256 character file name orlocation on the client machine.
If the file name or location contains embeddedspaces, the entire file name must be enclosed indouble quotation marks (“).
None No
CRLF Specifies how the records will be delimited.
The valid values are as follows:
● Y: delimited by carriage return line feed(CRLF).
● L: delimited by line feed (LF).
● N: no delimiters.
Y: if thedata typeis text.
N: for anyother datatype.
No
DataType Specifies the type of data being transferred.
The valid values are as follows:
● B: binary
● T: text
B No
DefaultNodePwd Specifies the password to be used with theDefaultNodeUserId parameter.
Certain target nodes might havecase-sensitive passwords.
None No
DefaultNodeUse
rId
Specifies the 1 to 20 character user ID to beused to authenticate the file transfer.
This authentication takes place at the nodewhich is specified in the NodeName parameter.
None No
DefaultWinDoma
in
Specifies the Windows domain to be used withthe DefaultNodeUserid and DefaultNodePwdparameters.
This parameter only applies for Windows-based target systems.
None No
64
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
Description Specifies the 1 to 256 character description ofthis file. This description will be presented tothe client user to describe the contents of thefile.
The entire description must be enclosed indouble quotation marks (“).
None No
DirectoryTrans
fer
Specifies whether this transfer definition is adirectory transfer.
The valid values are as follows:
● Y
● N
N Yes
DisableFlag Specifies whether to disable this transferdefinition.
The valid values are as follows:
● Y
● N
None No
DownloadUpload
Flag
Specifies the direction of the transfer.
This direction is from the end user'sperspective.
The valid values are as follows:
● U: user will upload a file.
● D: user will download a file.
None No
EmailFailureTe
mplate
Specifies the email template on the MFTCCserver to use for a failed transfer email.
This email template must reside on the MFTCCserver.
None No
EmailNotifyTem
plate
Specifies the email template on the MFTCCserver to use to notify the end user that a filehas been added.
None No
EmailSuccessTe
mplate
Specifies the email template on the MFTCCServer to use for a successful transfer email.
None No
65
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
EncryptFlag Specifies the level of encryption to be used withthis transfer.
The valid values are as follows:
● N: none
● D: DES encryption
● R: Rijndael encryption
Theencryptionfrom thenode.
No
ExpirationDate Specifies the date when this transfer will expire.
The valid values are as follows:
● never: the transfer will not expire.
● +n: n days after the available date.
● date: actual date in YYYY/MM/DD formatbetween 2000/01/01 and 2099/12/31.
+7: 7 daysafter theavailabledate.
No
FTPAlias Specifies the file name or directory that will bedisplayed when an FTP client accesses this filerecord.
The valid length is up to 256 characters.
When the file record is defined as a directory,the FTP alias is displayed to the user as adirectory. When the file record is defined as afile, the FTP alias is displayed to the user as afile.
If an FTP client accesses this file record and thisparameter is not defined, the transfer ID will beused as the FTP alias.
This parameter can be ignored unless the useraccesses MFTCC through FTP or Secure FTP.
Thetransfer IDassociatedwith thefile record.
No
LocalTranslati
onTable
Specifies the location of the MFTCC charactertranslation table on the MFTCC server.
None No
NotifyEmailTem
plate
Specifies the email template on the MFTCCserver to use for a notification email.
None No
66
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
NotifyFileAvai
lable
Specifies whether to send an email to the enduser when a file is available.
If the file is added for a group, all the membersof that group will be notified.
The email address used for this notification isspecified during the AddUser command action.
The valid values are as follows:
● Y
● N
None No
OneTimeFlag Specifies what happens to the file record afterthe transfer has been completed successfully.
The valid values are as follows:
● Y: deletes the record.
● N: keeps the record.
● K: keeps the record, but hides it from theuser or group.
Y No
PGPASCII
(pascii)
Specifies whether to use ASCII armored format.
The valid values are as follows:
● Y
● N
N No
PGPCompression
(pcomp)
Specifies the type of compression.
The valid values are as follows:
● default
● none
● zip
● zlib
default No
PGPDecrypt
(pde)
Specifies whether to decrypt the file when itarrives at the remote location.
The valid values are as follows:
● Y
● N
N No
67
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
PGPEncypt
(pen)
Specifies whether to encrypt the file when itarrives at the remote location.
The valid values are as follows:
● Y
● N
N No
PGPEncryptAlgo
rithm (pea)
Specifies the algorithm to be used to encryptthe PGP file.
The valid values are as follows:
● 3des
● default
● cast5
● blowfish
● aes128
● aes192
● aes256
default Yes
PGPHashAlgorit
hm (phash)
Specifies the hash algorithm to be used toencrypt the PGP file.
The valid values are as follows:
● default
● md2
● md5
● ripemd
● sha1
default Yes
PGPPrivateKey
(pkey)
Specifies the 1 to 64 character private key. None No
PGPSign
(psign)
Specifies whether to sign the PGP file transfer.
The valid values are as follows:
● Y
● N
N No
68
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
PGPVerifySigna
ture (pver)
Specifies whether to verify the signature of thePGP key.
The valid values are as follows:
● Y
● N
N No
PGPVerifyUserS
ignature
(puver)
Specifies whether to verify the signature of theuser in the defined file definition.
The valid values are as follows:
● Y
● N
N No
PostActionFlag
1-4
Specifies the conditions when a post processingaction must occur.
The post processing action will be performed atthe node which is defined in the NodeNameparameter.
This parameter is used in conjunction with thePostActionType and PostActionDataparameters.
The valid values are as follows:
● S: the transfer is completed successfully.
● F: the transfer fails.
None No
PostActionType
1-4
Specifies the type of post processing action tobe performed when the conditions of thePostActionFlag parameter are met.
The valid values are as follows:
● CALLPGM: calls a z/OS program withprogram to program parameter linkage.
● CALLJCL: calls a z/OS program with JCL toprogram parameter linkage.
● COMMAND: issues a command at the nodespecified in the NodeName parameter.
● SUBMIT: submits a job at the node specifiedin the NodeName parameter.
None No
69
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
PostActionData
1-4
Specifies the data passed to the specified typeof post processing action when the conditionsspecified in the PostActionFlag parameter aremet.
If the data contains embedded spaces, theentire data must be enclosed in doublequotation marks (").
None No
RemoteTranslat
ionTable
Specifies the location of the MFTCC charactertranslation table on the client machine.
None No
RemoveTrailing
Blanks
Specifies whether to remove any trailingspaces.
This parameter is used only with text typetransfers, and it is only valid when TIBCO MFTPlatform Server for z/OS is sending the file.
The valid values are as follows:
● Y
● N
None No
ServerFileName Specifies the 1 to 256 character file name orlocation of the server machine.
If the node name is *LOCAL, the server file namewill be located on the MFTCC server.
If the file name or location contains embeddedspaces, the entire file name must be enclosed indouble quotation marks (“).
None No
ServerName Specifies the 1 to 64 character name of theTIBCO MFT Platform Server within yournetwork.
An MFTCC node is a target destination that isrunning TIBCO MFT Platform Server that cansend or receive files.
The server name might also be specified as*LOCAL, which refers to the MFTCC server. TheMFTCC server does not have to be running theTIBCO MFT Platform Server.
None No
ToEmailAddrFai
lure
Specifies the email address to be used when atransfer fails.
You must configure your email server details insystem configurations to use this function.
None No
70
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
ToEmailAddrSuc
cess
Specifies the email address to be used when atransfer is successful.
You must configure your email server details insystem configurations to use this function.
None No
TraceLevelFlag This flag can only be set under the instructionfrom TIBCO technical support.
0 No
UserId Specifies the 1 to 64 character MFTCC user IDto transfer this file.
A transfer can be authorized to a user or agroup. See also the AuthGroupId parameter.
None Either theUserId orAuthGroupId
parametermust bespecified.
ValidDays Specifies the 7 character day of week patternwhen this file can be accessed. For example, thefirst character represents Sunday, the secondone represents Monday, and so on. Eachcharacter can be Y or N.
YYYYYYY No
ValidStartTime Specifies the time in military format HHMMfrom which on this file can be accessed.
0000 No
ValidEndTime Specifies the time in military format HHMMfrom which on this file cannot be accessed.
2359 No
WriteMode Specifies the options used when opening theoutput file on the target system.
The valid values are as follows:
● C: creates the file.
If the file already exists, the transfer will fail.
● CR: creates the file if the file does not exist;replaces the file if the file already exists.
● R: replaces the file.
If the file does not exist, the transfer will fail.
● A: appends to the file.
If the file does not exist, the transfer will fail.
● CA: creates the file if the file does not exist;appends to the file if the file already exists.
● CRN: the same as the CR option, but TIBCOManaged File Transfer (MFT) InternetServer will also create the directorystructure, if it does not already exist.
CRN No
71
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
zOSAllocPri Specifies the primary allocation value in unitsof the zOSAllocType parameter.
Only for transfers to z/OS.
None No
zOSAllocSec Specifies the secondary allocation value in unitsof the zOSAllocType parameter.
Only for transfers to z/OS.
None No
zOSAllocType Specifies the allocation type to be used whentransferring files to a z/OS system.
The valid values are as follows:
● T: tracks
● B: blocks
● C: cylinders
● K: kilobytes
● M: megabytes
None No
zOSBlockSize Specifies the block size to be used for file beingtransferred to a z/OS system.
None No
zOSDataClass Specifies the valid data class used whentransferring files to a z/OS system.
The valid values are 1 to 8 character data classnames defined by the storage administrator.
None No
zOSLRECL Specifies the logical record length for files beingtransferred to a z/OS system.
None No
zOSMgtClass Specifies the valid management class usedwhen transferring files to a z/OS system.
The valid values are 1 to 8 charactermanagement class names defined by thestorage administrator.
None No
72
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
zOSRECFM Specifies the record format for files beingtransferred to a z/OS system.
The valid values are as follows:
● F: fixed
● FA: fixed ASA
● FB: fixed block
● FBA: fixed blocked ASA
● FBM: fixed blocked machine
● FBS: fixed block standard
● FM: fixed machine
● FS: fixed standard
● V: variable
● VA: variable ASA
● VB: variable blocked
● VBA: variable blocked ASA
● VBM: variable blocked machine
● VBS: variable blocked spanned
● VM: variable machine
● VS: variable spanned
● U: undefined
None No
zOSStorClass Specifies the valid storage class used whentransferring files to a z/OS system.
The valid values are 1 to 8 character storageclass names defined by the storageadministrator.
None No
zOSUnit Specifies the device type for a file beingtransferred to a z/OS system.
The valid values are any device types definedto your z/OS system.
None No
zOSVolume Specifies the volume serial number fortransferring files to a z/OS system.
The valid values are any 1 to 6 charactervolume serial numbers on your z/OS system.
None No
Sample UpdateTransfer Command
This command updates a file definition in the MFTCC database.java cfcc.CFAdmin a:UpdateTransfer TransferId:F51150000008 ValidDays:YYYYYYY
ValidStartTime:0000 ValidEndTime:2359 ExpirationDate:never
73
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
User CommandsThe user commands are used to define, list, update, and delete users in the MFTCC system.
Action Description
AddAdminUser Adds an administrative user with administratorright.
AddTransferUser Adds a user with transfer rights.
ChangePassword Changes a user password.
GetUser Displays a specific user.
RetrieveAllUsers Displays all users.
RemoveUser Deletes a user.
UpdateUser Updates a user.
AddAdminUser
The AddAdminUser command action is used to define an administrative user to the MFTCC system.
This user will automatically be assigned the administrator right.
Parameter Description Default Required
AddPGPKey
(paddk)
Specifies whether to allow a user to add a PGPkey.
The valid values are as follows:
● Y
● N
● D: default
D No
AllowableProto
col
Specifies the protocol that the user will beallowed to use for a file transfer.
The valid values are as follows:
● FTP
● Secure FTP: referred as SECUREFTP.
● HTTPS
● CF: for TIBCO MFT Platform Server.
● Secure
● AS2
● All: includes all listed protocols except AS2.
All No
74
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
CanChangePassw
ord
Specifies whether to allow this user to changepassword.
The valid values are as follows:
● Y
● N
Y No
CertificateDN Specifies the 1 to 1024 character certificatedistinguish name of the user.
None No
ChangePassword
NextLogin
Specifies whether this user have to changepassword at the next logon.
The valid values are as follows:
● Y
● N
Y No
Company Name
(cname)
Specifies the 1 to 64 character company name. None No
DefaultRole Specifies the default role of the user. None No
Department Specifies the department the user will be placedin.
None No
Description Specifies the 1 to 256 character description forthis user.
If the description contains embedded spaces, theentire description must be enclosed in doublequotation marks (").
None No
DisableFlag Specifies whether this user is initially disabledfrom the MFTCC system.
The valid values are as follows:
● Y
● N
N No
EmailAddr Specifies the 1 to 64 character email address ofthe user.
None No
EndDate Specifies the date when the account of this userwill become inactive in the MFTCC system.
The format is YYYY/MM/DD.
The date range is 2000/01/01 to 2099/12/31.
None Yes
75
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
ExpirationDate Specifies the date when the account of this userwill be expired from the MFTCC system.
The format is YYYY/MM/DD.
The date range is 2000/01/01 to 2099/12/31.
None Yes
FullName Specifies the 1 to 256 character name for this user.
If the full name contains embedded spaces, theentire full name must be enclosed in doublequotation marks (").
None Yes
IPName (ipn) Specifies the 1 to 64 character machine name or IPaddress.
If the RestrictUser parameter is configured asY, this parameter is required.
None No
LockFlag Specifies whether to lock the user out of theMFTCC system.
The valid values are as follows:
● Y
● N
None No
Netmask (netm) Specifies the 1 to 64 byte netmask. None No
Password Specifies the 1 to 30 character password assignedto this user.
The password cannot contain any embeddedspaces. It is case sensitive.
None Yes
PasswordNeverE
xpires
Specifies whether this password ever expires.
This parameter overrides the global passwordrules.
The valid values are as follows:
● Y
● N
N No
PhoneNumber
(phone)
Specifies the 1 to 64 character telephone number. None No
RestrictUser
(rus)
Specifies whether to restrict this user.
The valid values are as follows:
● Y
● N
N No
76
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
StartDate Specifies the date when this user will be active inthe MFTCC system.
The format is YYYY/MM/DD.
The date range is 2000/01/01 to 2099/12/31.
None Yes
TraceLevelFlag This flag can only be set under the instructionfrom TIBCO technical support.
0 No
ValidDays Specifies a 7 character day of week pattern whenthe user can access the MFTCC system.
For example, the first character representsSunday, the second on represents Monday.
Each character can be Y or N.
None Yes
UserId Specifies the 1 to 64 character ID to be assigned tothis user.
The user ID cannot contain embedded spaces.
The user ID can be defined in bothuppercase and lowercase, but it will bestored in uppercase in the MFTCCdatabase.
None Yes
ValidEndTime Specifies a time in military format HHMM whenMFTCC will no longer allow this user access.
None Yes
ValidStartTime Specifies a time in military format HHMM whenthis user can start using MFTCC.
None Yes
Visibility Specifies the visibility of the user.
The valid values are as follows:
● PUB: public
● PRI: private
PRI Yes
Sample AddAdminUser Command
This command adds a user to the MFTCC user database.java cfcc.CFAdmin a:AddAdminUser UserId:CenterAdmin101 FullName:"MFT Command Center
Admin" Password:101 LockFlag:N ExpirationDate:2009/12/31 Description:"MFT Command
Center Admin 101" StartDate:2005/01/03 EndDate:2006/07/01 ValidDays:NYYYYYN
ValidStartTime:1700 ValidEndTime:2100 AllowableProtocol:All
AddTransferUser
The AddTransferUser command action is used to define a user to the MFTCC system.
This user will automatically be assigned transfer right.
77
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
AddPGPKey
(paddk)
Specifies whether to allow a user to add a PGPkey.
The valid values are as follows:
● Y
● N
● D: default. It indicates using the default valueof the Allow users to add PGP keysparameter in the Global PGP Settings sectionon the System Configuration page.
D No
AllowableProto
col (apl)
Specifies the protocol that the user will beallowed to use for a file transfer.
The valid values are as follows:
● FTP
● Secure FTP: referred as SECUREFTP.
● HTTPS
● CF: for TIBCO MFT Platform Server.
● Secure
● AS2
● All: includes all listed protocols except AS2.
All No
CanChangePassw
ord
Specifies whether to allow this user to changepassword.
The valid values are as follows:
● Y
● N
Y No
CertificateDN Specifies the 1 to 1024 character certificatedistinguish name of the user.
None No
ChangePassword
NextLogin
Specifies whether this user have to changepassword at the next logon.
The valid values are as follows:
● Y
● N
Y No
Company Name
(cname)
Specifies the 1 to 64 character company name. None No
DefaultRole Specifies the default role of the user. None No
78
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
Department Specifies the department the user will be placedin.
None No
Description Specifies the 1 to 256 character description forthis user.
If the description contains embedded spaces, theentire description must be enclosed in doublequotation marks (").
None No
DisableFlag Specifies whether this user initially is disablefrom the MFTCC system.
The valid values are as follows:
● Y
● N
N No
EmailAddr Specifies the 1 to 64 character email address ofthe user.
None No
EndDate Specifies the date when the account of this userwill become inactive in the MFTCC system.
The format is YYYY/MM/DD.
The date range is 2000/01/01 to 2099/12/31.
None Yes
ExpirationDate Specifies the date when the account of this userwill be expired from the MFTCC system.
The format is YYYY/MM/DD.
The date range is 2000/01/01 to 2099/12/31.
None Yes
FullName Specifies the 1 to 256 character name for this user.
If the full name contains embedded spaces, theentire full name must be enclosed in doublequotation marks (").
None Yes
IPName (ipn) Specifies the 1 to 64 character machine name or IPaddress.
If the RestrictUser parameter is configured asY, this parameter is required.
None No
LockFlag Specifies whether to lock the user out of theMFTCC system.
The valid values are as follows:
● Y
● N
N No
Netmask (netm) Specifies the 1 to 64 byte netmask. None No
79
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
Password Specifies the 1 to 30 character password assignedto this user.
The password cannot contain any embeddedspaces. It is case sensitive.
None Yes
PasswordNeverE
xpires
Specifies whether this password ever expire.
This parameter overrides the global passwordrules.
The valid values are as follows:
● Y
● N
N No
PhoneNumber
(phone)
Specifies the 1 to 64 character telephone number. None No
RestrictUser
(rus)
Specifies whether to restrict this user.
The valid values are as follows:
● Y
● N
N No
StartDate Specifies the date when this user will be active inthe MFTCC system.
The format is YYYY/MM/DD.
The date range is 2000/01/01 to 2099/12/31.
None Yes
TraceLevelFlag This flag can only be set under the instructionfrom TIBCO technical support.
0 No
UserId Specifies the 1 to 64 character ID to be assigned tothis user.
The user ID cannot contain embedded spaces.
The user ID can be defined in bothuppercase and lowercase, but it will bestored in uppercase in the MFTCCdatabase.
None Yes
ValidDays Specifies a 7 character day of week pattern whenthe user can access the MFTCC system.
For example, the first character representsSunday, the second on represents Monday.
Each character can be Y or N.
For example, NYYYYYN
None Yes
80
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
ValidEndTime Specifies the time in military format HHMMwhen MFTCC will no longer allow this useraccess.
None Yes
ValidStartTime Specifies the time in military format HHMMwhen this user can start using MFTCC.
None Yes
Visibility Specifies the visibility of the user.
The valid values are as follows:
● PUB: public
● PRI: private
PRI Yes
Sample AddTransferUser Command
This command adds a user to the MFTCC user database with the transfer right.java cfcc.CFAdmin a:AddTransferUser UserId: CenterUser001 FullName:"Brian Smith -
Accounting" Password: CenterUser001 LockFlag:N ExpirationDate:2009/12/31
Description:"Brian Smith from XYZ Inc." StartDate:2005/01/03 EndDate:2006/07/01
ValidDays:NYYYYYN ValidStartTime:1700 ValidEndTime:2100 AllowableProtocol:FTP
ChangePassword
The ChangePassword command action is used to change the password for an existing user in theMFTCC system.
To use the ChangePassword action command, you must have the permission to change passwords. Ifyou have AdministratorRight or HelpDeskRight, you can change the password of any user; If you havethe ChangePassword right, you can only change your own password. For more information on thisright, see AddUserToRole.
Parameter Description Default Required
Password Specifies the 1 to 30 character password assignedto this user.
The password cannot contain any embeddedspaces. The password is case sensitive.
None No
UserId Specifies the 1 to 64 character ID of the user to bealtered.
None Yes
Sample ChangePassword Command
This command changes the password for the user ACME0001.java cfcc.CFAdmin a:ChangePassword UserId:ACME0001 Password:FORGOT
81
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
GetUser
The GetUser command action is used to display an existing user in the MFTCC system.
Parameter Description Default Required
UserId Specifies the 1 to 64 character ID of the user to bedisplayed.
None Yes
Sample GetUser Command
This command displays the definition for the user User001.java cfcc.CFAdmin a:GetUser UserId:User001
RemoveUser
The RemoveUser command action is used to delete an existing user in the MFTCC system.
To use the RemoveUser action command, you must have UpdateTransferUserRight. For moreinformation on this right, see AddUserToRole.
Parameter Description Default Required
UserId Specifies the 1 to 64 character ID of the user to bedeleted.
None Yes
Sample RemoveUser Command
This command deletes the user User001 from the MFTCC database.java cfcc.CFAdmin a:RemoveUser UserId:User001
RetrieveAllUsers
The RetrieveAllUsers command action is used to display configuration parameters from all userdefinitions within the definition table of MFTCC users.
To use the RetrieveAllUsers action command, you must have UpdateTransferUserRight. For moreinformation on this right, see AddUserToRole.
When this command is executed successfully, each user that is in the MFTCC user definition table willbe displayed along with the configuration parameters defined for each definition.
No parameters are supported for this command action.
Sample RetrieveAllUsers Command
This command displays information for all MFTCC users.java cfcc.CFAdmin a:RetrieveAllUsers
82
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
UpdateUser
The UpdateUser command action is used to alter an existing user in the MFTCC system.
Parameter Description Default Required
AddPGPKey
(paddk)
Specifies whether to allow a user to add a PGPkey.
The valid values are as follows:
● Y
● N
● D: default
D No
AllowableProto
col (apl)
Specifies the protocol that the user will beallowed to use for a file transfer.
The valid values are as follows:
● FTP
● Secure FTP: referred as SECUREFTP.
● HTTPS
● CF: for TIBCO MFT Platform Server.
● Secure
● AS2
● All: includes all listed protocols except AS2.
All No
CanChangePassw
ord
Specifies whether to allow this user to changepassword.
The valid values are as follows:
● Y
● N
Y No
CertificateDN Specifies the 1 to 1024 character certificatedistinguish name of the user.
None No
ChangePassword
NextLogin
Specifies whether this user have to changepassword at the next logon.
The valid values are as follows:
● Y
● N
Y No
Company Name
(cname)
Specifies the 1 to 64 character company name. None No
DefaultRole Specifies the default role of the user. None No
83
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
Department Specifies the department the user will be placedin.
None No
Description Specifies the 1 to 256 character description forthis user.
If the description contains embedded spaces, theentire description must be enclosed in doublequotation marks (").
None No
DisableFlag Specifies whether this user initially is disabledfrom the MFTCC system.
The valid values are as follows:
● Y
● N
N No
EmailAddr Specifies the 1 to 64 character email address ofthe user.
None No
EndDate Specifies the date when the account of this userwill become inactive in the MFTCC system.
The format is YYYY/MM/DD.
The date range is 2000/01/01 to 2099/12/31.
None Yes
ExpirationDate Specifies the date when the account of this userwill be expired from the MFTCC system.
The format is YYYY/MM/DD.
The date range is 2000/01/01 to 2099/12/31.
None Yes
FullName Specifies the 1 to 256 character name for this user.
If the full name contains embedded spaces, theentire full name must be enclosed in doublequotation marks (").
None Yes
IPName (ipn) Specifies the 1 to 64 character machine name or IPaddress.
If the RestrictUser parameter is configured asY, this parameter is required.
None No
LockFlag Specifies whether to lock the user out of theMFTCC system.
The valid values are as follows:
● Y
● N
N No
Netmask (netm) Specifies the 1 to 64 byte netmask. None No
84
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
Password Specifies the 1 to 30 character password assignedto this user.
The password cannot contain any embeddedspaces. It is case sensitive.
None Yes
PasswordNeverE
xpires
Specifies whether this password ever expire.
This parameter overrides the global passwordrules.
The valid values are as follows:
● Y
● N
N No
PhoneNumber
(phone)
Specifies the 1 to 64 character telephone number. None No
RestrictUser
(rus)
Specifies whether to restrict this user.
The valid values are as follows:
● Y
● N
N No
StartDate Specifies the date when this user will be active inthe MFTCC system.
The format is YYYY/MM/DD.
The date range is 2000/01/01 to 2099/12/31.
None Yes
TraceLevelFlag This flag can only be set under the instructionfrom TIBCO technical support.
0 No
UserId Specifies the 1 to 64 character ID to be assigned tothis user.
The user ID cannot contain embedded spaces.
The user ID can be defined in bothuppercase and lowercase, but it will bestored in uppercase in the MFTCCdatabase.
None Yes
ValidDays Specifies a 7 character day of week pattern whenthe user can access the MFTCC system.
For example, the first character representsSunday, the second on represents Monday.
Each character can be Y or N.
None Yes
85
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
ValidEndTime Specifies the time in military format HHMMwhen MFTCC will no longer allow this useraccess.
None Yes
ValidStartTime Specifies the time in military format HHMMwhen this user can start using MFTCC.
None Yes
Visibility Specifies the visibility of user.
The valid values are as follows:
● PUB: public
● PRI: private
PRI Yes
Sample UpdateUser Command
This command updates the user User001 to allow access to the MFTCC system on weekends and onlyfrom 1 a.m. to 9 a.m.
java cfcc.CFAdmin a:UpdateUser UserId:User001 ValidDays:YNNNNNY ValidStartTime:0100
ValidEndTime:0900 AllowableProtocol:All
User Profile CommandsThe user profile commands are used to define, list, and delete user profile records in the MFTCCsystem.
Action Description
AddUserProfile Adds a profile for a user.
GetUserProfiles Displays a specific user profile.
RetrieveAllUserProfiles Displays all user profiles.
RemoveUserProfile Deletes a user profile.
UpdateUserProfile Updates a profile for a user.
AddUserProfile
The AddUserProfile command action is used to add a server credential definition to the MFTCCsystem.
No command line actions are provided to add definitions to banks.
The user profile definition contains user ID and password information that is used whencommunicating with the remote Platform Server system.
When a transfer is attempted to target TIBCO MFT Platform Server, MFTCC will search the servercredential database for a match on the user or group that is requesting the transfer and the target serverdefinition. If a match can be found, MFTCC will extract the remote user ID, remote password, andremote domain. This information is them sent to the remote Platform Server system.
The advantage of using server credential definitions is that you can define all logon information in asingle place. Different users can be given different logon information.
86
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
The server credential overrides the default user and default password definitions defined on thetransfer and server records.
To use the AddUserProfile action command, you must have UpdateServerCredentialRight. For moreinformation on this right, see AddUserToRole.
Parameter Description Default Required
GroupId Specifies the 1 to 64 character MFTCC group IDthat has been defined in the group database.
If the defined group is not in the group database,the request will fail.
This parameter is exclusive with the UserIdparameter.
When a transfer is done, MFTCC will check all ofthe groups that a user is a member of todetermine whether a match can be found in theuser profile database.
The advantage of defining a group ID user profileis that you can use a single user profile record todefine user IDs and passwords for many users.
If user profiles are defined for both theGroupId and UserId parameters for auser performing a file transfer, the userID definition will be used first.
None Either theGroupId orUserId
parametermust bedefined.
NodeName Specifies the 1 to 32 character MFTCC servername that has been defined in the serverdatabase.
This parameter defines the target Platform Serverdefinition for a file transfer.
If the defined server is not in the server database,the request will fail.
None Yes
RemotePassword Specifies the 1 to 32 character remote PlatformServer password.
This parameter defines the password that will besent to the target Platform Server system whenthe file transfer is performed. This passwordmust be valid on the target Platform Serversystem, or the file transfer request will fail.
The target Platform Server system will validatethe RemoteUserId parameter along with theRemotePassword parameter to insure that it isvalid.
On some systems, such as UNIX and Windows,this parameter is case sensitive. On some othersystems, such as z/OS and AS/400, this parameteris not case sensitive.
None Yes
87
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
RemoteUserId Specifies the 1 to 32 character remote PlatformServer user ID.
This parameter defines the user ID that will besent to the target Platform Server system whenthe file transfer is performed. This user ID mustbe defined on the target Platform Server system,or the file transfer request will fail.
The target Platform Server system will validatethe RemoteUserId parameter along with theRemotePassword parameter to insure that it isvalid.
On some systems, such as UNIX, this parameteris case sensitive. On some other systems, such asz/OS, AS/400, and Windows, it is not casesensitive.
None Yes
RemoteUserWinD
omain
Specifies the 1 to 256 character remote PlatformServer Windows domain.
This parameter is only used when the targetPlatform Server system runs on Windowsplatforms. This parameter is ignored for all otherplatforms.
This parameter defines the domain where theremote user ID is defined. If this parameter is notdefined, or is defined incorrectly, the user ID andpassword validation on TIBCO MFT PlatformServer for Windows will fail.
None No
UserId Specifies the 1 to 64 character ID to be assigned tothis user.
The user ID cannot contain embedded spaces.
If the defined user is not in the user database, therequest will fail.
This parameter is exclusive with the GroupIdparameter.
This parameter references the client user ID thatis performing the file transfer request.
None Either theGroupId orUserId
parametermust bedefined.
Sample AddUserProfile Command
This command adds a user profile. That user profile is used when the user mftuser1 is communicatingwith the NYNode1 node. When MFTCC communicates with TIBCO MFT Platform Server, it will passthe defined RemoteUserId, RemotePassword, and RemoteUserWinDomain parameters to the targetPlatform Server system.java cfcc.CFAdmin a:AddUserProfile UserId:mftuser1 NodeName:NYNode1
RemoteUserId:NYUser1 RemotePassword:NYPassword RemoteUserWinDomain:NYWinDomain
88
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
GetUserProfiles
The GetUserProfiles command action is used to display configuration parameters from a specifieduser profile definition from the MFTCC server definition table.
No command line actions are provided to retrieve definitions from banks.
To use this command, MFTCC will search for a match on the GroupId or UserId parameter and theServer parameter. If a match cannot be found, the request will fail.
To use the GetUserProfiles action command, you must have UpdateServerCredentialRight. For moreinformation on this right, see AddUserToRole.
When the GetUserProfiles command is executed successfully, the user profile is displayed along withthe configuration parameters defined.
Parameter Description Default Required
GroupId Specifies the 1 to 64 character MFTCC group IDthat has been defined in the group database.
For this command, a server credential definitionwith this group ID and the defined serverdefinition must be on the server credential table;otherwise the request will fail.
This parameter is exclusive with the UserIdparameter.
None Either theGroupId orUserId
parametermust bedefined.
NodeName Specifies the 1 to 32 character name of theMFTCC server that has been defined in the serverdatabase.
This parameter defines the target Platform Serverdefinition for a file transfer.
If the defined server along with the GroupId orUserId parameter is not in the user profiledatabase, the request will fail.
None Yes
UserId Specifies the 1 to 64 character MFTCC user IDthat has been defined in the user database.
For this command, a server credential definitionwith this user ID and the defined serverdefinition must be on the server credential table.
This parameter is exclusive with the GroupIdparameter.
None Either theGroupId orUserId
parametermust bedefined.
Sample GetUserProfiles Command
This command displays information for the user profile for the user mftuser1 and the NYNode1 node.All parameter associated with this profile are displayed.java cfcc.CFAdmin a:GetUserProfile UserId:mftuser1 NodeName:NYNode1
89
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
RetrieveAllUserProfiles
The RetrieveAllUserProfiles command action is used to display configuration parameters from allserver credential definitions in the MFTCC system.
No command line actions are provided to retrieve definitions from banks.
To use the RetrieveAllUserProfiles action command, you must have UpdateServerCredentialRight.For more information on this right, see AddUserToRole.
When the RetrieveAllUserProfiles command is executed successfully, each server credential that isin the MFTCC server credential table will be displayed along with the configuration parameters definedfor each definition.
No parameters are supported for this command action.
Sample RetrieveAllUserProfiles Command
This command displays information for all MFTCC server credentials.java cfcc.CFAdmin a:RetrieveAllUserProfiles
RemoveUserProfile
The RemoveUserProfile command action is used to delete a predefined MFTCC server credentialdefinition.
No command line actions are provided to remove definitions from banks.
To use this command, MFTCC will search for a match on the GroupId or UserId parameter and theServer parameter. If a match is not found, the request will fail.
To use the RemoveUserProfile action command, you must have UpdateServerCredentialRight. Formore information on this right, see AddUserToRole.
Parameter Description Default Required
GroupId Specifies the 1 to 64 character MFTCC group ID.
This parameter is exclusive with the GroupIdparameter.
For this command, a server credential definitionwith this group ID and the defined serverdefinition must be on the server credential table;otherwise the request will fail.
None Either theGroupId orUserId
parametermust bedefined.
NodeName Specifies the 1 to 32 character MFTCC servername that has been defined in the serverdatabase.
This parameter defines the target Platform Serverdefinition for a file transfer.
For this command, a server credential definitionwith this group ID and the defined serverdefinition must be on the server credential table;otherwise the request will fail.
None Yes
90
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
UserId 1 to 64 character MFTCC user ID.
This parameter is exclusive with the GroupIdparameter.
For this command, a server credential definitionwith this user ID and the defined serverdefinition must be on the server credential table.
None Either theGroupId orUserId
parametermust bedefined.
Sample RemoveUserProfile Command
This command deletes the server credential for the user mftuser1 and the NYNode1 node.java cfcc.CFAdmin a:RemoveUserProfile UserId:mftuser1 NodeName:NYNode1
UpdateUserProfile
The UpdateUserProfile command action is used to change a predefined MFTCC server credentialdefinition.
No command line actions are provided to update definitions in banks.
To use this command, MFTCC will search for a match on the GroupId or UserId parameter and theServer parameter. If a match is not found, the request will fail.
To use the UpdateUserProfile action command, you must have UpdateServerCredentialRight. Formore information on this right, see AddUserToRole.
Parameter Description Default Required
GroupId Specifies the 1 to 64 character group name thathas been defined.
If the defined group is not in the group database,the request will fail.
This parameter is exclusive with the UserIdparameter.
When a transfer is performed, TIBCO MFTInternet Server will check all of the groups thatthe user is a member of to determine whetherthere is a match in the server credential database.
The advantage of defining a group ID is that youcan use a single server credential record to defineuser IDs and passwords for many users.
If server credentials are defined forboth the GroupId and UserIdparameters for a user performing atransfer, the user ID definition will beused first.
None Either theGroupId orUserId mustbe defined.
91
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
NodeName Specifies the 1 to 32 character MFTCC servername that has been defined in the serverdatabase.
This parameter defines the target Platform Serverdefinition for a file transfer.
If the defined server is not in the server database,the request will fail.
None Yes
RemotePassword Specifies the 1 to 32 character remote PlatformServer password.
This parameter is the password that will be sentto the target Platform Server system when thetransfer is performed. This password must bevalid on the target Platform Server system, or thefile transfer request will fail.
The target Platform Server system will validatethe RemoteUserId parameter along with theRemotePassword parameter to insure that it isvalid.
On some systems, such as UNIX and Windows,this parameter is case sensitive. On some othersystems, such as z/OS and AS/400, it is not casesensitive.
None No
RemoteUserId Specifies the 1 to 32 character remote PlatformServer user ID.
This is the user ID that will be sent to the targetPlatform Server system when the file transfer isperformed. This user ID must be defined on thetarget Platform Server system, or the transferrequest will fail.
The target Platform Server system will validatethe RemoteUserId parameter along with theRemotePassword parameter to insure that it isvalid.
On some systems, such as UNIX, this parameteris case sensitive. On some other systems, such asz/OS, AS/400, and Windows, it is not casesensitive.
None Yes
92
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
RemoteUserWinD
omain
Specifies the 1 to 256 character remote PlatformServer Windows domain.
This parameter is only used when the targetPlatform Server system runs on Windowsplatforms. This parameter is ignored for all otherplatforms.
This parameter defines the domain where theremote user ID is defined. If this parameter is notdefined, or is defined incorrectly, the user ID andpassword validation of TIBCO MFT PlatformServer for Windows will fail.
None No
UserId Specifies the 1 to 64 character MFTCC user IDthat has been defined in the server credentialsdatabase.
If the defined user is not in the server credentialsdatabase, the request will fail.
This parameter is exclusive with the GroupIdparameter.
This parameter references the client user ID thatis performing the transfer request.
None Either theGroupId orUserId mustbe defined.
Sample UpdateUserProfile Command
This command updates a server credential for the user mftuser1 and the NYNode1 node.java cfcc.CFAdmin a:UpdateUserProfile UserId:mftuser1 NodeName:NYNode1
RemoteUserId:NYUser2 RemotePassword:NYPassword123 RemoteUserWinDomain:NYWinDomain
Miscellaneous CommandsThe commands retrieve system information from the MFTCC system.
Action Description
GetCopyrightInfo Displays copyright information.
GetProductNameVersion Gets MFTCC version information.
GetCopyrightInfo
The GetCopyrightInfo command action is used to display copyright information about MFTCC.
No parameters are supported for this command action.
Sample GetCopyrightInfo Command
This command displays the MFTCC copyright information.java cfcc.CFAdmin a:GetCopyrightInfo
93
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
GetProductNameVersion
The GetProductNameVersion command action is used to display version information about MFTCC.
No parameters are supported for this command action.
Sample GetProductNameVersion Command
This command displays the version of the MFTCC product.java cfcc.CFAdmin a:GetProductNameVersion
Help
The Help command action is used to get information on the commands that are used by Admin ClientUtility.
You might enter the following command:
java cfcc.CFAdmin help:xxxxxxx
The field xxxxxxxx must match one of the command actions.
Sample Help Command
This command lists all parameters supported by the AddGroup command action.
java cfcc.CFAdmin help:addgroup
You will receive the following output.Please provide following parameters via command line or in action file:GroupId --- group idDescription --- group descriptionDepartment --- Group's department. The value is ignored for department adminVisibility --- Group's visibility; PUB-public, PRI-private
Action FileThe action file is an XML file specified by the T parameter on the command line. By using an action file,you can put multiple actions in one file specified using XML format.
The format of the action file is as follows:<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE actions SYSTEM "siftactions.dtd"><actions> <action name="action1" output=”action2:file1”> <arg name="arg1" value="somevalue" sc="a1"/> …… </action> ……</actions>
The <action> element defines an action. The <arg> element defines a parameter needed for this action. Ifmultiple <action> elements are defined in the file, the program will execute them one by one.
The name attribute for the <action> element specifies the action name. This action name must be a validaction. The XML file names are all valid actions.
The name attribute for the <arg> element specifies the parameter name for an action. The name is casesensitive and cannot be edited. The sc attribute for the <arg> element specifies a shortcut name for thename attribute, and it is case insensitive. You can use shortcut names to specify values in command lineto replace default values specified in this file. If the action is specified by the A parameter in commandline, you must specify parameter name for that action rather than a shortcut name. Shortcut names canbe found in each XML file.
94
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
For actions that retrieve information from a web service, you can specify an output file in the outputattribute for the <action> element. The program will save the retrieved information into the file in actionfile format. This file can be used as an action file.
Sample Action File
If you want to add user B into the database, and user A whose information can be used for user Balready exists in the database, you can perform the following operations:
1. Build an action file userA.xml to retrieve the information of user A, and save the information intoan addUser command action in the file userB.xml.
The syntax of the userA.xml file will be as follows:<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE actions SYSTEM "siftactions.dtd"><actions> <action name=”getUser” output=”addUser:userB.xml”> <arg name=”UserId” value=”userA” sc=”UID”/> </action></actions>
The value for the output attribute is ActionName:FileName or ActionName>FileName. Because thegenerated file is in action file format, both the action name and file name are needed. Use a colon (:)to generate a new output file, or use the greater than symbol (>) to append to an existing file.
2. Run the program to get the information of user A, and generate an action file userB.xml.
java –classpath %cp% cfcc.CFAdmin U:userA P:pwdA T:userA.xml
3. Run the program again with the generated action file to add user B.
java –classpath %cp% cfcc.CFAdmin U:userB P:pwdB T:userB.xml UID:userB
4. Use UID:userB to overwrite the UserId parameter from the action file, in which the value is userA.
Currently, GetTransfer, GetGroup, GetServer, GetUser, and GetUserProfile command actionssupports writing output into an XML file. The sample XML files included in the product create theafTmpl.xml, agTmpl.xml, anTmpl.xml, asTmpl.xml, auTmpl.xml, and aupTmpl.xml files respectively.
Shortcuts Usage in the Action FileThe advantage of using action file template is that you can use shortcuts to define the parameter names.
An example of command line using shortcuts is as follows:
java cfcc.CFAdmin U:xyz P:xyz KN:certificate KP:pswd a:addFile CFN:clientfile.txt
SFN:serverfile.txt UID:user1 AuthGroupId:TransferRight TKN:cacerts TKP:changeit
You can change the shortcut names. The shortcut names defined in the XML template are the defaultshortcut names. In the above text, the CFN parameter is defined as the shortcut name for theClientFileName parameter. You can change this value to any value that you want, as long as the valuedoes not conflict with an existing parameter name or shortcut value. For example, you can use a texteditor to change the value CFN to CN. Therefore, you can use the value CN in the command line toreference the ClientFileName parameter whenever you use that XML template file.
If the Global.xml file has been updated to contain the user ID, password, and keystore information,you can simply execute following command line.
java cfcc.CFAdmin a:addFile
For client certificate authentication, the client must specify the keystore for its certificate via the Javasystem parameter, or via the KN and KP parameters of command line. To run the program over an SSLconnection, the certificate authority (CA) that signed the certificate of the client must be a trusted CA.This might require you to update your keystore.
95
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
The batch file used to setup classpath overwrites the default system classpath. Experienced users areencouraged to use other environment variable for classpath, and specify classpath in the Javacommand.
Name Description
U The user ID sent to the web service for authentication to use the web service.This parameter might be specified in the Global.xml file.
P The user password sent to the web service for authentication to use the webservice. This parameter might be specified in the Global.xml file.
A The action to take. For example, add file. If the parameter is specified, theprogram will ignore the T parameter that specifies the action file name. Theprogram only accepts one action from command line.
T The action file name. The file can contain multiple actions in XML format.The program will execute all actions specified in the file. If the programspecified the A parameter, this parameter will be ignored.
TL The trace level. This value only affects this utility. This parameter shouldonly be set when instructed to do so by TIBCO technical support. The validvalue rage is 0 to 10.
TD The trace directory. This value only affects this utility. Sets the directorywhere the trace files will be written.
G The global template file name. The default one is Global.xml in the currentdirectory.
S The web service address. For example, https://ip:port/cfcc/…..
KN The Java keystore name for client certificate authentication. The keystorename can be specified as a Java parameter, in which case, it is not necessaryto use this parameter again. This parameter might be specified in theGlobal.xml file.
KP The Java keystore password for client certificate authentication. Thekeystore password can be specified as a Java parameter, in which case, it isnot necessary to use this parameter again. This parameter might be specifiedin the Global.xml file.
TKN The trusted Java keystore name for certificate authentication. This fileshould contain the name of the keystore file that contains the Java trustedcertificate authorities. You can leave this parameter blank if you want to usethe default trusted keystore. This parameter might be specified in theGlobal.xml file.
TKP The trusted Java keystore password for client certificate authentication. Ifthe default password is used, you can leave this parameter blank. Thisparameter might be specified in the Global.xml file.
help The program will display the command line parameter list.
96
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Name Description
help:action The program will display the parameters needed for the action if the actionis a valid action; otherwise, the program will display all currently supportedactions.
name:value Other name:value pairs. These values will be used to assign the values ofparameters if the action is specified by the A parameter, or to replace thedefault values if the T parameter is used. The name is case sensitive if nameis a parameter name for an action. The name is not case sensitive if name is ashortcut for a real parameter name.
In the following example, four entries are defined in the addFile.xml file.<arg name="ClientFileName" value="clientFileName" sc="CFN" description="Client File Name"/><arg name="ServerFileName" value="serverFileName" sc="SFN" description="Server File Name"/><arg name="Description" value="fileDesc" sc="D" description="File Description"/><arg name="UserId" value="user id" sc="UID" description="UserID authorized to transfer this file"/>
The parameter that starts with the value sc= is the shortcut name that has been defined by the XML file.When executing Admin Client Utility with the action file parameter (T:) defined, you can use theshortcut name instead of the actual parameter name. For example in the above example, when definingthe client file name, you can use the CFN parameter instead of the ClientFileName parameter.
Sample Shortcuts Usage
The following examples show how to use standard parameters and shortcuts in the MFTCCcommands:
Using standard parameter names:
java cfcc.CFAdmin a:addFile ClientFileName:client.file1
ServerFileName:prod.file.name Description:”file upload” Userid:acctuser
Using shortcut parameter names:
java cfcc.CFAdmin t:addFile.xml CFN:client.file1 SFN:prod.file.name D:”file upload”
uid:acctuser
As you can see, the parameter names are much shorter when using the shortcut parameters. Theshortcut parameter names can only be used when the action file template (T:) parameter is used in theCFAdmin command. The shortcut values must be defined by the sc= value in the template.
XML FilesThe genExample command is run as part of the Config program. You can create various XML files thatcan be used in conjunction with the command line.
If you choose not to run this when running the Config program, it can be run any time using thefollowing command:
java cfcc.CFAdmin genExample
This will create various XML files that can be used in conjunction with the command line. Thefollowing table lists the names of the files that are created along with a brief description of what theXML file does.
Audit XML files
97
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
GetAudit.xml Displays a specific audit record.
RemoveAudit.xml Removes an audit record.
SearchForAudits.xml Searches for audit records.
Department XML files
AddDepartment.xml Creates a department.
GetDepartment.xml Displays a department.
RemoveDepartment.xml Deletes a department.
RetrieveAllDepartments.xml Displays all departments.
RetrieveAllUsersInDept.xml Displays users assigned to this department.
UpdateDepartment.xml Updates a department.
Group XML files
AddGroup.xml Defines a group.
AddUserToGroup.xml Adds a user to a group.
GetGroup.xml Displays a group.
RemoveGroup.xml Deletes a group.
RemoveUserFromGroup.xml Deletes a user from a group.
RetrieveAllGroups.xml Displays all groups.
RetrieveAllGroupsForUser.xml Displays groups that the user is a member of.
RetrieveAllUsersInGroup.xml Displays all users in a group.
Role XML files
AddUserToRole.xml Adds a right to a user.
GetRole.xml Displays a right.
RemoveUserFromRole.xml Removes a right from a user.
RetrieveAllRoles.xml Displays all rights.
RetrieveAllRolesForUser.xml Displays the rights assigned to a user.
RetrieveAllUsersInRole.xml Displays users that have a specific right.
Server XML files
98
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
AddServer.xml Creates a server.
GetServer.xml Displays a server.
RemoveServer.xml Deletes a server.
RetrieveAllServers.xml Displays all servers.
UpdateServer.xml Updates a server.
Session XML files
DeleteExpiredSessionIds.xml Deletes all expired session IDs.
DeleteSessionId.xml Deletes an MFTCC session ID.
GetExpiredSessionIds.xml Lists expired session IDs.
ListActiveSessionIds.xml Lists active session IDs.
Transfer XML files
AddTransfer.xml Adds a transfer definition to MFTCC.
GetTransfer.xml Lists a specific transfer definition.
RemoveTransfer.xml Deletes an MFTCC transfer definition.
RetrieveAllTransfers.xml Lists all transfer definitions.
RetrieveAllTransfersForUser.xml Lists all transfer definitions for a user.
SearchForTransfers.xml Searches for transfer records.
UpdateTransfer.xml Alters an MFTCC transfer definition.
User XML files
AddAdminUser.xml Adds a user with administrator rights.
AddTransferUser.xml Adds a user with transfer rights.
ChangePassword.xml Changes a user password.
GetUser.xml Displays a specific user.
RemoveUser.xml Deletes a user.
RetrieveAllUsers.xml Displays all users.
UpdateUser.xml Updates a user.
User Profile XML files
99
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
AddUserProfile.xml Adds a profile for a user.
GetUserProfile.xml Displays a specific user profile.
RemoveUserProfile.xml Deletes a user profile.
RetrieveAllUserProfiles.xml Displays all user profiles.
UpdateUserProfile.xml Updates a profile for a user.
Miscellaneous XML files
GetCopyrightInfo.xml Displays copyright information.
GetProductNameVersion.xml Gets the MFTCC version information.
100
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Platform Transfer Client Utility
Platform Transfer Client Utility is designed to let the end user perform Platform Server transfers viaMFTCC through command line on Windows and UNIX platforms.
Platform Transfer Client Utility is run from the same directory where the .zip or .tar files wereextracted.
java cfcc.CFPlatform U:xyz P:xyz KN:certificate KP:pswd a:ListTransferBankRecords
TKN:cacerts TKP:changeit
If the Global.xml file has been updated to contain the user ID, password, and keystore information,you can simply execute the following command:
java cfcc.CFPlatform a:ListTransferBankRecords
For client certificate authentication, the client must specify the keystore for its certificate via the Javasystem parameter, or via the KN and KP parameters of command line. To run the program over an SSLconnection, the certificate authority (CA) that signed client certificates must be a trusted CA. This mightrequire you to update your keystore.
The batch file used to setup classpath overwrites the default system classpath. Experienced users areencouraged to use other environment variable for classpath, and specify classpath in the Javacommand.
Name Description
U The user ID sent to the web service for authentication to use the web service.This parameter might be specified in the Global.xml file.
P The user password sent to the web service for authentication to use the webservice. This parameter might be specified in the Global.xml file.
A The action to take. For example, add file. If the parameter is specified, theprogram will ignore the T parameter that specifies the action file name. Theprogram only accepts one action from command line.
T The action file name. The file can contain multiple actions in XML format.The program will execute all actions specified in the file. If the programspecified the A parameter, this parameter will be ignored.
TL The trace level. This value only affects this utility. This parameter can onlybe set when instructed to do so by TIBCO technical support. The valid valuerange is 0 to 10.
TD The trace directory. This value only affects this utility. Sets the directorywhere the trace files will be written.
G The global template file name. The default one is Global.xml in the currentdirectory.
S The web service address. For example, https://ip:port/cfcc/…..
KN The Java keystore name for client certificate authentication. The keystorename can be specified as a Java parameter, in which case, it is not necessaryto use this parameter again. This parameter might be specified in theGlobal.xml file.
101
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Name Description
KP The Java keystore password for client certificate authentication. Thekeystore password can be specified as a Java parameter, in which case, it isnot necessary to use this parameter again. This parameter might be specifiedin the Global.xml file.
TKN The trusted Java keystore name for certificate authentication. This file mustcontain the name of the keystore file that contains the Java trusted certificateauthorities. You can leave this parameter blank if you want to use thedefault trusted keystore. This parameter might be specified in theGlobal.xml file.
TKP The trusted Java keystore password for client certificate authentication. Ifthe default password is used, you can leave this parameter blank. Thisparameter might be specified in the Global.xml file.
help The program will display the command line parameter list.
help:action The program will display the parameters needed for the action if the actionis a valid action; otherwise, the program will display all currently supportedactions.
name:value Other name:value pairs. These values will be used to assign the values ofparameters if the action is specified by the A parameter, or to replace thedefault values if the T parameter is used. The name is case sensitive if nameis a parameter name for an action. The name is not case sensitive if name is ashortcut for a real parameter name.
CommandsThe commands of Platform Transfer Client Utility are used to define, list, update, and delete Platformtransfer bank definition records in the MFTCC system.
The following commands are used to transfer files between the TIBCO MFT Platform Servers.
Action Description
AddTransferToBank Adds a Platform transfer definition to the bankin MFTCC.
ExecuteFromBank Performs a Platform transfer from a list ofdefined transfers.
GetCopyrightInfo Displays the product copyright information.
GetProductNameVersion Displays the products name and versioninformation.
GetTransferFromBank Lists a specific Platform transfer already definedin the MFTCC bank.
Help Provides information on the action you want torun.
102
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Action Description
ListTransferBankRecords Retrieves all of the transfer records in the bank.
ReceiveFile Receives a file from another Platform Serversystem.
RemoveTransferFromBank Deletes a Platform transfer already defined inthe MFTCC bank.
SendCommand Sends a command to another Platform Serversystem.
SendFile Sends a file to another Platform Server system.
UpdateTransferFromBank Alters a Platform transfer already defined in theMFTCC bank.
AddTransferToBankThe AddTransferToBank command action is used to add a Platform Server transfer definition to theMFTCC system.
Parameter Description Default Required
CkPtInterval Specifies the checkpoint interval.
The Platform Server checkpoint uses a time intervalto determine when to send a checkpoint.
Because checkpoint is time-based, checkpointalways occurs at a regular interval. The checkpointinterval is specified in minutes, and the valid rangeis 1 to 90 minutes.
None No
CompressionFlag Specifies the compression algorithm.
TIBCO MFT Platform Server provides two differentcompression algorithms:
● Limpel-Zev (LZ)
● Run Length Encoding (RLE)
You can select the algorithm which best suits yournetwork.
The valid values are as follows:
● L: LZ
● N: none
● R: RLE
● U: undefined
None No
103
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
DataConversionT
ype
Specifies the type of data conversion to convert databetween ASCII and EBCDIC.
This parameter is used when communicating withsystems has defined data structures. This parameterwill not be necessary if you are communicatingfrom PC to z/OS.
If you are using TIBCO MFT Platform Server, whenyou change the combtlg.dat file, you have to stopand start the Platform Server service for the newconversion table to take effect.
The valid values are as follows:
● B: binary
● E: EBCDIC
● A: ASCII
None No
Delimiter Specifies the carriage return line feed control fortransferring files.
The valid values are as follows:
● C or CRLF: records are delimited by carriagereturn line feed.
● L or LF: records are delimited by line feed.
This is typically used when transmitting textdata to z/OS.
The line conversion is done on thez/OS platform.
● N: no record delimiters exist in the file.
This is typically done for a binary transfer.
None No
Department
(dpt)
Specifies the department associated with thePlatform transfer.
None No
Description (d) Specifies the 1 to 256 character descriptions of thisPlatform transfer bank file definition.
If the description contains embedded spaces orspecial characters, the entire description must beenclosed in double quotation marks (").
None Yes
104
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
EncryptionFlag Specifies the type of encryption to be used with thistransfer.
The valid values are as follows:
● 3D|3DES: 3DES encryption
● BF: blowfish
● BFL: blowfish long
● D|DES: DES encryption
● N: no encryption
● R|RJ|AES: Rijndael
● U: undefined
U No
ExpirationDays Specifies the number of days after which thetransfer should no longer be attempted.
If this transfer was scheduled, that will takeprecedence over expiration.
If expiration and retention are used, whichevervalue occurs first will take precedence.
The valid value range is 0 to 999999.
0 No
FileWriteMode Specifies the create option for the side writing thefile.
The valid values are as follows:
● A: append
● C: create
● CA: create/append
● CR: create/replace
● CRN: create/replace/new
● R: replace
C No
InitiatorFileNa
me
Specifies the name of the file on the platform that isinitiating the transfer.
On a send request, it is the file to be sent. On areceive request, it is where the file will be placed.
None Yes
LocalTransTable Specifies the location of the local translation tableused with this transfer.
If the path contains embedded spaces, the entirepath must be enclosed in double quotation marks(").
None No
105
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
LoginPWD Specifies the initiating user password.
The password might be up to 64 characters inlength and is case sensitive.
None No
LoginUID Specifies the initiator user ID used to log in toTIBCO MFT Platform Server.
If this parameter is defined, MFTCC will use theuser ID and password when connecting to TIBCOMFT Platform Server. If this parameter is notdefined, MFTCC will search for a server credentialthat matches the user ID and server definition.
None No
PermittedAction
s
Specifies the Windows-specific file attributes.
These attributes are only valid when sending to aWindows machine.
The valid values are as follows:
● A: archive
● C: NTFS compress
● E: EOF
● H: hidden file
● R: read-only
● S: system file
● Z: control Z EOF
None No
PortNum Specifies the IP port on which the remote PlatformServer system listens on.
The valid value range is 1025 to 65535.
None No
106
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
PPA1 - PPA4 Specifies the post processing action.
The post processing action allows you to performup to four actions to be completed by the serverwhen a file transfer request is completed.
The format of the command indicates whether apost processing action should be performed uponsuccess or failure.
The valid values are as follows:
● S|F: success or failure.
● L|R: local or remote.
● CALLPGM: calls a z/OS program with program toprogram parameter linkage.
This parameter allows the user to call a userprogram defined on the remote z/OS system.
● CALLJCL: calls a z/OS program with JCL toprogram parameter linkage.
This parameter allows the user to call a userprogram defined on the remote z/OS system.
● COMMAND: issues a command at the nodespecified in the NodeName parameter.
This is the command that you want to executeon the remote system.
● SUBMIT: submits a job at the node specified inthe NodeName parameter.
This parameter allows the user to submit a jobon the remote system. This differs from file tojob because the JCL to run actually sits on theremote system.
● ActionData: specifies the data passed to thepost action when the conditions specified aremet.
None No
ProcessName Specifies the 8 character field to describe theapplication which is initiating the transfer.
None No
PServerName Specifies the server name that identifies theinitiating TIBCO MFT Platform Server.
None Yes
RemoteTransTabl
e
Specifies the location of the remote translation tableused with this transfer.
If the path contains embedded spaces, the entirepath must be enclosed in double quotation marks(").
None No
107
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
RemoveTrail
(rmtrail)
Specifies whether to remove trailing spaces fromthe file.
The valid values are as follows:
● Y
● N
N No
ResponderFileNa
me
Specifies the name of the file on the platform that isresponding to the transfer.
On a send request, it is where the file is placed. Ona receive request, it is the file to be transferred.
None Yes
ResponderPWD Specifies the remote password.
The password might be up to 64 characters inlength and is case sensitive.
None No
ResponderUID Specifies the user ID that the initiator sends to theresponder to gain access to the system.
If this parameter is defined, the Platform Serverinitiator uses the user ID and password whenconnecting to the Platform Server responder. If thisparameter is not defined, the Platform Serverinitiator searches for a user profile that matches theuser ID and responder node definition. If no userprofile is found, the Platform Server initiator sendsa trusted user that the Platform Server respondercan be configured to accept or reject.
None No
RIPName Specifies the responder IP or host name. None Yes
RNodeName Specifies the remote node name.
You can define this parameter in place of definingthe RIPName parameter if the remote server isdefined in MFTCC and you know the server namebeing used for it.
None Yes
Or theRIPName
parametercan beused.
SecurityAttribu
te
Specifies the file name that the receiving partneruses as a template for its access control list (ACL).
The ACL is a list that specifies users and groups,and their access permissions on a file.
The ACL of this file is copied to the ACL of thedestination file. For this feature to function properlyon Windows, the file specified must be readable bythe partner which is receiving the file to file transferand the file being created must reside on an NTFSdrive.
None No
108
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
SSLFlag Specifies whether to use secure sockets layer (SSL).
The valid values are as follows:
● Y
● N
None No
ToEmailAddrF Specifies the email address for failed transactions. None No
ToEmailAddrS Specifies the email address for successfultransactions.
None No
TransferDirecti
on
Specifies the transfer direction.
The valid values are as follows:
● S: sends a file.
● R: receives a file.
● C: sends a command.
None Yes
TrScheduleDate Specifies the transfer schedule date.
The valid values are as follows:
● YYYY-MM-DD
● YYYY-MM-DD HH:MM
● YYYY/MM/DD HH:MM
None No
TryMaxCount Specifies the maximum number of transfer retriesallowed.
None No
UnixPermissions Specifies the UNIX permissions.
When a file is created on a UNIX system, TIBCOMFT Platform Server can set the UNIX permissionson the file.
The UNIX permissions are defined by a three digitnumber, such as 777, which is the same as for thechmod command.
None No
UserData Specifies the user data, with any alpha, numeric, ornational characters.
This parameter is up to 25 characters that will belogged into the history files that containinformation that describes the transfer on the localand remote system.
None No
109
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
WaitFlag Specifies whether to wait for completion.
This parameter will show the status of the transferafter execution.
The valid values are as follows:
● Y: waits for completion.
● N: not wait.
None No
zOSAllocDir Specifies the number of directory blocks to allocate.
This parameter is only used when the initiator isz/OS.
None No
zOSAllocPri Specifies the primary allocation value in the unitdefined by the zOSAllocType parameter.
This parameter is only used for transferring files toa z/OS system.
The valid values are any numeric.
None No
zOSAllocSec Specifies the secondary allocation value in the unitdefined by the zOSAllocType parameter.
This parameter is only used for transferring files toa z/OS system.
The valid values are any numeric.
None No
zOSAllocType Specifies the allocation type to be used whentransferring files to a z/OS system.
The valid values are as follows:
● T: tracks
● B: tlocks
● C: cylinders
● K: kilobytes
● M: megabytes
None No
zOSBlockSize Specifies the block size to be used for file beingtransferred to a z/OS system.
The valid values are any numeric.
None No
zOSDataClass Specifies the valid data class used whentransferring files to a z/OS system.
The values are 1 to 8 character data class namesdefined by your storage administrator.
None No
110
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
zOSLRECL Specifies the logical record length for files beingtransferred to a z/OS system.
The valid values are any numeric.
None No
zOSMgtClass Specifies the valid management class used whentransferring files to a z/OS system.
The valid values are 1 to 8 character managementclass names defined by your storage administrator.
None No
zOSRECFM Specifies the record format to be used whentransferring to a z/OS system.
The valid values are as follows:
● F: fixed
● FB: fixed block
● V: variable
● VB: variable blocked
● U: undefined
None No
zOSStorClass Specifies the valid storage class used whentransferring files to a z/OS system.
The valid values are 1 to 8 character storage classnames defined by your storage administrator.
None No
zOSUnit Specifies the device type for a file being transferredto a z/OS system.
The valid values are any device types defined toyour z/OS system.
None No
zOSVolume Specifies the volume serial number for transferringfiles to a z/OS system.
The valid values are any 1 to 6 character volumeserial numbers on your z/OS system.
None No
Sample AddTransferToBank Command
This command adds a file definition to the MFTCC database:java cfcc.CFPlatform a:AddTransferToBank RIPName:10.1.1.225 TransferDirection:S
PServerName:JCBWIN InitiatorFileName:c:\cfoutgoing\testfile1.txt
ResponderFileName:c:\mftincoming\$(LocalFileName)
111
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
ExecuteFromBankThe ExecuteFromBank command action is used to send a file from one TIBCO MFT Platform Server toanother TIBCO MFT Platform Server.
Parameter Description Default Required
TransferId Specifies the ID for the transfer record in the bank. None Yes
Sample ExecuteFromBank Command
This command executes a transfer directly from the MFTCC bank of Platform transfers.java cfcc.CFPlatform a:ExecuteFromBank TransferID:T62350000075
GetCopyrightInfoThe GetCopyrightInfo command action is used to display copyright information about MFTCC.
No parameters are supported for this command action.
Sample GetCopyrightInfo Command
This command displays the MFTCC copyright information.java cfcc.CFPlatform a:GetCopyrightInfo
GetProductNameVersionThe GetProductNameVersion command action is used to display version information about MFTCC.
No parameters are supported for this command action.
Sample GetProductNameVersion Command
This command displays the version of the MFTCC product.java cfcc.CFPlatform a:GetProductNameVersion
GetTransferFromBankThe GetTransferFromBank command action is used to retrieve a Platform Server transfer definitionfrom the MFTCC Platform transfer bank.
Parameter Description Default Required
TransferID
(tid)
Specifies the Platform transfer ID for the Platformtransfer you want to retrieve from the bank.
None No
Description (d) Specifies the Platform transfer bank descriptionfield.
You can use the percent sign (%) as a wildcardcharacter.
None No
Sample GetTransferFromBank Command
This command retrieves a transfer from the MFTCC bank of the Platform transfers.java cfcc.CFPlatform a:GetTransferFromBank TransferID:T62850000137
112
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
HelpThe Help command action is used to get information on the commands that are used by PlatformTransfer Client Utility.
You might enter the following command:
java cfcc.CFPlatform help:xxxxxxx
The field xxxxxxxx should match one of the command actions.
Sample Help Command
This command lists of all parameters supported by the SendCommand command action.java cfcc.CFPlatform help:sendcommand
You will receive the following output.Please provide following parameters via command line or in action file:PServerName --- the server name that identifies the initiator MFT Platform ServerTransferID --- the id for the transfer record in the bank. If present, server will use the parameters from bank and ignore other parameters hereLoginUID --- longin user id to the initiator MFT Platform ServerLoginPWD --- longin password to the initiator MFT Platform ServerPortNum --- IP portRIPName --- Responder IP name, responder uses TCP protocol. Exclusive with RNodeNameRNodeName --- Responder node name, responder uses SNA protocol. Exclusive with RIPNameCommand --- The command running on the destination MFT Platform Server. Command format: RCMD|CJ|CP|SJ=actual command, RCMD - remote command, CJ - CALLJCL, CP - CALLPGM, SJ - SUBMIT JOB
ListTransferBankRecordsThe ListTransferBankRecords command action is used to retrieves all of the transfer records in thebank.
No parameters are supported for this command action.
Sample ListTransferBankRecords Command
This command retrieves all transfers from the MFTCC bank of the Platform transfers.java cfcc.CFPlatform a:ListTransferBankRecords
ReceiveFileThe ReceiveFile command action allows one TIBCO MFT Platform Server to receive a file fromanother TIBCO MFT Platform Server.
Parameter Description Default Required
CkPtInterval Specifies the checkpoint interval.
The Platform Server checkpoint uses a time intervalto determine when to send a checkpoint.
Because checkpoint is time-based, checkpointalways occurs at a regular interval. The checkpointinterval is specified in minutes, and the valid rangeis 1 to 90 minutes.
None No
113
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
CompressionFlag Specifies the compression algorithm.
TIBCO MFT Platform Server provides two differentcompression algorithms:
● Limpel-Zev (LZ)
● Run Length Encoding (RLE)
You can select the algorithm which best suits yournetwork.
The valid values are as follows:
● L: LZ
● N: none
● R: RLE
● U: undefined
None No
DataConversionT
ype
Specifies the type of data conversion to convert databetween ASCII and EBCDIC.
This parameter is used when communicating withsystems has defined data structures. This parameterwould not be necessary if you are communicatingfrom PC to z/OS.
If you are using TIBCO MFT Platform Server, whenyou change the combtlg.dat file, you have to stopand start the Platform Server service for the newconversion table to take effect.
The valid values are as follows:
● B: binary
● E: EBCDIC
● A: ASCII
None No
Delimiter Specifies the carriage return line feed control fortransferring files.
The valid values are as follows:
● C or CRLF: records are delimited by carriagereturn line feed.
● L or LF: records are delimited by line feed.
This is typically used when transmitting textdata to z/OS.
The line conversion is done on thez/OS platform.
● N: no record delimiters exist in the file.
This is typically done for a binary transfer.
None No
114
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
Department
(dpt)
Specifies the department associated with thePlatform transfer.
None No
Description (d) Specifies the 1 to 256 character descriptions of thisPlatform transfer bank file definition.
The entire description must be enclosed in doublequotation marks (“).
None No
EncryptionFlag Specifies the type of encryption to be used with thistransfer.
The valid values are as follows:
● 3D|3DES: 3DES encryption
● BF: blowfish
● BFL: blowfish long
● D|DES: DES encryption
● N: no encryption
● R|RJ|AES: Rijndael
● U: undefined
U No
ExpirationDays Specifies the number of days after which thetransfer should no longer be attempted.
If this transfer was scheduled, that will takeprecedence over expiration.
If expiration and retention are used, whichevervalue occurs first will take precedence.
The valid value range is 0 to 999999.
0 No
FileWriteMode Specifies the create option for the side writing thefile.
The valid values are as follows:
● A: append
● C: create
● CA: create/append
● CR: create/replace
● CRN: create/replace/new
● R: replace
C No
InitiatorFileNa
me
Specifies the name of the file on the platform that isinitiating the transfer.
On a send request, it is the file to be sent. On areceive request, it is where the file will be placed.
None Yes
115
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
LocalTransTable Specifies the location of the local translation tableused with this transfer.
If the path contains embedded spaces, the entirepath must be enclosed in double quotation marks(").
None No
LoginPWD Specifies the initiating user password.
The password might be up to 64 characters inlength and is case sensitive.
None No
LoginUID Specifies the initiator user ID used to log in toTIBCO MFT Platform Server defined by thePlatform Server pull-down box.
If this parameter is defined, MFTCC will use theuser ID and password when connecting to MFTPlatform Server. If this parameter is not defined,MFTCC will search for a server credential thatmatches the user ID and server definition.
None No
PermittedAction
s
Specifies the Windows-specific file attributes.
These attributes are only valid when sending files toa Windows machine.
The valid values are as follows:
● A: archive
● C: NTFS compress
● E: EOF
● H: hidden file
● R: read-only
● S: system file
● Z: control Z EOF
None No
PortNum Specifies the IP port on which the remote PlatformServer system should be listening on.
The valid value range is 1025 to 65535.
None No
116
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
PPA1 - PPA4 Specifies the post processing action.
The post processing action allows you to performup to four actions to be completed by the serverwhen a file transfer request has been completed.
The format of the command indicates whether apost processing action should be performed uponsuccess or failure.
The valid values are as follows:
● S|F: success or failure.
● L|R: local or remote.
● CALLPGM: calls a z/OS program with program toprogram parameter linkage.
This parameter allows the user to call a userprogram defined on the remote z/OS system.
● CALLJCL: calls a z/OS program with JCL toprogram parameter linkage.
This parameter allows the user to call a userprogram defined on the remote z/OS system.
● COMMAND: issues a command at the nodespecified in node name.
This is the command that you would like toexecute on the remote system.
● SUBMIT: submits a job at the node specified inthe NodeName parameter.
This parameter allows the user to submit a jobon the remote system. This differs from file tojob transfer requests because the JCL to runactually sits on the remote system.
● ActionData: specifies the data passed to thepost action type when the conditions specifiedhave been met.
None No
ProcessName Specifies the 8 character field to describe theapplication which is initiating the transfer.
None No
PServerName Specifies the server name that identifies theinitiating TIBCO MFT Platform Server.
None Yes
RemoteTransTabl
e
Specifies the location of the remote translation tableused with this transfer.
If the path contains embedded spaces, the entirepath must be enclosed in double quotation marks(").
None No
117
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
RemoveTrail
(rmtrail)
Specifies whether to remove trailing spaces fromthe file.
The valid values are as follows:
● Y
● N
N No
ResponderFileNa
me
Specifies the name of the file on the platform that isresponding to the transfer.
On a send request, it is where the file will be placed.On a receive request, it is the file that will betransferred.
None Yes
ResponderPWD Specifies the remote password.
The password might be up to 64 characters inlength and is case sensitive.
None No
ResponderUID Specifies the user ID that the initiator sends to theresponder to gain access to the system.
If this parameter is defined, the Platform Serverinitiator will use the user ID and password whenconnecting to the Platform Server responder. If thisparameter is not defined, the Platform Serverinitiator will search for a user profile that matchesthe user ID and responder node definition. If nouser profile is found, the Platform Server initiatorwill send a trusted user that the Platform Serverresponder can be configured to accept or reject.
None No
RIPName Specifies the responder IP or host name. None Yes
RNodeName Specifies the responder node name.
If the remote server is defined in MFTCC and youknow the server name being used for it, you candefine it here in place of defining the RIPNameparameter.
None Yes
Or theRIPName
parametercan beused.
SecurityAttribu
te
Specifies the file name that the receiving partneruses as a template for its access control list (ACL).
The ACL is a list that specifies users and groups,and their access permissions on a file.
The ACL of this file is copied to the ACL of thedestination file. For this feature to function properlyon Windows, the file specified must be readable bythe partner which is receiving the file to file transferand the file being created must reside on an NTFSdrive.
None No
118
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
SSLFlag Specifies whether to use secure sockets layer (SSL).
The valid values are as follows:
● Y
● N
None No
ToEmailAddrF Specifies the email address for failed transactions. None No
ToEmailAddrS Specifies the email address for successfultransactions.
None No
TransferDirecti
on
Specifies the transfer direction.
The valid values are as follows:
● S: sends file.
● R: receives file.
● C: sends command.
None Yes
TrScheduleDate Specifies the transfer schedule date.
The valid values are as follows:
● YYYY-MM-DD
● YYYY-MM-DD HH:MM
● YYYY/MM/DD HH:MM
None No
TryMaxCount Specifies the maximum number of transfer retriesallowed.
None No
UnixPermissions Specifies the UNIX permissions.
When a file is created on a UNIX system, TIBCOMFT Platform Server has the ability to set the UNIXpermissions on the file.
The UNIX permissions are defined by a three digitnumber, such as 777, which is the same as for thechmod command.
None No
UserData Specifies the user data, with any alpha, numeric, ornational characters.
This parameter can contain up to 25 characters thatwill be logged into the history files that containinformation that describe the transfer on the localand remote systems.
None No
119
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
WaitFlag Specifies whether to wait for completion.
This parameter will show the status of the transferafter execution.
The valid values are as follows:
● Y: waits for completion.
● N: does not wait.
None No
zOSAllocDir Specifies the number of directory blocks to allocate.
This parameter is only used when the initiator isz/OS.
None No
zOSAllocPri Specifies the primary allocation value in units ofzOSAllocType.
This parameter is only used for transferring files toa z/OS system.
The valid values are any numeric.
None No
zOSAllocSec Specifies the secondary allocation value in units ofOS390AllocType.
This parameter is only used for transferring files toa z/OS system.
The valid values are any numeric.
None No
zOSAllocType Specifies the allocation type to be used whentransferring files to a z/OS system.
The valid values are as follows:
● T: tracks
● B: tlocks
● C: cylinders
● K: kilobytes
● M: megabytes
None No
zOSBlockSize Specifies the block size to be used for file beingtransferred to a z/OS system.
The valid values are any numeric.
None No
zOSDataClass Specifies the valid data class used whentransferring files to a z/OS system.
The values are 1 to 8 character data class namesdefined by your storage administrator.
None No
120
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
zOSLRECL Specifies the logical record length for files beingtransferred to a z/OS system.
The valid values are any numeric.
None No
zOSMgtClass Specifies the valid management class used whentransferring files to a z/OS system.
The valid values are 1 to 8 character managementclass names defined by your storage administrator.
None No
zOSRECFM Specifies the record format to be used whentransferring to a z/OS system.
The valid values are as follows:
● F: fixed
● FB: fixed block
● V: variable
● VB: variable blocked
● U: undefined
None No
zOSStorClass Specifies the valid storage class used whentransferring files to a z/OS system.
The valid values are 1 to 8 character storage classnames defined by your storage administrator.
None No
zOSUnit Specifies the device type for a file being transferredto a z/OS system.
The valid values are any device types defined toyour z/OS system.
None No
zOSVolume Specifies the volume serial number for transferringfiles to a z/OS system.
The valid values are any 1 to 6 character volumeserial numbers on your z/OS system.
None No
Sample ReceiveFile Command
This command receives a file to one Platform Server remote platform from another.java cfcc.CFPlatform a:ReceiveFile PServerName:zOS6 LoginUID:cfuser1 LoginPWD:pswdu1
RNodeName:Win27 PortNum:46464 InitiatorFileName:cfuser1.file ResponderFileName:"c:
\cfcc files\zos\file.txt"
121
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
RemoveTransferFromBankThe RemoveTransferFromBank command action is used to remove a Platform Server transfer definitionfrom the MFTCC platform transfer bank.
Parameter Description Default Required
TransferId
(tid)
Specifies the Platform transfer ID for the filedefinition you want to delete.
None Yes
Sample RemoveTransferFromBank Command
This command removes the T21610000001 transfer definition from the MFTCC platform transfer bank.
java cfcc.CFPlatform a:RemoveTransferFromBank TransferID:T21610000001
SendCommandThe SendCommand command action will send a command from one TIBCO MFT Platform Server toanother TIBCO MFT Platform Server.
Parameter Description Default Required
CkPtInterval Specifies the checkpoint interval.
The Platform Server checkpoint uses a time intervalto determine when to send a checkpoint.
Because checkpoint is time-based, checkpointalways occurs at a regular interval. The checkpointinterval is specified in minutes, and the valid rangeis 1 to 90 minutes.
None No
CompressionFlag Specifies the compression algorithm.
TIBCO MFT Platform Server provides two differentcompression algorithms:
● Limpel-Zev (LZ)
● Run Length Encoding (RLE)
The users can select the algorithm which best suitstheir network.
The valid values are as follows:
● L: LZ
● N: none
● R: RLE
● U: undefined
None No
122
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
DataConversionT
ype
Specifies the type of data conversion used toconvert data between ASCII and EBCDIC.
This parameter is used when the communicatingwith systems has defined data structures. Thisparameter is not necessary if you arecommunicating from PC to z/OS.
If you are using TIBCO MFT Platform Server, whenyou change the combtlg.dat file, you have to stopand start the Platform Server service for the newconversion table to take effect.
The valid values are as follows:
● B: binary
● E: EBCDIC
● A: ASCII
None No
Delimiter Specifies the carriage return line feed control fortransferring files.
The valid values are as follows:
● C or CRLF: records are delimited by carriagereturn line feed.
● L or LF: records are delimited by line feed.
This is typically used when transmitting textdata to z/OS.
The line conversion is done on thez/OS platform.
● N: no record delimiters exist in the file.
This is typically done for a binary transfer.
None No
Department
(dpt)
Specifies the department associated with thePlatform transfer.
None No
Description (d) Specifies the 1 to 256 character description of thisPlatform transfer bank file definition.
The entire description must be enclosed in doublequotation marks (“).
None No
123
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
EncryptionFlag Specifies the type of encryption to be used with thistransfer.
The valid values are as follows:
● 3D|3DES: 3DES encryption
● BF: blowfish
● BFL: blowfish long
● D|DES: DES encryption
● N: no encryption
● R|RJ|AES: Rijndael
● U: undefined
U No
ExpirationDays Specifies the number of days after which thetransfer should no longer be attempted.
If this transfer is scheduled, that takes precedenceover expiration.
If expiration and retention are used, whichevervalue occurs first will take precedence.
The valid value range is 0 to 999999.
0 No
FileWriteMode Specifies the create option for the side writing thefile.
The valid values are as follows:
● A: append
● C: create
● CA: create or append
● CR: create or replace
● CRN: create, replace, or new
● R: replace
C No
InitiatorFileNa
me
Specifies the name of the file on the platform that isinitiating the transfer.
On a send request, it is the file to be sent. On areceive request, it is where the file will be placed.
None Yes
LocalTransTable Specifies the location of the local translation tableused with this transfer.
If the path contains embedded spaces, the entirepath must be enclosed in double quotation marks(").
None No
124
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
LoginPWD Specifies the initiating user password.
The password can be up to 64 characters in lengthand is case sensitive.
None No
LoginUID Specifies the Initiator user ID used to login toTIBCO MFT Platform Server defined by thePlatform Server pull-down box.
If this parameter is defined, MFTCC will use theuser ID and password when connecting to TIBCOMFT Platform Server. If this parameter is notdefined, MFTCC will search for a server credentialthat matches the user ID and server definition.
None No
PermittedAction
s
Specifies the Windows-specific file attributes.
These attributes are only valid when sending filesto a Windows machine.
The valid values are as follows:
● A: archive
● C: NTFS compress
● E: EOF
● H: hidden file
● R: read-only
● S: system file
● Z: control Z EOF
None No
PortNum Specifies the IP port on which the remote PlatformServer system listens on.
The valid value range is 1025 to 65535.
None No
125
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
PPA1 - PPA4 Specifies the post processing action.
The post processing action allows you to performup to four actions to be completed by the serverwhen a file transfer request is completed.
The format of the command indicates whether apost processing action should be performed uponsuccess or failure.
The valid values are as follows:
● S|F: success or failure.
● L|R: local or remote.
● CALLPGM: calls a z/OS program with program toprogram parameter linkage.
This parameter allows the user to call a userprogram defined on the remote z/OS system.
● CALLJCL: calls a z/OS program with JCL toprogram parameter linkage.
This parameter allows the user to call a userprogram defined on the remote z/OS system.
● COMMAND: issues a command at the nodespecified in the NodeName parameter.
This is the command that you want to executeon the remote system.
● SUBMIT: submits a job at the node specified inthe NodeName parameter.
This parameter allows the user to submit a jobon the remote system. This differs from file tojob transfer requests because the JCL to runactually sits on the remote system.
● ActionData: specifies the data passed to thepost action type when the conditions specifiedare met.
None No
ProcessName Specifies the 8 character field to describe theapplication which is initiating the transfer.
None No
PServerName Specifies the server name that identifies theinitiating TIBCO MFT Platform Server.
None Yes
RemoteTransTabl
e
Specifies the location of the remote translation tableused with this transfer.
If the path contains embedded spaces, the entirepath must be enclosed in double quotation marks(").
None No
126
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
RemoveTrail
(rmtrail)
Specifies whether to remove trailing spaces fromthe file.
The valid values are as follows:
● Y
● N
N No
ResponderFileNa
me
Specifies the name of the file on the platform that isresponding to the transfer.
On a send request, it is where the file is placed. Ona receive request, it is the file that to be transferred.
None Yes
ResponderPWD Specifies the remote password.
The password might be up to 64 characters inlength and is case sensitive.
None No
ResponderUID Specifies the user ID that the initiator sends to theresponder to gain access to the system.
If this parameter is defined, the Platform Serverinitiator uses the user ID and password whenconnecting to the Platform Server responder. If thisparameter is not defined, the Platform Serverinitiator searches for a user profile that matches theuser ID and responder node definition. If no userprofile is found, the Platform Server initiator sendsa trusted user that the Platform Server respondercan be configured to accept or reject.
None No
RIPName Specifies the responder IP or host name. None Yes
RNodeName Specifies the remote node name.
You can define this parameter in place of definingthe RIPName parameter if the remote server isdefined in MFTCC and you know the server namebeing used for it.
None Yes
Or theRIPName
parametercan beused.
SecurityAttribu
te
Specifies the file name that the receiving partneruses as a template for its access control list (ACL).
The ACL is a list that specifies users and groups,and their access permissions on a file.
The ACL of this file is copied to the ACL of thedestination file. For this feature to function properlyon Windows, the file specified must be readable bythe partner which is receiving the file to file transferand the file being created must reside on an NTFSdrive.
None No
127
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
SSLFlag Specifies whether to use secure sockets layer (SSL).
The valid values are as follows:
● Y
● N
None No
ToEmailAddrF Specifies the email address for failed transactions. None No
ToEmailAddrS Specifies the email address for successfultransactions.
None No
TransferDirecti
on
Specifies the transfer direction.
The valid values are as follows:
● S: sends a file.
● R: receives a file.
● C: sends a command.
None Yes
TrScheduleDate Specifies the transfer schedule date.
The valid values are as follows:
● YYYY-MM-DD
● YYYY-MM-DD HH:MM
● YYYY/MM/DD HH:MM
None No
TryMaxCount Specifies the maximum number of transfer retriesallowed.
None No
UnixPermissions Specifies the UNIX permissions.
When a file is created on a UNIX system, TIBCOMFT Platform Server has the ability to set the UNIXpermissions on the file.
The UNIX permissions are defined by a three digitnumber, such as 777, which is the same as for thechmod command.
None No
Sample SendCommand Command
This command sends a command from one Platform Server remote platform to be executed on another.java cfcc.CFPlatform a:SendCommand PServerName:Win17 LoginUID:user2
RNodeName:unix201 PortNum:46464 Command:RCMD=ls
128
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
SendFileThe SendFile command executes a transfer based on a transfer record in the bank.
Parameter Description Default Required
CkPtInterval Specifies the checkpoint interval.
The Platform Server checkpoint uses a time intervalto determine when to send a checkpoint.
Because checkpoint is time-based, checkpointalways occurs at a regular interval. The checkpointinterval is specified in minutes, and the valid rangeis 1 to 90 minutes.
None No
CompressionFlag Specifies the compression algorithm.
TIBCO MFT Platform Server provides two differentcompression algorithms:
● Limpel-Zev (LZ)
● Run Length Encoding (RLE)
You can select the algorithm which best suits yournetwork.
The valid values are as follows:
● L: LZ
● N: none
● R: RLE
● U: undefined
None No
DataConversionT
ype
Specifies the type of data conversion used toconvert data between ASCII and EBCDIC.
The valid values are as follows:
● B: binary
● E: EBCDIC
None No
129
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
Delimiter Specifies the carriage return line feed control fortransferring files.
The valid values are as follows:
● C or CRLF: records are delimited by carriagereturn line feed.
● L or LF: records are delimited by line feed.
This is typically used when transmitting textdata to z/OS.
The line conversion is done on thez/OS platform.
● N: no record delimiters exist in the file.
This is typically done for a binary transfer.
None No
Department
(dpt)
Specifies the department associated with thePlatform transfer.
None No
Description (d) Specifies the 1 to 256 character descriptions of thisPlatform transfer bank file definition.
The entire description must be enclosed in doublequotation marks (“).
None No
EncryptionFlag Specifies the type of encryption to be used with thistransfer.
The valid values are as follows:
● 3D|3DES: 3DES encryption
● BF: blowfish
● BFL: blowfish long
● D|DES: DES encryption
● N: no encryption
● R|RJ|AES: Rijndael
● U: undefined
U No
ExpirationDays Specifies the number of days after which thetransfer should no longer be attempted.
If this transfer is scheduled, that takes precedenceover expiration.
If expiration and retention are used, whichevervalue occurs first takes precedence.
The valid value range is 0 to 999999.
0 No
130
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
FileWriteMode Specifies the create option for the side writing thefile.
The valid values are as follows:
● A: append
● C: create
● CA: create or append
● CR: create or replace
● CRN: create, replace or new
● R: replace
C No
InitiatorFileNa
me
Specifies the name of the file on the platform that isinitiating the transfer.
On a send request, it is the file to be sent. On areceive request, it is where the file is placed.
None Yes
LocalTransTable Specifies the location of the local translation tableused with this transfer.
If the path contains embedded spaces, the entirepath must be enclosed in double quotation marks(").
None No
LoginPWD Specifies the initiating user password.
The password might be up to 64 characters inlength and is case sensitive.
None No
LoginUID Specifies the Initiator user ID used to log intoTIBCO MFT Platform Server defined by thePlatform Server pull-down box.
If this parameter is defined, MFTCC uses the userID and password when connecting to TIBCO MFTPlatform Server. If this parameter is not defined,MFTCC searches for a server credential thatmatches the user ID and server definition.
None No
131
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
PermittedAction
s
Specifies the Windows-specific file attributes.
These attributes are only valid when sending file toa Windows machine.
The valid values are as follows:
● A: archive
● C: NTFS compress
● E: EOF
● H: hidden file
● R: read-only
● S: system file
● Z: control Z EOF
None No
PortNum Specifies the IP port on which the remote PlatformServer system should be listening on.
The valid value range is 1025 to 65535.
None No
132
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
PPA1 - PPA4 Specifies the post processing action.
The post processing action allows you to performup to four actions to be completed by the serverwhen a file transfer request is completed.
The format of the command indicates whether apost processing action should be performed uponsuccess or failure.
The valid values are as follows:
● S|F: success or failure.
● L|R: local or remote.
● CALLPGM: calls a z/OS program with program toprogram parameter linkage.
This parameter allows the user to call a userprogram defined on the remote z/OS system.
● CALLJCL: calls a z/OS program with JCL toprogram parameter linkage.
This parameter allows the user to call a userprogram defined on the remote z/OS system.
● COMMAND: issues a command at the nodespecified in the NodeName parameter.
This is the command that you want to executeon the remote system.
● SUBMIT: submits a job at the node specified inthe NodeName parameter.
This parameter allows the user to submit a jobon the remote system. This differs from file tojob transfer request because the JCL to runactually sits on the remote system.
● ActionData: specifies the data passed to thepost action type when the conditions specifiedare met.
None No
ProcessName Specifies the 8 character field to describe theapplication which is initiating the transfer.
None No
PServerName Specifies the server name that identifies theinitiating TIBCO MFT Platform Server.
None Yes
RemoteTransTabl
e
Specifies the location of the remote translation tableused with this transfer.
If the path contains embedded spaces, the entirepath must be enclosed in double quotation marks(").
None No
133
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
RemoveTrail
(rmtrail)
Specifies whether to remove trailing spaces fromthe file.
The valid values are as follows:
● Y
● N
N No
ResponderFileNa
me
Specifies the name of the file on the platform that isresponding to the transfer.
On a send request, it is where the file is placed. Ona receive request, it is the file to be transferred.
None Yes
ResponderPWD Specifies the remote password.
The password might be up to 64 characters inlength and is case sensitive.
None No
ResponderUID Specifies the user ID that the initiator sends to theresponder to gain access to the system.
If this parameter is defined, the Platform Serverinitiator uses the user ID and password whenconnecting to the Platform Server responder. If thisparameter is not defined, the Platform Serverinitiator searches for a user profile that matches theuser ID and responder node definition. If no userprofile is found, the Platform Server initiator sendsa trusted user that the Platform Server respondercan be configured to accept or reject.
None No
RIPName Specifies the responder IP or host name. None Yes
RNodeName Specifies the remote node name.
You can define this parameter in place of definingthe RIPName parameter if the remote server isdefined in MFTCC and you know the server namebeing used for it.
None Yes
Or theRIPName
parametercan beused.
SecurityAttribu
te
Specifies the file name that the receiving partneruses as a template for its access control list (ACL).
The ACL is a list that specifies users and groups,and their access permissions on a file.
The ACL of this file is copied to the ACL of thedestination file. For this feature to function properlyon Windows, the file specified must be readable bythe partner which is receiving the file to file transferand the file being created must reside on an NTFSdrive.
None No
134
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
SSLFlag Specifies whether to use secure sockets layer (SSL).
The valid values are as follows:
● Y
● N
None No
ToEmailAddrF Specifies the email address for failed transactions. None No
ToEmailAddrS Specifies the email address for successfultransactions.
None No
TransferDirecti
on
Specifies the transfer direction.
The valid values are as follows:
● S: sends a file.
● R: receives a file.
● C: sends a command.
None Yes
TrScheduleDate Specifies the transfer schedule date.
The valid values are as follows:
● YYYY-MM-DD
● YYYY-MM-DD HH:MM
● YYYY/MM/DD HH:MM
None No
TryMaxCount Specifies the maximum number of transfer retriesallowed.
None No
UnixPermissions Specifies the UNIX permissions.
When a file is created on a UNIX system, TIBCOMFT Platform Server has the ability to set the UNIXpermissions on the file.
The UNIX permissions are defined by a three digitnumber, such as 777, which is the same as for thechmod command.
None No
UserData Specifies the user data, with any alpha, numeric, ornational characters.
This parameter can be up to 25 characters that willbe logged into the history files that containinformation that describe the transfer on the localand remote systems.
None No
135
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
WaitFlag Specifies whether to wait for completion.
This parameter shows the status of the transfer afterexecution.
The valid values are as follows:
● Y: waits for completion.
● N: does not wait.
None No
zOSAllocDir Specifies the number of directory blocks to allocate.
This parameter is only used when the initiator isz/OS.
None No
zOSAllocPri Specifies the primary allocation value in the unitdefined by the zOSAllocType parameter.
This parameter is only used for transferring files toa z/OS system.
The valid values are any numeric.
None No
zOSAllocSec Specifies the secondary allocation value in the unitdefined by the zOSAllocType parameter.
This parameter is only used for transferring files toa z/OS system.
The valid values are any numeric.
None No
zOSAllocType Specifies the allocation type to be used whentransferring files to a z/OS system.
The valid values are as follows:
● T: tracks
● B: tlocks
● C: cylinders
● K: kilobytes
● M: megabytes
None No
zOSBlockSize Specifies the block size to be used for file beingtransferred to a z/OS system.
The valid values are any numeric.
None No
zOSDataClass Specifies the valid data class used whentransferring files to a z/OS system.
The values are 1 to 8 character data class namesdefined by your storage administrator.
None No
136
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
zOSLRECL Specifies the logical record length for files beingtransferred to a z/OS system.
The valid values are any numeric.
None No
zOSMgtClass Specifies the valid management class used whentransferring files to a z/OS system.
The valid values are 1 to 8 character managementclass names defined by your storage administrator.
None No
zOSRECFM Specifies the record format to be used whentransferring to a z/OS system.
The valid values are as follows:
● F: fixed
● FB: fixed block
● V: variable
● VB: variable blocked
● U: undefined
None No
zOSStorClass Specifies the valid storage class used whentransferring files to a z/OS system.
The valid values are 1 to 8 character storage classnames defined by your storage administrator.
None No
Sample SendFile Command
This command sends a file from one Platform Server remote platform to another.java cfcc.CFPlatform a:SendFile PServerName:zOS6 LoginUID:cfuser1 LoginPWD:pswdu1
RNodeName:Win27 PortNum:46464 InitiatorFileName:cfuser1.file ResponderFileName:"c:
\cfcc files\zos\file.txt"
UpdateTransferFromBankThe UpdateTransferFromBank command action is used to update an MFT Platform Server transferdefinition in the MFTCC platform transfer bank.
Parameter Description Default Required
CkPtInterval Specifies the checkpoint interval.
The Platform Server checkpoint uses a time intervalto determine when to send a checkpoint.
Because checkpoint is time-based, checkpointalways occurs at a regular interval. The checkpointinterval is specified in minutes, and the valid rangeis 1 to 90 minutes.
None No
137
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
CompressionFlag Specifies the compression algorithm.
TIBCO MFT Platform Server provides two differentcompression algorithms:
● Limpel-Zev (LZ)
● Run Length Encoding (RLE)
You can select the algorithm which best suits yournetwork.
The valid values are as follows:
● L: LZ
● N: none
● R: RLE
● U: undefined
None No
DataConversionT
ype
Specifies the type of data conversion used toconvert data between ASCII and EBCDIC.
This parameter is used when the communicatingwith systems has defined data structures. Thisparameter is not necessary if you arecommunicating from PC to z/OS.
If you are using TIBCO MFT Platform Server, whenyou change the combtlg.dat file, you have to stopand start the Platform Server service for the newconversion table to take effect.
The valid values are as follows:
● B: binary
● E: EBCDIC
● A: ASCII
None No
Delimiter Specifies the carriage return line feed control fortransferring files.
The valid values are as follows:
● C or CRLF: records are delimited by carriagereturn line feed.
● L or LF: records are delimited by line feed.
This is typically used when transmitting textdata to z/OS.
The line conversion is done on thez/OS platform.
● N: no record delimiters exist in the file.
This is typically done for a binary transfer.
None No
138
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
Department
(dpt)
Specifies the department associated with thePlatform transfer.
None No
Description (d) Specifies the 1 to 256 character descriptions of thisPlatform transfer bank file definition.
The entire description must be enclosed in doublequotation marks (“).
None No
EncryptionFlag Specifies the type of encryption to be used with thistransfer.
The valid values are as follows:
● 3D|3DES: 3DES encryption
● BF: blowfish
● BFL: blowfish long
● D|DES: DES encryption
● N: no encryption
● R|RJ|AES: Rijndael
● U: undefined
U No
ExpirationDays Specifies the number of days after which thetransfer should no longer be attempted.
If this transfer is scheduled, that takes precedenceover expiration.
If expiration and retention are used, whichevervalue occurs first takes precedence.
The valid value range is 0 to 999999.
0 No
FileWriteMode Specifies the create option for the side writing thefile.
The valid values are as follows:
● A: append
● C: create
● CA: create or append
● CR: create or replace
● CRN: create, replace, or new
● R: replace
C No
InitiatorFileNa
me
Specifies the name of the file on the platform that isinitiating the transfer.
On a send request, it is the file to be sent. On areceive request, it is where the file is placed.
None Yes
139
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
LocalTransTable Specifies the location of the local translation tableused with this transfer.
If the path contains embedded spaces, the entirepath must be enclosed in double quotation marks(").
None No
LoginPWD Specifies the initiating user password.
The password might be up to 64 characters inlength and is case sensitive.
None No
LoginUID Specifies the Initiator user ID used to log into theMFT Platform Server defined by the PlatformServer pull-down box.
If this parameter is defined, MFTCC uses the userID and password when connecting to TIBCO MFTPlatform Server. If this parameter is not defined,MFTCC searches for a server credential thatmatches the user ID and server definition.
None No
PermittedAction
s
Specifies the Windows-specific file attributes.
These attributes are only valid when sending to aWindows machine.
The valid values are as follows:
● A: archive
● C: NTFS compress
● E: EOF
● H: hidden file
● R: read-only
● S: system file
● Z: control Z EOF
None No
PortNum Specifies the IP port on which the remote PlatformServer system should be listening on.
The valid value range is 1025 to 65535.
None No
140
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
PPA1 - PPA4 Specifies the post processing action.
The post processing action allows you to performup to four actions to be completed by the serverwhen a file transfer request has completed.
The format of the command indicates whether apost processing action should be performed uponsuccess or failure.
The valid values are as follows:
● S|F: success or failure.
● L|R: local or remote.
● CALLPGM: calls a z/OS program with program toprogram parameter linkage.
This parameter allows the user to call a userprogram defined on the remote z/OS system.
● CALLJCL: calls a z/OS program with JCL toprogram parameter linkage.
This parameter allows the user to call a userprogram defined on the remote z/OS system.
● COMMAND: issues a command at the nodespecified in the NodeName parameter.
This is the command that you want to executeon the remote system.
● SUBMIT: submits a job at the node specified inthe NodeName parameter.
This parameter allows the user to submit a jobon the remote system. This differs from file tojob transfer requests because the JCL to runactually sits on the remote system.
● ActionData: specifies the data passed to thepost action type when the conditions specifiedare met.
None No
ProcessName Specifies the 8 character field to describe theapplication which is initiating the transfer.
None No
PServerName Specifies the server name that identifies theinitiating TIBCO MFT Platform Server.
None Yes
RemoteTransTabl
e
Specifies the location of the remote translation tableused with this transfer.
If the path contains embedded spaces, the entirepath must be enclosed in double quotation marks(").
None No
141
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
RemoveTrail
(rmtrail)
Specifies whether to remove trailing spaces fromthe file.
The valid values are as follows:
● Y
● N
N No
ResponderFileNa
me
Specifies the name of the file on the platform that isresponding to the transfer.
On a send request, it is where the file is placed. Ona receive request, it is the file to be transferred.
None Yes
ResponderPWD Specifies the remote password.
The password might be up to 64 characters inlength and is case sensitive.
None No
ResponderUID Specifies the user ID that the initiator sends to theresponder to gain access to the system.
If this parameter is defined, the Platform Serverinitiator uses the user ID and password whenconnecting to the Platform Server responder. If thisparameter is not defined, the Platform Serverinitiator searches for a user profile that matches theuser ID and responder node definition. If no userprofile is found, the Platform Server initiator sendsa trusted user that the Platform Server respondercan be configured to accept or reject.
None No
RIPName Specifies the responder IP or host name. None Yes
RNodeName Specifies the remote node name.
You can define this parameter in place of definingthe RIPName parameter if the remote server isdefined in MFTCC and you know the server namebeing used for it.
None Yes
Or theRIPName
parametercan beused.
SecurityAttribu
te
Specifies the file name that the receiving partneruses as a template for its access control list (ACL).
The ACL is a list that specifies users and groups,and their access permissions on a file.
The ACL of this file is copied to the ACL of thedestination file. For this feature to function properlyon Windows, the file specified must be readable bythe partner which is receiving the file to file transferand the file being created must reside on an NTFSdrive.
None No
142
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
SSLFlag Specifies whether to use secure sockets layer (SSL).
The valid values are as follows:
● Y
● N
None No
ToEmailAddrF Specifies the email address for failed transactions. None No
ToEmailAddrS Specifies the email address for successfultransactions.
None No
TransferDirecti
on
Specifies the transfer direction.
The valid values are as follows:
● S: sends a file.
● R: receives a file.
● C: sends a command.
None Yes
TrScheduleDate Specifies the transfer schedule date.
The valid values are as follows:
● YYYY-MM-DD
● YYYY-MM-DD HH:MM
● YYYY/MM/DD HH:MM
None No
TryMaxCount Specifies the maximum number of transfer retriesallowed.
None No
UnixPermissions Specifies the UNIX permissions.
When a file is created on a UNIX system, TIBCOMFT Platform Server has the ability to set the UNIXpermissions on the file.
The UNIX permissions are defined by a three digitnumber, such as 777, which is the same as for thechmod command.
None No
UserData Specifies the user data, with any alpha, numeric, ornational characters.
This parameter can be up to 25 characters that willbe logged into the history files that containinformation that describe the transfer on the localand remote system.
None No
143
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
WaitFlag Specifies whether to wait for completion.
This parameter shows the status of the transfer afterexecution.
The valid values are as follows:
● Y: waits for completion.
● N: does not wait.
None No
zOSAllocDir Specifies the number of directory blocks to allocate.
This parameter is only used when the initiator isz/OS.
None No
zOSAllocPri Specifies the primary allocation value in the unitspecified by the zOSAllocType parameter.
This parameter is only used for transferring files toa z/OS system.
The valid values are any numeric.
None No
zOSAllocSec Specifies the secondary allocation value in the unitspecified by the zOSAllocType parameter.
This parameter is only used for transferring files toa z/OS system.
The valid values are any numeric.
None No
zOSAllocType Specifies the allocation type to be used whentransferring files to a z/OS system.
The valid values are as follows:
● T: tracks
● B: tlocks
● C: cylinders
● K: kilobytes
● M: megabytes
None No
zOSBlockSize Specifies the block size to be used for file beingtransferred to a z/OS system.
The valid values are any numeric.
None No
zOSDataClass Specifies the valid data class used whentransferring files to a z/OS system.
The values are 1 to 8 character data class namesdefined by your storage administrator.
None No
144
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Parameter Description Default Required
zOSLRECL Specifies the logical record length for files beingtransferred to a z/OS system.
The valid values are any numeric.
None No
zOSMgtClass Specifies the valid management class used whentransferring files to a z/OS system.
The valid values are 1 to 8 character managementclass names defined by your storage administrator.
None No
zOSRECFM Specifies the record format to be used whentransferring files to a z/OS system.
The valid values are as follows:
● F: fixed
● FB: fixed block
● V: variable
● VB: variable blocked
● U: undefined
None No
zOSStorClass Specifies the valid storage class used whentransferring files to a z/OS system.
The valid values are 1 to 8 character storage classnames defined by your storage administrator.
None No
zOSUnit Specifies the device type for a file being transferredto a z/OS system.
The valid values are any device types defined toyour z/OS system.
None No
zOSVolume Specifies the volume serial number for transferringfiles to a z/OS system.
The valid values are any 1 to 6 character volumeserial numbers on your z/OS system.
None No
Sample UpdateTransferFromBank Command
This command updates the T50700000001 transfer definition in the MFTCC platform transfer bank.
java cfcc.CFPlatform a:UpdateTransferFromBank TransferID:T50700000001
InitiatorFileName:PROD.ACCT.DATA
Action FileThe action file is an XML file specified by the T parameter on the command line. By using an action file,you can put multiple actions in one file specified using XML format.
The format of the action file is as follows:<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE actions SYSTEM "siftactions.dtd"><actions>
145
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
<action name="action1" output=”action2:file1”> <arg name="arg1" value="somevalue" sc="a1"/> …… </action> ……</actions>
The <action> element defines an action. The <arg> element defines a parameter needed for this action. Ifmultiple <action> elements are defined in the file, the program will execute them one by one.
The name attribute for the <action> element specifies the action name. This must be a valid action. TheXML file names are all valid actions.
The name attribute for the <arg> element specifies the parameter name for an action. The name is casesensitive and should not be edited. The sc attribute for the <arg> element specifies a shortcut name forthe name attribute, and it is case insensitive. You can use shortcut names to specify values in commandline to replace default values specified in this file. If the action is specified by the A parameter incommand line, you must specify parameter name for that action rather than a shortcut name. Shortcutnames can be found in each XML file.
For actions that retrieve information from a web service, you can specify an output file in the outputattribute for the <action> element. The program will save the retrieved information into the file (inaction file format), which can be used as an action file.
Sample Action File
If you want to add user B into the database, and user A whose information can be used for user Balready exists in the database, you can do the following operations:
1. Build an action file userA.xml to retrieve the information of user A, and save the information intoan addUser command action in the file userB.xml.
The syntax of the userA.xml file will be as follows:<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE actions SYSTEM "siftactions.dtd"><actions> <action name=”getUser” output=”addUser:userB.xml”> <arg name=”UserId” value=”userA” sc=”UID”/> </action></actions>
The value for the output attribute is ActionName:FileName, or ActionName>FileName. Because thegenerated file is in action file format, both the action name and file name are needed. Use a colon (:)to generate a new output file, or use the greater than symbol (>) to append to an existing file.
2. Run the program to get the information of user A, and generate an action file userB.xml.
java –classpath %cp% cfcc.CFAdmin U:userA P:pwdA T:userA.xml
3. Run the program again with the generated action file to add user B.
java –classpath %cp% cfcc.CFAdmin U:userB P:pwdB T:userB.xml UID:userB
4. Use UID:userB to overwrite the UserId parameter from the action file, in which the value is userA.
Currently, the GetTransferFromBank action supports writing output into an xml file. The sample xmlfile included in the product creates the sfTmpl.xml file.
Shortcuts Usage in the Action FileThe advantage of using action file template is that you can use shortcuts to define the parameter names.
An example of command line using shortcuts is as follows:
java cfcc.CFInternet U:xyz P:xyz KN:certificate KP:pswd a:ListAllFiles TKN:cacerts
TKP:changeit
146
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
If the Global.xml file has been updated to contain the user ID, password, and keystore information,then you can simply execute following command line.
java cfcc.CFInternet a:ListAllFiles
For client certificate authentication, the client must specify the keystore for its certificate via the Javasystem parameter, or via the KN and KP parameters of command line. To run the program over an SSLconnection, the certificate authority (CA) that signed the certificate of the client must be a trusted CA.This might require you to update your keystore.
The batch file used to setup classpath overwrites the default system classpath. Experienced users areencouraged to use other environment variable for classpath, and specify classpath in the Javacommand.
Name Description
U The user ID sent to the web service for authentication to use the web service.This parameter might be specified in the Global.xml file.
P The user password sent to the web service for authentication to use the webservice. This parameter might be specified in the Global.xml file.
A The action to take. For example, add file. If the parameter is specified, theprogram will ignore the T parameter that specifies the action file name. Theprogram only accepts one action from command line.
T The action template file name. The file can contain multiple actions in XMLformat. The program will execute all actions specified in the file. If theprogram specified the A parameter, this parameter will be ignored.
TL The trace level. This value only affects this utility. This parameter shouldonly be set when instructed to do so by TIBCO technical support. The validvalue range is 0 to 10.
TD The trace directory. This value only affects this utility. Sets the directorywhere the trace file(s) will be written.
G The global template file name. The default one is Global.xml in the currentdirectory.
S The web service address. For example, https://DNS_HostName:httpsPort/cfcc/…..
KN The Java keystore name for client certificate authentication. The keystorename can be specified as a Java parameter, in which case, it is not necessaryto use this parameter again. This parameter might be specified in theGlobal.xml file.
KP The Java keystore password for client certificate authentication. Thekeystore password can be specified as a Java parameter, in which case, it isnot necessary to use this parameter again. This parameter might be specifiedin the Global.xml file.
147
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Name Description
TKN The trusted Java keystore name for certificate authentication. This fileshould contain the name of the keystore file that contains the Java trustedcertificate authorities. You can leave this parameter blank if you want to usethe default trusted keystore. This parameter might be specified in theGlobal.xml file.
TKP The trusted Java keystore password for client certificate authentication. Ifthe default password is used, you can leave this parameter blank. Thisparameter might be specified in the Global.xml file.
AD The audit file directory. This parameter defined the directory where theaudit file will be written. This should point to an existing directory andshould not include a file name. MFTCC will create the file name in theformat: MFT Command Center Audit_YYYYMMDD.xml.
help The program will display the command line parameter list.
help:action The program will display the parameters needed for the action if the actionis a valid action; otherwise, the program will display all currently supportedactions.
[name:value] Other name:value pairs. These values will be used to assign the values ofparameters if the action is specified by the A parameter, or to replace thedefault values if the T parameter is used. The name is case sensitive if nameis a parameter name for an action. The name is not case sensitive if name is ashortcut for a real parameter name.
In the following example, four entries are defined in the addFile.xml file.<arg name="ClientFileName" value="clientFileName" sc="CFN" description="Client File Name"/><arg name="ServerFileName" value="serverFileName" sc="SFN" description="Server File Name"/><arg name="Description" value="fileDesc" sc="D" description="File Description"/><arg name="UserId" value="user id" sc="UID" description="UserID authorized to transfer this file"/>
The parameter that starts with the value sc= is the shortcut name that has been defined by the XML file.When executing Platform Transfer Client Utility with the action file parameter (T:) defined, you can usethe shortcut name instead of the actual parameter name. For example in the above example, whendefining the client file name, you can use the CFN parameter instead of the ClientFileName parameter.
Sample Shortcuts Usage
The following examples show how to use standard parameters and shortcuts in the MFTCCcommands:
Using standard parameter names:
java cfcc.CFAdmin a:addFile ClientFileName:client.file1
ServerFileName:prod.file.name Description:”file upload” Userid:acctuser
Using shortcut parameter names:
java cfcc.CFAdmin t:addFile.xml CFN:client.file1 SFN:prod.file.name D:”file upload”
uid:acctuser
148
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
As you can see, the parameter names are much shorter when using the shortcut parameters. Theshortcut parameter names can only be used when the action file template (T:) parameter is used in theCFAdmin command. The shortcut values must be defined by the sc= value in the template.
XML FilesThe genExample command is used to automatically create XML files.
To create all the sample XML files, run the following commands:
java cfcc.CFAdmin genExample
This will create various XML files that can be used in conjunction with the command line. Thefollowing table lists the names of the files that are created along with a brief description of what theXML file does.
Bank XML files
ExecuteFromBank.xml Performs a Platform transfer from a list ofdefined transfers.
GetTransfersFromBank.xml Lists a Platform transfer from the group ofdefined transfer.
ListTransferBankRecords.xml Retrieves all Platform transfer records in thebank.
Receive XML files
ReceiveFile.xml Receives a file from another MFT PlatformServer system.
Send XML files
SendCommand.xml Sends a command to another MFT PlatformServer system.
SendFile.xml Sends a file from another MFT Platform Serversystem.
Miscellaneous XML files
GetCopyrightInfo.xml Displays copyright Information.
GetProductNameVersion.xml Gets the MFTCC version information.
149
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
Command Line Manual Configuration
This appendix describes how to manually configure the Global.xml file for both Admin Client Utilityand Platform Transfer Client Utility, as well as how to create the keystore in order for the command lineutility to function properly on any Windows or UNIX machine.
These instructions are given as an alternative to running the configuration program described in theCommand Line Utilities.
● Administrator Global Settings● File Transfer Global Settings● Java Keystores Settings● Environment Settings
Administrator Global SettingsAdmin Client Utility can utilize the Global.xml file to hold parameters that are required for allcommands.
By setting these values in the global, it eliminates the need to specify them each time you run the utility.The following command line parameters can be configured in the Global.xml file:
● Service: the URL of the Admin Client Utility service.● U: the user ID under which the utility changes are performed.● P: the password for the user ID.● KN: the Java keystore name.● KP: the Java keystore password.● TKN: the trusted Java keystore name.● TKP: the trusted Java keystore password.
You can configure the administrator global settings in the following steps:
1. To edit the Global.xml file, you can use the following editors:
● For Windows: Notepad● For UNIX: vi
2. To add the service address, locate the following lines in the Global.xml file.<!-- default service address --><msg name="service" value=""/>
3. Modify the value attribute to specify the location of your service.
For example:<!-- default service address --><msg name="service" value="https://MFT Command Center.MYCOMPANY.COM:8443/cfcc/control?view=services/AdministratorService"/>
Make sure that the service address is added between the double quotation marks (“).
4. Repeat these changes for the user ID, password, keystore name, keystore password, trustedkeystore, and trusted keystore password.
For example:<!-- default user id --><msg name="userid" value="USERID"/>
150
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
<!-- default user pwd --><msg name="userpwd" value="PASSWORD"/><!-- the encrypted user password, if has value, will overwrite userpwd --><msg name="encrypteduserpwd" value="9abe8f97ebf00295" /><!-- default java keystore name --><msg name="jksname" value="C:\keystore\cacerts"/><!-- default java keystore password --><msg name="jkspwd" value="changeit"/><!-- encrypted java keystore password --><msg name="encryptedjkspwd" value="48d938b0ba29fb4d0b47bb121441a37f"/><!-- default trusted java keystore name --><msg name="trustedjksname" value="C:\keystore\cacerts"/><!-- default trusted java keystore password --><msg name="trustedjkspwd" value="0a095e1e7ff74c8e8cdfc5e73ab442f4"/><!-- encrypted trusted java keystore password --><msg name="encryptedtrustedjkspwd" value=""/>
5. If you do not want clear text passwords stored in the Global.xml file, you can use MFTCC ConfigUtility to generate encrypted keys in this file.
File Transfer Global SettingsPlatform Transfer Client Utility utilizes the Global.xml file to hold parameters that are required for allcommands.
By setting these values in the global, it eliminates the need to specify them each time you run the utility.The following command line parameters might be configured in the Global.xml file:
● Service: The URL of the Platform Transfer Client Utility service.
● U: The user ID under which the utility changes will be performed.
● P: The password for the user ID.
● KN: The Java keystore name.
● KP: The Java keystore password.
● TKN: The trusted Java keystore name.
● TKP: The trusted Java keystore password.
● AD: The audit directory.
You can configure the administrator global settings in following steps:
1. To edit the Global.xml file, you can use following editors:
● For Windows: Notepad
● For UNIX: vi
2. To add the service address, locate the following lines in the Global.xml file.<!-- default service address --><msg name="service" value=""/>
3. Modify the value attribute to specify the location of your service.
For example:<!-- default service address --><msg name="service" value="https://MFT Command Center.MYCOMPANY.COM:8443/cfcc/control?view=services/FTService"/>
Make sure that the service address is added between the double quotation marks (“).
4. Repeat these changes for the audit directory, user ID, password, keystore name, keystore password,trusted keystore, and trusted keystore password.
151
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
For example:<!-- default user id --><msg name="userid" value="admin"/><!-- default user pwd --><msg name="userpwd" value="admin"/><!-- default java keystore name --><msg name="jksname" value="D:\keystore\mykeystore.jks"/><!-- default java keystore password --><msg name="jkspwd" value="changeit"/><!-- default trusted java keystore name --><msg name="trustedjksname" value="D:\keystore\cacerts"/><!-- default trusted java keystore password --><msg name="trustedjkspwd" value="changeit"/><!-- default audit directory --><msg name="auditdirectory" value=""/>
5. If you do not want clear text passwords stored in the Global.xml file, you can use MFTCC ConfigUtility to generate encrypted keys in this file.
Java Keystores SettingsMFTCC supports the use of two Java keystores. The file names for both keystores are defined in theGlobal.xml file.
The trustedjksname file defines the certificate authorities that this Java client will trust whenperforming the initial handshake. The jksname file defines the certificate that will be used when theMFTCC web server is defined to require client certificates.
Both the types of certificate files will now be discussed. Included in the discussion is an explanation ofwhat the file is used for, when it should be used and how to update or create it.
● The Java Trusted Authority Certificate File
● The Java Certificate File
● The SSH Java Certificate Keystore
The Java Trusted Authority Certificate FileThe trustedjksname parameter defines the file that contains the list of certificate authorities that aretrusted when validating a certificate.
All certificates are issued by certificate authorities (CA). When you want to validate a certificate, inaddition to validating the certificate itself, you have to insure that the CA that issued the certificate isvalid as well.
By default, Java has a trustedjksname file that contains a group of common certificate authorities. Thefile name is cacerts and this file is contained in the JRE runtime library under the …lib/securitydirectory. In many, if not most cases, the certificate authorities that are contained in the default Javacertificate file are sufficient, and no further work has to be done. In this case, you can let thetrustedjksname parameter default. Java will then pick up its default trusted certificate authority filecalled: …lib/security/cacerts. You should however, specify the trustedjkspwd file to define thepassword of the default certificate file. This can be done in clear text in the Global.xml file orencrypted by the EncryptPassword action command.
In cases where the server certificate was not issued by one of the default trusted authorities, you willhave to add the server certificate to the Java trusted certificate authority file (cacert). To do this, youhave to have the server CA certificate in Base64 format. Then you can issue the following Javacommand to add this certificate to the trusted certificate authority file:keytool -import -keystore c:\program files\java\jre1.8.0_66\lib\security\cacerts -alias MFTCommandCenterServerKey -file cacert.file -storepass changeit
152
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
This command should be typed as a single line.
● -keystore: specifies the name and location of a keystore.
You should point to the default Java keystore.
● -alias: specifies the unique name for this certificate key.
If you do not specify this parameter, a default value of mykey will be assigned.
● -file: specifies the certificate file name in Base64 format.
● -storepass: specifies the password for the cacerts keystore.
This parameter is the password that you must configure as trustedjskpwd within the MFTCCGlobal.xml file. The default password is changeit.
After entering the command, you will be asked to confirm the request. After confirming the request, thecertificate will be added to the trusted certificate authority file. Now, when your client makes a requestto the MFTCC server, the certificate of the MFTCC server will authenticate correctly.
The Java Certificate FileWhen MFTCC is communicating with a web server that requires client certificates, you must configurethe jskname and jskpwd parameter in the Global.xml file.
If you have a Java keystore that contains the client certificate, you must define the jskname parameterto point to the Java keystore file that contains the client certificate, and define the jskpwd parameter tospecify the password for the keystore.
If the MFTCC web server does not require client certificates, then you should use the default values forjskname and jskpwd parameters. You do not have to create any Java keystores and you do not have todefine the jskname and jskpwd parameters in the Global.xml file.
When the MFTCC web server requires a Java certificate and you do not have a Java keystore thatcontains a Java certificate, you will have to create one. The Java keystore is typically created in the homedirectory of user; however it can be created in any directory.
To create a Java keystore, you must execute the following command:keytool -genkey {-alias alias} [-dname dname] [-keypass keypass] {-keystore keystore} [-storepass storepass] [-keyalg rsa]
This command should be typed as a single line.
● -alias: specifies the unique name for this certificate chain and the private key in this new keystoreentry.
If you do not specify this parameter, a default value of mykey will be assigned.
● -dname: specifies the X.500 distinguished name to be associated with alias.
This parameter is used as the issuer and subject fields in the self-signed certificate. You must set thecommon name (CN=) to the host or IP name of client. The name will be used to access the MFTCCserver.
If no distinguished name is provided at the command line, the user will be prompted for one.
● -keypass: specifies a password used to protect the private key of the generated key pair.
If no password is provided, the user is prompted for it. If you press Enter at the prompt, the keypassword is set to the same password as that used for the keystore.
This parameter must be at least 6 characters long.
● -keyalg: specifies the algorithm to use when creating the key.
RSA is typically used.
153
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
● -keystore: specifies the name and location of a keystore.
If no keystore is provided on the command line, the file named .keystore in the home directory ofuser will be assigned.
● -storepass: specifies a password for the new keystore.
This password must be configured as jskpwd within the MFTCC Global.xml file.
After the keystore has been created, you must generate a certificate request. You can issue the followingJava command to generate a certificate request:keytool -certreq {-alias alias} {-file certreq_file} [-keypass keypass] {-keystore keystore} [-storepass storepass]
● -alias: specifies the alias that you defined for this certificate request.
If you do not specify this parameter, a default value of mykey will be assigned.
● -file: specifies the output file for this command.
This parameter is the CSR file that you will have to provide to your CA.
● -keypass: specifies a password used to protect the private key of the generated key pair.
This parameter must match what you defined as the keypass when you generated the key pair.
● -keystore: specifies the name and location of a keystore.
● -storepass: specifies a password to a keystore.
At this point, you have created a certificate request file. This file must be sent to the certificate authorityor the department responsible for creating certificates. When the certificate authority completesprocessing the certificate request, they will then return a certificate file in Base64 format. Then thiscertificate must be imported into the Java keystore as shown in the next step.
Now that the certificate has been created you must import the certificate into the keystore. To do this,you have to have the client certificate in Base64 format. Then you can issue the following Javacommand to add this certificate to the trusted certificate authority file:keytool -import -keystore c:\home\mftuser\keystore.jsk -alias MFT Command CenterClientKey -file cert.file -storepass changeit
This command should be typed as a single line.
● -keystore: specifies the name and location of a keystore.
You should point to the Java keystore. This file name should be added to the jskname parameter inthe Global.xml file.
● -alias: specifies the unique name for this certificate.
The value defined should match the alias defined in the certreq command.
● -file: specifies the certificate file name in Base64 format.
● -storepass: specifies the password for the cacerts keystore.
This password must be configured as jskpwd within the MFTCC Global.xml file. The defaultpassword is changeit.
After entering the command, you will be asked to confirm the request. After confirming the request, thecertificate will be added to the Java keystore. Now, when your client makes a request to the MFTCCserver, the certificate can be passed to the MFTCC web server.
154
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
The SSH Java Certificate KeystoreWhen MFTCC is installed, a default SSH keystore is installed. The SFTP transfers will work using thisdefault keystore, or the user can create another keystore.
There are two types of keystores that can be used:
● DSA keystore uses the DSA key algorithm to create the public/private key pair.● RSA keystore uses the RSA key algorithm to create the public/private key pair.
● The default SSH keystore uses the DSA key algorithm.
● DSA is required for SSH operation and that virtually all SSH clients and servers support the DSAkey algorithm.
● Some SSH client or server software does not support the RSA algorithm.
● If keystores for both DSA and RSA are defined, then the SSH client and server will negotiate todefine which SSH key will be used.
The Java keytool utility can be used to create the SSH certificate. Below is the format of the keytoolcommand. When you have created the SSH certificate, you must update the Management > SSH Server> Configure SSH Server web page with the following information:
● DSA Keystore: specifies the DSA keystore file defined by the keystore parameter.● DSA Keystore Password: specifies the DSA keystore password defined by the storepass
parameter.● Confirm Password: specifies the confirm password which should be the same as the DSA keystore
password.● DSA Private Key Alias: specifies the DSA alias name created by the alias parameter.
● RSA Keystore: specifies the RSA keystore file defined by the keystore parameter.● RSA Keystore Password: specifies the RSA keystore password defined by the storepass
parameter.● Confirm Password: specifies the confirm password which should be the same as the RSA keystore
password.● RSA Private Key Alias: specifies the RSA alias name created by the alias parameter.keytool -genkey {-alias alias} [-dname dname] [-keypass keypass] {-keystore keystore} [-storepass storepass] [-keyalg dsa]
This command should be typed as a single line.
● -alias: specifies the unique name for this certificate chain and the private key in this new keystoreentry.
If you do not specify this parameter, a default value of mykey will be assigned.● -dname: specifies the X.500 distinguished name to be associated with alias, and is used as the issuer
and subject fields in the self-signed certificate.
You should set the common name (CN=) to the host or IP name of client. This name will be used toaccess the MFTCC server.
If no distinguished name is provided at the command line, the user will be prompted for one.● -keypass: specifies the password used to protect the private key of the generated key pair.
This parameter must be the same as the storepass parameter defined. If no password is provided,the user is prompted for it. If you press ENTER at the prompt, the key password is set to the samepassword as that used for the keystore.
155
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide
● -keyalg: specifies the algorithm to use when creating the key.
The valid values are DSA or RSA. DSA is typically used with SSH, because all SSH clients support DSA,but only part of them support RSA.
● -keystore: specifies the name and location of a keystore.
If no keystore is provided on the command line, the .keystore file in the home directory of userwill be assigned.
● -storepass: specifies a password for the new keystore.
You can configure this parameter in the Configure SSH Server page. This password must be thesame as the keypass parameter.
Example:keytool -genkey -alias CFCCSSH -dname "CN=yourmachine, O=yourcompany, OU=yourorganization, L=yourcity, ST=yourstage, C=yourcountry" -keypass changeit-keystore "c:\cfccinstall\keystore\keystore.dss" -storepass changeit-keyalg DSA -keySize 1024 -validity 3650
This command should be typed as a single line.
Environment SettingsYou can run batch file to set up classpath for the program in both Windows and UNIX operationsystem.
Run the following batch file to set up classpath for the program.
● For Windows: setutilcp.bat
● For UNIX k-shell: setutilcp.sh
The setutilcp file must be run each time you open a new command shell.
If you do not configure the environment settings, you have to specify all necessary .jar files in theclasspath when running the Java program.
156
TIBCO® Managed File Transfer Command Center Command Line Utilities Guide