Strucad G3 MM Users Guide

Model Management System

G3 - Users Guide G3-1

Users Guide For the


Contents

Overview 3

System Overview 3

System Architecture 4

System Principles & Concepts 5

Information Workflow 6

User Rights and Options 7

Connecting to the Model Management Server 8

Connecting to a Remote Web Service 9

Creating a Server Model 10

Assigning Users to a Server Model 11

Creating a New Local Model 12

The Model Manager Interface 13

View Modes 14

Item Browser 14

3D Model and file selection 15

Model Browser 16

Layer Filtering 16

Model Manager Stages 17

Modelling 18

Get Latest Downloading the Latest Model 18

Checking In Uploading Model Information 19

Checking Out Modifying Model Information 20

Checking Out on Behalf of other users 21

Undoing Check Outs 22

Automatic Checking Out 22

Issuing 23

Preparing the Model for Issuing 23

Get Issue Building an Issue model 24

Put Issue Sharing Issued Piece Mark Data 26

Managing Production Data 27

Checking Out Drawings Editing 2D Drawings 27

The Group Functions 28

The MUserStatus Command 28

Server Model Options 29

Sending Messages 30

Automatic Check-In E-mail Notification 31

Model History & Role Back 32

System Administrator Options 34

Event Logs 34

Server Options 34

System Back-ups 35

Controlled Files 35

StruCad Training Course Model Manager

G3-2 G3 - Users Guide



Overview of Model Management & Issuing System

The StruCad Model Management & Issuing System is a unique software module, designed and

developed by AceCad Software to provide users with a simple & efficient model management

system. Including advanced management features for single and multiple users, powerful

issuing facilities, with the ability to collaborate via the LAN and WLAN networks or the internet.

Single & Multiple user applications, benefits all users.

Quick & Efficient sharing of model information, without the limitations of always being

connected to other users or the master model.

Full integration into all StruCad environments.

Administrative & security features providing powerful project management tools while

still being simple to use at the User level.

Change detection and management, prevents errors and duplication of work.

Notification of Model changes to others users on the project.

Management & Issuing of all production data.

Powerful Issuing features for part and whole model issues.

Uploading of piece Mark data, instantly shareable with others.

Model History with change preview and audit trails.

Collaboration via LAN, Wide Area Networks (VPN etc) & the Internet.

Built using the very latest Microsoft .NET & SQL technologies.

StruCad Training Course

G3-4


The architecture of the Model Management system is based on that of a Client

application. A master StruCad model is stored within an SQL database, forming the Server

element.

A StruCad user can access the Server and share information using the i

Management tools from within the StruCad workspace and wire frame, forming the Client

element.

A common interface known as the Model Manager is used to facilitate the process of

exchanging model information between the Client and Server.

This type of architecture allows the user to stay up to date with latest model changes without

the restrictions of requiring a permanent connection.

This simple architecture allows the Model

Area Network, via a Wide Area N

Server

Model Manager

Model Management System Architecture

The architecture of the Model Management system is based on that of a Client


access the Server and share information using the i

s from within the StruCad workspace and wire frame, forming the Client


ing model information between the Client and Server.


the restrictions of requiring a permanent connection.

This simple architecture allows the Model Management System to be used ove

Network or over the internet.

Network

The World

G3 - Users Guide

The architecture of the Model Management system is based on that of a Client-Server


access the Server and share information using the integrated Model

s from within the StruCad workspace and wire frame, forming the Client



Management System to be used over a fixed Local

WWW

Internet

Wide Area

Network

Local Area

Network



Model Management System Principles & Concepts

The Model Management system stores a master model on the Server, each user has a local

copy of all or part of the model, using their Client, the StruCad 3D modelling environment for

the process of detailing and issuing. This allows the user to continue using the powerful

StruCad 3D modelling system to its full potential while taking advantage of the new

management and issuing facilities.

The Model Manager in simple terms uploads and downloads information between the StruCad

model and the Master server model, allowing it to be shared between users.

The Model Manager goes further than this by assigning ownership of the information to

different users. This process helps users to work efficiently together, prevent errors and

duplication of work and generally improving the management of all aspects of the Model from

detailing to issuing.

The Model Manager operates using 5 key modes. Each of these modes is integrated into the

StruCad modelling environments.

The Get Latest, Check In and Check Out modes are used by users to share model

information between the model and the server.

Get Latest Mode

This mode allows users to Get any wireframe entities, piece mark data and other files for

reference, any changes made to these items will not be automatically selected for uploading

back to the server model.

Check Out Mode

This mode allows users to check out any wireframe entities or other files, the process of

Checking Out assigns ownership of the item to that user. Any changes made to these items

by that user will be automatically selected for uploading back to the server model, however

any changes made to that item by other users cannot be upload to the server, thus preventing

error and duplication/overwriting of information.

Check In Mode

This mode allows the user to update the server model with any new or changed wireframe

entities or other files. When uploading a modified entity it must be Checked Out by the user

before it can be Checked In.

When issuing a part or whole model the Get Issue and Put Issue modes are used to generate

the issue model and upload the piece mark data to the server so it can be shared with others.

Get Issue Mode

This mode generates the issue model automatically, selecting the members, end types,

parameter files etc required to issue the selected members but also intelligently selecting other

parts of the model that are required for consistency of joint connectivity and marking

information, automatically allocating these to a non-issue status.

Put Issue Mode

