Creating an Enterprise-Wide Network Library System

Overview

xStream users on a network can access shared libraries to simplify model verification, enhance analysis and reporting consistency, and eliminate redundant work. Initial setup is required to enable this functionality.

• Create and Save Data Files - Data for components, materials, formats, and other necessary elements must be created and stored in various data files.

• Make the Files Available - These files must be made accessible to xStream users by creating a file named DATABASE.LIB in the xStream installation folder.

• Connect to the Libraries - Users must connect to the newly listed libraries and select the relevant sections to use.

• Protect the Libraries (Optional) - To prevent users from modifying shared libraries at the operating system level, the library .DAT files can be designated as Read Only Libraries.

Each of these steps is explained below. To maintain data integrity and control, it is recommended that a designated individual be responsible for creating and managing the network libraries. The following discussion is presented from this individual's perspective.

Internal and External Libraries

Table 1 shows the relationship between Internal and External Libraries, as well as the library file structure that xStream uses to locate these libraries.

• External Libraries - Any library file created by a user and listed in XTR_DBUSER.LIB, located in the local user directory. These libraries can be connected or disconnected using Library Manager and may reside on any local or mapped drive. External libraries are fully controlled by the local user.

• External Shared Libraries - Libraries that are common to all xStream users on the network. Files listed in DATABASE.LIB are treated as read-only by xStream; users can connect to and use these libraries but cannot modify their contents from within the application. These libraries cannot be removed from the available list, but they can be connected or disconnected using Library Manager.

• Special Libraries - xStream also includes two special Internal Libraries: the Default Internal Library and the Local User Library. These are xStream Internal Libraries which cannot be disconnected or made unavailable.

By following the setup process and understanding the different types of libraries, organizations can ensure efficient data management and streamlined collaboration within xStream.

Creating Library Files

To begin, create the library file that will store the shared information. Library files can contain data on pipe materials, components (e.g., pumps, valves), fluids, and other relevant information.

In this scenario, the objective is to create a pipe material library for use across the network. Follow these steps:

1. In the Library Manager, click Create New Library.

2. Enter a file name for the library (e.g., VailMaterials.dat) and save it to a local working location.

3. Provide a description for the library. This description will appear in the Library Browser for all users. For this example, use "Vail Resort Materials."

4. Open the pipe material editor via Edit Pipe Materials and confirm that the new library is selected as the active save destination before creating or saving any materials.

5. Create the required pipe materials. All new materials will be saved directly to the new library file.

Note: If the pipe materials already exist in the Local User Library (XTR_User#.DAT), use Move Content - not Copy Content - to transfer them to the new library. Copying retains the materials in XTR_User#.DAT, which can cause duplicate warnings and ambiguity about the source of the data.

6. Close xStream before proceeding to the next step.

Sharing Library Files Using DATABASE.LIB

After creating the library file, it must be made available to all xStream users on the network. This is done by moving the file to a shared network location and listing its path in a file named DATABASE.LIB.

1. Move the Library File to the Network

Move the library .DAT file from its local working location to a network location accessible to all xStream users. A suggested path is:

\\NetworkServer\EngApps\AFT Products\AFT xStream\Libraries

Alternatively, the file may be placed in any accessible network location. Using a UNC path (beginning with \\) rather than a mapped drive letter is recommended - this ensures that all users can locate the file regardless of how their network drives are mapped locally.

2. Create or Edit DATABASE.LIB

DATABASE.LIB is a plain text file that lists the paths to all External Shared Libraries. xStream reads this file at startup and makes the listed libraries available to all users. It must be placed in the xStream installation folder (e.g., C:\Program Files (x86)\Datacor\xStream #\).

If DATABASE.LIB does not already exist, create it as follows:

1. Open Notepad.

2. Type the full UNC path to the library file. For example: \\NetworkServer\EngApps\AFT Products\AFT xStream\Libraries\VailMaterials.dat

3. In Notepad, go to File > Save As. Set Save as type to All Files (*.*), enter the filename DATABASE.LIB, navigate to the xStream installation folder, and click Save.

Important: If Save as type is left as Text Documents, Notepad will save the file as DATABASE.LIB.txt, which xStream will not recognize.

To add additional shared libraries in the future, open DATABASE.LIB in Notepad and add each additional file path on a new line.

3. Remove the Local Library Reference from Library Manager

Because the library .DAT file has been moved from its original local location, any existing reference to the old path in Library Manager will be broken. Open the Library Manager, locate the old reference in the Library Browser, and disconnect and remove it.

Connecting to the External Shared Libraries

After the libraries are placed on the network and DATABASE.LIB is configured, each user must connect to the libraries and activate the necessary sections. In the Library Manager, External Shared Libraries appear in the Library Browser. To connect a library, select its checkbox. To use specific sections within a library, ensure their checkboxes are selected. A library can be connected without any active sections.

To retain these connections each time xStream starts, select Set As Default. To apply these settings to an existing model, open the model, go to the Library Manager, and select User Default. If a default has been set, the connections and settings are applied automatically.

Protecting Shared Libraries from Modification

Files listed in DATABASE.LIB are treated as read-only by xStream. Users can connect to these libraries, view and use their contents in a model, and copy content out - but write operations are not available from within the application. In the Library Browser, these libraries are displayed with a gold highlight to indicate their read-only status.

For an additional layer of protection at the operating system level, the library .DAT file can be set as read-only using the Windows file attribute. This prevents the file from being modified directly in File Explorer by users who have access to the network location, independent of xStream's own enforcement.

To set the Windows read-only attribute:

1. In Windows File Explorer, navigate to the library .DAT file on the network.

2. Right-click the file and select Properties.

3. Under the General tab, check the Read-only checkbox.

4. Click OK.

Note: Libraries listed in DATABASE.LIB will reappear in the Library Browser after each application launch even if a user removes them, because removing a library from the Library Browser list does not modify DATABASE.LIB.

For a full description of Read Only Library behavior, see Library Browser.

Sharing Model Formats/Preferences

Previously, the Library Manager included an option to share format and preference settings, such as Output Control layouts, within shared libraries. These files can still be shared but are no longer managed through the Library Manager. Instead, format files must be loaded directly through their respective control windows. For example, an Output Control format must be loaded in the Output Control window.