DOCUMENTS
READ HERE ALL INFORMATION ABOUT:

  • Procedure to install the DPF Manager in different system platforms
  • User manual for the command line
  • Manual for the Graphical User Interface
  • How to install

    Choose your platform

    USER MANUAL

    Command Line Syntax

    DPF Manager can be run in command line mode (CLI) and through a Graphical user interface (GUI).

    In Linux there is a single executable for both interfaces of the DPF Manager, with the name "dpf-manager". In order to open the GUI, execute “dpf-manager” (without parameters). For running the CLI, execute it with parameters, e.g. "dpf-manager --help".

    In Windows there are two executables, one for the CLI, named "dpf-manager-console.exe" and another one for the GUI, named "DPF Manager.exe".

    For MacOS, there is a single package in the Applications folder with the name "DPF Manager" that runs the GUI by default (double-clicking it). The CLI can be run by executing the inner executable "DPF Manager.app/Contents/MacOS/DPF Manager" through the terminal. You can create a shortcut with the command: alias dpf_manager="/Applications/DPF\ Manager.app/Contents/MacOS/DPF\ Manager"

    To run the DPF Manager from the command line, execute the appropriate executable file for your operating system with commands:

    dpf-manager [commands]

    These are the available commands:

    • check: Performs a local files check.
    • config: Manages the configuration files.
    • gui: Launches graphical user interface.
    • modules: Manage the conformance checkers.
    • periodic: Manage periodic checks.
    • remote: Performs remote file checks.
    • server: Launches the server mode.

    Each command has its associated options and parameters, and there are also a set of general options:

    • -h, --help: Shows this screen.
    • -l, --language: Change the application language.
    • -v, --version: Shows application version number.

    Command check

    Usage: dpf-manager check [options] sources

    Where {sources} is the tiff's list to scan. Each element of the list can be:

    • A file. It can be either and absolute or a relative path. Example: "image.tif"
    • A folder. All the files inside the folder will be processed. Example: "photos/tifimages"
    • An URL. Example: "http://www.dpfmanager.org/image1.tif"
    • A zip file. Example: "images.zip"

    The following options are available:

    Option: Help

    Shows the help information.

    Syntax:

    -h, --help

    Option: Output folder

    Specifies a output folder for the summary report.

    Syntax:

    -o, --output name

    Where name is the name of output folder. Default value is "report"

    Option: Report format

    Specifies the report format.

    Syntax:

    -f, --format type

    Where type can be xml, json and html, separated by commas. Default value is "xml,json,html"

    Option: Silence

    Do not show info messages in the CLI.

    Syntax:

    -s, --silence

    Option: Configuration file

    Specifiy a configuration file.

    Syntax:

    -c, --configuration filename

    Where filename is the name of configuration file.

    Option: Threads

    Specify maximum number of threads used for checking. By default, SO chooses.

    Syntax:

    -t, --threads N

    Option: Show Report

    Open the report at the end of the execution.

    Syntax:

    --show-report


    Command config

    Usage: dpf-manager config [actions] [options]

    Action: Add

    Creates a new configuration.

    Syntax:

    -a, --add name

    The name can be either a path or a configuration file name.

    Action: Edit

    Edits a configuration.

    Syntax:

    -e, --edit name

    The name can be either a path or a configuration file name.


    Action: Info

    Shows a configuration.

    Syntax:

    -i, --info name

    The name can be either a path or a configuration file name.


    Action: List

    Edit the execution path of a conformance checker.

    Syntax:

    -l, --list type

    Lists useful information depending on 'type'. Type can be: 'iso', 'rule', 'fix', 'autofix'

    Action: Remove

    Deletes a configuration.

    Syntax:

    -r, --remove name

    The name can be either a path or a configuration file name.

    Option: Autofix

    Adds an autofix.

    Syntax:

    --autofix

    Use 'dpf-manager config --list autofix' to see the autofixes list.

    Option: Description

    Sets the description of the configuration.

    Syntax:

    -d, --description description

    If description is 'EMPTY', it will remove the description.

    Option: Disable iso

    Disables a rule of an iso.

    Syntax:

    --disable-iso-rule iso_id rule_id

    Use 'dpf-manager config --list iso' to see the ISOs list.

    Option: Enable iso

    Enables a rule of an iso.

    Syntax:

    --enable-iso-rule iso_id rule_id

    Use 'dpf-manager config --list iso' to see the ISOs list.

    Option: Fix

    Adds a fix specified by the parameters.

    Syntax:

    --fix operator tag

    See fix specification below.

    Option: Format

    Specifies the report format.

    Syntax:

    -f, --format '[xml, json, pdf, html]'

    Default is 'xml,html'.

    Option: Iso

    Adds an ISO to check.

    Syntax:

    --iso iso_id

    Use 'dpf-manager config --list iso' to see the ISOs list.

    Option: Output

    Specifies the output folder.

    Syntax:

    -o, --output path

    Path can be either a path or 'DEFAULT'.

    Option: Remove autofix

    Removes an autofix.

    Syntax:

    --remove-autofix autofix

    Option: Remove fix

    Removes a fix.

    Syntax:

    --remove-fix operator tag

    See fix specification below

    Option: Remove iso

    Removes a ISO to check.

    Syntax:

    --remove-iso iso_id

    Option: Add rule

    Adds a rule.

    Syntax:

    --rule type tag operator vaule

    See rule specification below

    Option: Remove rule

    Removes a rule.

    Syntax:

    --remove-rule type tag operator vaule

    See rule specification below

    Rule specification:

    • Type must be 'error' or 'warning'.
    • Tag must be an accepted Tag. Use 'dpf-manager config --list rule' to see the list of accepted tags.
    • Operator must be 'GT' (Greather than), 'LT' (Less than) or 'EQ' (Equals).

    Fix specification:

    • Type must be 'addTag' or 'removeTag'.
    • Tag must be an accepted Tag. Use 'dpf-manager config --list fix' to see the list of accepted tags.
    • Value is the value of the added tag.

    Command modules

    Usage: dpf-manager modules [options]

    Options:

    Option: Add

    Add a conformance checker.

    Syntax:

    -a, --add name path

    Where name is the name of the conformance checker and path is its location.

    Option: Configure

    Set the configuration of a conformance checker.

    Syntax:

    --configure name

    Where name is the name of the conformance checker.


    Option: Disable

    Deactivate a conformance checker.

    Syntax:

    --disable name

    Where name is the name of the conformance checker.


    Option: Edit

    Edit the execution path of a conformance checker.

    Syntax:

    -e, --edit name path

    Where name is the name of the conformance checker and path is its location.

    Option: Enable

    Activate a conformance checker.

    Syntax:

    --enable name

    Where name is the name of the conformance checker.

    Option: Extensions

    Set the extensions of a conformance checker.

    Syntax:

    --extensions [ext1...extn]

    Where ext1...extn are the file extensions. For example 'tif,tiff'.

    Option: Info

    Get information of a conformance checker.

    Syntax:

    -i, --info name

    Where name is the name of the conformance checker.

    Option: List

    Show the list of conformance checkers.

    Syntax:

    -l, --list

    Option: Parameters

    Set the input parameters of a conformance checker.

    Syntax:

    --parameters name parameters

    Where name is the name of the conformance checker and parameters its arguments.

    Option: Remove

    Remove a conformance checker from the list.

    Syntax:

    -r, --remove name

    Where name is the name of the conformance checker.


    Command periodic

    Usage: dpf-manager periodic [options] sources

    Options:

    Option: Add

    Add a new periodical check. It requires the options periodicity, configure and the sources.


    Syntax:

    -a, --add

    Option: Configure

    Specifies the configuration file.


    Syntax:

    --configure filename

    Where filename is the path to the configuration file.

    Option: Edit

    Edits the periodical check with the specified id. It requires the options periodicity, configure and the sources.

    Syntax:

    -e, --edit id

    Where id is the identifier of the periodical check.

    Option: List

    Lists all periodical checks.

    Syntax:

    -l, --list

    Option: Periodicity

    Specifies the periodical check mode.

    Syntax:

    --periodicity <D|W|M> [extra_info]

    It must be D (daily), W (weekly) or M (monthly). In case of weekly, extra_info must be a list of the week days (with numbers, where 1 = Monday and 7 = Sunday) separated by ','. In case of monthly, extra_info must be the number of the day of the month (between 1 and 28, both included).

    Option: Remove

    Removes the periodical check with the specified id.

    Syntax:

    -r, --remove id

    Where id is the identificator of the periodical check.

    Option: Time

    Specifies the time for the periodical check.

    Syntax:

    --time <HH:mm>

    The time format must be HH:mm. Default value is '00:00'.


    Command remote

    Usage: dpf-manager remote [options] sources

    Options:

    Option: Configuration

    Selects a configuration file.

    Syntax:

    --configuration filename

    Where filename is the path to the configuration file.


    Option: Format

    Specifies the report format (overriding the one in the config file).

    Syntax:

    -f, --format type

    Where type can be xml, json and html, separated by commas. Default value is "xml,html".

    Option: Job

    Get job state.

    Syntax:

    -j, --job id

    Where id id the job identifier.


    Option: Output

    Specifies the output folder (overriding the one specified in the config file).

    Syntax:

    -o, --output path

    Where path is the destination folder.

    Option: Url

    Specifies the remote server url.

    Syntax:

    -u, --url url

    Where url is the complete URI. For example "http://example.com/dpfmanager", or also with a custom port "example.com:9000/dpfmanager"

    Option: Wait

    Wait for a remote check to finish.

    Syntax:

    -w, --wait

    Default is false.


    Command server

    Usage: dpf-manager server [options]

    Options:

    Option: Port

    Specifies a port number.

    Syntax:

    -p, --port port_number

    Where port_number is the port number. Default port is randomly chosen.

    Graphical User Interface

    To run the DPF Manager with graphical user interface, double click the DPF Manager, or execute it without params.

    gui main

    Select or create a configuration file, with a 5-step process which consists of selecting the profiles to be checked, defining the policy checker, specifying the report format/s and defining the metadata fixes and autofixes.

    gui main

    Then select a file to process, and click the "Check files" button to see the results in the defined report format (HTML by default).

    report

    You can view the list of all generated reports in the reports tab.

    reports list

    Periodical checks can be configured from the Periodical Checks tab.

    reports list

    In the tab Conformance Checkers, the external conformance checkers can be managed.

    reports list

    Consult the User Manual for more detailed instructions.

    Get Involved as: