Publish to Teamwork

Publish your changes to Teamwork from Development Studio. Publishing makes your updated model available in Teamwork.

Note: Only users with Teamwork Publisher role are able to publish to Teamwork.

Before you start

Confirm your Teamwork connection is configured in Development Studio. In Entitlements, configure the Teamwork server URL and a Teamwork API key, then verify the connection. Only a Development Studio administrator has access to configure or edit this connection. For more information, see Configure AVEVA Teamwork.

To publish to Teamwork

1. In the editor, select Publish to Teamwork.

   The Publish to Teamwork confirmation dialog appears.

   

   Note: If publishing will delete or relocate existing entities in Teamwork, a warning banner displays 'Your changes will result in the deletion and/or relocation of existing entities with Teamwork.' You must acknowledge this warning to proceed.

2. Select I agree to continue.

3. Select Publish.

   A notification confirms that publish to Teamwork was successful and you are redirected to the Project versions page.

   Here you:

   • Check the Status / actions column for your published version. If the publish was successful, you will see a Publish to Teamwork successful status.

   • Select Download report button to review the details of your publish operation. The report provides a summary of the publish process for that version. For more information on the report, see View publish report

     Note: All changes and failures are written to a downloadable report and an entry is added to your CONNECT Audit Log.

Understand publish statuses

Use the Status / actions column on the Project versions page to track the current state.

• Teamwork edit in progress: Editing session active. Only the user who started the editing session has access to edit or publish. An administrator who is also a Teamwork publisher has access to take over a session if needed.

  

• Publish to Teamwork successful. The version was published and the report is available for download.

  

• An error has occurred. Select Download report button to review the error details.

  

Throttling

Development Studio uses AVEVA Teamwork APIs, which are rate limited to help prevent denial of service attacks on the server. Development Studio uses its own throttling system to manage publish and retrieval operations and reduce the risk of triggering rate limits on the Teamwork server.

For best results, use a dedicated API key for Development Studio. If you are working with multiple models in Teamwork, consider using more than one API key.

Throttling errors may still occur if multiple large publishes are made to a Teamwork server at the same time, especially when using the same API key. If a throttling error occurs during publish, the affected items will be listed in the publish report. You can retry the publish operation to attempt these items again.