EDMmodelServerManager™

User Manual – general functionality
Version 0.7

Document revision history

Initials:
AETArne Tøn
MDMarco Delgado
JRAJorulv Rangnes
PPPrasad Pokala
PZPavelas Zolotariovas
PHPål Huse



Proprietary notice:
Information in this publication is subject to change without notice. The software described in this publication is furnished under license agreement or non-disclosure agreement. The software may be used only in accordance with the terms of those agreements. No part of this publication may be distributed to third parties, copied, duplicated, in any form, whole or in part, without the prior written permission of Jotne EPM Technology AS, Grenseveien 107, N-0607 Oslo, Norway.

Innhold
EDMmodelServerManager™ Generelt
1 Introduksjon
1.1 Referanser
1.2 Informasjon for innlegging – maildata og rådata
2 Grunnfunksjonalitet / brukergrensesnitt
2.1 Logge inn
2.1.1 Bytte passord
2.2 Control Windows Layout
3 Working with Models
3.1 Import Models
3.2 Export Models
3.3 Open and Close Models
3.4 Model Navigation
3.4.1 Model Explorer
3.4.2 3D Viewer
3.4.3 Property Sheet
3.4.4 Reports
3.5 Model Units
3.6 Model Versioning
3.7 Check-In and Merge
3.8 Access Control for Models
3.9 Delete Models
4 Reporting
4.1 Manage Reports
4.1.1 Create and Edit Reports
4.1.2 Running a report
4.1.3 Selecting columns
4.1.4 Formatting of cells
4.1.5 Running a report
4.1.6 Import and Export Reports
4.2 Execute Reports
4.2.1 Report Aggregation
4.3 Access Control for Reports
5 Funksjoner
5.1 Dokumenthåndtering
5.1.1 Visning av dokumenter i treeview
5.1.2 Dokumentrapport
5.1.3 Basisfunksjonalitet
5.2 TFM Håndtering
5.2.1 Generelt
6 Systemadministrasjon
6.1 Server Installasjon
6.2 Klient Installasjon
6.3 Brukeradministrasjon
6.3.1 Opprette brukere
6.3.2 Opprette SSO brukere
6.3.3 Roller / grupper
6.3.4 Opprette prosjekt
6.3.5 Tildele roller i prosjekt
6.4 Backup
7 Problemløsning
7.1 Problemer med logon med Single Sign-on (SSO)
7.2 "Illegal model name syntax" error when importing new model
8 Annex : Teknisk informasjon
8.1 Diskplass og minnekapasitet på server
9 Annex : Default tilgang for roller
10 Teknisk informasjon
10.1 Rapporter som må være i systemet

Introduksjon

This document is a placeholder for a future English version of "Brukermanual for modellserver for St. Olav Eiendomsdrift, Trondheim." Følgende omhandles i denne manualen:
Installasjon
Brukeradministrasjon
Tekst skrevet med rød kursiv tilsvarendende dette er kommentarer til dokumentet.

Referanser

Jotne-1. «MSMUserGuide-BIMUpgrade.docx.» .

Informasjon for innlegging – maildata og rådata

From: Gudbrand Skarseth
Sent: 5. juni 2015 11:48
To: Arne Tøn
Cc: Pavelas Zolotariovas; Prasad Pokala; Marco Delgado
Subject: Releasenotes MSM3 - Release date tuesday 9. june.
New MSM3 core functionality

• Systems, zones and ownership nodes are not displayed in the IFC treeview any more.
    This reduces the number of nodes in the treeview significantly.
• New Catalog treeview showing all type objects in the model with their related element instances below.
    Must be configured in the enterprise registry.
    New Registry_Unit.xml checked in on \trunk\Install\Schemata\Export_Import\195.139.163.189.4020\ModelServer_#_ENTERPRISESCHEMA\EnterpriseModel_Entities
• New Systems treeview showing all groups, systems and zones in the model with their related element instances below.
    Must be configured in the enterprise registry.  New Registry_Unit.xml checked in (see above).
