NAME

       fileImport - Import files into WebGUI's Asset Manager.

SYNOPSIS

        fileImport --configFile config.conf --pathToFiles path
                   --parentAssetID id
                   [--groupToEdit group]
                   [--groupToView group]
                   [--owner id]
                   [--findByExt ext1,ext2,...]
                   [--ignoreExtInName]
                   [--webUser username]
                   [--recursive]
                   [--overwrite]
                   [--override]
                   [--quiet]

        fileImport --help

DESCRIPTION

       This WebGUI utility script imports files into WebGUI's Asset Manager attached to a
       specified parent Asset, helping bulk uploads of content.

       This utility is designed to be run as a superuser on Linux systems, since it needs to be
       able to put files into WebGUI's data directories and change ownership of files. If you
       want to run this utility without superuser privileges, use the --override option described
       below.

       --configFile config.conf
           The WebGUI config file to use. Only the file name needs to be specified, since it will
           be looked up inside WebGUI's configuration directory.  This parameter is required.

       --pathToFiles path
           Path to a folder containing the files to import. This parameter is required.

       --parentAssetId id
           Attach the imported files to the Asset id in WebGUI's Asset Manager.  This parameter
           is required.

       --groupToEdit id
           Make members of WebGUI's group identified by id be able to edit the uploaded files. If
           left unspecified, it defaults to Group ID 4, (Content Managers).

       --groupToView id
           Make members of WebGUI's group identified by id be able to view the uploaded files. If
           left unspecified, it defaults to Group ID 7, (Everybody).

       --owner id
           Make WebGUI's user identified by id own the uploaded files. If left unspecified, it
           defaults to User ID 3 (Admin).

       --webUser username
           The system user that your web server runs as. If left unspecified it will default to
           www-data.

       --override
           This flag will allow you to run this utility without being the super user, but note
           that it may not work as intended.

       --skipOlderThan interval
           Skip files older than interval seconds. If left unspecified, it will default to skip
           no files.

       --findByExt patterns
           Import only those files with matching file extensions. patterns is a list of comma-
           separated extensions to match. If left unspecified, it will default to import all
           files.

       --recursive
           Import files recursively. If left unspecified, only files in the folder will be
           imported, without following subfolders.

       --overwrite
           Overwrite any matching file URL with the new file rather than creating a new Asset for
           the file. Instantiate the existing asset and replace the file.

       --ignoreExtInName
           Do not include the filename extension in the Title and menuTitle database fields.

       --quiet
           Disable all output unless there's an error.

       --help
           Shows this documentation, then exits.

EXIT VALUES

       The following exit values are returned upon completion:

         0  Successful execution.
         1  Stop the script if not super user.
         2  A folder can't be opened for reading.
         3  Two files had the same name and were selected to be imported
            during recursive mode.
         4  Missing required parameter.
         5  Specified parent AssetId does not exist.

AUTHOR

       Copyright 2001-2009 Plain Black Corporation.