0% found this document useful (0 votes)
166 views56 pages

AECOsim Building Designer Deployment Guide For ProjectWise Managed Workspaces - v1.0 PDF

Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
166 views56 pages

AECOsim Building Designer Deployment Guide For ProjectWise Managed Workspaces - v1.0 PDF

Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 56

AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

AECOsim Building Designer V8i Deployment Guide:


ProjectWise V8i Managed Workspaces
Version 1.0 – March 2012
AECOsim Building Designer V8i (SELECTseries 3) 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 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 3) is compatible with a ProjectWise Integration Server V8i
(SELECTseries 3) or (SELECTseries 4) and requires a ProjectWise Explorer Client (SELECTseries 4)

• The Trane Ductulator and the RAM Viewer have not been ProjectWise integrated and/or 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

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.

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 1


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

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

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 2


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

Before You Begin

A fully operational and configured ProjectWise integration Server V8i (SELECTseries 3) or (SELECTseries
4) server and a defined datasource must be available. Access to ProjectWise Administrator V8i
(SELECTseries 4) and the ProjectWise Explorer V8i Client (SELECTseries 4) applications with
corresponding administrator privileges are also required. Please consult your ProjectWise
implementation team and/or administrators before initiating ProjectWise Manage workspaces.

ProjectWise Explorer V8i (SELECTseries 4) Client must be installed to include the iDesktop Integration for
Bentley Application base Integration, in order to fully support AECOsim Building Designer V8i application
integration for ProjectWise Managed Workspaces.

Install and configure AECOsim Building Designer V8i onto a client workstation. This will ensure that the
application workspace has all the required components for your application prior to importing it into
ProjectWise. Use this client to complete the instructions in this document.

Desktop integration:
The AECOsim Building Designer V8i installer offers the option to include ProjectWise Desktop
Integration within the “Custom” options during installation. The option can also be applied at any point
after the installation by initiating the “Change” options for active AECOsim Building Designer V8i
installation under the Windows Control Panel>Programs>Programs and Features>Uninstall or change
program.

The ProjectWise Desktop Integration opens the ProjectWise repository verses the standard manager
dialog when AECOsim Building Designer is initiated via an application shortcut. This step is optional and
not required for a successful ProjectWise managed workspace with AECOsim Building Designer - Please
consult your ProjectWise implementation team and/or administrators.

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 3


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

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…).

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 4


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

Overview of Steps:

1. Import Workspace & Dataset files into PW, using Manage Workspace Wizard. (approx. 30+ Min)
2. Import Project Configuration File(s) to ProjectWise Configuration Setting Blocks, using Manage
Workspace Wizard. (approx. 10 min)
3. Add/Edit ProjectWise CSBs (approx.5 Min)
4. Add exclusions (approx.5 Min)
5. ProjectWise Application Definition (approx. 5 min )
6. Link CSBs to the Projects (approx.5 Min)
7. Test/Validate (Troubleshoot)

Addendum: Step by Step Guide to create Predefined CSBs * Time estimates are approximate based on
out-of-the-box configuration and a remote connection to the PW server. Individual results may vary.

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 5


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

Step 1: Import Workspace & Dataset files into PW, using Manage Workspace Wizard.
(approx. 30+ Min)

1. In ProjectWise Administrator, under Workspace Profiles>Managed (Right-Click) and select “Import Managed
Workspace”. This will open the Import Managed Workspace Wizard. In the Welcome dialog, Click Next

2. On the Choose Desired Action page, select the second option "Import Data ProjectWise from File System",
Then click Next

3. On the Import and Validate ProjectWise Folder Structure and Documents page, select the workspace to
import in the Local File System list
Default workspace paths:
o Windows XP - …\Program Files\Bentley\)\Bentley\AECOsimBuildingDesigner
V8i\AECOsimBuildingDesigner\AECOsimBuildingDesigner.exe
o Windows 7 - …\Program Files (x86)\Bentley\AECOsimBuildingDesigner
V8i\AECOsimBuildingDesigner\AECOsimBuildingDesigner.exe

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 6


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