• Drag/drop functions for model import and export in Project Explorer
• Drop of documents (files) to any building object in the Model explorer
• Drag-drop export (check-out) of IFC files from Model Explorer.
• Drop of IFC files to Model Explorer initiates Check-in/Merge dialog.
• Animated image (GIF) in row indicator of the Project Explorer and Model Explorer indicating progress during export/import
  Gudbrand
  
  

  Grunnfunksjonalitet / brukergrensesnitt

  Logge inn

  Brukere kan logge inn i modellserver dersom de har en brukerkonto. Om du ikke har noen brukerkonto, må denne opprettes av systemadministrator (superuser), se avsnitt xxx.
  For å holde orden på flere brukerkontoer og server kan du definere flere tilkoblingsoppsett (connections). Logg inn som følger:

• Velg eller lag et navn på tilkobling (connection name)
• Skriv inn brukernavn og brukergruppe (rolle)
• Skriv inn passord.
• Legg inn IP-adresse og portnummer for modellserver.

Når all informasjon er lagt inn kandu sjekke om den korrekt ved å trykke "Test" knapp. Dersom informasjonen er riktig, skal knappen vise , dersom noe er galt vil du få en feilmelding. Det kan ta en liten stund fra du trykker på testknappen til testen er ferdig kjørt..
Dersom du krysser av "Log on when EDMmodelServer starts" vil du automatisk bli koblet til forrige brukte tilkobling når MSM klienten starter.
Dersom du krysser av "Use SSO" vil MSM klient bruke påloggingsinformasjon fra Windows / Active Directory, brukernavn og passord være grået ut, og din "domenebruker" vil bli brukt i stedet. Dette vil kun fungere dersom din domene-bruker er definert i modellserver, se avsnitt xxx.-
Du kan kjøre mot en local database på din egen maskin ved å bruke "LOCAL" fanen. Dette er en funksjon for spesielll bruk/brukere, og vil ikke bli omhandlet mer her.

Bytte passord

Du kan bytte password ved å velge "Change Password" fra "File" verktøystripe. Dette vil åpne "Change Password" dialog. Når du legger inn nytt passord, bruk helst lovlige symboler for å unngå portabilitetsproblemer, (see addendum for illegal characters).

Control Windows Layout

EDMmodelServerManager is divided into components, which are straightforward and have easy-to-use design-time experience. Each component can be customized based on user needs. If you want to have "Project Explorer" in the left bottom corner, you can drag and drop in there. After performed action selected component will always be located there (even after reloading EDMmodelServerManager) unless user will want to change it location again.

From "View" tab it possible to select two standard control windows layout options "Reload Last Saved" and "Default Layout".
"Reload Last Saved" – allows user to load last saved customization of windows layouts;
"Default Layout" – restores all component windows to default positioning.

Working with Models

Import Models

Users can import IFC models to EDMmodelServer™, both in STEP or XML format. In order to do so, select "Import Model" in the "File" tab. There is also a possibility to access "Import Model" form from "Project Explorer" (press right mouse button).

Select a "Project" from the available list to which you want to assign an importing model;
Type in appropriate Industry;
Select or type in appropriate Discipline;
Select or type in appropriate status of IFC model;
It is not obligatory to enter an Author of the IFC Model;
Select "Browse" to navigate to the appropriate IFC file and select it;
Rename Model name or accept the default model name.
EDMmodelServer™ supports versioning at model level. New version of the model will increment if Model name and Discipline is the same as an existing model. If a described criterion is not met, model will be imported as a new/different model. Users can switch back and forth between the versions of a model after import.

Export Models

Users can export IFC models from EDMmodelServer™, both in STEP or XML format. Export option is also available either from "File" tab or from "Project Explorer" (right mouse click on the model and select "Export model"). As it was mentioned previously EDMmodelServer™ supports versioning at model level, so before exporting a model you should select a preferred model version.

Push "Browse" and navigate to the appropriate folder, where you want to save a model;
Note: It is not possible to store model on root level;
Rename Model name or accept the default model name;
Select in which format you want to save selected model;
Push "Export" button and wait for action to finish;
When export will finish file explorer will be opened.
Note: If you received an error message that export was unsuccessful please contact your EDM Administrator.

Åpne og lukke modeller

I Project Explorer listes tilgjengelige modeller, med navn, versjonsnummer, disiplin etc.
For å åpne ønsket modell, marker modellen i 'View' kolonnen som vist i figuren nedenunder. Flere modeller kan være åpne samtidig.
For å lukke modellen, fjern markering i 'View' kolonnen.

