Distributed development in a team

Overview

Next Design allows you to split models and profiles into files for distributed development in a team.

The following describes how to use the following Next Design functions.

Next Design Functions	Overview
Splitting and merging model files	Splitting a model in a project into multiple model files allows parallel development in a team.
Register Model File	By registering a split model file in another project, you can share and edit the model file with another project.
Export Model File	By exporting a split model file, you can reuse some of the model in another project.
Partial loading of model files	By switching between automatic and manual loading for each split model file, you can prevent the loading of unnecessary model files and shorten the loading time of large-scale projects.
Splitting and merging profiles	By splitting a profile from a project, you can manage models and profiles separately.

Dividing and merging model files

Dividing into model files

To divide a model in a project into multiple model files, follow these steps.

Operation procedure

1. In the model navigator, select the model you want to divide into model files.
2. Execute the division into model files in one of the following ways:

• Click [Team Collaboration] > [File] > [Devide into Model File] from the ribbon.
• Click [Devide into Model File] from the context menu.

3. If you want to divide only one model into a model file, specify the file name in the [Devide into Model File] dialog.
   (If you select multiple models to divide into model files, you cannot change the file name)
4. Specify a save folder in the [Devide into Model File] dialog and press the [OK] button.
   The specified folder should be under the [Models] folder in the same folder as the project file.
5. Once split into model files, the model will have an icon representing the model file.
   The model will then be stored as an nmdl (for JSON format) or imdl (for database format) file in the specified folder.

note

• Only models that have the [Allow model file splitting] checkbox checked in the metamodel can be split into model files.
• If the [Devide into Model File] menu is disabled, check the metamodel definition for that model.

Integrating split model files

To integrate split model files into a project, follow the steps below.

Operation procedure

1. In the Model Navigator or Project Navigator, select the split model file.
2. Integrate the model file using one of the following methods.

• Click [Team Collaboration] > [File] > [Integrate Model File] from the ribbon.
• Click [Integrate Model File] from the context menu.

3. Check the message in the confirmation dialog and press the [OK] button.
4. When the model file is integrated into the project, the icon representing the model file disappears from the model.

Registering a model file

There are three types of model file registration:

• Register: Register the model file as a model in your own project.
• Import: Copy the model file into your own project and register it.
• Reference registration: Registers a model file to be shared and edited with another project.

The type of registration is determined by the storage location of the model file.

• Registration: [Models] folder in the same folder as the project file.
• Import: A folder different from [Models] folder. If you select [Import] in the dialog box that appears when specifying the folder.
  (The model file will be copied to the folder selected when registering the model file)
• Reference registration: A folder different from [Models] folder. If you select [Reference] in the dialog box that appears when specifying the folder.
  (The model file will be displayed directly under the [Model] folder)

Note

• Check beforehand that the project that created the model file you want to register reuses a modularized profile. If you are reusing a profile, refer to Profile Definition > Profile Operation > Output compatibility information to model file and set it to output compatibility information to the model file.
  For information on reusing profiles, refer to the following:
• Profile Definition > Profile Operation > Reusing Profile

To register a model file, follow the steps below.

Operation Procedure

1. Open the project to register.
2. Switch to [Project Navigator] in the selector at the top of the Navigator.
3. Select [Model] or a folder under [Model] displayed at the top level of the tree.
4. Register the model file in one of the following ways:

• Click [Team Collaboration] > [File] > [Register] from the ribbon.
• Click [Register Model File] from the context menu.

5. In the [Register Model File] dialog, select the model file (.nmdl or .imdl) and press the [Open] button.
6. If the selected model file is stored outside the [Models] folder in the same folder as the project file, the [Register Model File] dialog appears.
   In the [Register Model File] dialog, select [Import] or [Reference].
7. The model file is added to the project navigator, and the model is added to the model navigator.

info

• The file save format of the project to which the file is to be registered and the model file to be registered must be the same.

Warning

• The profile of the project to which you are registering must be the same as (or include) the profile that created the model file to be registered. If they are not the same, the design information will not be read correctly. You can check which design information can no longer be read in the warning message.
  