Then in the ProjectWise list, select the folder to import the workspace into. If the folder does not exist yet,
you can right-click in the list and select New Folder to create one.
• In your ProjectWise repository, create a folder that will contain the workspaces to manage. For
the purpose of this document define a directory called " AECOsim Building Designer Ss3" and
under that create another directory called “Managed Workspace”

Once you have selected a folder on both sides of the lists, click the Map button that is between the two lists,
this will enable the Validate option.

4. Click Validate.

During the validation process, the wizard compares the content of the local workspace with the contents
stored in ProjectWise. Since this is a fresh install, there shouldn’t be any files with which to compare and this
process should be rather quick. In the future, you can use this utility to update a workspace and/or dataset.
It will compare the two directories and identify whether files exist or not. It does not compare the contents
of the file, only whether the files exist or not.

Once the validation is complete, the Validation of File System Structure against ProjectWise dialog opens.
The following dialog compares the Local File System to the ProjectWise Mappings you have selected. Select
an item to view its status. Items with a red ‘X’ indicates the file/folder is not present in the mapped
ProjectWise repository, while the green check indicates it is present in the mapped ProjectWise repository.

The tree structure in the left hand panel will display the status of each item as either present or not present
in the ProjectWise repository. Items with a red ‘X’ indicates the file/folder is not present in the ProjectWise
repository, while the green check indicates it is present in ProjectWise repository Select an item in the list
on the left to see what the status of the item is in ProjectWise. Since this is a fresh install, the entire
workspace will be marked as not present.

While it is acceptable to import the workspace in its entirety, it is somewhat unnecessary. We can
streamline the workspace by managing only what is necessary. Reducing the number files being
exchange between the ProjectWise datasource and local machine translates into shorter downloads
times and greater performance to your users. We really only need to be concerned about three
directories, the “BuildingDatasets”, “Projects” and “Standards” directories.

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 7


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

Once you have only selected the “BuildingDatasets”, “Projects” and “Standards” directories, click Resolve.

5. When ready, click Resolve to upload all missing items to ProjectWise.


6. When finished, click Next.
7. Verify that the option to “Return to Introduction” is selected, and then click Continue to return to the first
page of the wizard to begin Step 2.

Note: To make further use of Sample Project Data, you will need to run Tools>Scan References and
Linksets… from the ProjectWise Explorer Client to reconnect and resolve al the project references
and linksets. Please consult the ProjectWise help documentation for more information.

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 8


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

Step 2: Import Project Configuration File(s) to ProjectWise Configuration Setting Blocks,


using Manage Workspace Wizard. (approx. 10 min)

If you are continuing from Step 1, skip to #3 on next page, bypassing #1 (opening the "Import Managed Workspaces…"
wizard.)

1. Open the "Import Managed Workspaces…" wizard.


2. In ProjectWise Administrator, under Workspace Profiles>Managed (Right-Click). Then click "Import Managed
Workspaces…" this will open the Managed Workspace Wizard.
3. In the Welcome dialog, click Next

4. On the Choose Desired Action page, select the first option "Import MicroStation Configuration File to
ProjectWise Configuration Setting Blocks", Then click Next

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 9


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

5. Choose a MicroStation Installation and Workspace Root:


• Locate the MicroStation Installation by browsing and locating the AECOsimBuildingDesigner.exe
executable.
• Default installation –
o Windows XP - …\Program Files\Bentley\AECOsimBuildingDesigner
V8i\AECOsimBuildingDesigner\AECOsimBuildingDesigner.exe
o Windows 7 - …\Program Files (x86)\Bentley\AECOsimBuildingDesigner
V8i\AECOsimBuildingDesigner\AECOsimBuildingDesigner.exe
• Locate the Workspace Root Directory
• Default installation –
o Windows XP - …\Documents and Settings\All Users\Application
Data\Bentley\AECOsimBuildingDesigner V8i\WorkSpace
o Windows 7 - …\ProgramData\Bentley\AECOsimBuildingDesigner V8i\WorkSpace
• Verify that the option to "Create configuration block for workspace root variable" is NOT selected.
(checked by default)
• Click Next

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 10


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