Model Navigation

Man kan navigere i modeller på flere måter:

• I Model Explorer, ved å ekspandere og velge elementer i tree views. Ved å dobbeltklikke et element i et av de tilgjengelige tree view, highlightes dette og det zoomes inn til det.
• I viewer, gjennom bruk av musen.

Model Explorer

I Model Explorer presenteres modell i ulike trestrukturer:

• IFC View: topologisk nedbrytning av modell; site, bygning, etasje, elementer i etasjen,
• Element View: byningselementene gruppert etter type (dekker, vegger, dører, vinduer, etc.)
• TFM: trestruktur med elementer tagget i henhold til Tverrfaglig MerkeSystem (TFM)
• Nomenklatur: for romobjekter, 'Nomenklaturet' klassifisering (Hovedfunksjon, Delfunksjon, Romnavn, Romspesifikasjon, Kapasitetsbærende)
• Ownership: <???>
• Catalog: gruppering på typeobjekter. Individer av typen listes gjennom å ekspandere ønsket typeobjekt.
• Systems: gruppering på modellens systemer…..

Man kan ekspandere trestruktur og dobbeltklikke et element i strukturen for å zoome inn til det, samt se objektets egenskaper listet i 'Properties' vinduet for valgt element.

3D Viewer

Navigering i viewer kan gjøres på ulike måter, litt avhengig av hvilken navigasjonsmodus som er valg. Den vanligste (default) er 'spin' modus . Modus kan endres gjennom å klikke på symbolet, og velge en av de andre modusene.

I 'Spin' modus, har musetastene følgende funksjoner:

• Hold venstre musetast nede og beveg: modellen snurres om 'pekerpunktet'
• Scroll med rullehjul: zoom inn/ut
• Trykk ned rullehjul, hold nede og beveg: panorer modellen
• (Høyre musetast har ingen funksjon)

'Walk' modus er nyttig om man ønsker å navigere i ett og samme plan (f.eks. i en etasje).
I 'Walk' modus har musetastene følgende funksjoner:

• Hold venstre musetast nede og beveg forover/bakover: 'gå' forover/bakover' i modellen
• Hold venstre musetast nede og beveg sideveis: snu modellen i retning av musebevegelsen
• Scroll med rullehjul: 'tilter' modellen opp/ned
• (Høyre musetast har ingen funksjon)

Predefinert views velges ved å klikke symbolet og velge ønsket view:

For å zoome ut for å se hele modellen, klikk på .
For å zoome til et område, klikk på . Klikk så et punkt i viewer, og deretter et punkt til for å definere et rektangel for å zoome inn til dette.

Property Sheet

For et valgt element, vises dets egenskaper i Properties vinduet, under 'Properties' fanen. Egenskaper på hvit bakgrunn er egenskaper for det valgte elementet/individet, mens egenskaper som vises med rosa bakgrunn er egenskaper arvet fra aktuelt typeobjekt.

Under fanen 'Tasks' vil eventuelle oppgaver/arbeidsordre for aktuelt objekt listes.
Under fanen 'Relations', listes objektets relasjoner
Under fanen 'Placement' listes objektets posisjon (relative koordinater)
Under fanen 'Documents' listes eventuelle dokumenter for objektet. Se også kap. 5.1.

Reports

Model Units

Man kan angi hvilke enheter man ønsker benyttet i modellene gjennom bruk av 'Unit Settings' og 'Unit Conversion On' under Tools menyen:

Klikke på 'Unit Settings' for å endre de enheter som ønskes benyttet for de ulike målerverdiene. Velg enheter og trykk OK for å aktivere.

For at endrede enheter skal vises i Propeties vinduet, må 'Unit Conversion On' være huket av (markert med blå ramme i figuren ovenfor).

Model Versioning

Har man en ny versjon av en modell, kan man importere den nye versjonen gjennom å høyreklikke på aktuell modell i Project Explorer. Man får da en contextmeny, og velger da 'Model Management > Import new version of model'.

Man får da opp en dialog for å velge fil inneholdende den nye versjonen. En del felter er preutfyllt, med informasjon fra aktuell versjon i databasen.

