configurationengine/doc/cli/export.rst
changeset 3 e7e0ae78773e
parent 0 2e8eeb919028
equal deleted inserted replaced
2:87cfa131b535 3:e7e0ae78773e
     1 ConE export action
     1 ConE export action
     2 ==================
     2 ==================
     3 Running action export
     3 Running action export
     4 Usage: cone export [options]
     4 Usage: cone export [options]
     5 
     5 
     6 The export functionality exports configurations from the current project to a remote project. Default value for the current project is the currently working directory. A project can be either a folder or a CPF/ZIP file.
     6 The export functionality exports configurations from the current project to a remote project. Default value for the current project is the currently working directory. A project can be either a folder or a CPF/ZIP file or even a Carbon webstorage (via ExtAPI).
     7 
     7 
     8 Examples
     8 Examples
     9 --------
     9 --------
    10 
    10 
    11 **Export a configuration from folder to a zip file**::
    11 **Export a configuration from configuration project folder to a zip file**::
    12 
    12 
    13     >cd configproject_root
    13     >cd configproject_root
    14     >cone export -c configuration_root.confml --remote=exported.zip
    14     >cone export -c configuration_root.confml --remote=exported.zip
    15 
    15 
    16 or use the option -p|--project to point to the configuration project root::
    16 or use the option -p|--project to point to the configuration project root::
    37 **Export a configuration from a folder to webstorage (carbon)**::
    37 **Export a configuration from a folder to webstorage (carbon)**::
    38 
    38 
    39     >cd configproject_root
    39     >cd configproject_root
    40     >cone export --remote http://carbonqa.nokia.com/extapi -c configuration_root.confml 
    40     >cone export --remote http://carbonqa.nokia.com/extapi -c configuration_root.confml 
    41 
    41 
       
    42 **Export a configuration and run a action during the export**::
       
    43 ConE can also run separate actions during the exporting for example to fix model level errors if possible. To run for example the fix step during export you can use --run-action=fix attribute.
       
    44 
       
    45     >cd configproject_root
       
    46     >cone export -c configuration_root.confml --remote=../export_folder --run-action=fix
    42 
    47 
    43 
    48 
    44 Options list
    49 Options list
    45 ------------
    50 ------------
       
    51 Options:
    46   --version             show program's version number and exit
    52   --version             show program's version number and exit
    47   -h, --help            show this help message and exit
    53   -h, --help            show this help message and exit
    48   --print-settings      Print all the default settings from the current
    54   --print-settings      Print all the default settings from the current
    49                         setting container.
    55                         setting container.
    50   --print-supported-impls
    56   --print-supported-impls
    51                         Print all supported ImplML XML namespaces and file
    57                         Print all supported ImplML XML namespaces and file
    52                         extension.
    58                         extensions.
       
    59   --print-runtime-info  Print runtime information about ConE.
    53   -v LEVEL, --verbose=LEVEL
    60   -v LEVEL, --verbose=LEVEL
    54                         Print error, warning and information on system out.
    61                         Print error, warning and information on system out.
    55                         Possible choices: Default is 3.
    62                         Possible choices: Default is 3.
    56                         NONE (all)    0
    63                         NONE (all)    0
    57                         CRITICAL      1
    64                         CRITICAL      1
    58                         ERROR         2
    65                         ERROR         2
    59                         WARNING       3
    66                         WARNING       3
    60                         INFO          4
    67                         INFO          4
    61                         DEBUG         5
    68                         DEBUG         5
    62   --log-file=FILE       Location of the used log file. Default is 'cone.log'
    69   --log-file=FILE       Location of the used log file. Default is 'cone.log'
       
    70   --log-config=FILE     Location of the used logging configuration file.
       
    71                         Default is 'logging.ini'
       
    72   --username=USERNAME   Username for webstorage operations. Not needed for
       
    73                         filestorage or cpf storage. If the username
       
    74                         is not given, the tool will use the logged in
       
    75                         username. Example: cone export -p webstorage_url -r .
       
    76                         -c sample.confml --username=admin --password=abc123.
       
    77   --password=PASSWORD   Password for webstorage operations. Not needed for
       
    78                         filestorage or cpf storage. If the password
       
    79                         is not given, the tool will prompt for password if
       
    80                         needed.
    63   -c CONFIG, --configuration=CONFIG
    81   -c CONFIG, --configuration=CONFIG
    64                         defines the name of the configuration for the action
    82                         Defines the name of the configuration for the action,
       
    83                         can be specified multiple times to include multiple
       
    84                         configurations.
       
    85   --config-wildcard=WILDCARD
       
    86                         Wildcard pattern for including configurations, e.g.
       
    87                         product_langpack_*_root.confml
       
    88   --config-regex=REGEX  Regular expression for including configurations, e.g.
       
    89                         product_langpack_\d{2}_root.confml
    65   -p STORAGE, --project=STORAGE
    90   -p STORAGE, --project=STORAGE
    66                         defines the location of current project. Default is
    91                         defines the location of current project. Default is
    67                         the current working directory.
    92                         the current working directory.
    68 
    93 
    69   Export options:
    94   Export options:
    70     The export functionality is meant to export configurations between
    95     The export action is intended for exporting configurations from one
    71     current project (defined with -p) to an remote project (defined with
    96     project (storage) to another. A project can be a folder, a CPF or ZIP
    72     -r). Default value for the current project is the currently working
    97     file, or a Carbon web storage URL.
    73     directory. A project can be either a folder or a cpf/zip file.
    98     Two different ways of exporting are supported:
       
    99     1. Exporting multiple configurations into one new project using
       
   100     --remote
       
   101     2. Exporting configurations into a number of new projects using
       
   102     --export-dir
    74 
   103 
    75     -r STORAGE, --remote=STORAGE
   104     -r STORAGE, --remote=STORAGE
    76                         defines the location of remote storage. Default name
   105                         Defines the location of remote storage. All
    77                         for remote storage is the source configuration name
   106                         configurations included using --configuration,
    78     -a SET, --add=SET   Add a configuration layer to the given configuration
   107                         --config-wildcard and --config-regex are exported into
    79                         as last element.The add operation can be used several
   108                         the storage. If the remote storage location is not
       
   109                         given, the default location is determined based on the
       
   110                         first included source configuration name. E.g.
       
   111                         'example.confml' would be exported into 'example.cpf'
       
   112     --export-dir=EXPORT_DIR
       
   113                         Defines the directory where each included
       
   114                         configuration is exported as a new project.
       
   115     --export-format=EXPORT_FORMAT
       
   116                         Defines the format into which projects are exported
       
   117                         when using --export-dir. Possible values are 'cpf'
       
   118                         (the default) and 'dir'.
       
   119     -a CONFIG, --add=CONFIG
       
   120                         Adds a configuration layer to the given configuration
       
   121                         as last element. The add operation can be used several
    80                         times in a single command and it can create even an
   122                         times in a single command and it can create even an
    81                         empty layer.Example --add foo/root.confml --add bar
   123                         empty layer. Example --add foo/root.confml --add bar
    82                         /root-confml.
   124                         /root-confml.
    83     --exclude-folders   Excludes empty folders from .cpf export
   125     --run-action=PLUGIN
       
   126                         Adds a execution of extra step that can manipulate the
       
   127                         configuration before it is exported to external
       
   128                         storage. The --run-action operation can be used
       
   129                         several times in a single command and it will execute
       
   130                         the actions in given order.Example --run-action=fix,
       
   131                         which would execute fix action during export.
       
   132     --exclude-folders   Excludes empty folders from export