Wiki Admin

dssdefinitionexport - DSS 6 | Data Source Solutions Documentation

Export as HTML Export as PDF Export as DOCX
Edit

Documentation: dssdefinitionexport - DSS 6 | Data Source Solutions Documentation

dssdefinitionexport

Usage

  • <b>dssdefinitionexport</b> [<b>-R</b><em>url</em>] <b>-C</b> [<b>m</b> [<b>-a</b>]] <em>hub expjsonfile</em>
  • <b>dssdefinitionexport</b> [<b>-R</b><em>url</em>] <b>-c</b><em>chn...</em> [<b>-m</b> [<b>-a</b>]] <em>hub expjsonfile</em>
  • <b>dssdefinitionexport</b> [<b>-R</b><em>url</em>] <b>-c</b><em>chn </em><b>-T</b> <em>hub expjsonfile</em>
  • <b>dssdefinitionexport</b> [<b>-R</b><em>url</em>] <b>-c</b><em>chn </em><b>-t</b><em>tbl... hub expjsonfile</em>
  • <b>dssdefinitionexport</b> [<b>-R</b><em>url</em>] <b>-L</b> [<b>-a</b>] <em>hub expjsonfile</em>
  • <b>dssdefinitionexport</b> [<b>-R</b><em>url</em>] <b>-l</b><em>loc...</em> [<b>-a</b>] <em>hub expjsonfile</em>
  • <b>dssdefinitionexport</b> [<b>-R</b><em>url</em>] <b>-h</b><em>hub expjsonfile</em>
  • <b>dssdefinitionexport</b> [<b>-R</b><em>url</em>] <b>-l</b> [<b>-u</b>] <em>hub expjsonfile</em>
  • <b>dssdefinitionexport</b> [<b>-R</b><em>url</em>] <b>-i</b><em>ev_id_tstamp...</em> [<b>-u</b>] <em>hub expjsonfile</em>
  • <b>dssdefinitionexport</b> [<b>-R</b><em>url</em>] [<b>-b</b><em>tstamp</em>] | [<b>-e</b><em>tstamp</em>] [<b>-u</b>] <em>hub expjsonfile</em>

Description

Command dssdefinitionexport exports channel, location, and table definitions from a hub into a JSON file.

Options

This section describes the options available for command dssdefinitionexport.

Parameter Description
-a

Include actions for exported locations.

This requires options -l (export specific location loc only), -L or -m.
-A

Export agent location properties only.

This requires -l (export specific location loc only) or -L.
-btstamp Export Definition_Change events since time stamp _tstamp_.
-cchn

Export specific channel chn only.

This cannot be combined with option -C.
-C

Export all channels.

This cannot be combined with option -c.
-etstamp Export Definition_Change events until timestamp _tstamp_.
-h Export all hub-level actions.
-iev_id_tstamp Export specific Definition_Change event ev_id_tstamp.
-I Export all Definition_Change events.
-lloc

Export specific location loc only.

This cannot be combined with -L.
-L

Export all locations.

This cannot be combined with -l (export specific location loc only).
-m

Include locations which are members of the exported channels.

This requires option -c or -C and cannot be combined with option -t or -T.
-Rurl

Remote hub server. Access the hub server running on a remote machine, via the REST interface.

This option is required for remote CLI access. When using this option, command dsslogin should be run first, for authentication.
-ttbl

Export specific table tbl only. This requires single -cchn.

This cannot be combined with option -T.
-T

Export only tables (not a channel). This requires single -cchn.

This cannot be combined with -t.
-u

Export the undo operation of the original Definition_Change event.

This requires options -b, -e, -i, or -I (export all Definition_Change events).

-Vaccessmeth

Handle classified data.

  • redact: Redact classified data.

  • storage default: Save classified data as they are stored in the hub system.

  • @outputfile: Apply transport encryption, save key to file outputfile.

  • @print: Apply transport encryption using the transport encryption key and display the key in command terminal.

Examples

This section provides examples of using the dssdefinitionexport command.

Example 1. Export all definitions in a hub

The following command exports all definitions in hub dsshub:

dssdefinitionexport dsshub expjsonfile
Example 2. Export all channels including locations

The following command exports all channels including locations that are members of the exported channels and actions defined in the exported locations:

dssdefinitionexport -C -m -a dsshub expjsonfile
Example 3. Export specific channels with locations

The following command exports channels mychannel and demochannel including locations which are members of the exported channels and actions defined in the exported locations:

dssdefinitionexport -c mychannel -c demochannel -m -a dsshub expjsonfile
Example 4. Export tables

The following command exports all tables of channel mychannel:

dssdefinitionexport -c mychannel -T dsshub expjsonfile
Example 5. Export specific table

The following command exports table mytable of channel mychannel:

dssdefinitionexport -c mychannel -t mytable dsshub expjsonfile
Example 6. Export locations with actions

The following command exports all locations including actions:

dssdefinitionexport -L -a dsshub expjsonfile
Example 7. Export specific location

The following command exports location mylocation:

dssdefinitionexport -l mylocation dsshub expjsonfile
Example 8. Export agent properties

The following command exports agent properties of location mylocation:

dssdefinitionexport -l mylocation -A dsshub expjsonfile
Example 9. Export hub-level actions

The following command exports hub-level actions of hub dsshub:

dssdefinitionexport -h dsshub expjsonfile
Example 10. Export definition changes

The following command exports all Definition_Change events:

dssdefinitionexport -I dsshub expjsonfile
Example 11. Export specific definition change

The following command exports a specific Definition_Change event with ID 2019-05-17T11:45:49+02:00:

dssdefinitionexport -i 2019-05-17T11:45:49+02:00 dsshub expjsonfile
Example 12. Export definition changes performed during specific time range

The following command exports the Definition_Change events for the time range between October 9, 2020 and October 29, 2020

dssdefinitionexport -b 2020-10-09 -e 2020-10-29 dsshub expjsonfile