Introduction to the piconfig utility
- Last UpdatedJan 13, 2023
- 2 minute read
- PI System
- PI Server
The piconfig utility is a command-line administration tool for Data Archive. It provides simple and scriptable access to almost all Data Archive configuration tasks and underlying data tables. The piconfig utility is automatically installed on all Data Archive computers and PINS (PI Networking System) nodes.
Note: A PINS node is a PI client computer that does not run a Data Archive server. It can be an interface computer, a client computer, or a computer that runs the PI Management Subsystem.
You can run the piconfig utility in the following ways:
-
Interactive: Enter commands one at a time at the command prompt.
-
Batch: Input multiple commands by using a source file.
The following steps provide an overview of how you work with the piconfig utility.
-
Open a command window and enter the command:
piconfig
-
The piconfig executable file is in the folder Program Files\PI\adm. You might want to include this folder in your PATH variable.
-
Access the table you want to work with by using the command:
@tabl tablename
-
Use the command to list available tables.
-
At any time, enter to see a list of available commands.
-
Set the required mode of operation by using the command:
@mode mode
-
Available modes are: Create, Edit, List, Compare, Convert and Delete.
-
Perform required tasks. See piconfig examples, for examples of what you can do with the piconfig utility.
-
To switch to working on another table, use this command again:
@tabl tablename
-
To end a piconfig session, use the command:
@exit
-
It is not necessary to use the exit command when you run piconfig in batch mode.
Note: piconfig commands begin with followed by four letters. Any additional letters are truncated when the command is parsed.