Felter med rød asterisk er obligatoriske. Fyll ut disse feltene, og velg 'Import' knappen for å importere den nye versjonen av modellen. Versjonsnummer for aktuell modell inkrementeres med en. Man kan når som helst åpne hvilken som helst av versjonene man har tilgjengelig, gjennom å velge ønsket versjonsnummer for ønsket modell i Project Explorer.

Check-In and Merge

Users can open couple of models at the same time and 3D View of each will be merged into 3D scene by the system. During the check in operation, users can select the original model and the system will automatically merge the imported data back into the model.
Right mouse click on the model in "Project Explorer" and select Check-In/Merge option, a new for will appear.
"From Model" list or "From File" select which model/s to you want to merge with a selected model;
By need select your Check-In/Merge options (do not combine them between):
Version Control:
"Do not create new model version" – merge will be processed on the current model version.
Note: Rollback will not be possible.
"Create only one new model version" – create new version of the final result only. This option is relevant when you merge couple of models.
Note: By default merge will create new version for each individual input model.
Performance:
"Skip 3D outline" – skips 3D outline. Therefore merge functionality will be performed quickly;
"Skip entire 3D generation" –no 3D generation is being done.
Merge:
"Do not recalculate relative positions of elements" - by default when elements are checked-in to a new parent in the spatial structure the relative placement is re-referenced to the parents placement and relative placement is recalculated. This option turns off this feature.

Push "Check-In" button.
The system performs a deep merge operation where each element of the model is checked for existence or modification. If the element no longer exists in the imported data it's deleted from the model, whether if it's modified the model element is updated accordingly.
Note: Merge finished successfully will indicate that a new version of the model has been added to "Project Explorer".

If you suspect that merge was performed not correctly, press "Show Messages" button in order to show output log of the merge functionality which can be sent to support team for detailed investigation.

Access Control for Models

Delete Models

Reporting

Manage Reports

Create and Edit Reports

How to create a new report:

• Navigate to "Report Management" under Tools.
• Press [+] button
• Give the report a new name (Name)
• Navigate to "Assign to Objects"
• Choose selected type(s) for example"ifcDoor" and press [>>]
• The report is now created.

Running a report

• Open a model
• Select object(s) in Model Explorer
• Right-click and run the report by selecting it from the drop-down list under "Show Reports"
• Velg en dør i rapporten (klikk på en rad) slik at Properties vises.

Selecting columns

Use Drag-Drop from Properties to column header area to add new columns to report.

Formatting of cells

There are two ways to set number of decimals (and other sorts of formats) on columns in the report module.

Local formatting

• Right-click on cell in column and select "Set column display style".
• Select Format type: Numeric
• Specify format expression: e.g. 0.## for two decimals.

Please note:
There is a bug in your current MSM version that will cause this sort of formatting of reports not to be kept between MSM sessions. All sorts of report formatting (e.g. column format, column width, column sequence etc) is not always kept between sessions.
This bug is corrected and will be available in next release.

Setting format in report definition  

2. Specify "Format" in "Detail" tab in Report Management module.
    This will define the initial column format the first time the report is used by a user.
    This format can also be obtained by the "Reset to standard layout" button in the report module.
    Format specification syntax:  e.g. "BTASpace,Numeric,0.##; NTASpace,Numeric,0.##"
    ";" is used as splitter between each column spec.
    "," us used between column name (e.g. "BTASpace") and the column type and format spec (e.g. "0.##")
  

Running a report

Import and Export Reports

Execute Reports

Report Aggregation

Access Control for Reports

Tilgangsstyring for rapporter er tilgjengelig fra 'Tools' menyen. Trykk på 'Reports Management' for å åpne rapportverktøyet.

Definer tilgang for valgt rapport gjennom å klikke på permissions symbolet ( ) for rapporten.

For å gi tilgang til rapporten for grupper og/eller individuelle brukere, klikk på 'Add' knappen for å åpne valgliste med definerte grupper og brukere.

