Working with external programmers
If you work with people outside your company, they sometimes need to access your files and make changes to them.
In versiondog, all external personal are referred to as suppliers. The term refers to all persons who are not employees and therefore were not created as users in your versiondog user. administration.
It is possible to integrate external vendors into the versiondog workflow for editing programming projects, even if they are not versiondog users on your system. Use supplier Check-Out and SmartImport for supplier projects if you want to retain all the organizational benefits of versiondog (centralization, documentation, version history, avoiding two people working on the same project at the same time, etc) but do not want to include an external contractor as a versiondog user on your system.
Exporting projects from the versiondog system for editing by an external software engineer
- Start the UserClient and select the component that you want to export. Then click on Check-Out
- The dialogue Check-Out will open
- As with every Check-Out, you transfer the files you want to export from the area Components on the server to the area Selected components using the > button
- Check the checkbox Supplier Check-Out (user-defined target directory) in the section Selected components
- These three additional checkboxes will be displayed:
- Check the checkbox Compressed if you want your files compressed as ZIP files.
- Check the checkbox Use project tree directory structure if you want to keep the access path. We recommend using this step if you want to check out more than one component.
- Activate the checkbox Show target directory in file manager after Check-Out to automatically open the target directory in the file manager after Check-Out.
We strongly recommend using Lock for other users when you Check-Out projects to be sent to external programmers
Each project checked out for an external vendor using Supplier Check-Out is accompanied by the files SupplierChangeReason.txt and SupplierComment.txt. These files are for the vendor to enter the text that will be entered into the change history in versiondog on re-import.
Each project is also accompanied by a file SupplierDeliveryNote.vdog-sdn - do not delete this file or it will not be possible to re-import using SmartImport.
SmartImport for supplier projects only works for projects that have been checked out via the supplier checkout and re-imported using the SupplierDeliveryNote.vdog-sdn file. Additionally, the component, into which the project files are to be imported, need to be checked out, i.e., available locally, at the time of the import.
We recommended that suppliers return project files either in a folder named "ProjectData" or in a ZIP archive "ProjectData.zip".
Re-importing projects into the versiondog system after editing by an external software engineer
- Start the UserClient and then go to the Home tab and click on SmartImport for supplier projects
- The dialogue SmartImport for supplier projects will then appear
- In the section supplier projects, click on Add, and then select the directory containing the projects that you want to import. This needs to be the directory where the SupplierDeliveryNote.vdog-sdn file created during check-out is located.
Check the checkbox in the import column for the projects you want to import
If you want to see what the external engineer has changed before you import, go to the right of the dialogue and click on one of the comparison options:
- Differences: supplier data <-> original version: The differences between the component provided by the supplier and the version that was originally issued to the supplier are displayed.
- Differences: supplier data <-> working directory: The differences between the component provided by the supplier and the content of your working directory are displayed.
- Differences: Working directory <-> last version: The differences between the state of the component in the working directory and the current version of the component are displayed.
Initially, the checkbox Differences: Supplier data <-> original version will be displayed. The other options can be selected via the arrow in a drop-down list.
When you are ready to import, go to the bottom-right of the dialogue and click on one of the following import options
Initially, the checkbox Create versions will be displayed. The other options can be selected via the arrow in a drop-down list. If an option has already been selected, it will be displayed directly during the next import.