This mode allows piece mark data to be uploaded to the server and shared with other users.

Production data such as Drawings, Material Lists, CAM data etc is then Checked In.



StruCad Model Management & Issuing System Information Workflow

Check In

Incoming

Check Out

Outgoing

Get Latest

Read Only

Detailer

Detailer

Check Out on

Behalf Of...

Model

Server

Sub Contractor

WAN Network (VPN)

WWW

Internet

LAN Network

Freeware Engineer

StruMIS Analysis Links

CAM Data Drawings Material Listing

Issuer

Put Issue

Uploads Piece Mark Data

Get Issue

Builds Issue Model

Production Data



User Profiles, Rights and Options

Each person working with the model manager will log in using a user profile. This user profile

will control the User Rights and User Options. The user rights dictate the type of access and

level of functionality the user has available to them and the User Options control automated

selection functionality within the model manager.

Now we will explore the what User Rights and User Options each profile controls and look at

how they can be configured to suit each company.

User Rights

Each user right that is activated allows the user access to additional functionality, whether it is

access to new commands or advanced options for other commands.

The user rights are as follows: Check In Only

Check Out and Modify

Mark and Issue

Create Server Model

User rights are configured by the system administrator when the user is created. The user

rights can be modified at the model level by the system administrator or a user with the create

server model right.

User Options

Each user has a series of options controlling the automated selection functionality of the model

manager. When using the model manager in certain modes, wire frame entities and files can

automatically selected for being uploaded or downloaded. These options should be configured

by the administrator to suit your user profile and should not need to be changed.

These options are broken down by mode as follows;

Check In Mode

Automatically add checked out items to the check in selection.

Automatically add new items to the check in selection.

Automatically add new output files to the check in selection.

Get Latest Mode

Automatically add server only items to the get latest selection.

Automatically add different items to the get latest selection.

Automatically add items that have been deleted on the server to the get latest

selection.

Undo Check-Out Mode

Automatically add checkout items to the undo checkout selection.

General Options

Auto selection on mode change.

Auto add member end types.

For full details of how to configure the User Rights and User Options, see the guide G1 Set-up

and Configuration Guide.



Connecting to the Model Management Server

The model manager is a client-server application, in simple terms this means that the user

works in a local 3D model which is on their computers hard drive. The user shares information

with other user on the project by uploading information to the server where the master model

is stored, by uploading and downloading model information the users can work together on the

same project.

When using the model management system the user is required to login, the process of

logging in makes a connection with the master server model. As it is possible to use the model

management system over a network or the internet, the user can specify which server to

connect to. The connection details can be changed at any time but generally entered will not

need to be changed.

1. Start the Model Manager from the StruCad workspace or using the Model Manager

commands from within the wireframe.

2. On the Login dialog click the Show connection button in the bottom right of the dialog.

3. Select the down arrow on the right of the Server Name option and choose

The menu will pause for a few seconds while all SQL servers on the network are detected and

will then close.

A list of SQL servers will now be available. You can identify the server you require by the

machine name on which it is installed; this may be a server or your local computer name or

manually enter the machine name or IP address followed by a back slash \ and the word

ACECADMODELSVR

Examples; \ACECADMODELSVR

DO_Server\ACECADMODELSVR

DO_01\ACECADMODELSVR

111.111.1.101\ACECADMODELSVR

4. Click the Refresh Users icon to the right of the User Name dialog to update the list

with the available users on the selected server.

5. Click Connect to log in and open the model manager.



Database User and Password

Each SQL database has user name and password required to access it. This is entered into the

Database User and Database Password fields this will be set to default when the server is

installed, unless required it does not need to be changed.

Connecting to a Remote Web Service over the internet. These instructions detail how to connect to a remote Web Service over the internet.

1. Start the Model Manager from the StruCad workspace or 3D wireframe. At the Login

dialog click the Show Connection button to display the connection settings.

Change the Connection Type to Remote webservice

2. Set the Web URL to the external IP address or URL of the web service machine

followed by a / (forward slash) and the virtual directory name specified during the

installation of the web service eg;

172.17.254.19/VirtualFolder or ModelManager.AceCad.co.uk\ StruCadMMWebService

3. Click the Refresh Available Users icon to the right of the Login drop down. This will

connect to the web service and retrieve the list of available users.

4. Select your assigned user name from the list, enter your password as supplied and click

Connect.

5. The Model Manager will now connect to the remote server and log in as normal. The

Model Manager will operate in exactly the same manner as if connected via a local area

network.

Note: All operational performance is dependant upon connection speed and contention

over the users internet connection.

StruCad Training Course

G3-10

Creating Server Models

The process of creating a server model will create a new database on the

automatically populate it with the standard model files. Users can then be assigned to the

model allowing them to upload and download information from the server model. This is the

first stage required for any project using the Model Management

Follow the instructions below to create a new server model.

1. From the StruCad work space select the category Detailing to display the work folder

detailer. Select the folder detailer at the top of the Model Browser.

2. Click New Server Model f

Model from the drop down menu.

3. Log into the Model Manager as either the System Administrator or any user with the

Create Server Model right activated.

4. The Model Manager will open with the M

and click Ok to create the server model. The Model Details are identical to those used

when creating a stand-alone model.

If you have an existing 3D model in the

current work directory tick the Use Ex

option to automatically upload that model

to the server rather than use a default

model for the current installation set.

