How to select a project version at start-up
PcVue's command line arguments allow you to select a particular version of a project or library at start-up on a given computer in your system. These command line arguments are used with the Central project management which is a tool that helps you create and maintain version of your PcVue project. To use the command line arguments at start up, you have to configure the Central project management and the project versions. Refer to the topic How to manage project and library versions to learn more.
PcVue always runs a local copy of the project. When and if necessary, the project or libraries are copied from the central storage to the local file system at startup.
When using Central project management it is essential to make sure that the time is synchronized on all the stations involved.
The following command line arguments can be used to control the project version at startup:
Argument |
Description |
-r or -r_delta |
Starts using the REF version. |
-preref |
Starts using the PREREF version. |
-x |
Allows the interactive user to select any OPE or REF version at startup. As the use of -x require user interaction at startup, it must not be used when running PcVue as a Windows Service with Central project management. |
-d |
Allows the interactive user to select any version at startup. Example: [InstallDir]\bin\sv32.exe -d As the use of -d require user interaction at startup, it must not be used when running PcVue as a Windows Service with Central project management. |
-d tag_proj=myProjTag [tag lib=myLibTag] -d tag_lib=myLibTag [tag_proj=myProjTag] |
Starts the version of the project and libraries specified by the associated tags. If tag_lib or tag_proj is omitted, the local project or libraries are used. In case the specified tag is not associated to any project or library version, a message is logged in the Event viewer. |
In all cases, if the version corresponding to the command line argument or choice of the user is not available locally, it is first downloaded from the central store before proceeding with the actual project startup.
Using the -r or -r_delta command line argument
The -r or -r_delta command line arguments force a start with the Reference version (REF) of the project and libraries (if any). It is designed to be used on runtime stations in production.
No version selector dialogs are displayed. On startup, the local project's version number and creation time are checked against that of the reference project in the central versions folder. The following actions are then taken:
- If the local and reference versions are different, i.e. if the version information in the local INFOS.DAT is different to that of the reference project in the central versions store.
- If using the -r switch the entire reference project is copied from the central storage to the local station.
- If using the -r_delta switch only those files that have changed are copied from the reference project in the central storage to the local station. This may take some time, as each file is compared in turn.
- If the local and reference versions are the same, the local version is used.
- If there is no reference version, the local version is used.
The central INFOS.DAT file is only updated when using the Central project management dialog to create a new version or update an existing version. It is not updated in any other circumstance. Modifying the local project without then using the Central project management dialog does not update the local INFOS.DAT file.
Using the -preref command line argument
The -preref command line argument force a starts with the Pre-Reference version (PREREF) of the project and libraries (if any). It is designed to be used on validation stations prior to deployment in production.
No version selector dialogs are displayed. On startup, the local project's version number and creation time are checked against that of the pre-reference project in the central versions folder. The following actions are then taken:
- If the local and pre-reference versions are different, i.e. if the version information in the local INFOS.DAT is different to that of the pre-reference project in the central versions store, the version is copied to the local project folder.
- If the local and pre-reference versions are the same, the local version is used.
- If there is no pre-reference version, the local version is used.
When a version is copied from the central project store to the local project folder, the folders of the selected project are copied to a local temporary storage then the required folders are copied to the local station's project storage, overwriting the previous one if any. In case the copying fails, a network error message is displayed.
If the file system is damaged or the storage space is full, an error message is displayed. Any copies made are deleted, the previous folders are restored, copies with the '.OLD' suffix are deleted, and the original project is started.
If the error message is ignored, start-up may continue on a version of the project other than the one intended.
Using the -x command line argument
The -x command line argument causes the project version selection, and library version selection, dialogs to appear at start-up. The dialogs display information about the version currently available in the local project folder plus a list of the Operational (OPE) and Reference (REF) versions available in the central folder.
- The Project Version Selector dialog opens first. You can check the local project version details in the upper pane.
- Select a version from the list and click the Download button. The version is copied to the local project folder.
- Click Next to copy libraries or Start to start without selecting a library version.
- If you have clicked Next, the Libraries Version Selector dialog opens. You can check the local version of the libraries in the upper pane.
- Select the required version from the list and click the Download button. The version is copied to the local folder. A time-bar shows the progress of copying the files.
- Click the Startup button. The start-up process continues with whichever versions of the project and/or libraries are now loaded.
To use the existing local version of the project and libraries, click the Startup button of the selector dialog. Start-up continues using the local version of the project and libraries.
Using the -d command line argument
Using the -d command line argument, without including a particular version, has similar behavior to the -x switch except that development versions (DEV) and pre-reference version (PREREF) of the project and libraries can be selected as well as reference and operational.
Using the -d command line argument with a specific version, for example -d "proj=1.0.0, lib=1.0.0", causes that version to be copied to the local project folder and started without any dialog boxes being displayed.
When using the -d command line argument, you can either omit the proj or lib parameter. For example, you can use the argument -d "proj=2.3.1" to start the project version 2.3.1 along with the libraries already available locally, or the argument -d "lib=1.2.5" to start the project already available locally along with the libraries version 1.2.5.
You can use the -d command line argument with tags instead of a specific version Id. Tags are like labels that you can associate to a version and add to the -d command line argument when attempting to start up a project. PcVue will start the version with a tag matching the one you put on the command line.