Import Trading Partner Data Through the Basic Import Utility

You can import a file that contains document envelopes or control numbers from the command line.

  1. Change to the install_dir/tp_import directory.
  2. Run one of the following commands:
    ./import.sh -input [input filename] (UNIX)

    import.cmd -input [input filename] (Windows)

    Note: Input filename is the name of the XML file you want to import. This is a mandatory parameter used with the Import utility.

    ./import.sh -batch [input filename] (UNIX)

    import.cmd -batch [input filename] (Windows)

    Note: Input filename, when you are running a batch import, indicates that each line in file name is a separate import (XML file) to run. This is a mandatory parameter used with the Import utility.

    When you are importing multiple files, you must add the -input parameter for each file. If a resource is getting updated, you must also add the -update parameter.

    All the available parameters are listed in the following table:

    Option Description
    -backup [filename] Name of the file in which the backup of the updated records is stored. Optional; if not present, the backup records are not saved.
    -batch [input filename] Specifies the names of the files to import. Mandatory.

    In addition to -batch, use the -input option for each file that you want to import. If the same resource is also getting updated, use the -update parameter.

    Example: import.sh -input testEnvelope -update.

    This parameter is mutually exclusive from the -input parameter (use either the -input parameter or the -batch parameter). An error occurs if the input file name is not provided.
    -errors [filename] Name of the file in which records that Sterling B2B Integrator failed to process are stored. Optional; if not present, the error records are not saved.
    -h | -? Displays the help screen.
    -input [input filename] Specifies the name of the XML file to import. Mandatory.

    Example: import.sh -input testEnvelope.

    This parameter is mutually exclusive from the -batch parameter (use either the -input parameter or the -batch parameter). An error occurs if the input file name is not provided.

    When you are importing multiple files, you must add the -input parameter for each file.
    -KeepExistingControlNumbers Indicates whether you want to keep existing control numbers. If you use this parameter, it specifies that for existing envelopes and control numbers, control number values in the import file will not be imported. If a version of an envelope or control number being imported already exists in the system, the import process will overwrite the value specified in the import file with the existing control number value for that envelope or control number. If you do not specify this parameter, the control numbers in the import file will be imported.
    -NumberOfThreads [number of threads] Identifies the number of threads used to run the imports in parallel (default to 1).
    -passphrase [passphrase] Password used to import entities into Sterling B2B Integrator. Optional.
    Note: This is the passphrase that was used during export.
    -pre32passphrase [passphrase] Password used to import some encrypted resources into Sterling B2B Integrator, if the file was exported from Sterling B2B Integrator prior to version 3.2. Optional.
    Note: This is the system passphrase of the Sterling B2B Integrator version prior to version 3.2 from which the file was exported.

    Example: import.sh -input [input filename] -pre32passphrase [system passphrase from system where exported] -passphrase [passphrase entered by user during export]
    -privatecerts Indicates that private key certificates will be imported if any are found. Optional.
    -report [filename] Specifies the path to the report file. The default is import.rpt or batchimport.rpt. Optional.
    -resourcetag [resource tag] Specifies the resource tag for the imported resources. Specify USETAGININPUTFILE to apply the resource tag contained in the input file. Optional.
    -update Indicates the system will update the existing trading partner profiles. Optional; if not present, the existing records remain unchanged.

    When you are updating multiple files, you must add the -update parameter for each file.
    -x Specifies not to return an exit code. Optional. By default, the utility returns an exit code.