I listen velger man gruppe og/eller bruker som skal gis tilgang til rapporten gjennom å markere disse og deretter klikke 'Add' knappen.
Som default får de nye gruppene/brukerne kun leserettigheter. Endre til ønsket tilgangsnivå (lese/skrive/full tilgang) for gruppe/bruker som ble gitt tilgang og klikk 'Apply' for å effektuere.
Tilgang for en valgt gruppe eller bruker kan fjernes gjennom å velge gruppe/bruker for aktuell rapport, og deretter klikke 'Remove' knappen.

Funksjoner

Dokumenthåndtering

Visning av dokumenter i treeview

Dersom det er tilordnet dokumenter til noder i treeview, vises dette som ikoner utenfor nodene. "Enkeltdokument" ikon viser at det finnes dokument for denne noden. "Flere dokument" ikon viser at det finnes dokumenter på underliggende nivåer også.

Her ser vi for eksempel at det finnes tilordnet dokument til "Plan 1 etasje". "000 Referansebygg" har både tilordnet dokument og dokumenter på en eller flere undernoder.

Dokumentrapport

Ved å klikke på dokument-ikon vil dokumentene vises i en tilpasset rapport "Documents". Rapporten må våre definert i konteksten "NoticeFlags", og kategorien må være "Document":

Om dette er i orden, skal det vises en rapport som ser omtrent slik ut:

Basisfunksjonalitet

Legge dokument til node i treeview:

1. Velg dokument (fil) i Filutforsker, dra inn i MSM klient og slipp på ønsket objekt.
2. Om et dokument slippes på et "Typeobjekt", for eksempel "Våtrom" under "IFCSPACE", så vil det gjelde for alle objekter av denne typen i alle etasjer.

Se dokumenter for node i treeview:

1. "Documents" fane i Properties vil vise tilordna dokumenter for "denne" noden.
2. Det finnes dokumenter tilordet "denne" noden. Trykk på ikon for å kjøre "Documents" rapporten, som viser dokumenter for "denne" noden og underliggende.
3. Det finnes dokumenter for underliggende noder. Trykk på ikon for å kjøre "Documents" rapporten, som viser dokumenter for "denne" noden og underliggende.
4. IFC view vill merke alle objekter som dokumentet gjelder for.

Fjerne et dokument:

1. Trykk på [X] i "Documents" rpporten

TFM Håndtering

Generelt

Systemadministrasjon

Server Installasjon

Last ned EDMSix fra omforent sted
Last ned maldatabase fra omforent sted
Set opp server med Areal Administrasjon "mal" database

Klient Installasjon

Last ned installasjonssett for EDMmodelServerManager (MSM) fra omforent sted.
Pavelas: er dette fremdeles riktig?
Last ned .ZIP "Plugin Folder" fra omforent sted
Pakk ut .ZIP "Plugin Folder" til C:\ProgramData\Jotne EPM Technology AS\MSM\klient_versjon_nr\ mappe (ved release av en ny klient, bare kopier alle plugins til den nye opprettede klientmappen i \MSM)

Plassering, Plugins og rapportmaler
For å installere og/eller sette opp programtillegg for moduler som "Arealadministrasjon" og "Prosjekt" referer til manualer for den enkelte modul. Her er kun gitt den generelle framgangsmåten.
Dersom et programtillegg (plugin) ikke lastes, må blokkering fjernes (høyre-klikk på .dll – Egenskaper – Unblock )

For å sjekke om et programtillegg er lastet må du starte opp en installert klient, og logge inn med en gruppe som skal ha tilgang til tillegget, eksempel: logg inn i "fm-admin" gruppe for å sjekke Arealadministrasjon. Om Arealadministrasjon plugin er vellykket lastet inn, skal du kunne se "Areal Administrasjon" fanen/menyen.

"Areal Administrasjon" fane/meny

Brukeradministrasjon

For å administrere brukere, prosjekter, aksess med videre, må du logge inn som "superuser": Username: superuser ; Password: ********

Innloggingsbilde
Etter tilkobling, velg Administration Center under fanen/menyen Tools.

Tools fanen/menyen.
I Administration Center må du opprette prosjekt, brukere og tilegne roller i det aktuelle prosjektet.

Opprette brukere