The creator of the model is set by

the Model Administrator which will allow

the user to assign other users to

and dictate which user rights those users

have. It t recommended that the M

Administrator fields are left as the defaults.

Once the server model has been created a

local model will be created in the default

work folder of the user who cre

server model.

A model created by the Model Manager and

a standalone model created by StruCad can

be distinguished from each other by the

model icon to the left of the model

Model Manager Standard

Model Icon Model Icon

Model Manager

The process of creating a server model will create a new database on the server and



first stage required for any project using the Model Management System.

Follow the instructions below to create a new server model.

From the StruCad work space select the category Detailing to display the work folder


Click New Server Model from the tool bar or select Model Manager

Model from the drop down menu.

Log into the Model Manager as either the System Administrator or any user with the

Create Server Model right activated.

The Model Manager will open with the Model Details tab displayed. Fill in the details


alone model.

If you have an existing 3D model in the

current work directory tick the Use Existing

option to automatically upload that model

to the server rather than use a default

model for the current installation set.

is set by default as

which will allow

o assign other users to this model

and dictate which user rights those users

It t recommended that the Model

left as the defaults.

Once the server model has been created a

local model will be created in the default

work folder of the user who created the

A model created by the Model Manager and

a standalone model created by StruCad can

be distinguished from each other by the

to the left of the model.

Standard StruCad

Model Icon

G3 - Users Guide

server and



From the StruCad work space select the category Detailing to display the work folder


rom the tool bar or select Model Manager -> New Server

Log into the Model Manager as either the System Administrator or any user with the

odel Details tab displayed. Fill in the details




Assigning Users to a Model

Assigning users to a model allows that user access to the server model. Only the System

Administrator and the Model Administrator can assign users to a model.

Until a user has been assigned to a model it will not be present in their Model Browser,

preventing user from accessing models without administrative control.

Each user has a default set of User Rights configured by the System Administrator, these

rights can be changed by the System Administrator or the Model Administrator for each

server model.

Follow the instructions below to assign user to a model. User can be assigned to a model at

any time.

1. Log into the Model Manager as the System Administrators or the Model Administrator.

2. Open the Model Browser panel listing the currently assigned models. If the Model

Browser panel is not displayed, select Window -> Model Browser from the drop down

menus.

3. Right click on the model to which the user is to be assigned and select the Assign User

option and open the drop down menu that is displayed.

4. A list of available users will be shown, select a user from the list to assign this user to

the model.

It is possible to remove a user from a model using the right click Remove User option in the

Model Browser panel.

The user right for each user assigned to the model can be modified by right clicking on the

user in the Model Browser and selecting Edit User.



Creating a New Local Model

When working with the model management system each user has a local model on their hard

drive which they perform all of the modelling/issuing activities within.

Each user that is assigned to a server model will first need to create a new local 3D wire frame

model to work with.

The process of creating a local model will only need to be carried out once the first time the

user works on the project.

Step 1

Start the Model Manager from the StruCad Workspace using the toolbar icon or the Model

Manager drop down menu.

Step 2

When the model manager opens a list of model that the user

is assigned to will appear in the Model Browser panel on the

right hand side.

Step 3

Right click on a model in the list that does you require a local

model for and choose the Create New Local Model Option.

Step 4

The model will be loaded on screen and downloaded to the users local work folder. The model

manager will automatically switch to Get Latest mode.

If you wish to Get any information into the local model, select the items and click the Go

button to download them.

Step 5

The local model will now be present in the users work folder.



The Model Manager Interface

The Model Manager is the common interface used to control the information in the users local

model and allows the user to exchange information between their local model and the master

server model.

The Model Manager has a common appearance irrespective of how or when the Model Manager

is opened. In this section will look at the standard interface functions and layouts, including

the toolbars, drop down menus.

Lets take a brief look at the Model Manager and see where things are;

The model manager has a similar appear to most programs. At the top of the screen you will

find the drop down menus and toolbars. The commonly used options can be found on the

toolbars, while some additional options are only available through the drop down menus.

The screen is then divided horizontally across the screen into 3 sections or Panels;

The Item Browser Model Entities such as putlibs, macros etc not seen in the preview.

The Model View Tabs Server/Local model preview and other system information.

The Model Browser List current server models the user is assigned to.

Each Panel contains information relating to either the current model or the system as a whole.

If at any time a panel gets turned off, it can be turned on again using the Window option in

the drop down menus. If required the panels can be resorted to the default layout using the

Window -> Reset Layout option from the drop down menu.

Now well explore each panel and what information they display and how to control it.



Model Manager View Mode

The View Mode that the model manager is set to affects how each of the panels displays and

filters it information. The view mode can be set to either Differences Mode, Status Mode or

Entity mode.

Difference mode: This mode highlights the differences between the users local model and

the server model. Items are coloured differently based on being new,

modified, only on the server etc.

Status Mode: This mode highlights who owns which parts of the model. the preview

displays both server model and local model content. Items belong to a

user specific user or can be classed as Check In (not owner by anyone)

or Issued (checked out to the issuer using the GetIssue mode.)

Entity Mode: This mode highlights entities based on their wireframe layer/colour.

For both Difference and Status mode the legend at the bottom of the screen can be used to

determine what the colour means.

The mode selected also affects the Item Browser display, listing items by either their

Differences or their Status.

The Refresh Server option is used to refresh your current session with the server should