6. Add configuration files: At this point you have the option to scan the entire workspace for configuration files
that could be eligible to be imported into ProjectWise, but a scan is unnecessary because we are only after
project .pcf files. In the Workspace Configuration Files dialog, click Add. This will initiate a windows browser;
navigate to your local projects directory and select the BuildingTemplate_US.pcf. Once the project .pcf file is
added into the Workspace Import dialog, click Next.

Projects directories:
• Windows XP - …\Documents and Settings\All Users\Application Data\Bentley\AECOsimBuildingDesigner
V8i\WorkSpace\Projects\BuildingExamples\
• Windows 7 - …\ProgramData\Bentley\AECOsimBuildingDesigner
V8i\WorkSpace\Projects\BuildingExamples\

Tip: The goal is to have a good standard project.pcf files to convert into a project CSB that is
scalable and reusable across multiple projects or is suited for a specific project type.

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 11


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

7. When the text, “Scanning for Workspace Configuration Files completed successfully”, appears click Next

8. On the Configuration Settings Blocks page, review the ProjectWise Configuration Settings Blocks that will be
created. Configuration Settings Block names can be changed,reassigned to different ProjectWise levels, or they
can be removed if unwanted from within in this dialog. When finished, click Next

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 12


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

9. Please review the configuration file setting. If any errors or changes are noted, use the back button to step
backward through the Workspace Import Wizard. If satisfied, click Import. This will begin the process to convert
your configuration files into ProjectWise Configuration Setting Blocks also referred to by the acronym CSB or
CSBs (plural).

10. When the import is finished (*** IMPORT SUCCESSFUL ***), click Next.

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 13


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

11. For this exercise, we are done with the Workspace Import Wizard. Click Close.
12. Proceed to the ProjectWise Administrator to review the newly-created configuration blocks in ProjectWise
Administrator to verify the import. (Datasource>Workspace Profiles>Managed)

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 14


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

Step 3: Add/Edit ProjectWise CSBs

In ProjectWise Administrator, under Workspace Profiles>Managed

In this step, you are going to complete the following tasks:


• Create a new ‘Predefined’ CSB for AECOsim Building Designer – Electrical (ABD_Electrical)
• Create a new ‘Predefined’ CSB for AECOsim Building Designer (ABD_Workspace)
• Create new ‘Global ‘ CSB (Global_Variables)
• Create a new ‘Project’ CSB (Dynamic_Project)
• 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’ CSB for AECOsim Building Designer – Electrical (ABD_Electrical)
(This CSB will define the Electrical portion of AECOsim Building Designer to work with ProjectWise.)

1. In ProjectWise Administrator , under Workspace Profiles>Managed>Predefined, right mouse click over the
‘Predefined’ Level and select New> Configuration Block

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 15


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

2. In the New Configuration Block Properties, enter the name ABD_Electrical and the description: ABD
Electrical (SELECTseries 3). Once complete click Apply. The dialog title will change to ABD_Electrical
Properties.

3. Add the following variables and/or directives:

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 16


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

Add Variable to the ABD_Workspace CSB

Name BBES_DETAILED_CFG
Description Enable BBES Detailed Configuration
Add Value Operation Type: '='- Assignment
Value Type: Change 'String' to 'ProjectWise Folder'
Value: 1
Locked YES