Det finnes to typer brukere, enkeltstående brukere og single sign-on (SSO) brukere. De førstnevnte må logge inn separat for hver gang MSM skal aksesseres, mens SSO brukere logges inn automatisk med brukerident som de har i systemongivelsene.
For å kunne opprette brukere, må du være logget inn som superuser.
Uansett brukertype, begynner du med å velge"All Users" i "User Management" liste oppe til venstre i Administration Center og trykk på "Legg Til" knappen:
For å opprette enkeltstående bruker:
Velg "General" Fane, fyll ut datafeltene og trykk "Add".

Dialog for å opprette bruker , fra User Management Tab (All Users)

Opprette SSO brukere

Velg "Active Directory" fane, fyll ut eventuelt gruppenavn for å begrense brukerlista til en gruppe og trykk "Get Users" :

Brukerliste fra Active Directory
Velg de brukerne som skal ha tilgang til modellserver ved å dobbeltklikke på dem. De skal da dukke opp i "Selected Users" feltet. Avslutt med å trykke "Add".
OBS: Adgangsrettigheter, gruppetilhørigheter osv i modellserver må settes opp på samme måte for SSO bruker som for enkeltstående brukere.

Roller / grupper

Følgende roller er aktuelle:
fm-user: kun leseaksess for "åpne" data.
fm-owner: Full aksess til de kontrakter hvor din organisasjon (firma) har eierskap. Vanlig rolle for saksbehahandlere
fm-admin: full råderett over arealmodul. Denne rollen trengs for å tildele eierskap, dvs det må finnes minst en fm-admin for hvert prosjekt.
fm-prosjekt: full råderett over Arbeidsordre/Prosjekt modul
Roller kan konfigureres i Administration Center, hvor man kan gi tilgang til ulik funksjonalitet gjennom å markere et sett med aktuell funksjonalitet for den enkelte rolle. Rollene kommer med «default» sett av tilganger. Nedenunder vises en oversikt over tilgjengelige tilganger, med korte forklaringer:

Se avsnitt 8 for default settings for system default roller.
Nedenunder vises et eksempel for markering av tilgang for rollen fm-admin.

Eksempel, tilgang for fm-admin

Opprette prosjekt

Velg ""Project" i venstre liste i Administration Center og bruk for å lage nytt prosjekt.

Dialog for å opprette Project fra Project Tab

Tildele roller i prosjekt

Dialoger for tildeling av roller (fm-admin eller fm-user) for valgte prosjekt

Backup

Mangler foreløbig

Problemløsning

Problemer med logon med Single Sign-on (SSO)

Problem: selv om jeg har aktivert SSO får jeg ikke logget inn:

En vanlig forklaring er at brukeren (brukernavnet) er definert som en enkeltstående brukerfra før. Du kan ikke å logge in, fordi din bruker er ikke lagt inn fra Active Directory (domain brukere) men fra General taben (hvor du lagt til en bruker, som ikke er i domenet).

"Illegal model name syntax" error when importing new model

Set configuration parameter:
EDM_EXTENDED_NAME_CHARACTERS=0123456789!#$%%&'*+-/=?^`{|}~@._æøåÆØÅ


 Hvis du har lyst til å bruke SSO, logg inn som superbruker (superuser), slett din bruker rolle fra "by project" og etterpå egen bruker:


 
Når du har slettet din bruker, lag SSO bruker. Åpne „Active Directory" taben og trykk på „Get users" knappen. Etterpå i „Username" felt skriv dein bruker ID – 75599-03 og trykk „Add" knappen. Etterpå gi bruken en rolle og prøv å logge inn:

 
Noter:
Når du sletter din bruker, alle referanser til ArealAdministrasjon for eksempel: kontrakter, leietakere, brukere informasjon og etc., vil bli slettet.

Annex : Teknisk informasjon

Diskplass og minnekapasitet på server

Dette er ikke komplett informasjon ennå.
Om EDMmodelServer skal kjøres med godt resultat bør server ha minst følgende fysiske kapasitet:

• Diskplass: 1 Terrabyte
• Tilgjengelig minne : 16 Gigabyte

Annex : Default tilgang for roller

Default tilganger for system default roller:

Teknisk informasjon

Rapporter som må være i systemet

Følgende rapporter må være lagt inn i modellserver, og alle relevante brukere må ha tilstrekkelig tilgang: