Linkage with SCM system

Overview

Next Design integrates with Subversion, a configuration management system, allowing you to complete a series of file operations on the configuration management repository using the Next Design UI.

The following describes Next Design operations in conjunction with the configuration management repository, in the following order:

• Retrieve and open a project from the repository
• Obtain editing permissions and start editing
• Revoke editing permissions
• Retrieve the latest version from the repository
• Undo changes and revert
• Commit changes and update the repository
• View the commit log
• Register a project with the repository
• Manage the repository to be used

note

• Please prepare the configuration management repository to be integrated with Next Design in advance.

Retrieving and Opening a Project from the Repository

To retrieve and open a project from the repository, follow these steps from the Next Design start page:

Procedure

1. Click [Start] > [Open a Project from the repository...] to display the [Repository Selection] dialog.
2. Select the repository where the project is stored using one of the following methods and click the [Next] button.

• If you are using a configuration management repository for the first time in Next Design, or if the configuration management repository where the project is stored is not registered, register the repository using the following steps:
  (1) Select [Register a new Repository] and click the [Next] button.
  (2) Enter the connection information for the configuration management repository and click the [Next] button.
  
• If the configuration management repository where the project is stored is already registered, select that repository and click the [Next] button.

3. Select the project file to retrieve using one of the following methods:

• Select a project from the project list displayed on the [Select Project File] tab.
• Switch to the [Select from Folder] tab and select the folder containing the project file (.nproj) from the displayed folder tree.

4. Specify the destination folder for the project file in [Check out to] and click [Check out].
5. If the project file is successfully retrieved, it will open.

caution

• Please specify an empty new folder as the destination folder.

Obtaining Editing Permissions and Starting Editing

To obtain editing permissions and start editing, follow these steps:

Procedure

1. Select the project or model file to start editing using one of the following methods:
   

• Select the file in the Project Navigator.
• Select the project or model in the Model Navigator.

2. Begin editing using one of the following methods:

• Click [Team Collaboration] > [Edit] > [Get edit permission]/[Get Edit Permission below Selected Model]/[Get all edit permission] from the ribbon.
• Click [Get edit permission] from the context menu.

3. Once editing begins, the model file icon will change, and "[(You are editing)]" will be appended to the model file in the Project Navigator.

Releasing Edit Permissions

To release editing permissions, follow these steps:

Releasing Editing Permissions for a Specified File

Procedure

1. Select the project or model file from which you want to release editing permissions using one of the following methods:
   
   • Select the project or model in editing mode in the Model Navigator.
   • Select the file in editing mode in the Project Navigator.
   • Select the file in editing mode in the Configuration Management Navigator.
2. Release editing using one of the following methods:
   • Click either [Team Collaboration] > [Edit] > [Release edit permission] or [Release Edit Permission below Selected Model] from the ribbon.
   • Click [Release edit permission] from the context menu.

To remove edit permissions for all files at once

Procedure

1. Click [Team Collaboration] > [Edit] > [Release All Edit Permission] from the ribbon.

Note

• If you remove edit permissions without committing changes from the configuration management navigator, the modified files will remain, resulting in an inconsistency with the repository.
• To revert to the repository, follow the instructions in "Undo Changes" below to revert the changes.

Retrieving the Latest Version from the Repository

To update files previously retrieved from the repository to the latest revision, follow these steps:

Checking if it has been updated since the last time it was retrieved

Instructions

1. From the ribbon, click [▼] at the bottom of [Team Collaboration] > [Sync Repository] > [Get the Latest], and then click [Check for updates].

Updating all files to the latest revision

Instructions

1. Update to the latest revision using one of the following methods:

• Click the icon for [Team Collaboration] > [Sync Repository] > [Get the Latest] from the ribbon.
• Click [▼] at the bottom of [Team Collaboration] > [Sync Repository] > [Get the Latest] from the ribbon, and then click [Get All Files].

Updating a specified file to the latest revision

Instructions

1. Select the project or model file to update to the latest revision using one of the following methods:
   

• Select a project or model in the Model Navigator.
• Select a project file or model file in the Project Navigator.

2. Update to the latest revision using one of the following methods:

• From the ribbon, click [Team Collaboration] > [Sync Repository] > [Get the Latest], then click [▼] at the bottom and click [Update Selected File Only].
• Click [Get the latest version of selected File] from the context menu.

note

• Files that have been modified since retrieval are ignored, and other files are updated to the latest revision.

Undoing Changes and Reverting

To undo changes to uncommitted files and revert to the original revision, follow these steps:

To revert changes to all files

Procedure

1. Switch the navigator to the Configuration Management Navigator.

2. Click [Revert All] from the [Commit Target] context menu.