• If you are registering a model file as a reference, you must maintain a state in which the profile of the project that is sharing and editing that model file is the same as (or includes) it. If they are not the same, the design information of the model file will not be read correctly. If you save the project in this state, the design information saved in another project that is sharing the model file may be lost.
• For information on exporting and importing profiles, see the following.
• Profile Definition > Profile Operation > Operation Flow

Export Model File

To export a split model file from a project, follow the steps below.

Operation procedure

1. Switch to [Project Navigator] in the selector at the top of the Navigator.
2. In the Project Navigator, select the model file to export.
3. Export the model file in one of the following ways:

• Click [Team Collaboration] > [File] > [Export] from the ribbon.
• Click [Export Model File] from the context menu.

4. Select the destination folder and press the [Save] button.
5. The split model file will be exported and stored in the selected folder.

note

• To import the exported model file into another project, the profile must be the same.
• For details, see the following.
• Profile Definition > Profile Operation > Operation Flow

Moving a Model File

You can move the storage location of a model file in the Project Navigator. To move it, follow the steps below.

Operation Procedure

1. Switch to [Project Navigator] using the selector at the top of the Navigator.
2. Drag the target model file on the tree and drop it into the destination folder.

tip

• You can change the destination folder structure from the context menu of the folder under [Model] displayed at the top level of the tree.

note

• Folders that do not store model files registered in the project are not displayed in the Project Navigator.
  If you create a folder in the project navigator but do not store a model file in it, the folder will not be displayed the next time you open the project.
• Reference registered model files cannot be moved in the project navigator.
• Save the project after changing the hierarchy or name of the model file.
  If you close the project without saving, the change in the model file path will not be saved, and the model file will not be loaded the next time you open the project.
• Moving a model file, renaming a file, or deleting a folder cannot be undone.
• If you move a model file with a tool other than Next Design, the model file will not be loaded.

Partially loading a model file

Setting a model file to manual load

To set a model file to manual load, follow the steps below.

Operation procedure

1. In the project navigator, select the model file you want to switch to manual load.
2. From the context menu, select [Load Configuration] > [Set Manual Load].
3. An icon indicating manual loading appears to the right of the model file node.
4. The next time the project is opened, that model file will no longer be loaded automatically.

Returning model file to autoload

To return a model file to autoload, follow the steps below.

Procedure

1. In the project navigator, select the model file you want to switch to autoload.
2. From the context menu, select [Load Configuration] > [Set Auto Load].
3. The icon indicating manual loading disappears from the right of the model file node.
4. The next time the project is opened, that model file will be loaded automatically.

Loading a model file set to manual loading

When you open a project, model files set to manual loading are in an unloaded state. To manually load an unloaded model file, follow the steps below.

Procedure

1. In the project navigator, select the model file you want to manually load.
2. Select [Load Model File] from the context menu.
3. The model file will be loaded.

tip

• Model files set as manual nodes are marked with an "M" icon in the project navigator.
• Model files that have not been loaded are marked with a grayed-out model file name in the project navigator.

• The following operations can be performed on all model files under a folder in the project navigator at once.
• Load Settings
• Load Model File
  This operation is performed from the folder's context menu.

Reference

• For details on partial loading of model files, see the following:
• Reference > Partial Loading of Model Files

Dividing and Merging Profiles

Dividing a Profile from a Project

To divide a profile into files, follow these steps:

Operation Procedure

1. Switch to [Project Navigator] in the selector at the top of the Navigator.
2. Select [Profile] displayed at the top level of the tree.
3. Click [Devide into File] from the context menu.
4. Once the profile has been divided into files, it will be stored as .nprof or .iprof files in the [Profile] folder in the same folder as the project file.

Warning

• Do not replace a profile split into files (.nprof or .iprof file) with a profile edited in another project.
• When reflecting a profile from another project, follow the instructions below.
• Profile definition > Profile operation > Operation flow

Integrate a profile split from a project

To integrate a profile into a project, follow the steps below.

Operation procedure

1. Switch to [Project Navigator] in the selector at the top of the Navigator.
2. Select the profile split into files.
3. Click [Integrate into Project File] from the context menu.
4. When the profile is integrated into the project, the .nprof or .iprof file in the Profile folder is also deleted.