Certain file types, such as MicroStation files, AutoCAD files, and Word files, can reference other files. Files that reference other files are called master files. The files referenced by master files can be manipulated separately or reused.
The relationships between these reference files and master files are tracked to keep the files associated during check in, check out, viewing, and other operations. This tracking is managed by creating reference relationships between the files. Reference relationships are created between files when a master document is created and files are attached and when the master file is checked back in after a checkout. These relationships are created because the user can add or delete reference files while the master file is checked out.
You can also use the Web Client to manage master files, reference files, and their
relationships. For more information, see Reference files and relationships.
When a file is attached or checked in, SmartPlant Markup Plus reads the headers of all files, extracts the reference file names, and supplies the reference file names to the Desktop Client. As a result, relationships defined in the native application are honored.
SmartPlant Markup Plus must be installed on the SmartPlant Foundation server for reference file relationships to be created.
When a user checks out or views files that have references, copies of the reference files are provided to the user's computer along with the master file.
Reference files can contain links to other reference files. The system administrator can configure the system to process these nested reference files while checking in, checking out, viewing, and other operations on the master file. The maximum number of nested reference files allowed in these operations is set in the User Preferences. For more information, see Change user preferences.
The system administrator can also configure the system to allow files to reference themselves or to reference each other in a cyclical relationship. Document A can reference document B, and document B can reference document A. These relationships can be created by dragging reference files onto the files they reference.
In the following example, the Document C document is a reference file of Document B, which in turn is a reference file for Document A. However, Document A is also a reference file for Document C.
-
If the file you are attaching references other files and those files are already in the system, the software automatically creates relationships between the file and the reference files.
-
If the file you attach references files that are not in the system, the software displays an error message to let you know that the referenced files do not already exist. You can create the relationship to the reference file later after it has been added to the system.
-
To delete a reference file that was attached to a master file that was deleted, right-click the document and select Refresh.
Allows you to choose what version of a reference file is associated with the master document.
Name - Displays the name of the master document and a list of any reference files associated with it.
Parent Revision Name - Displays the name of the parent revision.
Update Reference Relationship To - Select the version of the reference file to which you want to create a relationship for the master document. You can choose from the out-of-date version, the latest released version, or the latest working version of the reference file.
Out of Date Revision - Displays the name, revision, and version number of the superseded version to which the master file is currently related.
Latest Released Revision - Displays the name of the latest revision that was released for distribution.
Latest Working Revision - Displays the name of the latest revision that has been created but was not yet released for distribution.
Reference Control - Indicates the option selected for managing the relationship between the master file and this references file. This field is display only.
You must select the Show all items on update references dialog option on the General tab of the Change User Preferences dialog box to view the files with reference relationships in the Update Reference Relations dialog box.
-
If Show all items on update references dialog option is set to True, the files with reference relationship of Always Fixed is displayed as inactive, while files with the reference relationships such as Always Update, Prompt Update and Always Update Working Revisions are displayed as active or inactive depending on their reference relationships with the master document.
-
If Show all items on update references dialog option is set to False, the Update Reference Relations dialog box does not display the files with up to date reference relation and the files which do not have up to date reference relation with their Master documents are displayed as active.
-
If Show all items on update references dialog option is set to False, the Update Reference Relations dialog box does not display when all the files have up to date reference relation with their Master documents.
What do you want to do?