Managing Partner Profile with PartnerManager

Edit online

The PartnerManager is a robust tool that performs different operations on one or more Odette FTP Partner Profile and CLID information, such as doing mass imports or exports.

Use the command line tool of PartnerManager to:
  • Import a PartnerProfile.xml file into the Sterling B2B Integrator database (Odette FTP Partner Profile) or perform a consistency check of a new PartnerProfile.xml file.
  • Export from the Sterling B2B Integrator database (Odette FTP Partner Profile) one or more partner profile elements and CLID information into a PartnerProfile.xml file.
  • Delete one or more partner profile elements and CLID information in the Sterling B2B Integrator database (Odette FTP Partner Profile). Alternatively, to get an initialized state, all entries can be deleted.
  • List one or more partner profile records and CLID information from the Sterling B2B Integrator database (Odette FTP Partner Profile) in a short overview containing only the names of the partner profile elements.

For more information on the structure of the PartnerProfile XML file, see Partner Profile XML Setup.

CAUTION:
Use caution when executing PartnerManager (performing database write operations) while your Sterling B2B Integrator instance is still running, especially when Odette FTP adapters are enabled to execute OFTP sessions. You should close Sterling B2B Integrator or verify that no OFTP sessions will take place, for example, by disabling all Odette FTP adapters.

The PartnerManager is invoked by executing the OFTPPartnerManager.cmd (for Windows) or OFTPPartnerManager.sh (for UNIX) script in the bin directory.

When executing without any parameters, a usage screen displays the operations that can be performed:

Usage: PartnerManager <command>
 where:
   <command> ::= [<importCommmand>] <PartnerProfileName>[-cleandb]
               || -delete all | <selection>
               || -export <exportSelection> [<exportfilename>]
               || -list  all | <selection>
     <importCommmand>   ::= -insert || -update || -replace || -flatinsert 
                            || -simulate
     <selection>        ::= <elementList>
     <exportSelection>  ::= allflat | alltree | <selection>
     <elementList>      ::= <element>=<name||"*"> [<elementList>]
     <element>          ::= PhysicalPartner || pp 
                           || PhysicalPartnerContract || ppc
                           || LogicalPartner || lp 
                           || LogicalPartnerContract  || lpc
                           || CLID  || clid
The key <name> in <elementList> specifies a particular name of one of the Odette FTP elements that can be selected:
  • Physical Partner (pp)
  • Physical Partner Contract (ppc)
  • Logical Partner (lp)
  • Logical Partner Contract (lpc)
  • CLID information (clid)