This section describes how to use the Used Projects Auto Update Wizard to configure and generate a properties file.

Prerequisites

  • The Used Projects Auto Updater plugin must be enabled in your modeling tool.
  • It is highly recommended to log in to Teamwork Cloud with a dedicated user. This is the only way to ensure that all dedicated user permissions are checked and the properties file is configured correctly.
  • Projects within the update path will require these permissions: Administer Resources; Edit Resource; Edit Resource Properties; Read Resources. However, the target used project only needs the Read Resources permission.

    Example: If you have projects: A, B, and C and these projects are in use as follows A->B->C (project A is using project B; project B is using project C). To update project B to the latest version, you only need the Read Resources permission for project B and the Administer Resources, Edit Resources, Edit Resource Properties, and Read Resource permissions for project A.

    However, to update used projects B and C, you need the Administer Resources, Edit Resources, Edit Resource Properties, and Read Resources permissions for projects A and B. You will need only the Read Resources permission for project C.

After the plugin is enabled in the Project Usages dialog you will see a new button:  Used Projects Auto Update Wizard . 


To generate a properties file with the Used Projects Auto Update Wizard

  1. Log in to Teamwork Cloud with the dedicated user.
  2. Open the project the used project of which you want to update. 
  3. In the main menu, go to Options > Project Usages.
  4. In the Project Usages dialog, click .
    In the opened Used Projects Auto Update Wizard dialog, you can see the username you are logged in with. This user will be set up in the properties file to automatically update used projects.
  5. Depending on your authentication type, fill in the following boxes:
  6. Click the Next button.
  7. Select directly and indirectly used projects you want to update. The values listed in the Status column show whether or not a used project can be updated.

    To see where the selected used project is used, click the Project Usage Information button. This will help to find update paths. An  update path is a path of projects that must be updated in order to update a certain used project.

    The plugin does not update used projects that are involved in cyclic dependencies.




  8. Click the Generate button to create the properties file that can later be used in the command line tool. 

Possible errors and warnings with explanations

Warning: Causes version conflict with at least one used project.

This warning indicates that in this project, there is at least one other unselected used project that is using the same project. In order to achieve consistency on the model, we recommend updating all used projects that use this particular project.

ERROR: Cannot be updated due to insufficient permissions.

This error indicates that the user who is logged in does not have enough permissions to update this particular project. Please add required permissions for the user in order to update this project.

ERROR: Cannot be updated due to read-only using project

This error indicates that the used project is being used in a read-only project (e.g. public branch); thus, we can not commit a new version of a read-only project in order to update the selected project. Please use this project directly or in another project with a branch for which the user has read-write permissions.

ERROR: Cannot be updated due to cyclic usage.

This error indicates that the used project has cyclic dependencies between projects. Please remove any used projects from this used project that would cause a cycle between projects.

ERROR: Cannot be updated due to missing update path.

This error can appear on indirectly used projects due to a missing update path. An  update path is a path of projects that must be updated in order to update a certain used project. The following example explains this term:

An example

A Main Project uses project A. Project A uses Project B. In order to update Project B in the Main Project, we are required to update Project B in Project A first and then update Project A in the Main Project. Thus, the update path for Project B is: Main Project > Project A.