3. When the dialog box confirming project reloading appears, click the [Yes] button.

To revert changes to a specified file

Procedure

1. Switch the navigator to the Configuration Management Navigator.
2. From the [Commit Target] in the Configuration Management Navigator, select the file whose changes you want to revert.
3. Click [Revert This File] from the context menu.
4. When the dialog box confirming project reloading appears, click the [Yes] button.

Note

• Editing permissions have been removed for the file whose changes were reverted.
• To continue editing, you must obtain editing permissions again and start editing.
• Committed changes cannot be undone in Next Design.

Committing Changes and Updating the Repository

To commit changes to a file and update the repository, follow these steps:

:::note: Instructions

1. Save the modified file.
2. Switch to the configuration management navigator using one of the following methods:

• Click [Team Collaboration] > [Sync Repository] > [Commit] from the ribbon.
• Click [Change Navigator] from the selector at the top of the navigator.

3. Check the files displayed under [Commit Target]. By default, all modified files are checked as targets for commit. Uncheck any files you want to exclude from the commit.
4. Enter a commit message.
5. After entering the commit message, click the [Commit] button below the input field, or press the ctrl+enter key.
6. This updates the files in the repository and adds a commit log.

:::

tip

• If there are files that have been changed and saved but not committed, a mark will appear on the icon in the configuration management navigator.
• A change mark will appear on the icon of uncommitted files.

tip

• If you check the [Keep editable state] checkbox at the bottom of [Commit Target] before committing, you can continue editing each file while retaining editing permissions.
  (Editing permissions will not be maintained in the case of changes to the hierarchy or renaming of model files that change the file path.)
• By default, this checkbox is unchecked, and editing permissions are removed at the same time as committing.

Note

• Changed files will not appear in [Commit Target] until you save them.
• Please save before committing.
• If you are using Subversion, please commit each change when you modify the hierarchy or rename model files.

If you try to edit continuously without committing, a message will appear prompting you to obtain editing permissions for the necessary model files. However, even if you try to obtain editing permissions for the model files as instructed, you will get an error during the configuration management operation and will not be able to obtain them.

Please commit the changes once, or revert the changes before editing.

Displaying the Commit Log

To display the commit log for a file, follow these steps:

Procedure

1. Select the project or model file whose commit log you want to display using one of the following methods:
   • Select the file in the Project Navigator.
   • Select the project or model in the Model Navigator.
   • Select the file in the Configuration Management Navigator.
2. Display the commit log using one of the following methods:
   • Click [Team Collaboration] > [Sync Repository] > [Commit Log] from the ribbon.
   • Click [Show commit log] from the context menu.
3. The [Log Messages] dialog box will appear, displaying a list of commit logs for each revision.
4. The list of commit logs can be filtered by specifying the start and end dates.

Registering a Project to the Repository

To register a project that is not yet registered in the repository, follow these steps:

Procedure

1. Create a folder with the same name as the folder to be added to the repository, and move the project files and other related files into it. 2. Open the project file in Next Design.
2. From the ribbon, click [Team Collaboration] > [Repository] > [Registration to Repository].
3. Select the repository where the project will be stored using one of the following methods and click the [Next] button.

• If this is your first time using a configuration management repository in Next Design, or if the destination repository is not yet registered, register the repository using the following steps:

1. Select [Register a new Repository] and click the [Next] button.
2. Enter the connection information for the configuration management repository and click the [Next] button.

• If the destination repository is already registered, select that repository and click the [Next] button.

5. Select the destination folder for the project folder and click [Register].
6. If the repository registration is successful, the Configuration Management Navigator will become available as an option in the Navigator.

caution

• Please be sure to register the repository within Next Design.
• If you register to a repository using a Subversion client tool other than Next Design, Next Design's configuration management system integration function may not work correctly.
• Immediately after registering to a repository, you will have started editing all the registered files.
• If you do not intend to edit the repository immediately after registration, please revoke your editing privileges.

Managing the Repositories You Use

To register a configuration management repository in Next Design or to change registered connection information, follow these steps:

:::note: Instructions

1. Click [Team Collaboration] > [Repository] > [Repository Management] on the ribbon to display the [Repository Management] dialog box.

2. To register a new repository, click the [Add] button, then enter the repository connection information in the [Editing Repository Setting] dialog box and click the [Add] button.

3. To change the connection information of an already registered repository, select the registered repository, click the [Edit] button, edit the repository connection information in the [Editing Repository Setting] dialog box, and click the [OK] button.

4. To remove a registered repository, select the repository, click the [Delete] button, and then click the [OK] button in the confirmation message.

5. To confirm the above changes, click the [OK] button in the [Repository Management] dialog box.

:::