Note: BBES_DETAILED_CFG enables BBES Detailed configuration option which is required for ProjectWise
Managed Workspace Support. The detailed configuration option allows for more explicit directory
definition as seen in the excerpt from the BuildingDisciplines.cfg below:
#----------------------------------------------------------------------
# Electrical Detailed Path Configuration for ProjectWise Integration
#----------------------------------------------------------------------
%if defined (BBES_DETAILED_CFG)
BBES_MWS_SYMLIBNO : 080
BBES_MWS_METADATA : $(BBESDIR)/METADATA/
BBES_MWS_IES : $(BBES_MWS_METADATA)/IES/
BBES_MWS_RES : $(BBESDIR)/RES/
BBES_MWS_SYMLIBS : $(BBESDIR)/SYMLIBS/
BBES_MWS_SYMLIB : $(BBES_MWS_SYMLIBS)$(BBES_MWS_SYMLIBNO)/
BBES_MWS_CSS : $(BBES_MWS_SYMLIBS)CSS/
BBES_MWS_VIS : $(BBES_MWS_SYMLIBS)VIS/
BBES_MWS_WIRING : $(BBES_MWS_SYMLIBS)WIRING/
MS_LIGHTING < $(BBES_MWS_IES)
BBES_SYMBOLMANAGER_REDIRPATH = 1
%lock BBES_SYMBOLMANAGER_REDIRPATH
%endif

Any of the above configuration variables can be further redefined in a project CSB. If the Electrical
portion is configured in a “Hybrid” Manage workspace, where the components of electrical dataset are
external of ProjectWise, then it is not necessary to define this variable.

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 17


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

Add Variable to the BBES_DBDIR

Name BBES_DBDIR
Description Electrical Centralized Project Database Location
Add Value Operation Type: '='- Assignment
Value Type: Change 'String' to 'Directory'
Value: \\<ServerName>\<ShareFolder>\$(_USTN_PROJECTNAME)\_bbes
Locked YES

Note: BBES_DBDIR defines the electrical centralized project database location. BBES_DBDIR should point
to the project specific _bbes folder outside of ProjectWise. This location is user definable. This folder
contains project specific database files that cannot be properly managed by ProjectWise at this point.
Information about building structure, room spaces, elements count and mounting heights is stored in
_bbes folder.

Using a UNC (Universal Naming Convention) to define the directory destination allow for the greatest
availability and access to a centralized location. The _USTN_PROJECTNAME value is resolved from the
ProjectWise Project; however the corresponding directory will need to be manually created for each
project in the centralized location since ProjectWise cannot manage directories outside of ProjectWise.

To troubleshoot configuration issues with a ProjectWise managed workspace, refer to the bbes.ini file
located at C:\Program Files (x86)\Bentley\AECOsimBuildingDesigner
V8i\AECOsimBuildingDesigner\ServerApp\bin.

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 18


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

The final ABD_Electrical CSB:

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 19


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

Create a new ‘Predefined’ CSB for AECOsim Building Designer (ABD_Workspace) - 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 and the description
ABD Workspace (SELECTseries 3). Once complete, click Apply. The dialog title will change to
ABD_Workspace Properties.

3. Add the following variables and/or directives:

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 20


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

Add Variable to the ABD_Workspace CSB

Name _TF_WORKSPACEROOT
Description ABD PW Workspace (_TF_WORKSPACEROOT)
Add Value Operation Type: '='- Assignment
Value Type: Change 'String' to 'ProjectWise Folder'
Value: Change value to point to ProjectWise Workspace, browse to
pw:\\<server name>:<datasource name>\ Documents\AECOsim
Building Designer Ss3\Managed Workspace\

Locked YES

Note: _TF_WORKSPACEROOT defines the root workspace directory containing all workspace files used
by AECOsim Building Designer.

Tip: Since Workspaces can be version specific, you may want rename the
ABD_Workspace CSB to include the major version number, such as ABD_Workspace
_081109.
Tip: Use the CSB description to organize and manage collection of CSB. For example,
change the description of WorkspaceRoot_081109 CSB to "08.11.09 Workspace Root",
this will allow us to sort 08.11.09 CSB by description.

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 21


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