updates or changes occur while you are logged on and the Model Manager is open.

Item Browser

The Item Browser contains a list of Controlled

Files. These are files with the model that are

being included in the server model.

These files are automatically compared, looking

for differences every time the Model Manager is

opened. The initial window will display a list of all

files on the server and the users local. The tree

structure can be expanded to see sub

folders/files.

The filter buttons at the bottom of the item browser can

be used to filter the list to only display controlled files of

a particular status. This is dependent on the view mode

being used. If set the Differences mode it will list new,

changed, deleted etc. If set to Status mode it will list

user names, Issued, Checked In etc.

The folders and files listed in the item browser are context

sensitive, the right click mouse options will allow

individual files to be added/removed from the current

selection and also allow some files to be opened and

edited.



The Model View Tab

The Model View tab displays a preview of the models current state. The preview contains a

simple wireframe style 3D view of the model. the view is a combined depiction of the local

model and the server model.

The wireframe depiction can be manipulated and viewed from a different direction using the

same controls as the StruCad 3D & 2D environments.

Fixed View Directions;

The view direction tool bar allows the user to select from a series of fixed view directions

exactly as in the 3D & 2D environments.

ISO, ISO2, ISO3, ISO4, FRONT, BACK, LEFT, RIGHT, PLAN

Dynamic Rotation;

The mouse can be used to rotate the wireframe preview by holding down the Shift key as in

the 2D & 3D environments.

The mouse wheel can be used at any time to zoom in or out of the view. The zoom centre

point is focused on the mouse cursor.

Entity Selection;

The Model Manager has several different facilities available for the

selection of wire frame items. Many of the facilities are similar, if

not the same, as those used in the 3D wireframe.

We will now look at a few different ways of selecting these entities.

All selection options are accessed via the Selection toolbar or by

right clicking the mouse in the model view.

Below is a brief description of each selection option.

Single Selection: Selects one item at a time using the mouse.

Window: Selects any item which falls completely 100% within the window

area.

Cross: Selects any item that a portion of lies within the selection area.

Selection area is rectangular.

Circle: Selects any item that a portion of lies within the selection area.

Selection area is circular.

Visible: Selects any item currently visible on the screen

All: Selects all items shown in the model view, whether they can be

seen or not, irrespective of layers being turned off or frozen.

Group: Selects items based on group criteria, see below.

Add: Set the selection mode to Add. Any selection function used will

add items to the selection set.

Remove: Sets the selection mode to Remove. Any selection functions used

will remove items from the selection set.

Add Endtypes: Add the Endtypes of selected members if not selected.



Layer Filtering

Another way to make selections easier is to use the layer

selection option; this functions in the same manner as the

StruCad Layer command, allowing users to toggle layers

on/off as required, as well as freezing the layers so they

cannot be selected.

The Model Browser

The Model Browser panel displayed on the right side of the screen lists all model that the user

has been assigned to. If the user has not been assigned to a model then it will not be visable

in the list.

Each model can be expanded to list the users assigned to the model. Both the model and the

users assigned to it are context sensitive. Right clicking on either the model or a user presents

a list of options based on the users rights. The use of these options is seen throughout these

manuals.

Toolbars

The model manager has a standard set of toolbars containing the common commands and

functions that will be used.

The toolbars can be moved and detached/attached by clicking and hold the left mouse button

over the vertical dots to the left of each toolbar. The toolbars can also be customised using the

down arrow at the end of each tool bar block, this option can add and remove buttons from the

toolbar as well as creating new toolbars.


G3 - Users Guide

Model Manager Stages

Any project can be broken down

carried out by the user to build the project too completion. Each user will be involved in 1 or

more of these stages based on the size of the job and the user

highlights the commands and modes

illustrates the stages.

Set-up, this is the process of creating the server model and generating the initial wireframe

model. This process only needs to be carried out once at the start of the project.

Modelling, this is the process of generating the wire frame and connections. Users at this stage

only need use the Check in & Check Out mode to build the model and the Get Latest mode to

keep up to date with changes.

Restricted Users, this process allows

information but at a very restricted level. Users at this stage only need use the Check In mode

and Get Latest mode. The Check Out on Behalf of mode is used by the

access conditions.

Read Only, this process allows a user access to the server model but in a read only mode. This

means they can only use the Get Latest mode.

Issuing, this is the process of generating the issuing model then sharing the mark and

production data with other users. Users at this stage only need use the Get Issue and Put

Issue modes, they may also use the Check In mode to control production data.


Any project can be broken down several stages. Each stage represent a process that

d out by the user to build the project too completion. Each user will be involved in 1 or

more of these stages based on the size of the job and the users working on it.

highlights the commands and modes a particular user may use. The diagram bel

this is the process of creating the server model and generating the initial wireframe


this is the process of generating the wire frame and connections. Users at this stage


this process allows restricted users eg, Sub Contractors to access the model


and Get Latest mode. The Check Out on Behalf of mode is used by the administrator

this process allows a user access to the server model but in a read only mode. This

means they can only use the Get Latest mode.

this is the process of generating the issuing model then sharing the mark and

ers. Users at this stage only need use the Get Issue and Put


G3-17

stages. Each stage represent a process that are

d out by the user to build the project too completion. Each user will be involved in 1 or

working on it. Each stage

particular user may use. The diagram below best

this is the process of creating the server model and generating the initial wireframe


