Parameter file

The parameter file is an INI file you can use to modify settings for the export. With the parameter file you can, for example, specify what data you want to export and which file you want to export it to.

You create the parameter file yourself in any text editor. The name and file extension of the parameter file are freely selectable, for example Parameter.config.ini.

The settings that can be made for all exports are listed in the tables below. The settings that apply only to individual exports can be found in the description of the respective export.

Section [User]

Key Value
Account User, who starts the Export process
Domain

Domain in which the user is created

This key only needs to be specified if the user is part of a domain and this was not specified when the call was made.
Password

Password of the user

This key is only observed if the executing user is also specified in the parameter file.
PasswordMode

Specifies the way the password is interpreted. The following values are possible:

  • 0: The password will be interpreted as unencrypted (default value).
  • 2: The password has to be entered via the command line.
Token

Access token of the user

The access token can be generated in the AdminClient and is required to execute the ExportModule.

If a token is specified, the other credentials do not need to be passed on.

Section [Common]

Key Value
ReportType*

Report to be produced. The following values are possible:

  • ComponentTree

    • Exports the Project tree

  • JobList

    • Exports an overview of the jobs

  • JobResults

    • Exports the job results of all jobs

  • UnequalJobResults

    • Exports only the job results of the jobs where differences were detected or errors occurred

  • UserManagement

    • Export of users and user groups

  • ComponentTypes

    • Exports the component types and their configuration (name, ID, etc.)

  • Componentlog

    • Exports the content of the component log

  • Event log

    • Exports the content of the Event log module

  • Adminlog

    • Exports a list of changes to the modules of the AdminClient.

  • StandardLibraryManagement

    • Exports an overview of where which standard blocks are used

  • ComponentsWithStdLibAssignments

    • Exports an overview of the components that are linked to standard libraries.

  • AssetState

    • exports an overview of the Factory Floor Status

  • UsageInformation

    • Creates a user information file.

Only an attribute is possible.

ExportType

Specifies which export is to be created in which format.

Not every export can be created in every format. You have the following possibilities:

  • ComponentTree: XML or JSON
  • JobList: CSV or JSON
  • JobResults: CSV or JSON
  • UnequalJobResults: CSV or JSON
  • UserManagement: XML or JSON
  • ComponentTypes: XML or JSON
  • Componentlog: CSV or JSON
  • Event log: CSV or JSON
  • Adminlog: CSV or JSON
  • StandardLibraryManagement: CSV or JSON
  • ComponentsWithStdLibAssignments CSV or JSON
  • AssetState: CSV or JSON

*The respective underlined format is used as default value if ExportType is not specified in the parameter file.
ExportFile* Absolute path (with file name) of the file where the export results should be stored. If the file already exists, it will be overwritten.
CsvSeparator

Separator between columns in a CSV file that is output as an export result, e.g. semicolon, comma, tab, or a space character.

To use a tab as a separator, the following alternatives are available:

  • String TAB

  • Quotation mark + Tab key + Quotation mark ("⇥")

You also enter a space with quotation marks. (" ")

If this key is not specified, the separator configured in the AdminClient in the Global Settings module is used.
FlatExport

This key can be used only for ExportType JSON.

Specifies whether the JSON file contains only data without enclosing elements.

The following values are possible:

  • Y: The JSON file does not contain any enclosing elements.
    Example:

    • [
    {
    Job1 ...
    },
    {
    Job2 ...
    }
    ]

  • N: All elements in the JSON file are output.

    • {
    "Jobs": [
    {
    Job1 ...
    },
    {
    Job2 ...
    }
    ]
    }

Section [Result]

Key Value
ErrorText At this point, errors that occurred during export are listed.
LastExecution Timestamp of the last executed export

The attributes marked with *(asterisk) are mandatory attributes. They must be assigned.

Related topics
AdminClient-> INI files
AdminClient-> Server