Add Variable to the ABD_Workspace CSB

Name _USTN_SITE
Description ABD PW Standards (_USTN_SITE)
Add Value Operation Type: '='- Assignment
Value Type: String
Value: $(_TF_WORKSPACEROOT)standards/
Locked YES

Note: _USTN_SITE defines the directory containing site configuration files, otherwise known as
workspace “standards”.

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 22


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

Add Directive to the ABD_Workspace CSB

Directive %include
Description ABD Electrical

Add Value Value type: Configuration Setting Block


Value: ABD_Electrical: ABD_Electrical (SELECTseries 3)

The final ABD_Workspace CSB:

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 23


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

Create new ‘Global ‘ CSB (Global_Variables)


Create a new ‘Predefined’ Level CSB called " Global_Variables “

1. In ProjectWise Administrator , under Workspace Profiles>Managed>Global, right mouse click over


the ‘Global’ Level and select New> Configuration Block

2. In the New Configuration Block Properties, enter the name Global_Variables and the description
Global Variables. Once complete click Apply. The dialog title will change to Global_Variables
Properties.

3. Add the following variables and/or directives:

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 24


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

Add Variable to the Global_Variables CSB -

Name _USTN_DISPLAYALLCFGVARS
Description Display All Configuration Variables
Add Value Operation Type: '='- Assignment
Value Type: Numeric
Value: 1
Locked YES

Note: _USTN_DISPLAYALLCFGVARS displays all system level configuration variable and is useful
for Administrators during certification and debugging.

The final Global_Variables CSB:

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 25


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

Create a new ‘Project’ CSB (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)

Preferred method: Project Support with ProjectWise Projects


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

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 26


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

Create a new ‘Project’ Level CSB called "Dynamic_Project “


(This CSB will make the vital connection between the CSBs and the ProjectWise datasource.)

1. In ProjectWise Administrator , under Workspace Profiles>Managed>Project, right mouse


click over the ‘Predefined’ Level and select New> Configuration Block

2. In the New Configuration Block Properties, enter the name Dynamic_Project and the
description Dynamic Project. Once complete click Apply. The dialog title will change to
Dynamic_Project Properties.

3. Add the following variables and/or directives:

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 27


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

Add Variable to the Dynamic_Project CSB

Name _USTN_PROJECTDATA
Description ProjectWise Project
Add Value Operation Type: '='-Assignment
Value Type: String
Value: $(dms_project(_DGNDIR))
Locked YES

Tip: The configuration variable dms_project(_DGNDIR) resolves the directory path to the first
ProjectWise Project definition it encounters as it traverses backwards through the directories.
This could resolve to a single parent Project (with no subprojects) or a Subproject. The
configuration variable dms_parentproject(_DGNDIR) resolves the directory path to only the
parent ProjectWise Project .

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 28


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

Add Variable to the Dynamic_Project CSB

Name _USTN_PROJECTNAME
Description ProjectWise Project Name
Add Value Operation Type: '='- Assignment
Value Type: String
Value: $(LastDirPiece (dms_project(_DGNDIR)))
Locked YES

Tip: The configuration variable LastDirPiece(dms_project(_DGNDIR)) resolves the project


name based on the directory path to the first ProjectWise Project definition it
encounters as it traverses backwards through the directories. This project name is
required for the Global CSB: ABD_Electrical.

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 29


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

The final Dynamic_Project CSB:

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 30


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

Create a new ‘Project’ Level CSB called "Dynamic_Dataset “


(This CSB will make the vital connection between the CSBs and the ProjectWise datasource.)

1. In ProjectWise Administrator , under Workspace Profiles>Managed>Project, right mouse


click over the ‘Predefined’ Level and select New> Configuration Block

2. In the New Configuration Block Properties, enter the name Dynamic_Dataset and the
description: Dynamic Dataset. Once complete click Apply. The dialog title will change to
Dynamic_Dataset Properties.

3. Add the following variables and/or directives:

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 31


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

Add Directive to the Dynamic_Dataset CSB

Directive %include
Description Include Dataset Configuration File
Add Value Value type: String
Value: $(TFDIR)dataset.cfg

Note: This CSB include the configuration file associated with each datasets, If the dataset changes
from project to projects, this CSB will ensure the correct supporting configuration file will be loaded.

The final Dynamic_Dataset CSB:

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 32


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

Edit Project Level CSB -


In ProjectWise Administrator , under Workspace Profiles>Managed>Project, locate the Project CSB that
was imported from the project configuration file ( .pcf) in Step 2 (BuildingTemplate_US) and double click
it to open it for editing.

In the Configuration tab, locate and insert you cursor at the top of the text preview panel, just before
the “_USTN_PROJECTDESCR” text. This will either insert your cursor at the beginning of the text preview
panel or highlight this section as displayed below, either is acceptable.

In this Project CSB file, click the plus icon “+” and add the following directive:

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 33


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

Add Directive to the project configuration CSB (i.e. BuildingTemplate_US project CSB)

Directive %include
Description Dynamic Project
Add Value Value type: Configuration Setting Block
Value: Dynamic_Project: Dynamic Project

This include statement should be inserted at the top of project CSB

Back in the Configuration tab, insert you cursor towards the bottom of the text preview panel.

In this Project CSB file, click the plus icon “+” and add the following directive:

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 34


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

Add Directive to the project configuration CSB

Directive %include
Description Dynamic Dataset
Add Value Value type: Configuration Setting Block
Value: Dynamic_Dataset: Dynamic Dataset

This include statement needs to be inserted at the bottom of project CSB

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 35


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

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 CSB 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 3)

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 36


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

Application Definitions in ProjectWise Administrator:

• In ProjectWise Administrator, under Applications, locate the application definitions for AECOsim
Building Designer in the right panel. ProjectWise V8i (SELECTseries 4) is delivered with five (5)
predefined application definitions for AECOsim Building Designer.

• If the predefined applications are not available, the applications can be created manually or can
be imported using the administrative dmsconv.exe utility, using the corresponding XML
application definition file (ABD_appdef.xml). Instructions on how to apply the XML, using the
dmsconv.exe, are include within the XML file.

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 37


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

Manually Creating AECOsim Building Designer Application Definitions:

Copying and editing a program definition, such as MicroStation, might be more efficient
than creating a new application. Copying a previous application offer some benefits
since the some other Actions (View, Markup and Print) are already defined and easily
modified. Also, some organization may find MicroStation an attractive option as an
available application to use with ProjectWise’s “open with” option.

1. In ProjectWise Administrator, right-click over Applications and select New>Application, this will
open the New Application Properties dialog.

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 38


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

2. In the New Application Properties dialog, within the General tab , enter the name “AECOsim
Building Designer”. You also have the opportunity to set the icon, by selecting Set icon, and
locating either the AECOsimBuildingDesigner.exe or any of the .ico files located within the same
directory.

3. Click the Actions tab and click the Create button to create a new application association.

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 39


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

4. In the Create Association dialog, fill out the application association criteria

Action Open
Program description AECOsim Building Designer
Program class name Bentley.AECOsimBuildingDesigner.Application
Command line arguments <leave blank>
Enable legacy integration <unchecked>
Replace default arguments <unchecked>

The Program class can be defined for browsing for the AECOsim Building Designer
application in the Programs list in the Programs tab, or browsing for the
AECOsimBuildingDesigner.exe in the Executables tab, or if the application isn’t loaded
locally, then the class name can be filled out manually in the Advanced tab, with the
‘Enter text is a program class name” option. If the class is defined properly, the
application should be resolved in the Command line preview, unless it is not installed
locally.

5. Once all the application association option are completed click OK, to return to the applications
properties dialog and click Apply to save the application definition.

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 40


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

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 - Architectura
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>

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 41


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

7. Returning to the Actions tab, verify that the correct application is associated as the “default”
application. The “default” application is denoted by a black diamond icon next to the Action and
in line with the Association description. If the desired association is not the “default”, select the
desired association and then click the “Set Default” button. The black diamond icon will be
reassigned to the selected association and the “Set Default” button will become disabled for this
selection. Note, each action has its own default association, when there are multiple
associations defined for that action. If no default is defined, and there are multiple associations
defined, the user will be asked to decide.

8. Additional Application association will need to be defined to support the other ProjectWise
actions for View, Markup, and Print.

Create application association for View Action with Bentley View

Action Open
Program description Bentley View
Program class name B Bentley.View.Application
Command line arguments <leave blank>
Enable legacy integration <unchecked>
Replace default arguments <unchecked>

Create application association for View Action with Bentley Navigator

Action Open
Program description Bentley Navigator
Program class name Bentley.Navigator.Application
Command line arguments <leave blank>
Enable legacy integration <unchecked>
Replace default arguments <unchecked>

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 42


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

Create application association for Markup Action with Bentley Navigator

Action Open
Program description Bentley Navigator
Program class name Bentley.Navigator.Application
Command line arguments <leave blank>
Enable legacy integration <unchecked>
Replace default arguments <unchecked>

Create application association for Print Action with AECOsim Building Designer

Action Open
Program description AECOsim Building Designer
Program class name Bentley.AECOsimBuildingDesigner.Application
Command line arguments <leave blank>
Enable legacy integration <unchecked>
Replace default arguments <unchecked>

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 43


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

Step 6: Link CSBs to the Project

In the ProjectWise Explorer, locate the project directory. (For example:


pw:\\<server name>:<datasource name> \AECOsim Building Designer Ss3\Managed
Workspace\Projects\BuildingExamples\BuildingTemplate_US\), right-click, and get the properties of this folder.
Select the Workspace Tab.

1. Associate to the project directories with Predefined CSB called "ABD_Workspace".


2. Associate to the project directories with the Global CSB called “Global_Variables”.
3. Associate to the project directories with the appropriate Project CSB.
For example: the Project CSB called "BuildingTemplate_US"

The result should be similar to the image below, (with/without Personal Workspace)

Personal workspace settings allow user-specific workspace configuration for managed workspaces. By
default, you may not have Personal workspace associated if there is nothing defined in your personal
workspace, once something is defined in the personal workspace it is automatically associated. (To
review the contents of your personal workspace CSB, in ProjectWise Explorer file menu select
Tool>Options, select the Personal Workspace tab.

Note: The option to hide the compatibility warning when building applications are initiated is stored in
your Personal Workspace.

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 44


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

Step 7: Test/Validate (Troubleshoot)

To test or Validate your Integration, in the ProjectWise Explorer, locate the delivered file empty.dgn in the project
BuildingTemplate_US (pw:\\<server name>:<datasource name\AECOsim Building Designer Ss3\Managed
Workspace\Projects\BuildingExamples\BuildingTemplate_US\empty.dgn).

Set the file to be associated to the AECOsim Building Designer application. This can be achieved by selecting the
empty.dgn file in ProjectWise Explorer, then selecting the Modify option from the right-click menu. In the Modify
document dialog, select AECOsim Building Designer from the drop down list under “Application:” Select OK to complete
the association.

Double click on the empty.dgn file to open it. If it is properly configured, you should see the Manage Workspace Export
Progress dialog, indicating the initial workspace download.

Note: To make further use of Sample Project Data, you will need to run Tools>Scan References and Linksets…
from the ProjectWise Explorer Client to reconnect and resolve al the project references and linksets. Please
consult the ProjectWise help documentation for more information.

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 45


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

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.

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 46


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

Troubleshooting

If you are presented with the following message to restart your MicroStation Session, then there is something
different in the managed configuration that requires a change in your manage workspace.

This dialog is common and is to be expected if you are opening files from another project or if you are using
ProjectWise desktop Integration (launching AECOsim Building Designer from the desktop and connecting to
ProjectWise). However, this dialog does not typically appear if you are opening different files from within the
same project. If it does occur:
• Verify that the files contain the same ProjectWise manage Workspace assignments. They should all be
inherited from the Project Folder.
• Verify that there are no ProjectWise Manage Workspace CSB assignments on the ProjectWise
Application associated to the document. This alert will appear if you switch to a file that does not share
the same application association as the original file opened and the application has a CSB assigned to
the application definition.
• Inspect your configuration files, any configuration variable defined to equal _DGNDIR or _DGNFILE will
need to be add the exclusion list defined by PW_MWP_COMPARISON_IGNORE_LIST in the ProjectWise
mcm.cfg file.

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 47


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

Addendum: Step by Step Guide to create Predefined CSBs

Creating a new ‘Predefined’ Level CSB called " ABD_Workspace “ - 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_Electrical and enter description
ABD Electrical (SELECTseries 3). Once complete click Apply and OK.

Note: This CSB is being created purely as a placeholder CSB that we will reference later in the
exercise, however you will need complete the definition of this CSB as per to the instruction in
this deployment document, please reference “Predefined CSB” - Create a new ‘Predefined’ Level

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 48


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

CSB called "ABD_Electrical“

3. In the New Configuration Block Properties, enter the name ABD_Workspace and description ABD
Workspace (SELECTseries 3). Once complete click Apply. The dialog title will change to
ABD_Workspace Properties.

4. Switch to the Configuration tab at the top of the dialog.

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 49


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

5. Click the plus icon and to select Add Variable to create a new variable.

i.
6. In the new variable dialog box populate the following fields:

Name _TF_WORKSPACEROOT
Description ABD PW Workspace (_TF_WORKSPACEROOT)
Locked YES

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 50


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

Click the Add button to enter the following values:

Operation Type '='- Assignment


Value Type Change 'String' to 'ProjectWise Folder'
Value: Change value to point to ProjectWise Workspace,
browse to pw:\\<server name>:<datasource name>\
Documents\AECOsim Building Designer Ss3\Managed
Workspace\

Click OK to close the Edit Value dialog, returning to the <New variable> dialog.

Click OK to accept the variable definition. The results of the WorkspaceRoot properties CSB
should be as follows:

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 51


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

7. Click Apply to accept the variable definition

8. Click the plus icon and add another variable to the ABD WorkspaceRoot CSB

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 52


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

9. In the new variable dialog box populate the following fields:

Name _USTN_SITE
Description ABD PW Standards (_USTN_SITE)
Locked YES

Click the Add button to enter the following values:

Operation Type '='- Assignment


Value Type String
Value $(_TF_WORKSPACEROOT )standards/

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 53


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

10. Click OK to close the Edit Value dialog, returning to the <New variable> dialog.

11. Click OK, to accept the variable definition. The results of the WorkspaceRoot properties CSB should
be as follows:

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 54


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

12. Click the plus icon but this time, select Add Directive

13. In the Modify Directive dialog box, populate the following fields:

Directive %include
Description ABD Electrical

Click the Add button and enter the following values:

Value type Configuration Setting Block


Value ABD_Electrical: ABD_Electrical (SELECTseries 3)

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 55


AECOsim Building Designer V8i Deployment Guide ProjectWise Managed Workspace

14. Click OK to close the Edit Value dialog, returning to the <New variable> dialog.

15. Click OK to accept the directive definition. The results of the adding the direct to the CSB should be
as follows:

16. Click Apply to accept the variable definition and then OK to close the dialog. At any point you have
successfully completed creating a Predefined CSB.

END – Step by Step Guide to create Predefined CSBs.

Copyright © 2012 Bentley Systems, Incorporated| AECOsim Building Designer Technote 56

You might also like