0 ratings0% found this document useful (0 votes) 319 views18 pagesCustomization Day1
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content,
claim it here.
Available Formats
Download as PDF or read online on Scribd
Senso tama
Windchill Customization Intro and Basic
Day 01
res ceeenins
Takeaway
At the end ofthis session you should be able to
Overview of Customization
Windchill Development Environment
Windchill Design Pater
RBInfo : Stale and Team
Windchil Utities
Acton and Action Models
2 SSUMRDUAS
Windchill Client Architecture Overview
> The Windchil Client Architecture provides a framework for building Custonizaton Basics
pages easily and consistenty by providing a standard set of » contigratonOpons
components and services that are configurable and customizable. ¢ nn oreayn‘ne set of components ncuges, outs notimtea to, a tane, a tee,
{an information page, @ wizard, and @ dynamic javascript menu. Ata, Pe
lover level, these container components use other commen ° Wie! Dcy
‘components, called actions, action models and GUI! components, to
splay data inside of tem > Popes nd Posey
> The Windchill Cent Architecture is Modet-View-Contoler based.
There are two MVC based paths availabe for use, a Java Buller” Ex8me# Oeroen
‘based approach and a JSP based approach > winsentie
> Windchill documents are used to contain and manage fles (such as.” S#°
‘Microsoft fice documents}, inks, and extemal content not
electronically accessible
PSUMRDHAS
Windchill Client Architecture Overview
Configuration Options
> Properties and Preferences : Windchill provides an extensive set of options that contol
hhow the system behaves, how the user interacts with the system, or how the system
presents itself tothe user, These options are either properties or preferences.
> Properties : Properties are created in text fies in the Windchill codebase and contol
‘overall system confguration. For example, the wt home property contains the path to the
instalation drei, Properties re sored in les, wih te propertes extension
Changing most properties requires a restart ofthe Windchill method server.
> Preferences : Preferences are set through the Windchill user interface and do not
equ 2 Seer festa. They cont) eppeaton behavior or pac reasons, sore
Properties also control application behavior). Preferences can be implemented on
different levels of deal. Preferences can be configured to contol the whole Windchil
instalation, or can be used more narrowly fo contol an organization's or an application
Containers (e.g. Product, Library), or a spectc user's setup.PUMPS
Configuration Options
» Service Customizations
Windchil supported server-side customizations to enable certain business processes or
‘enforce business constrained. Any kind of customization can be performed. The most
‘common lypes of customizations falsnto one ofthe folowing categories:
» Proces om data submited through the use nteace
> Validate data (9. Do not lw te sero ener 2 Need Date fora Change Request thats more
than 30 days ini the futur)
> Implement service listners (9. Creal a listener that wats for any daa tobe checked in and
populate an MRP sjstom with appropriate data)
> GouPut data in an extoral systoms (0. when the user navigates to a pats got the cost
of he par rom te ERP sysiem and splay tin the same UI)
DIS
Customizations Points
> Data Model Customizations
> Windchil Information Modelers one of the Windchil development components that can
be used to customize your Windchill envionment. Information Modeler contains the
‘Windchill modeling fies and source code that you will use to develop your customizations.
CCuslom Java Annotations are used to model business objects, Windchil then uses this
‘model to generate code that is used in server and cient development
> User Interface Customizations
The Windchil Cent Architecture is @ Windchil-ware JSP framework. It provides very
hightevel building blocks known 2s common components which make Windehil Ul
‘development a very ecient process done with ease.
‘UMEDAwinacniii Uevelopment environment
Directory Structure : The image shows the Windchill
Gireclry structure air you isa al avaiable components, ace rtp
if Windchill was installed as recommended to folow this Sie One
‘structure, go to the home directory where Windchill is Bon (Uteseator
installed and navigate through this structure as it is ae us
described here Ss =
Some
Sar" Bate
=
So Grass
See Gare
Sere
oe Br
Ss
SSUMRDHAS
Windchill Development Environment
> Codebase Directory: In genera, the codebase direcioy Qusrltwhe Grate
conlans executable lass fle, property fles, and other ase” Cuma
fies tat contain infomaton needed by trerunime Qtr
environment for Java and Web processing. The codebase Gem
irectory can be expanded to show the following directories ae =
ce eo
Sor Stone
os ss
Sram Soe
=" oe
Sm Se
Srrcsees — Grtre
‘SUMEDIAS:
Windchill Development Environment
Sre Directory : In general, the sre directory contain the source fles| Oe mt
needed for appcaton development. The sr directory can be expanded to Sat cane
show te following decors. BG cotreston
> The wland compte directories contains the source fies forthe packages Clash
‘supplied by Windehil (only a subset of which are shown inthis ilustation). al powcaw
> Inthe wt directory and its package subdirectories, you wil se the fllowing
kinds of fies
Localzable ResourceBundles(ibnf and java) les, wtich contain customizable
spay txt for EnumratedTypes and business laments and UI stings.
eeoed?
giseyProperty Files
> Windhil uses standard Java property fies to detemine unime confguration
properties.
> The codebase directory contains:
> wtproperties.: Contains properties used for general Java system configuration and
Windeit
> service.properties : Contains properties used by the Windchill service delegate
mechanism
> user properties : Contains usr overdes used by resoure bundle and sal soit
generation
> db properties : Contains properties used bythe Windcil database connection layer to
access the database
" as
Property and Action Report
> Property Report
Property report provides the detail of validate attribute lists for customization
>» Action Report
The Action Report is a search page that returns the details of actions matching the
search criteria,
‘The Report can be accessed at:
hitp:ocahost Windhillapptptt etmarketsplcaramboatosactonRepoacton fp
YHUMEDHASWindchill URL Construction
‘er Rant ssl LR aide eat agente
labia nt rat
‘veto hectlbe UL betel eorrglbe Lari ee bee
pteoun
hierar ant Sak acne kono arpa
np —Unt PRL wate oki te
lem Undin Be a htbeink ah pee
Teta teams wetwtonpttyadorane wine tones
ete. teste
}
Ce ec
SY EUMEDHAS
Windchill Development Environment
> Download Latest Eclipse
> Install and Configure Ecipse
Sel Java pat for Eclipse Add Java path SWT_INSTALL_PATHJJavalhin to system path eg,
cpteWindcil_t0Vavaltin
D Install FleSync Help > Insta New Sofware , Enter the following URL.
‘nani gmatome deeciose
Window > Preferences, Java > Compiler > Buidng
Ure Odsal Sb anes crrgpcs
Create lave Project and add Jr's
Exercise ~ How fo setup and Compl fist Windhil Hello Word.
Windchill Development Environment
FileSync Preference
For annotation, compile before using the ant-
based annotation class that was deployed on
Windchill cass path =This configuration wil be effected when you
‘create new modeling wii the annotation,
‘and te system wil automaticaly synchroriz
to Windchil. &
Itmeans, Ecipse wil aso update registry les
(shouldbe kept in mind)
© you do notwant to automaticaly update,
lease do not se this oto.
Create Project Using Command Line
\Windehi supeertore command fo making echoes projet automaticaly.
1 Openninacit sat
2, Exebant-fbintaok.xml eines. project
5. Thewaksace prea we ead an*$Mindehil LoadPontecpslest Windhll sé
Ec) cigtingel 00ecpsacust insti se
4. Openectpse
5. Ingo cea pce! File > nor...» General > Existing Projets into Workspace?
A Seka
you wantta see nlp massage on howto use tne carand:
1 Opener st
2. Exsuat-fbintoot xml else project
Windchill Design Patterns
‘The Object Reference Design Pato
‘hig at esertaly encapsiaies das concoing
Psa oess onde uve Clase quer rye
atom asa al an chests 2 deve str Ey
Felwence and lc nat peed, Te cbosTs uns aaa
Shaear anne nee
Lee see a
ae tte tn pcs sae
hat etree part oy Bay et
{Besinplce d sda abet aa aces wen vane eos
overeat esau ope aero cane gen fom
be ee! tlererce wc aye may ol be carey ad
be ote he defer dors tot te oe are
Begg ed re je ese va ey emWindchill Design Patterns
The Business Service Design
Pattern
This pattem has the following
‘jor kinds of abstractions
Type
‘Cooke
Heber
Senice
SeniceEvent
‘SenvceException
SeniceFacory
Windchill Design Patterns
Te tantrtraton Dain, Pater: Thon
peal eis ho Soe at wen cont wh
{ho anstar et ono, aor sous rl ost 2
etary md A roe be aan
terns
Da tase 1 stetginn of a pug
trator wit te td
Pe. The ats has buses model an cect
se hat a ont err he asd
Inrace Wen fs azn e buses Se!
Sas hgh trans The
Bsmese obec st srg od
te
SS Seabee
igi rebar tae
Resource Info (.rbInfo) Files> Resource ini flesarean [Enumerate |”
alternative to storing localizable | feet df hninenseeeinehicnnes
textinListResourceBundie | Ssteiy a ee cucu sninne
Sapte Son
source cade files. They are | Sah"? eae
structured properties files that | sesastaie tanuan © Anepinacannen dancing
facilitate easy manipulation bY | Seqss oy ouec) bora ~
sea ee
automated tools Sea ene im] Reiman eet
> EnumeratedType represents a | See) bmg ee
whose possible values are eee
type whose possi © tein en tin
constrained toa set. setae
> see
© Stee abo s
RyaueeaES
Resource Info (.rbInfo) Files
Resource info fle are an vate
alternative to string localzable Thee a ii pe
text in ListResourceBundle ey
source code fils. They are Tei
structured properties fles that commer
facilitate easy manipulation by recreate
automated tools oe
secs > ox
> EnumeratedType represents a | Sane Se ct soon
type whose possible values are | Zusote et x
constrained fo set > nave
Spt pain ttt
> Exercise: Crete anew state Seen
Training > eseeme
> Sti re ha asses
Senn
Eres
Windchill Utilities
> The xconfmanager is a command line utlty that you can run to add, remove, or
‘modify properties in Windchill property fies that are used for your defining your
system.
>» The xconfmanager utlity saves your changes inthe site.xconf fle and provides an
‘option to generate undated property fles using the updates inthe site.xonf fle, The
site-xconf fle contains the changes made to Windchill property fies starting with the
installation and continuing with each use ofthe xoonfmanager utity.
> Before executing the xconfmanager command, set up your environment by using
the windchill shell.> Exercise : Create @ new entry in WT property .ext.raining welcome=Hello
Action and Action Models
The actos tamonot prises 2 way deacons andacton nado win he system. sania, cae he
‘SlandardNmAcbonServicerisragus he sof atone and een moseain he s}Sam
ets a acton mal ae dele vw Hes rare asxeraeton xa axaconmadl. am Thre
‘ne Stout sons and sso eh esters wah he sem However emerson may
‘Su fave tonne se we wich also managed he acon sence
For customization ppote, 3 cator-acon ln custractonnodes dele ih oped and te
found igor eaves te Waal estten Seb,
‘Atte he toe ets alan stannoses nl es aro lasted nfeosecmiactos.
‘ha delgt actos. and aetormods ls coin commonly sed actos, su 3s oy, ad conmely
ecschonnedas sch ae wae Sure
> dates actors al nt actonmoses wn es cor ates anéacion motels eed he ton ates
(ag: Changelteragoneraciors, nv arars ace ante ohn ranagener Paragon ins
(friars alos rated pat raragener)
> in goreral a deter ou woul pathaveto drcly mak cal othe ladernAonSarice. Those cas re
Gore wath coronas al super say of corse acon neds, lo ears, Woes, emai
panes.
EUMDS
Define a New Action
> Actions in the system are uniquely identified by the name of the action and the
‘object type. They should be defined in an xm ile that follows the structure based on
the codebaselconfiglactions‘acions.ctd,
> Here is an example ofan action definition forthe New Document wizard,
-iesnpenane une cosar ceUTDosre esweeBunebn ener doccoemeneD ee
‘enna venrmeHEATE SOC
“Sern surement centre neo a
neuro roei'>
‘SYPSUMEDHASDefine a New Action
Objecttype tag
The abet nani away zeal anane spo a el a8 packaging for actos tad a saco
eter teorl sen, neato expe, fe vane Soot cess unqurane sate
shatopy owt: WTDecen
convene the ame ofa bey an be any combina of lunar characte.
eyes ara asa pastas joao nhs re pons reat hens hat apy ony
{Senin Sen ancy. ant pune eyo ye ereconeend tah
‘Sletypstves rel spout compar peer colers wih ea pes tered we
Parameters
Name The nama used to eernco hie bec yp0
Class Object cass forineenclsed acions|
> repoureeBundle Claes name forthe deft recource bundle fuse fore propeies the can tare
Tobe ocaizes
SPRUNS
Define a New Action
Aton
> Ra acerca ete eerste eae
> eae rmeeeeerenrerentamam nanan,
© Aamsenssasentot tae
> Locsin
‘tora seateot en re
cba aera eames tat yt ae
New Action — Navigation Menu
Register New XML Fles
\Wecan day chane te egal XM, ut is athe es way because canbe changed when updating or
deplangptches Wee 30, we yt se exer es. °
OTB ar xan rod cion-aceled s
aston anna ML noise net
‘Add following sentence nT. HOMEicodebaselonfigactionsiuston-atons.xml‘Add the following sentence in WT. HOME Wicodebase\configlactonsicuston-actionModels xml
Create a New Action
(Create registered action fle on the corect directory. Action and ActontModel files are in cferent
format, o you have to wath out while making & new fle
‘Greate and mesiy 4WT_HOMEY\codebase\configlactonstrantrainactions aml
> For Action fle, you must add DTD configuration ine such as line-2.
> Acton-ype fie whose name is “navigation” is already assigned by Windchl, so we wil just reuse
‘the objettype action,
> Ifyou want toad top menu (button, itis enough.
PUMEDHAS
Create new Action Model
Create registered action file on correct directory. Action and ActionNodel fles are indifferent
format, so you have to watch out while creating new fle.
Create and mosity %4NT_ HOME'codebaselconfilactionstainitrai-actionmodels.xml
SY PSUMEDHASAdd Resource Bundle
‘The resource bundles of menu which is displayed on the Ul are managed the other way
comparing it wth original OOTB resource bundle architecture.
The source fe is managed on “$WT_HOMEicodebaselacton_{Loode code properties
Alloflocae character must be changed UTF-8 format except on English
Also you must update default property fe, (action properties)
pine WHT HOMESendsaslcton LOCALE ropes nd action ropris
[Eirini nm
ee
> yoyant naa yurconigstenvttn retard, she loving Wel commen:
‘wnhlcon pte emarets ame NnActoeSaneehber
Sub-Navigation Menu
Designing sub-menu using actions on
WT_HOME*S\codebaselconfiglactionslcsclcsc-actionModels.xm
‘Sub-model name is created by a rule which combines name and type values ofthe
‘main navigation's action
ceotet namee"tenin navigation” datas Actanamee"tabtastnplas” dateuetiontypen*teaLn?>
“action nam="tesncampas” typas"tasa” />
‘Action is generated to find action from action.xml. Type is objectiype name, and
‘name is an element name of objecttype
” Sains
Sub-Navigation Menu
‘ding designed acton fr sub~menus on
RWT_HOME'%\codebase\configiactions\train\train-actions. xm!» WC10 was added a MVC architecture, so inthe acton, you can call MVC builder using
tag instead af tag. (MVC wil be explained inthe next phase.)
Sub-Navigation Menu
Mody acon properties fr Display
‘PEUMEDIAS
Set isla texto acon properties. you don set bis property, the menu int show txt descripion
such s the navigation icon,
Tha resoure fies ranogdon SU HOWElcodehasfcton Loe cote ropes
Aloe charts xcept Engst rst be change 0 UTF-8omat
‘As you must update faut propery fis (acon proper)
Modify to %WT_HOME®%\codebaselaction LOCALE properties
Tab Models
‘The tbs rendered in navigator are nothing
but actions inaction lists just ike any other
actions in the system. Adding tabs and
{abs under them is very much lke adding
any other action into the system, but there
are some additonal special
considerations
> The abs inthe red cicle are the navigator
tabs, the tbs inthe bive circle are the fist
level navigation tabs, and the items inthe
(green crce are the second level
‘avigaton. The folowing sections will
detal how to add tabs af different levels.
EUMEDIAS
EVALPeUMEDHAS
Tab Models
‘oc rags tb compete flog ss:
SYSUMEDHAS
Create Resource Bundle for Tab
te eregoue ure ing anata. yu want use oer anguge, you ave tree ret
lana ssi
> The constant vali mustincude tb motel ae. Fr exam, bjctraningNavigatorTab navigation desertion”
> Resource Bure mist be created ig Wiha.
Resource Bundle mtb exes am WTLisResoueBunde
El Sy PSUMEDHASAction Report
Action reports provide deta on the actions used inthe Windchill Ul launch wizards and
‘execute operatons. Such deals incude the acon abe, acton name, the ava class used to
vabdate whether the acbons availble to the user, the lin which the acon fs defined, and many
others.
‘tion reports also enable you to modty the abel an td tip of an action,
‘Action rpats can be accessed by browsing io Customisation» Toos>Acion and entering suitable
‘search cteria to locate the action of intrest, navigating via the information con fran acon will
provide adciional detail for the ection eg abe, where used, defniton flee
"Not that this screen can be used to update the Label and Tool Tp atbutes ofthe acton
Action pars can be accessed by browsing to Customisation>Tools>Action and entering
suitable
earch ceria to locate the acon of intrest
——
Action Report
Action ReportReward YourCuriesty
fvees
=
ee
a=
=z clots ah nt yes
wa ‘a pines
/SUME!