AECOsim V8i (SELECTseries 4) Deployment Guide: V8i Managed ... · This document: is intended to provide recommendations and implementation guidance for integration of the AECOsim
This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace
AECOsim Building Designer V8i (SELECTseries 4) Deployment Guide: ProjectWise V8i Managed Workspaces Version 2.2 – May 2013 AECOsim Building Designer V8i (SELECTseries 4) with ProjectWise V8i (SELECTseries 4) or later:
Deployment Guide Intro:
This document: is intended to provide recommendations and implementation guidance for integration of the AECOsim
Building Designer V8i (SELECTseries 4) into a ProjectWise Environment.
is a supplemental document to the "ProjectWise Implementation Guide” and the help documentation provided by ProjectWise Administrator and ProjectWise Client and while it shares common concepts and instructions with those documents, this document is intended to provide the best path to integrate AECOsim Building Designer V8i with ProjectWise.
will focus on topics concerning ProjectWise application definition, workspace integration and Project association. Please refer to ProjectWise documentation for topics not addressed.
should not be used to configure legacy building applications such as Bentley Architecture (BA), Bentley SpacePlanner (BSP), Structural Modeler (formally Bentley Structural (BS)), Bentley Building Mechanical Systems (BBMS), and Bentley Building Electrical Systems (BBES). For information on integrating those applications into ProjectWise, please refer to “Bentley Building Application Deployment Guide: ProjectWise Managed Workspaces”, Version 1.7.
Restriction and Limitations of integrating Building Application in a ProjectWise Managed workspace
AECOsim Building Designer V8i (SELECTseries 4) is compatible with a ProjectWise Integration Server V8i (SELECTseries 3) or (SELECTseries 4) and requires a ProjectWise Explorer Client (SELECTseries 4)
If you have an existing ProjectWise Manage workspace deployment of AECOsim Building Designer V8i (SELECTseries 3) , Please note: The AECOsim Building Designer V8i, (SELECTseries 4) datasets are not backwards compatible with AECOsim Building Designer V8i (SELECTseries 3). Therefore, we encourage user to create a new and separate workspace and dataset dedicated for use with AECOsim Building Designer V8i (SELECTseries 4)
The Trane Ductulator and the RAM Viewer have not been ProjectWise integrated and may not benefit from ProjectWise Managed Workspaces.
The Electrical portion of AECOsim Building Designer will have the following limitation in a ProjectWise
fully managed workspace. o Only one symbol library can be used in a project (specified by the BBES_MWS_SYMLIBNO
variable). If additional libraries are stored in the database they will not be visible. o Selected symbol library is available in read only mode. o No additional symbols or symbol subtypes can be created or existing ones modified. o Bidirectional Interface with Visual will not be able to update subtype definitions when lights are
imported from Visual Professional. o No additional cable types can be defined o No additional tag styles can be defined or existing ones changed
AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace
The Electrical portion of AECOsim Building Designer can be configured in a “hybrid” managed workspace if more flexible configuration is required. However, “hybrid” managed workspaces are not covered in this general deployment document and it is recommend that users consult with the Bentley’s Building Professional Service Group for assistance.
Some AECOsim Building Designer Utilities (Utilities> Building Designer Utilities) have not been ProjectWise integrated and may not be beneficial in a ProjectWise Managed Workspaces session. Those AECOsim Building Designer utilities will be automatically disabled in a ProjectWise integrated session of AECOSIM Building Designer.
ProjectWise V8i (SELECTseries 4) currently does not offer integration support for the 64‐bit version of Microsoft Office 2010 and is not supported with AECOsim Building Designer V8i using a managed workspace.
ProjectWise managed workspace does not support an offline or briefcase mode. PW manage workspace require an active connection to a PW server.
PW managed workspace is a thick‐client solution and is not supported with the ProjectWise Web Client (SharePoint Web parts)
When working with ProjectWise managed workspaces, it is recommended that users access files through the ProjectWise Explorer and not through application shortcuts in the start menu, quick launch toolbar, or desktop. These application shortcuts will open the application in an unmanaged mode and require the application to restart when opening a managed file.
The ProjectWise environment is encouraged to be configured for a "Captive" environment. (When working in integrated applications, the term captive environment refers to the state of integration when the user cannot save documents to or open documents from the local file system. They are “captive” to working in the ProjectWise environment. ) ‐Please consult your ProjectWise implementation team and/or administrators before configuring ProjectWise for a "Captive" environment.
For ProjectWise Managed Workspaces, ProjectWise administrators and users are encouraged to set the user option to "Leave Local Copy on check in". This will improve operational performance for large projects. If changes in files are detected, ProjectWise will synchronize as required.
Configuration files located in either the local workspace\standards directory or a centralized "Shared" workspace\standards directory are automatically processed and are incorporated as part of the ProjectWise Managed workspace. Diligence is required to ensure the configuration files contained within either of these directories does not contaminate the ProjectWise Managed Workspace Configuration.
ProjectWise and MicroStation are registered trademarks or trademarks of Bentley Systems, Inc., in the USA and other countries. All other brand names, product names, or trademarks belong to their respective holders.
AEC
COsim Buildin
Before Yo
A4)(Scoim PBin
InapP D Inafinpr Thdnco
ng Designer V
Copyrig
ou Begin
fully operatio) server and aSELECTseries orrespondingmplementatio
rojectWise Exentley Applicantegration for
nstall and conpplication worojectWise. U
esktop integrThe AE
ntegration witfter the instanstallation unrogram.
he ProjectWiialog when Aot required foonsult your P
Local Disk Space: In a ProjectWise Managed workspace, documents from the ProjectWise Server are downloaded to the local machine and made available to the intended applications. The local machine may require a significant amount of available disk space to accommodate several projects, dataset and other supporting documents. Once project documents are local, the exchange between the ProjectWise Server and the local machine are conducted using Delta file transfer. Delta file transfer is a ProjectWise technology that improves performance when sending large files over networks by only sending the changes needed to update the file, rather than the entire file. This local repository can easily be managed by the Local Document Organizer, found in Project Explorer (Tools> Local Document Organizer…).
AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace
In ProjectWise Administrator, under Workspace Profiles>Managed
In this step, you are going to complete the following tasks:
Create a new ‘Predefined’ level CSB for AECOsim Building Designer Electrical
Create a new ‘Predefined’ level CSB for AECOsim Building Designer called ABD_Workspace_Ss4
Create a new ‘Global’ level CSB called Global_Variables
Create a new ‘Project’ level CSB called Dynamic_Project
Create a new ‘Project’ level CSB called Dynamic_Dataset
Create a new ‘Project’ level CSB to support IFC Dataset Extensions (New is Ss4)
Edit ‘Project’ CSB File to support Project Data
If you are not familiar with creating/editing CSB files, please refer to the Addendum at the end of this document for a step by step guide that will walk you through the process of creating one.
Create a new ‘Predefined’ level CSB for AECOsim Building Designer Electrical (This CSB will define how the Electrical portion of AECOsim Building Designer to work with ProjectWise.) The Electrical portion of AECOsim Building Designer can be configured in several ways depending on the requirement for Electrical in your workflow. Regardless which method is utilized, it must be configured “correctly” as it is an integrated discipline within AECOsim Building Designer. We have included two integrations methods; Integrated or Local Electrical. Please implement only one option.
1. Integrated Electrical ‐ If your organization requires use of the electrical discipline within AECOsim Building Designer
2. Local Electrical – If your organization does NOT utilize the electrical discipline within AECOsim Building Designer, this configuration uses local resources versus ProjectWise resources, providing the minimum footprint and overhead for a ProjectWise manage workspace integration.
Method 1: Integrated Electrical
1. In ProjectWise Administrator , under Workspace Profiles>Managed>Predefined, right mouse click over the ‘Predefined’ Level and select New> Configuration Block
AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace
bles BBES Detce Support. Teen in the exc‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐nfiguration for Pr‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐_CFG) BBESDIR)/METADWS_METADATA))/RES/ SDIR)/SYMLIBS/_MWS_SYMLIBSWS_SYMLIBS)CSWS_SYMLIBS)VISS_MWS_SYMLIBS_IES) DIRPATH = 1ER_REDIRPATH
variables can n a “Hybrid” f ProjectWise
Managed W
ted| AECOsim
CSB
d Configuratio
Assignment
tailed configuThe detailed ccerpt from th‐‐‐‐‐‐‐‐‐‐‐‐‐ rojectWise Integ‐‐‐‐‐‐‐‐‐‐‐‐‐
1. In ProjectWise Administrator , under Workspace Profiles>Managed>Predefined, right mouse click over the ‘Predefined’ Level and select New> Configuration Block
Create a new ‘Predefined’ level CSB for AECOsim Building Designer called ABD_Workspace_Ss4 ‐ THIS IS A CRITICAL TASK!
(This CSB will make the vital connection between the CSBs and the ProjectWise datasource.)
1. In ProjectWise Administrator , under Workspace Profiles>Managed>Predefined, right mouse click over the ‘Predefined’ Level and select New> Configuration Block
2. In the New Configuration Block Properties, enter the name ABD_Workspace_Ss4 and the description ABD
Workspace (SELECTseries 4). Once complete, click Apply. The dialog title will change to
Create a new ‘Project’ level CSB called Dynamic_Project
Perform the following configuration options depending on the method of Project integration with ProjectWise. (Please consult your ProjectWise implementation team as to the appropriate method for project integration)
Preferredmethod:ProjectSupportwithProjectWiseProjectsIf your projects folders have been promoted to PW projects, then the _USTN_PROJECTDATA can be automatically extracted by defining the following dynamic Project level CSB.
Folders that have been promoted to a ProjectWise Project have the ProjectWise icon associated with the Folder icon as displayed in the diagram above.
Create a new ‘Project’ level CSB to support IFC Dataset Extensions (New is Ss4)
In this step, you are going to complete the following tasks:
Create a new ‘Project’ CSB called IFC2x3 Extension
Create a new ‘Project’ CSB called IFC2x3 + FM Handover Extension The goal of the IFC2x3 dataset extension is to allow users to quickly and easily extend their projects with properly constructed and DataGroup compatible IFC 2x3 schema and property sets. Currently there are three options for this dataset extensions, all controlled by the configuration value IFC_PROJECT.
IFC_PROJECT = 0 (default ) or Undefined– The dataset is NOT extended with any IFC2x3 Property sets and maintains the original delivered schema.
IFC_PROJECT = 1 – The dataset is extended with the common IFC 2x3 Property Set, an extended version of the IFC ‘Coordination View’ model view definition.
IFC_PROJECT = 2 ‐ The dataset is extended with the common IFC 2x3 Property Set, plus additional property sets as defined by the IFC 'Facility Management Handover' model view definition and additional considerations for the COBIE (Construction Operation Business information Exchange) specification
Tip: To learn more about COBie, Please see our “COBie User Guide” posted on BE Communities.
Create a new ‘Project’ Level CSB called "IFC2x3 Extension“ (This CSB will make the vital connection between to the dataset extensions.)
1. In ProjectWise Administrator , under Workspace Profiles>Managed>Project, right mouse
click over the ‘Project’ Level and select New> Configuration Block
Create a new ‘Project’ Level CSB called " IFC2x3 + FM Handover Extension “ (This CSB will make the vital connection between to the dataset extensions.)
1. In ProjectWise Administrator , under Workspace Profiles>Managed>Project, right mouse
click over the ‘Project’ Level and select New> Configuration Block
2. In the New Configuration Block Properties, enter the name IFC2x3 + FM Handover Extension
and the description IFC2x3 + FM Handover Dataset Extension. Once complete click Apply.
The dialog title will change to IFC2x3 + FM Handover Extension Properties.
AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace
Apply Dataset Extensions to a Project (New in Ss4) Before you can extend a project with a dataset extension in ProjectWise, you MUST first remove the configuration variable definition for IFC_PROJECT which is automatically included from importing the project configuration files into Project CSBs
Back in the Configuration tab, locate the variable IFC_PROJECT, it can be found towards the bottom of the text preview panel. Insert you cursor over the IFC_PROJECT variable. This will highlight the entire variable definition, as indicated in the image below. Then, click the “X” icon to delete this variable from the Project CSB and select ‘Apply’ to save these changes.
There are two methods in ProjectWise in which a project can be extended with the Dataset Extension. (Pick one)
1. Add Directive to source Project CSB ‐ Add either the IFC2x3 Extension or the IFC2x3 + FM Handover Extension CSB to the source Project CSB that represents the project configuration file (pcf)
2. Add CSB to ProjectWise Project Workspace Properties (Recommend Method) ‐ Add either the IFC2x3 Extension or the IFC2x3 + FM Handover Extension CSB to ProjectWise Project workspace properties.
Step 4: Add exclusions (variables to be excluded from copy‐out)
In certain scenarios, there are configuration variables that you may not want ProjectWise to use in managed workspaces. You can define and “exclude” ProjectWise from using these configuration variables by adding them to the list of excluded variables.
In ProjectWise Administrator, under Workspace Profiles>Managed>Variables to exclude from copy out
Below are some optional variables that may be excluded from copy out, depending on the AECOsim Building Designer workflows:
MS_BUMP (supports Visualization ‐ optional) If you are not using project explorer the following can be excluded:
MS_DESIGNDIR ( supports Project Explorer harvesting of Dynamic Views‐ optional)
MS_DRAWINGDIR (supports for Project Explorer harvesting of Dynamic Views ‐ optional)
MS_SHEETDIR (supports for Project Explorer harvesting of Dynamic Views ‐ optional)
TF_DRAWINGS (supports for Project Explorer harvesting of Drawing Extractions (DEM)‐ optional)
The files defined by these configuration variables, will be excluded during the download of the workspace
Step 5: ProjectWise Application Definition
ProjectWise Application definition for Building Applications using the Program Class Name
Program Class Name ‐ A Program Class Name defines and stores in the Windows registry both the executable and any command line arguments as defined during the installation on the local machine. This is the most reliable and universal application definition because ProjectWise does not store any hard coded directory path information. Registry support relies on the client registry to provide ProjectWise with the proper drive/directory location of application to launch. This allows an organization to have the applications installed in varying directories and drive locations on the local machines and reduce the requirement of installation consistency across an organization. All other customizations can be accommodated through strategic definitions of files. ProjectWise V8i (SELECTseries 4) is delivered with predefined application definitions for AECOsim Building Designer using these registry program class definitions. The program class name is the preferred method to define ProjectWise application support because it uses the Window registry to locate the designated executables. This is the recommended and most reliable method for building application initiation in a ProjectWise Managed Workspace. In the event the applications definitions are not predefined or you are working on a version previous to ProjectWise (SELECTseries 4), please review the following information to create the application definitions for AECOsim Building Designer (SELECTseries 4)
6. Since AECOsim Building Designer is a multi‐disciplinary application, we will want to create addition application actions, so we can take advantage of the ProjectWise’s “open with” options to open files in a more discipline specific environments. We will want to repeat steps 3 and 4, filling out the application association criteria for the following four (4) addition application definitions. The only change (highlighted in red) from one definition to another is the program description and the command line arguments.
Create application association for Open Action with AECOsim Building Designer ‐ Architectural
Action Open
Program description AECOsim Building Designer‐ Architectural
Program class name Bentley.AECOsimBuildingDesigner.Application
Command line arguments wsBB_DISCIPLINE=Architectural
Enable legacy integration <unchecked>
Replace default arguments <unchecked>
Create application association for Open Action with AECOsim Building Designer – Structural
Action Open
Program description AECOsim Building Designer ‐ Structural
Program class name Bentley.AECOsimBuildingDesigner.Application
Command line arguments ‐wsBB_DISCIPLINE= Structural
Enable legacy integration <unchecked>
Replace default arguments <unchecked>
Create application association for Open Action with AECOsim Building Designer – Mechanical
Action Open
Program description AECOsim Building Designer ‐ Mechanical
Program class name Bentley.AECOsimBuildingDesigner.Application
Command line arguments ‐wsBB_DISCIPLINE=Architectural
Enable legacy integration <unchecked>
Replace default arguments <unchecked>
Create application association for Open Action with AECOsim Building Designer – Electrical
Action Open
Program description AECOsim Building Designer ‐ Electrical
Program class name Bentley.AECOsimBuildingDesigner.Application
Command line arguments ‐wsBB_DISCIPLINE=Architectural
Enable legacy integration <unchecked>
Replace default arguments <unchecked>
AEC
COsim Buildinng Designer V
Copyrig
7. Returnapplicain line desirereassigselectiassociadefine
In the ProjectWise Explorer, locate the project directory. (For example: pw:\\<server name>:<datasource name> \AECOsim Building Designer Ss4\Managed Workspace\Projects\BuildingExamples\BuildingTemplate_US\), right‐click, and get the properties of this folder. Select the Workspace Tab.
Associate the Predefined Workspace with Predefined CSB called "ABD_Workspace_Ss4".
*(Optional) ‐Associate the Global Workspace with the Global CSB called “Global_Variables”. Associate the Project Workspace with the appropriate Project CSB.
For example: the Project CSB called "BuildingTemplate_US"
* Note: Since the Global_Variable CSB contains _USTN_DISPLAYALLCFGVAR, which is often considered an administrative configuration, this CSB could be added to the Administrative User Group instead of the
Project. This would make it applicable to only administrative users. See ‘Link CSBs to Groups’ below.
The result should be similar to the image below. (with/without Global_Variables or Personal Workspace)
AEC
COsim Buildin
PedwreTo
Link CSB ProjectWi_USTN_Dto the Adusers. To following
1
23
Th
ng Designer V
Copyrig
ersonal workefault, you m
workspace, oneview the conool>Options,
Note: Tyour Pe
Bs to Groups
ise CSB can bISPLAYALLCFGministrative Uimplement thsteps in the P
Manage Workspace Export Progress Dialog, which shows successful completion of all tasks:
Note: Errors in the first three tasks usually are the result of an error in the application definition or association. Please validate the application definition in the ProjectWise Administrator. Note: Opening a managed project or application the first time will require ProjectWise to download the workspace and datasets locally, which can take 5 minutes or more the first time, depending on your connection speed and size of your workspace and dataset. Please be patient, subsequent loads will have much faster load times. In many cases you will experience performance better than that of loading the same design file from a typical LAN server or shared network drive. From within the AECOsim Building application, you can verify you are successfully using a ProjectWise Manage Workspace by selecting Workspace>About Workspace from the File menu. You should be presented with a ProjectWise Manage Workspace Dialog, similar to what is displayed below.
AEC
Trou
COsim Buildin
ubleshoot
If you are different
This dialoProjectWiProjectWisame proj
Vin
VAthth
Innm
ng Designer V
Copyrig
ing
presented win the manag
g is common ise desktop Inise). Howeveject. If it does
erify that thenherited from
erify that thepplication asshe same applhe application