this is the process of generating the wire frame and connections. Users at this stage


Sub Contractors to access the model


administrator to set the

this process allows a user access to the server model but in a read only mode. This

this is the process of generating the issuing model then sharing the mark and

ers. Users at this stage only need use the Get Issue and Put




The Get Latest Mode

The Get Latest mode downloads or Gets the latest information from the master server and

downloads it into the users local wireframe model.

This mode is classed as a read only mode as it simply reads information on the server and

does not make any changes to the server model.

Step 1

Start the model manager in Get Latest mode from within the StruCad wireframe model using

the GETLATEST command. This can be found on either the Model Manager tool bar or the

Model Manager drop down menus.

Alternatively if the model manager is already open the Get Latest mode and be activated by

selecting the Get Latest Mode button on the toolbar.

Step 2

The model manager is opened and the automatic comparison is run, this will then display on

screen the visual difference between the server model and the users local model. Any

differences in any files with the model structure will be indicated in the Item Browser panel.

Step 3

Select the wire frame entities and files to be Got into the users local model. This can be done

manually using the selection tools described in the Model Manager Interface section.

If the automatic Get Latest selection options are activated then the required wire frame

entities and files should be automatically selected. These automatic options are;

Automatically add server only items to the get latest selection.

Automatically add different items to the get latest selection.

Automatically add items that have been deleted on the server to the get latest

selection.

Step 4

When the require wire frame entities and files have been selected the Go button is clicked, a

summary dialog will appear detailing the items that will be downloaded to the users model.

Tick the Download Mark Data option to

have the piece mark data for issued items

download to your local model.

Click Ok and the items will be downloaded

into the local StruCad model. Click Cancel

to return to the selection stage.



The Check In Mode

The Check In mode performs two separate actions; firstly it uploads or adds information In

to the master server model. New wire frame entities or file are uploaded from the users local

model directly into the server. Secondly it releases ownership of any items that have been

Checked Out to the user. Therefore any existing wire frame entities or files that have been

modified or deleted can be uploaded to the server, but only if they have check out to the user.

Step 1

Start the model manager in Check In mode from within the StruCad wireframe model using

the CHECKIN command. This can be found on either the Model Manager tool bar or the Model

Manager drop down menus.

Alternatively if the model manager is already open the Get Latest mode and be activated by

selecting the Get Latest Mode button on the toolbar.

Step 2




Step 3

Select the wire frame entities and files to be Check In to the server model. This can be done

manually using the selection tools described in the Model Manager Interface section.

If the automatic Check In selection options are activated then the required wire frame entities

and files should be automatically selected. These automatic options are;

Automatically add checked out items to the check in selection.

Automatically add new items to the check in selection.

Automatically add new output files to the check in selection.

Step 4

When the require wire frame entities and

files have been selected the Go button is

clicked, a summary dialog will appear

detailing the items that will be uploaded

into the server model.

If a comment is entered it will be used as a

description of what is being uploaded in the

Model History and rollback.

Tick the Keep Checked Out option

uploaded the items but keep them Check

Out.

Click Check In and the items will be

uploaded into the server model. Click

Cancel to return to the selection stage.



The Check Out Mode

The Check Out mode performs tow different actions; Firstly it downloads information from the

server into the local StruCad model, in the same way as the Get Latest mode. Secondly it

assigns ownership of the items being checked out to the user. This allows the user the modify

the items and upload them to the server using the Check In mode.

Step 1

Start the model manager in Check Out mode from within the StruCad wireframe model using

the CHECKOUT command. This can be found on either the Model Manager tool bar or the


Alternatively if the model manager is already open the Check Out mode and be activated by

selecting the Check Out Mode button on the toolbar.

Step 2




Step 3

Select the wire frame entities and files to be Checked Out from the server model. This can be

done manually using the selection tools described in the Model Manager Interface section.

Step 4


summary dialog will appear detailing the items that will be checked out to the user.

Tick the Keep Local Objects option to check out the items to the user but not have them

downloaded from the server into the local model.

Click Check In and the items will be uploaded into the server model. Click Cancel to return to

the selection stage.



The Checking Out on Behalf of other users

The Check Out on Behalf of mode can be used to perform a Check Out on behalf of another

user, this simply assigns ownership of the items to a user but does not download anything

from the server. The user that the items have to check out for can then use the Get Latest

mode to download the items checked out to them. As the items have been checked out to the

user they can therefore be modified and checked in.

This option can be used when you wish to restrict access the level of access a particular user

has to the model. The user will have the Check In Only right activated, allowing the user to

add new content but only modify or delete content is assigned to the user by the Check Out

on Behalf of mode.

The Check Out on Behalf of mode can only be used by either the system administrator or the

model administrator.

Step 1

Either the system administrator or the model administrator log into the model manager from

the StruCad workspace so that the Model Browser panel is displayed.

Step2

Expand the user list under the model that the Check Out on Behalf of

is to be preformed against and right click on the user that the items

are to be check out to. Select the Check Out on Behalf of option from

the menu.

The status bar will display the message The next Check Out will occur

on behalf of ... and the mode will be changed to Check Out mode.

Step 3

Select the wire frame entities and files to be Checked Out from the server model. This can be

done manually using the selection tools described in the Model Manager Interface section.

Step 4


summary dialog will appear detailing the items that will be checked out to the user.

Step 5

The user who the items have been checked out for performs a Get Latest and the items will

be automatically added to the get latest selection, other items can be added to the selection

either manual or using the automatic Get Latest selection options.

Step 6

The Check In mode can then be used to upload changes to the items that have been checked

out to them.



The Undo Check Out mode

The Undo Check Out mode is used to undo a check out that has been preformed. This option

may be used when the user who performed the check out is not present, or the user wants to

check in items without actually updating the server.

Automatic Checking Out

When modifying end types, either putlibs or macros and when editing the section catalogue

the user will be prompted directly to check out the files being altered.

Putlibs

When an existing putlib is being overwritten the user will be prompted to Check Out the putlib

file (.lib) if they do not already have it checked out. If the user click Ok to check out the file.

the model manager will open in Check Out mode. Once the file has been checked out the user

is returned to the putlib dialog and can over write the file.

Macros

When an existing macro is being edited the user will be prompted to Check Out the macro

setup files (.dat or .xml) if they do not already have it checked out. If the user click Ok to

check out the file. the model manager will open in Check Out mode. Once the file has been

checked out the user is returned to the macro editor dialog and can save the file.

Section Catalog

When editing the section catalog using the SEECTION command or any other command that

modifies the catalog files the user will be prompted to Check Out the catalog files if they do

not already have them checked out. If the user click Ok to check out the files. the model

manager will open in Check Out mode. Once the file has been checked out the user is

returned to the command to continue adding the section size.



Preparing the Model For Issuing

Before the Issuing functions can be used the model and members to be issued need to the

prepared and set up appropriately.

The Model Management System uses Mark Categories to select the members to be issued in

the same way as the ISSUE command.

Mark Categories need to be applied to any members that you wish to issue.

It will also be necessary for all users on the project to Check In everything just prior to the

Get Issue mode being used, this is to ensure that all members and files are free for selection

by the Put Issue mode.

While the above items are required to be performed before the issuing process is started it is

advised that the following items are all configured prior to issuing.

All User Attributes are applied.

Marking Parameters Model Parameters & InitMark

Drawing Parameters Fabrication Drawing Parameters (FADPS) etc.

General Parameter Files CAM Data, Post Processors etc.

Issuing through model manager has the following major advantages over previous issuing

methods;

Prevents any steel from being issued with connections missing created by connecting

parts in the model.

Automatically allocates connecting members not being issued to mark category 99.

Option to automatically make connecting members dummy.

The far end joints of connecting members are automatically nulled to prevent macros

errors and prevent plate/cleat marks being used.

When members are selected for issue, all members, endtypes, parameter files etc. are

automatically checked out to the Issuer, preventing other users modifying connections

or parameters that have been used for the issue.

Once an issue is complete the mark number can be uploaded back to the server

allowing all users to download mark numbers for the issued steel within seconds of it

being issued.



The Get Issue Mode

The Get Issue mode automatically generates the issue model, selecting the members, end

types, parameter files etc required to issue the selected members but also intelligently

selecting other parts of the model that are required for consistency of joint connectivity and

marking information, automatically allocating these to a non-issue status and making them

into dummy members.

Step 1

A user with the Mark and Issue rights logs into the model manager and creates a new local

model. They do not perform a Get Latest on the model at any point.

Step 2

Start the model manager in Get Issue mode from within the StruCad wireframe model using

the CHECKOUT command. This can be found on either the Model Manager tool bar or the


Step 3

The Model Manager will open displaying

all members in the model in Grey

indicating they are not issued;

From the Issues panel (right) select the mark

categories to be issued and change the Status to

Selected for Issue;

The members in those mark

categories will turn Green

indicating they are selected for

issue.

The connecting member from

other mark categories will turn

Red indicating they are

Connected to a member/joint in

mark categories previously

selected for issue and so are

required to make the connections.



The connecting members will form part of the issue model, their mark categories will be

changed to 99 and they will be made dummy members, this change will only be in the issue

model, not on the server.

Step 4

Connecting members can be made either dummy or real members, this is an option that is

set when users are added to the system by the administrator;

Step 5

Click OK at the bottom of the Issues panel to download the wire

frame information to be issued.

The Update Local Files dialog box will now appear; this contains all

the end type files that are required for the issue to commence.

These files will be Checked Out automatically and assigned to the

issuer along with the wire members.

Click OK to continue and return to the 3D model.

Step 6

The model and can be issued using the standard issuing procedures for StruCad, running the

ISSUE command and generating the required drawing, reports, CAM data etc.

Note: If the mark data on the server does not match the mark data in the model i.e. a change

has occurred locally in the issue model, you will be prompted to run a Put Issue before the

Get issue can be run.



The Put Issue mode

This mode allows piece mark data to be uploaded from the local Issue model to the master

server model. The solid and mark data for all issued items is uploaded by the Put Issue mode,

this can then be downloaded by the using the Get Latest mode, marking all issued items in

the local model the same as the Issue model.

Step 1

Issue the model using the ISSUE command. Ensure all mark data is correct and that all items

in the Issue model have been marked.

Step 2

Start the model manager in Put Issue mode from within the StruCad wireframe model using

the PUTISSUE command. This can be found on either the Model Manager tool bar or the Model

Manager drop down menus.

Step 3

The 3D wire frame will be temporally hidden and the Put issue dialog displayed. Click the Ok

button to start the uploading process. This may take more time that the other

uploading/downloading options as more information is being exchanged.

When finished the 3D wireframe will open again and the mark data will have been uploaded.



Managing Production Data

The Model Management system not only controls the wire frame entities and solid model mark

data but also the production Data that is generated from the model. This covers drawings,

material reports, Cam data etc.

To upload the production data generated by the issue model we use the Check In mode.

When the Put Issue has been run a check in is then run to upload the production data.

The model manager has be configured to automatically detect new, modified or deleted

production data and include it in the check in selection, if the automated Check in options are

selected.

The Controlled Files configurations determine which files within the models structure will

checked and available to be Check in. More on controlled files can be found in the Controlled

Files section.

The Check Out Drawing Mode

This is a special command only available from within the 3D wire frame. It is used to select

drawings that may need to be check out and modified. This allows the user to select a single or

group of wire members and choose which related drawings they wish to Check Out.

Step 1

Start the model manager in Check Out Drawings mode from within the StruCad wireframe

model using the CHKOUTDRW command. This can be found on either the Model Manager tool

bar or the Model Manager drop down menus.

Step 2

Select the wire members which any type of drawing is required for and press enter.

Step 3

The drawing selection dialog appears, select the

drawings you require and click Ok for them to

be checked out and downloaded into your local

model.



The Group Functions

The Group function uses member attributes such as stock size, mark category, user attributes

etc. each attribute can be set as either true (is equal to that value) or false (is equal to

anything other than that value). Using the selection tools described above, the members can

then to added or removed from the current selection set.

The Group function displays a grid in the right panel

listing the attributes available to group by. Select the

value you want to group by in the Value column and set

its Logic as true or false.

Once the group criteria have been defined, you need to

define which members you wish the group function to

find items matching the criteria from. Use the selection

tools described above to select the members.

The final option is whether to add or remove items from

the selection set. This can be achieved by setting the

selection set to Add or remove using the Add/remove

options.

Wire Frame Grouping

An addition option has been added to the 3D

wire frame group command to allow the user

who owns a wire to be grouped.

Simply run the GROUP command as usual

and on the last page enter the user name in

the Model Manager User dialog.

The MUSERSTATUS Command

The MUSERSTAUS command performs the same function as the Status Mode does in the

model manager but within the StruCad 3D wire frame.

When the MUSERSTATUS command is run in the wire frame each wire is coloured according

the user that owns the member. The colour is taken directly from the colours defined in the

model manager.

To return the wire colours to the layer/wire colour simply run the MUSERSTATUS command

again.

The MUSERSTATUS command can be started from the wire frame toll bar or the model

manager drop down menus.



Server Model Options

Once a sever model has been created each user has a variety

of option available to them related to that model. These options

are accessed by right clicking over the model name in the right

hand panel.

The following sections will cover these options.

Create New Server Model

This option allows the current user to create a new server model. This will create a new

database on the server and automatically populate it with the standard model files. Further

details can be found in the User Guide detailing the full New Server Model Options.

Create New Local Model

This option creates a new 3D wireframe model in the work folder of the current user. This

model is connected to the Model Manager and as such will allow the Model Management

commands to be run within the 3D wireframe model that is created.

The models background files will be automatically downloaded into the Local model however

the Wireframe will be empty. As soon as the model has been created Locally the Model

Manager will switch to Get Latest mode. At this point at part of the current server model can

be downloaded directly to the Local model.

Create New Standalone Model

This option creates a new 3D wireframe model in the work folder of the current user. This

model is not connected to the Model Management server and as such the Model Management

commands cannot be run within the 3D wireframe model that is created.

Delete Model

This option deletes the currently selected model from the server. This deletes the model

database and all references to it. Once the model has been deleted it cannot be restored.

Load Model

This option loads the selected model into context. This basically loads up the details of the

model, displaying the Item Browser the Model View tabs.

Restore Model Database

This option allows a model to be restored to the server from a backup file (.bak) created using

the Backup Model Database option. This option is only available to the System Administrator.

Backup Model Database

This option allows a model to be back up into an SQL backup file (.bak), this can only the

restored by the Restore Model Database option. This option is only available to the System

Administrator.

Assign User

This option allows the user to Assign users to the currently selected model. This option is only

available to the System Administrator or the Model Administrator.



Sending Messages between Users

Once logged into the Model Manager messages can be sent directly between users via the

Model Browser panel. Once a message has been sent it will be received by the user it is sent

to the next time the Model Manager is opened.

1. Start the Model Manager and open the Model Browser panel

listing the currently assigned models. If the Model Browser

panel is not displayed, select Window -> Model Browser

from the drop down menus.

2. Expand the model list to display all current models and then

expand the list of users assigned to the model.

3. Right click on a specific user and select Create Message.

4. Enter your message in the Create Message Dialog that is

displayed and click Ok to send it.

The message will be sent to the user and received the next time the user logs into the Model

Manager.

If a message has been send it error or is no longer required it can be deleted by using the

Delete Messages option. This will delete all pending messages to the selected user, sent from

the currently logged in user.



Automatic Check-In Notification

It is possible to use an external e-mail server to send automatic notification messages to a

user every time a Check In is preformed.

This will required two different settings to be configured. Firstly the e-mail server details will

need to be entered, secondly the user will have to activate the Check In e-mail notification

option.

Configuring a E-mail Server Settings

To configure an external e-mail server to use for automatic check-in notification the global

server option will need to be modified.

1. Log into the Model Manager using the System Administrators login details.

2. Select Tools -> Server Options from the drop down menu.

3. When the Server options tab is displayed, select the General option on the right side.

4. Enter the IP address of the e-mail server to be used into the E-mail Server option.

5. Click the Ok option to save the changes.

Activating Automatic Check-In Notifications

Each user has the option to activate automatic Check in notifications on a per model basis.

1. Log into the Model Manager using the System Administrators login details.

2. Open the Model Browser panel listing the currently assigned models. If the Model

Browser panel is not displayed, select Window -> Model Browser from the drop down

menus.

3. Expand the model list to display all current models and then expand the list of users

assigned to the model.

4. Right click on your user and select the Edit Notifications option.

5. To activate the automatic notifications

option tick the Receive Email Check-In

Notifications for above. Un tick the

option to de-activate.

6. Click the Ok option to save the

changes.



Model History and Rollback

The Model History and Rollback feature allow the history of change to any server model to be

viewed and if necessary Rolled back, restoring the server model to a previous version.

Model History

The Model History option allows any user to view a history of modifications to the server

model. Any time a Check In is preformed the details of what changes were made during that

check in can be viewed.

1. Log into the Model Manager using the credentials of any user assigned to the model.

2. To open the Model History select Tools -> Model History from the drop down menus

to display a list of Check Ins preformed against the model to date.

3. Select a Check In event and choose from one of the options at the bottom. Click Ok

to close the Model History tab.

The Details option

Select a Check In event from the list and click Details to view the specific summary of

changes made by the selected Check In event.

The summary of changes can be viewed and expanded in the left panel while the changed

wireframe entities can be seen on the right. Tick the Show All option in the bottom left corner

to view the changes in context of the whole server model.

The Report option

Select a Check In event from the list and click Report to save a report of all changes made by

that specific check in, in either PDF or XSP format.



Model Rollback

The Rollback option allows the System Administrator or Model Administrator to restore the

server model back to a previous point in time. Selecting a Check In event and clicking

Rollback will return the current server model state to the point after that Check In event

occurred.

The rollback process is recursive which means a rollback can be preformed to any point in the

models lifetime and multiple rollbacks can occur, effectively allowing the user to rollback a

model to a state before a previous rollback occurred.

Note: It is advised to make a backup of the server model prior to using the rollback

features.

The Purge option removes or purges the history details of a particular Check In or rollback

event. This can be used to reduce the server model size or clean up the model history.



System Administrator Options

The System Administrator has certain functionality available that are not available to any

other user.

Server Options

The Server Options data contains many settings related to the server as a whole, and some

information related to default behaviour for the local workstation.

The server options can only the accessed by the System Administrator from the Tools ->

Server Options drop down menu. When the Server Options tab opens, you will have 2 pages

to choose from, the Connection and General pages.

The General page contains two options. The SQL Backup Folder option details the location of

the Model Servers backup folder. This should by default be with the Model servers installation

folder. The Email Server option is used for automated check in notifications, when activated.

The Connections page contains three sets of options. The Default connection options are

related to the default connection parameters used by the local computer when starting the

Model Manager. The Web proxy details are used if the local computer is connecting to a

remote web service, these options are not always required. The Remote connection options

are used if connecting to a remote web server by default.

Event Logs

The Event logs contain a list of server events that have been logged. When logged in as the

System Administrator the event logs and be accessed through the Event Logging button at

the bottom of the Administrative Browser panel.

The User option displays a list of current user on the system. The Type option allows the either

error, warning or information events to be viewed, ranging in severity from error to

information. The From and To options allow events to be selected between specific date

ranges.

The View option can be used to view the events matching the select criteria, the Purge

option can be used to remove event matching the specified criteria.

Event logs can be used to diagnose system problems.



System Back-ups

It is possible to backup individual models via the Model Browser. It is also possible to make

an SQL backup (.bak) of the Model Manager System information. This will contain information

such as users and their configurations, server options, current models etc.

This information can be used to restore the Model Management system to working order

should the server data become corrupt or can be used if moving the server to a new location

or installation.

Controlled Files

Controlled files are files within the models structure that are considered by the model manager

when determining what is to be uploaded or downloaded, between the local model and the

server.

By default all of the required controlled files are preconfigured to be considered. It may be

necessary at times to add additional files and folders to the list to be considered, such as

engineers drawings, customised output files etc.

The controlled files configurations can only the altered by the system administrator.

Step 1

Start the model manager from the StruCad workspace and log in as the system administrator.

Step 2

Open the Controlled Files dialog using the Tools -> Configure Controlled Files option from the

drop down menus.

Step3

Click the Add button to add additional controlled files to the list. The Add File Configuration

dialog will appear.

Step 4

Enter the file configuration details and click Ok.

Description: This is the description of the controlled file configuration.

Folder: This is the folder structure within the model structure where the

files to be considered are located. Enter the folder structure such

as spf\fab\ to look in the fab folder or enter and * at the to look

in the fab folder and all sub folders.

File or Wildcard: Then the file types to be considered. Eg bolts.dat, grades.dat etc.

The * wildcard can be used to select files of a similar name eg

*.spf for all spf files.

Type: This option controls the type of file being considered. This affects

which user options are used for these file.

Text Editable: Tick this box if the file is editable in the Model Manager text

editor.

Documents

Strucad G3 MM Users Guide