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 folder.

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

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 FTH_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. While these libraries cannot be removed from the available list, 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 files 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 files that will store the shared information. These files, referred to as library files, can contain data on pipe materials, components (e.g., pumps, valves, etc.), fluids, and other relevant information. Library files can be created using the following methods:

• Use the Create New Library button in the Library Manager, as described earlier. Data can be sourced from the current model or other libraries.

• Copy and paste sections from one file into another using a text editor.

This discussion focuses on the first two methods. In this scenario, it is assumed that a network library administrator has already created a new pipe material and that the objective is to establish a network-wide library to store this material.

To create the library file, copy the material data from the Local User Library (XTR_User#.DAT, where # represents the version number) to a new file using the Library Browser in the Library Manager. Follow these steps:

1. In the Library Browser, select Local User Library as the source library.

2. Select Pipe Materials from the available categories.

3. Click Create New Library, then enter a file name (e.g., VailMaterials.dat).

4. Provide a description for the library. This description should clearly indicate the library’s contents for xStream users. For this example, use "Vail Resort Materials" as the description.

5. In the Local User Library, right-click the Pipe Materials section and select Copy Content to copy the pipe materials into the new library file.

The pipe material library file is now created and ready for use.

Sharing Library Files Using DATABASE.LIB

After creating the library file for Pipe Materials, it must be made available to xStream users. The library files can be categorized into one of two groups based on their scope of use:

• External Library - Used locally by a single user.

• External Shared Library - Shared among multiple users over a network.

1. Designating the Library as an External Shared Library

In this example, the goal is to share the library file, so it must be designated as an External Shared Library. This requires listing it in the DATABASE.LIB file within the xStream directory on the network.

However, for security reasons, xStream does not write directly to network files. To facilitate this process, the file is initially treated as a local External Library, which is listed in the XTR_DBUSER.LIB file located in the local user directory on the workstation.

2. Copying the Library File to the Network

To ensure accessibility, it is recommended to store External Shared Library files on a network server in a subfolder within the xStream directory. A suggested path is: AFT Products\AFT xStream\Libraries

Alternatively, the files may be placed in any network location accessible to users. In this example, the pipe material library is placed in a Libraries subfolder on the network.

Best Practice: Copying the file to the network location before making it available in xStream simplifies path configuration and ensures proper accessibility through the Library Manager.

3. Adding the Library to xStream

Once the library file is in the designated network location, follow these steps to add it to xStream:

1. Open Library Manager in xStream.

2. Navigate to the Library Browser.

3. Click Add Existing Library and browse to the file.

4. Click OK - the library description will now appear in the Available Libraries list.

5. Click Close - this automatically updates the XTR_DBUSER.LIB file in the local user directory.

4. Configuring File Paths for Network Access

To ensure all users can access the library, paths must be configured correctly. When a library is added, xStream writes the full path to XTR_DBUSER.LIB. If a mapped drive letter was used when browsing to the file, the path will include that letter.

However, if other users have mapped the xStream folder to a different drive letter, they will not be able to locate the library files.

Alternative Path Options:

• Use a Network Path - Instead of a mapped drive, specify the network computer name (e.g., \\NetworkServer\EngApps\AFT Products\AFT xStream\Libraries\filename.dat).

• Use Relative Paths - Manually edit the paths in the library listing file to ensure they are relative to the xStream folder where the executable is stored.

To automatically configure xStream to use the computer name:

1. Select Network Neighborhood in the file browser.

2. Navigate to the appropriate computer.

3. Browse to the library file.

If using relative paths, manually adjust them in the library listing file.

5. Moving the Library Listing to the Network

When the pipe materials library is added, it is initially listed as an External Library in FTH_DBUSER.LIB. To make it accessible to all users, follow these steps:

1. Move the listing from the local machine to the xStream folder on the network.

2. Rename the listing file to DATABASE.LIB.

Once this process is completed, all users will have access to the shared library file.

Connecting to the External Shared Libraries

After the libraries are placed on the network and made available to all xStream users, 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.

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.