IMOS Coastal Observations A National Perspective John Parslow.
imos Catalog Creator (iCC) - Wood software1 imos Catalog Creator (iCC) tool for imos catalog data...
Transcript of imos Catalog Creator (iCC) - Wood software1 imos Catalog Creator (iCC) tool for imos catalog data...
1
imos Catalog Creator (iCC)
tool for imos catalog data preparation
version 2.2.0
Wood Software s.r.o.
www.woodsoftware.cz
5. 5. 2015
Note: This document does not belong to the official documentation of the imos AG. It may contain incorrect information. Please check your construction carefully. The imos AG will not be liable for any losses.
2
Content
1 Installation ....................................................................................................................................... 4
2 Configuration ................................................................................................................................... 7
2.1 Database setup ........................................................................................................................ 7
2.2 Language ................................................................................................................................. 7
2.3 Program parameters ............................................................................................................... 9
2.3.1 Basic ............................................................................................................................... 10
2.3.2 Update imos NET ........................................................................................................... 12
2.3.3 Update imos CAD........................................................................................................... 15
2.3.4 Design Manager Catalog................................................................................................ 16
2.3.5 Imos CAD ....................................................................................................................... 17
3 Basic components of User interface.............................................................................................. 18
3.1 Program menu ....................................................................................................................... 19
3.1.1 Program ......................................................................................................................... 19
3.1.2 Generate XML ................................................................................................................ 20
3.1.3 Support tool ................................................................................................................... 23
3.1.4 Options .......................................................................................................................... 27
3.1.5 Information .................................................................................................................... 28
3.2 Data sources .......................................................................................................................... 28
3.2.1 XML catalog ................................................................................................................... 28
3.2.2 Template ........................................................................................................................ 34
3.2.3 Include ........................................................................................................................... 35
3.2.4 Imos variables ................................................................................................................ 36
3.2.5 Imos products ................................................................................................................ 37
3.3 Workspace ............................................................................................................................. 37
3.3.1 Composer ...................................................................................................................... 38
3.3.2 Editor ............................................................................................................................. 47
3.3.3 XML preview .................................................................................................................. 48
4 Automatic data import .................................................................................................................. 48
4.1 Data source ............................................................................................................................ 49
4.2 Template ................................................................................................................................ 50
4.3 Process Data import .............................................................................................................. 51
4.4 Run generation process from command line ........................................................................ 52
4.4.1 Filldata ........................................................................................................................... 52
4.4.2 CADxml .......................................................................................................................... 53
3
4.4.3 NETxml ........................................................................................................................... 54
4
General
This is documentation for imos Catalog Creator (iCC) – a tool to help user create xml directly used by
imos NET and imos CAD products. General goal of iCC is to help user focus on logical structure more
then on hard coding and to avoid all typos and mistakes. All xml files are generated from structure
stored in db. Also all pictures and additional information are stored in separated db and saved on file
system during generation process.
1 Installation
For latest installation file please contact Wood Software s.r.o at [email protected]
Installation routine will guide you through whole process. By default application is installed to folder
c:\Program Files (x86)\Wood Software\imos NET Catalog Creator\ and all data are generated to
folder c:\iCC_xml\.
By default is application installed as DEMO version with restriction that reduce number of Catalog
items to 50 and does not allow to save any XML output, all other features stay as in full version.
To get full version ICC has to be registered via menu Information / Registration
Please fill your Company name, Name, Email and send this information online or send request file to
[email protected] . We send you Licence key to specified email back next bussiness day, please
insert your Licence key to second tab and press Check license key.
5
iCC returns message with license status
License is generated to particular machine on which was license requested and can not be
transferred to any other machine.
To see your license status go to Information / About
6
7
2 Configuration
2.1 Database setup
By default iCC will ask you for DB properties at first start-up.
When you enter iCC db name which does not exist on SQL server, iCC will create new database with
specified name. New db is created from db backup CreateTB.sql stored %program_root%\DB.
imos CAD DB and iCC has to be attached under same SQL server.
You can connect to other db by clicking on DB name at footer or via menu Option/DB connection
parameters.
In Database connection parameters you can specify imos DB, iCC DB, sql server name and type of
connection.
2.2 Language
iCC menu language can be change by clicking on Language on footer and choosing your favorite one.
8
MSG language file is stored in folder %program_root%\.
When you click on button “Options” you have functionality to
- If you do not see you language you can unhide hidden languages by checking “Show hidden”
- Or you can add or delete some languages with buttons
9
- With “Import LNG” you can import old translation format, this is kept for backward
compatibility
- With “Import MSG” you can import MSG file which is not currently used by iCC.
- “Save MSG” will save MSG content to actual MSG file in your program folder.
- “Edit MSG” will open MSG editor where you can edit all phrases in “Edited language” or
change “Reference language”.
2.3 Program parameters
With Options/Program parameters you can set up all necessary program setting. All settings are
stored in %program_root%\imosNETcc.ini file.
Program parameters are accessible via menu Options / Program paramets
Program parameters are divided into five sections
10
2.3.1 Basic
XML header for created files – define xml header for all created xml files, by default it is <?xml
version="1.0" encoding="UTF-8" standalone="yes" ?>
Imos Offline Catalog template – define structure for preview in Design Manager catalog structure, by
default it is <?xml version="1.0" encoding="UTF-8"?><catalog name="imos-test" ><category
name="Test category"><object model="%ART_NAME%" name="%ART_NAME%" "
/></category></catalog>
Imos Offline Catalog Registry Key – define which registry key is used for Offline preview.
- For imos 9 it is typically \Software\imosNET 2.0\CatalogFile,
- for imos 10 or newer it is typically \Software\imos AG\DesignManager\ActCatalog
Imos path to ini file - define imos.ini,
- typically for imos 9 it is c:\imos\config\imos.ini,
- for imos 10 or newer it is typically c:\ProgramData\imos AG\imos CAD OEM
10.0\config\IMOS.INI
For correct Article configuration preview please check in imos.ini following keys:
11
PICTUREDIR=c:\ProgramData\imos AG\Library\XML\IMG – define root folder for images
XML_DIR=c:\ProgramData\imos AG\Library\XML\ - define root folder for XML
Design Manager path – define path to Design manager when use for Offline preview. When empty
Offline configurator is started, when filled Design manager is started. Typically there is c:\Program
Files\imos AG\imos CAD OEM 10.0\BIN\DesignManagerWPF.exe
Typical imos 9 setup Typical imos 10 setup
Auto save XML after generating - all xml files are automatically saved when generated. If this option
is unchecked ICC does not save any file to disk.
Show hidden object in Article composer – affect Composer to show all item in Composer preview
with VISIBLE=FALSE attribute
Integrate include files into final article while importing from XML – influence import of XML
Program/Import XML behavior, when checked XML is imported as one structure with all include files
content.
Show inner IF nodes in IF editor – in composer are show also lower level IF in preview
Load all include sections while loading article in Composer – this force to load all include file content
into Composer preview. Checking this option will slow down article openings process.
Lock article for other network users at opening – when article is used by someone else, user is
notified that article is in use. This message is only informational and has no effect on further work –
12
user still can freely edit opened article with the risk that data between two article editors will be
overwritten.
Enable XLIFF localization – this enable XLF localization format when generating data for “imos NET”,
in article XML are all phrases generated like label="{translate:Box Decor|Box Decor}" and also XLF
files are generated automatically into catalog folder.
2.3.2 Update imos NET
This section defines all settings for generation of XML files when whole catalog is generated at once
for imos NET.
There can be used in PATH definition variables %CAT% and %LNG%. %CAT% add to path current
catalog name defined in Catalog properties. %LNG%. Add to path language shortcut for language in
which xml is generated. So same catalog could be generated in more languages, each language into
separate folder.
If XLIFF translation is enabled we recommend to skip variable %LNG% and change settings like shown
below:
13
Save article XML to folder – folder where article XML are stored e.g.
c:\%program_root%\customer_xml\%CAT%\%LNG%\article
Save catalog XML to folder – folder where catalog file is stored e.g.
c:\%program_root%\customer_xml\%CAT%\%LNG%\catalog
Save include XML to folder – folder where include files are stored, recommended is to store then in
one folder with article XML e.g. c:\%program_root%\customer_xml\%CAT%\%LNG%\article
Save verso XML to folder – folder where all verso XML are stored. Verso XML is used by imos Verso
to generated article geometry on server. It does not contain any special characters otherwise is
identical to article XML, e.g. c:\%program_root%\customer_xml\verso
Save images to folder – folder where images from configuration menus are stored eg.
c:\%program_root%\customer_xml\%CAT%\images
XML images prefix – images prefix used in XML file e.g. img/ imosNET then expect that all images are
stored uder root/img folder.
14
XML – Overwrite existing Include – this switch allow program to overwrite all existing Include files in
destination folder. Otherwise when Include file is detected in destination folder, program skip
generation of this Include file.
Overwrite existing images – this switch allow program to overwrite all existing images in destination
folder.
Remove special characters from XML – this switch remove all special characters used in XML, except
characters from ISO-8859-1 charset. This was due to the fact that older versions of imos and Offline
configurator was not able to interpret XML with other charsets correctly in logic part.
List of special characters could be configured in file spec_char.txt in folder LNG under iCC root
directory, usually “c:\Program Files (x86)\Wood Software\imos Catalog Creator\lng\”.
“spec_char.txt” has to be save under UTF-8 encoding and in first column is character which has to be
replaced, in second column is character replaced with.
Integrate Include files into final XML file in DEFINITION parts – force ICC to compile all Include files
content in DEFINITION part into final XML as one file.
Integrate Include files into final XML file in CONSTRUCTION part – force ICC to compile all Include
files content in CONSTRUCTION part into final XML as one file. This is used to integrate all variables
into final XML. It is highly recommended to leave this switch checked.
15
2.3.3 Update imos CAD
This section defines all settings for generation of XML files when whole catalog is generated at once
for imosCAD. Path settings where XML files and images are stored are used from imos.ini,
PICTUREDIR=c:\ProgramData\imos AG\Library\XML\IMG – define root folder for images
XML_DIR=c:\ProgramData\imos AG\Library\XML\ - define root folder for XML
Otherwise all used switches has identical meaning as in section Update imos NET.
16
2.3.4 Design Manager Catalog
This section defines all settings for generation of XML files when article preview is generated for
Offline catalog (imos 9) or Design manager (imos 10), for settings see above. All path where xml files
are stored are taken from imos.ini, see above.
This function generate all necessary XML and images and open Design Manager with generated
article.
Otherwise all used switches has identical meaning as in section Update imos NET.
17
2.3.5 Imos CAD
This section defines all settings for generation of XML files when article is generated for testing
directly in imos CAD, for settings see above. All path where xml files are stored are taken from
imos.ini. This function generate XML files and pre-set imos CAD, when user then open Design
Manager from imos CAD, there is directly offered tested article in Catalog.
Otherwise all used switches has identical meaning as in section Update imos NET.
18
3 Basic components of User interface
Standard user interface consist of
1. Program Menu
2. Data sources
3. Workspace
4. Quick setup
19
3.1 Program menu
3.1.1 Program
3.1.1.1 Imos CAD products
Show dialog with all imos CAD products. This dialog is only for information and there is possible to
use this for product selection when Article XML is created. All products has to be created in imos CAD
first.
3.1.1.2 Imos CAD variables
Show dialog with all imos CAD variables. This dialog is only for information and there is possible to
use this for variable selection when Article XML is created. All variables has to be created in imos CAD
first.
3.1.1.3 Import XML
There is possible to import already created xml’s. Copy all your article xml, included xml, pictures into
one folder. System will complete xml and import all data including pictures into db.
To import select destination folder in Catalog, Template or Include section, choose from menu
Import XML and choose one or more xml files for import. After then system load complete XML file
content into DB and all images.
3.1.1.4 Import whole XML Catalog
There is possible to import whole catalog. Copy all Catalog XML, Article XML, Include XML images
into one folder. You have to import INCLUDE files first and then ARTICLE files.
To import INCLUDE files create new folder in INCLUDE section
Then choose Program/Import XML and with Ctrl /Shift convention you can choose more files at once.
Further routine import all selected files and its parts.
To import complete catalog crate new catalog in
20
Stay on this new catalog item and choose from menu Import whole XML Catalog, choose Catalog file
from folder and let system to import complete catalog structure with all articles and images.
Important is switch in Program parameters/Basic/Integrate include into final article while importing
from XML, which force include files to be imported as separated files or as part of each article.
3.1.2 Generate XML
3.1.2.1 XML of active article
Generates XML of actual articles into XML preview tab. The same functionality behave when you click
on tab XML preview.
3.1.2.2 Texture mapping XML
Generates texture_mapping.xml, file is then necessary save to disk and zip to texture_mapping.zip
and upload to folder vgXXXX/decoobjects online. When generating texture mapping XML system
combine information from imos CAD DB and iCC DB, therefor is important to have correct imos CAD
DB connected on with data in iCC DB was created.
3.1.2.3 All articles VARTEXT XML
21
Generates vartext.xml, file is necessary save to disk and load to folder XXXX/VARTEXT online.
For offline has to be vartext.xml save with all other article XML in one folder. Local vartext.xml can
contain only one default language and there is only possible to map variables without any relation to
article.
So <label index="WC_1DD.ART_SIZEZ">Height (500mm-1000mm): %s</label> is not allowed, but
<label index="ART_SIZEZ">Height (500mm-1000mm): %s</label> is allowed.
Vartext is generated based on system variable _vartext at COMBOBOX, EDITBOX, CHECKBOX node and ITEM element. System attribute is accessible at Property inspector of each variable for type COMBOBOX, EDITBOX, CHECKBOX, ITEM.
22
For _vartext are several predefined values with system variables: “NOT_IN_VARTEXT” - variable will not be used for VARTEXT file “%label%: %s” – for VARTEXT will be used value from attribute “label”: and actual value of variable “%s” – only variable value will be shown “DO_NOT_DISPLAY” – this is used only for ITEM element, this ITEM will not be shown in NETshop “%label%” – only value of attribute “label” will be used Otherwise user can write any free text, which will be used for VARTEXT. Default settings for _vartext is “NOT_IN_VARTEXT”, field is mandatory. User also can define formatting for the phrase or its part, by clicking on appropriate sign for
- [u] underlined - [i] italics - [br] break line - [b] bold
For generating VARTEX is responsible stored procedure spVartext in iCC DB. The procedure works on following logic:
- All COMBOBOX, EDITBOX, CHECKBOX and ITEM which are in INCLUDE files are interpreted as article independent, e.g. <label index="Door_Model">Fronttyp %s</label>
- All COMBOBOX, EDITBOX, CHECKBOX and ITEM which are part of article directly are interpreted as article related, e.g. <label index="BC_1SD.Door_Model">Fronttyp %s</label>
3.1.2.4 Design Manager catalog XML
You have to choose one of you catalogs to generate Catalog XML into separate dialog window
3.1.2.5 On-line catalog XML
You have to choose one of you catalogs to generate Catalog XML into separate dialog window
3.1.2.6 imos NET update
You have to choose one of you catalogs and then all Article XML, Includes, images, Catalog XML for
online are generated at once. Paths where all data are stored are defined in Program parameters.
3.1.2.7 imos CAD update
You have to choose one of you catalogs and then all Article XML, Includes, images, Catalog XML for
imos CAD are generated at once. Paths where all data are stored are defined with keys
PICTUREDIR=c:\ProgramData\imos AG\Library\XML\IMG – define root folder for images
XML_DIR=c:\ProgramData\imos AG\Library\XML\ - define root folder for XML
in imos.ini
23
3.1.3 Support tool
3.1.3.1 Images
Open dialog to manage all images in system. All images are stored in DB and saved to local disk only
for preview or data update.
1 – there is possible to organize all picture into logical folder structure. This structure has no
influence or relation to image usage in XML. Folders can be organized via drag&drop function.
2 – add new folder under actual folder
3 – delete actual folder
4 – with drag&drop movement you can assign image to any folder. All images are automatically
visible under folder “All items”. All images which are not in folder are visible in “Unlisted” folder.
24
5 – select picture into XML
6 – empty image selection
7 – insert/load images into DB, images are inserted into folder which is actually active
8 – delete actual image
9 – for preview purpose are all image cached on local disk in folder %program_root%\ImgCache, here
you can Refreh cache – generate all images again from DB.
10 – clear local cache
11 – cancel dialog
12 – export select image to disk
3.1.3.2 Components
Nodes and elements used in XML are predefined in so called Components.
Components are user defined, as default all current imos xml nodes and elements are predefined. In
definition can user specify:
Node name
25
Node type - (Node – U, Element - E),
Parameter - name of node attribute or element or node
Var type – type of Parameter, possible values are U node, E element, A attribute
Value – predefined list of values, separated by comma
Mandatory – yes,no fill the attribute value with default value
Default – default value from list of values
Description – optional
For deeper understanding please see samples in Components. This can influence to change default
behavior of some nodes, elements and attributes.
3.1.3.3 Dictionary
Allow user to translate all phrases from Catalog or Article to unlimited number of languages. User
prepare Article XML and Catalog XML only once and with here specified translation ICC generate
article in any requested language.
Generally we can use two techniques for translation Catalog and Article data into more languages:
1. Each language has separate copy of Catalog and Article XML. This is mostly used by Design
Manager because local CAD - so far - does not support XLIFF translation technology.
In this case please uncheck Options/Program parameters/Basics/Enable XLIFF localization.
In Catalog properties you can specify languages to which iCC will generate Catalog and article
data.
2. There is only one Catalog and Article XML and iCC generate XLIFF translation file. This is
mostly use by NET 5 environment.
In this case please check Options/Program parameters/Basics/Enable XLIFF localization.
iCC will generate Catalog and Article data only once in XLIFF format and for each language it
will generate translation XLF file into Catalog folder.
This generation will work only for “imos NET” data generation.
26
There is possible to see all phrases when in Article combo box is selected “***none***”, when there
is selected article, there are shown only phrases from particular article.
Recommended is to prepare translation without article specification and later if needed specify
phrase translation for particular article individually.
Destination language can be selected from menu “Language”.
All phrases can be exported to text file with button “Export” and then translated externally.
Translated file can be again imported with command “Import” where you have to select which
language will be imported and update phrases existing in DB.
For special purposes you can remove special characters in export and import files by checking
“Replace special characters”
3.1.3.4 Language list for XML
List all languages which are used for Catalog preparation
27
One language has to be Default, this is usually language in which are Catalog data prepared.
3.1.3.5 Manitenance scripts
Some technical scripts for system maintenance. If you don’t know what below stated action means,
please do not run this.
3.1.3.5.1 Update imos type in Models
Update all imos variables types within Article. This cause that imos variables types are visualized
correctly in Composer. This happened when user type imos Variable name manually without select
box, then there is necessary to update this type.
3.1.3.5.2 Clear lod TempAttr records
Clear temporary tables for xml drag&drop and for tmp copy function.
3.1.3.5.3 Check if Command order
Reorder IF nodes to put commands first.
3.1.4 Options
Options for ICC configuration described above.
28
3.1.5 Information
Menu delivering Help, Registration and About dialog
3.2 Data sources
3.2.1 XML catalog
Allow user to create and structure own content. We can have three different types of data
- Catalog
- Templates
- Includes
29
3.2.1.1 Catalog
Catalog represent imosNET catalog in structure as will be shown online or offline. All menus are
available on right click or as context menu on top or bottom.
30
User can create “New catalog” and specify catalog name and further “Properties”.
Set catalog name Edit catalog Properties
XML name – if needed define exact name of XML file under which file will be stored, otherwise leave
empty, for catalog xml name will be used phrase from “Catalog description”
Global file – define name of Global file for this catalog
Global change file – define Global change file for this catalog
Decorative objects – define Decorative object katalog used with this catalog file
ToolTips file – file from which are used tooltips
Catalog description – define LABEL attribute, text which will be visible to end user
Catalog language – define in which language should be all XML output generated. If this language is
different from default language “Support tools/ Language list for XML” then before output
31
generation will appear dialog with untranslated phrases. For all untranslated phrases are used
phrases from default language.
If XLIFF translation is used just check languages in which you would like to generate.
If XLIFF translation is not used then iCC will generate article XML in each selected language separately
and here you can specify Catalog name and Name used for catalog header.
Within catalog can be created following type of object:
1 – Catalog – with focus on “Catalog root” choose New catalog to create new catalog
2 – Catalog folder – represent folder in catalog and as Properties we can specify “Catalog
description” and “Catalog image”.
“Generate XML when processing catalog” has to be checked for all folders we would like to see as
result in generated catalog. If unchecked then folder and all inherited items stays in DB and catalog
tree, but will not be visible in generated catalog.
3 – Article – represent article in catalog and as Properties we can specify article “XML name”,
“Catalog description” and “Catalog image”. If XML name is not specified for article, then is used name
of article from imos CAD as XML name.
32
4 – Global files – global files are used for global settings and global changes. To create global files
create standard article file first and then switch article type with right click menu to Global file XML.
5 – Folder for long parts – this type of folder is defined for long parts definition. With right click
menu you can change folder type to “Category_contparts”.
6 – Tool Tips - tool tip file is used as source for Tool Tips for elements. For each catalog has to be
defined one tool tip file. From this file are referenced all tooltips used in Article xml.
33
3.2.1.2 Tool Tips
To use tool tips inside iCC you need to
- Create tool tip file – “New item” above any catalog or folder
- Change item type to “ToolTips XML”
- Above Catalog properties please fill in “ToolTips” name of your tool tip file.
Then when Tool Tip file is opened user can add new tool tip with “New Tooltip ” and add text phrases
with “New Text”
34
Tool Tips are then reference from COMBOBOX, EDITBOX, CHECKBOX with atribut „tooltipid“ where
user can choose from list of tooltips.
3.2.2 Template
Templates are designed to store temporary parts of XML data.
You can create and organize them into folders (1), and create templates (2).
There are templates used as code snippets to be copied into different article, or as temporary
storage for part of code.
There are also special types of templates for default Article XML structure (3). These template
contains basic article XML structure which is copied into any new Article XML. Template can be
modified to contain all expected DEFINITION or LOGIC DEFINITION by default. Once the template is
copied into article there is no further relation between template and Article XML, so when template
is modified, changes are not transferred to Article XML based on this template.
For default Include file structure (4) is defined special template type, by default this is not necessary
to modify.
(2) You can fill any template file with drag&drop, just drag any node from Article and drop them on
template file. You can drop only one node and its content, with second drop the content of template
is overwritten.
35
(3) “Article template” for XML is responsible for XML structure when new article is created. You can
prepare several different type of templates and when new article is created then choose one of
these temples for “Use template” pull down menu.
(4) „Include template“ create basic structure for INCLUDE files. If there is not a good reason, you can
leave it as it is.
3.2.3 Include
Includes are designed to store parts of XML shared between several articles. You can create and
organize them into folders (1), and create header for INCLUDE file (2). There are also special types for
parts used in DEFINITION part (3) CONSTRUCTION part (4) and LOGIC_DEFINITION part.
Different types of INCLUDE parts can be changed and adusted with right click and menu „Set include
type“
36
Depending on INCLUDE part type is each particular part opened in DEFINITION, CONSTRUCTION,
LOGIC_DEFINITION part in COMPOSER. Also depending on this part type is possible to insert this
INCLUDE part to proper article part in COMPOSER.
3.2.4 Imos variables
Dialog shows variable tree from attached imos CAD database and particular values for each variable
depending on type of variable, so e.g. variable type FAMILY you will see values sets, for MATERIAL
variable all materials . If you need to use variable name somewhere, here you can find variable and
with F2 copy its name.
37
3.2.5 Imos products
Show all imos CAD products later to be used in Articles.
3.3 Workspace
Double click on Article xml or Include part open workspace where user can edit item content. This
area is divided into three tabs to COMPOSER, EDITOR, XML preview.
COMPOSER is designed for visual way of creating, EDITOR represents tree structure of whole XML
and is closer to text editing and XML preview shows result XML as text.
Any item can be tested locally on any computer where imos CAD is installed properly.
Design Manager preview generate all data and starts temporary catalog with one tested article,
which user can open in Configurator and test look and feel or logic behavior.
Imos CAD preview only generates data for article and preset Design Manager for temporary catalog.
User then has to open article with Design Manager from imos CAD and except viewing article itself
Articles tree is taken directly from imos
Dialog where can be specified default
values for each article, it is later used
in xml definition
38
can insert article into imos CAD directly, this speed up catalog development and article behavior
testing.
3.3.1 Composer
Composer has three major areas Article tree showing XML structure, Property inspector showing
component details and Components showing xml preview.
3.3.1.1 Aticle tree
Article tree represents article structure and this allow user to orientate in Article content.
Each article consist of four basic parts ARTICLE which define article header, DEFINITION define article
menus, CONSTRUCTION consists of Article variables and LOGIC DEFINITION is responsible for article
logic.
39
3.3.1.1.1 ARTICLE
(1) „Item“ – define article from imos, with button (5) user can open dialog with all imos articles and
insert article or if article is not in imos CAD then click on (4) „Enable edit“ and insert any article name.
(2) if article is inserted from imos systém correctly fill column (2) „Art Type“, in case article was
inserted as text, please enter here „ANGOLO“.
(3) field „Art info short“ should contain short article description which is used in basked and
printouts.
3.3.1.1.2 DEFINITION
In definition part we can work with following elements
40
(1) PARAFOLDER which define basic article menu structure, (2) EDITBOX containing user written
imput, (3) COMBOBOX which is list of predefined values, (4) CHECKBOX which can be checked or
uchecked, (5) GROUP which can contain elements and separate them visually or logically, (6)
INCLUDE PART which represent shared part of XML and can not be edited in Article XML, for that
reason is visualized as blue text. To edit INCLUDE PART you have to open INCLUDE directly and then
refresh Article XML content.
All elements can be inserted and deleted with following menu on the top of „Article tree“. Element is
iserted into PARAFOLDER or GROUP on which is user actually standing.
When inserted COMBOBOX, EDITBOX, CHECKBOX then dialog to define variables appear. Function of
this dialog is just select variable and items. Further adjustments of variable and item atributs has to
be done in Property inspector for each variable and item separately.
(1) – variable tree visualied from imos CAD DB. Variable name is used for atribut LABEL and NAME.
(2) - possible values for each varialbe type, e.g. for family are there value sets, for profiles si there
shown profile library. All values which should be used has to be checked. When inserting COMBOBOX
we can choose unlimited number of items, for CHECKBOX it make sense to check only two, for
EDITBOX only one.
(3) – user can insert description for each item, this text will be used for attribut LABEL and shown to
user.
(4) – image for item form imos or taken from iCC image library. If there is image in imos, iCC use it for
image by default and when item is inserted into article tree, image is automatically inserted into iCC
image library under folder „Unsorted“
(5, 6) – possibly we can predefine values for INFO1 and INFO2 attributs used later in logic with
INFO1LIST and INFO2LIST
(7, 8) – shown item description and image from imos CAD if avaliable
41
(9) – there is possible to insert own variable, just type here text which will be used for variable NAME
and LABEL attribut.
(10) – type here values for own variable separated by semicollon.
All elements can be modified with following buttons
(1) „Find“ which is usefull when searching particular part of Article
(2) „Replace“ serve to replace part of the Article. This can be usefull when part or Article is coppied
and user need only adjust part of inserted data. User can also make choise which element attributes
will be influenced by Replace function.
(3) „Locked“ – show status of LOCKED attribut and can be with this button modified
(4) „Visible“ – show status of VISIBLE attribut and can be with this button modified
(5) „Active“ – show status of ACTIVE attribut and can be with this button modified
(6) „Up“ – move element up in the „Article tree“. With “SHIFT + Up” you can move item in step 10
items upper.
(7) „Down“ – move element down in „Article tree“. With “SHIFT + Down” you can move item in step
10 items lower.
(8) „Copy to TEMP“ – copy actual subtree to TEMP memory, this function is equel to Ctrl+C
(9) „Paste from TEMP“ – past actual subtree from TEMP memory, this function is equel to Ctrl+V
(10) „Refresh“ – refresh actuall subtree
42
(1) „Locked“ – show status of LOCKED attribut and can be with this button modified
(2) „Visible“ – show status of VISIBLE attribut and can be with this button modified
(3) „Active“ – show status of ACTIVE attribut and can be with this button modified
(4) „Add item“ – add item to COMBOBOX element
(5) „Delete item“ – delete item from COMBOBOX element
(6) “Show/Hide preview” – Show or hide components preview in DEFINITION part
3.3.1.1.3 CONSTRUCTION
By default all variables used in Article XML are inserted into VARIABLES node, but only all from imos
CAD are visualized in CONSTRUCTION part automatically and then in XML inserted into VARIABLES
node. The rest is hidden in XML structure.
(1) – List of variables in Article tree, user can delete particular VAR here
(2) – in Article tree particular variables can be moved with arrows up or down
43
(3) – Refresh list of variables
(4) – There is possible to Reload all variables from XML. So list of current variables is deleted and only
imos CAD variables are inserted into VAR list. If all imos CAD variables are not recognized then Run
script from menu Support tools/Maintenance script/Update imos types in models. This script
compare imos CAD db and iCC db and assign to all variables info about variable type, in which
element type is used in article, Element description, this data are stored in VAR systém attribut
_inner separeted by semicollon.
(5) – there is possible to hide variables from VAR listopad
(6, 7) – there is possible to restore hidden variable to VAR list. Typically when user need to send
some user defined variable into imos CAD or ERP.
3.3.1.1.4 LOGIC_DEFINITION
LOGIC_DEFINITION contain information about article logic. Logic itself is organized in tree structure
which show relation of particular IF.
(1) – root for LOGIC_DEFINITION, user can see all elements and its order directly under
LOGIC_DEFINITION. There is possible to insert COMMAND directly under root with plus
button.
44
(2) – LIBRARY contain all MESSAGEBOX records. There is highly recomanded to keep this folder
directly under LOGIC_DEFINITION root.
With plus button user can add new message box and specify for this message box Name,
Label, Text and Type of button. There can be also added comment which is used only internaly.
(3) IF node represented in tree structure
(4) IF node which is inserted into ELSE part of parent IF
(5) IF node which is inserted into THEN part of parent IF
(6) Part of the logic inserted a s INCLUDE file
(7) move to the upper IF node
45
(8) optional comment for IF node, shortly describing content of logic, this comment is later shown in
LOGIC_DEFINITION tree and easy orientation in logic
(9) root of IF stated, here can be inserted condition
(10) root of THEN part, here can be inserted commands when IF condition are true
(11) root of ELSE part, here can be inserted commands when IF conditin are false
(12) this button hide all lover level IF nodes
(13) this button comment out/comment on current record. So the record stay as is, but is not inseted
into output XML. This is very helpfull for testing, user can comment out part of the logic and test
behavior.
(14) reorder IF node first and COMMANDs and vise versa
(15) add new item – condition or command
(16) delete current item
(17, 18) move item up and down
(19) add AND
(20) add OR
(21) replace AND and OR
3.3.1.2 Property inspector
Is used to control all attributes properties. All mandatory attributes are filled automatically with
default values when node or element is inserted. All other possible attributes are shown in grey color
below.
46
3.3.1.3 Definition preview
Preview for visual check how Definition part will looks like in configurator. Preview can visualize all
nodes or just these which has attribute VISIBLE set to TRUE. This depends on settings in Option /
Program parameters / Basic / Show hidden objects in Article composer.
In preview is visualized if element is LOCKED (1) with dark red color, not VISIBLE (3) with grey color or
not VISIBLE and LOCKED (2) with light red color of text.
47
3.3.2 Editor
Editor show complete XML in raw state as pure tree structure. User can insert nodes and elements
directly via command “Insert” from list of defined components and then define all attributes
manually.
48
3.3.3 XML preview
XML preview allow user to save file manually or find text in generated XML.
4 Automatic data import
iCC contain option to automatically import your data from Excel, CSV file, SQL database and create
XML data for prices, descriptions etc.
General idea is that customer will create Template – data structure which will be repeated for each
line in Data Source. With placeholder %column_name% will be in template identified places where
should be inserted data from column_name column from Data source like Excel file, CSV file, SQL
database or other connection based on ODBC driver.
In import there is only possible to fill include parts. Data import is accessible via Right click menu on
include part “Fill include from data source”
49
General recommended workflow is:
1. Create new Include with new Part
2. Define new Data Template
3. Define new Data Source
4. Fill data from Data Source into Include Part
4.1 Data source
As source data can be used Excel file, CSV file or and data source based on ODBC like MSSQL, MySQL,
SQLLite etc. If there is as source data used text file for Excel file, first row has to contain column
names. Column names are later used for referencing this columns in templates.
Nr. ID Text P1 P2 P3 P4 1 PU-3-00-040302-0 Elemente (leer) verleimt, mit Rückwand, ohne Front 425 555 525
2 PU-0-40-080404-0 Schubkasten Blum Tandembox 380 535 435 775 3 PU-0-43-080404-0 Schubkasten mit Holz Zarge Buche 690 840 740 1025 4 PU-0-44-080404-0 Schubkasten mit Holz Zarge Nussbaum 1300 1455 1355 1640
For defining Data source click on „New Data Source“ button and fill
- “Source name” – be able to save this and reference for later usage
- Choose „Connection string templates“, so far we have predefined connection strings for
connection strings for XLS, CSV, MSSQL, MySQL, SQL Lite. User has to take that appropriate
ODBC driver is properly installed on his machine.
50
- “Parameters” dialog show all parameter from connection string for user to be able to fill
values. E.g. for excel file user has to fill
o FileNameFull – path to the xsl file
o SheetName – name of sheet which contain data
- “Command text” – contain select statement where data could be filtered or validated or
maybe specific columns could be imported.
Recommended is “Test connection” or “Preview data”
There is also possibility to import data without ODBC driver setup. Option is hidden under button
“Direct from MS Excel”.
Run MS Excel before you start iCC - open your XLS file. Then select first column’s cell in a row, from
which your import will start. First row of excel table supposed to have column names. You can
specify if you would like to „Overwrite records“ or „Add to current list“ or „Records to load“ – if 0 is
set then all records till empty line are imported. When ready then press button „Load“ - all data will
be loaded into data grid. Then when you click „OK“ imported data are inserted to „Data preview“ grid
where you can generate include content from them.
4.2 Template
User can create new template in under Templates and has to “Set template type” to “Data template”
51
Template can be edited in “Editor” or copied as finished piece of code from regular article or even
imported from XML file.
Template sample:
<IF>
<AND>
<EQ expr1="FIELD(H_Artikel).value" expr2="%ID%"></EQ>
<EQ expr1="FIELD(ICC_Korpus_Oberflaechenart).value"
expr2="1"></EQ>
</AND>
<THEN>
<COMMAND>FIELD(H_Art_Preis).value=%P1%</COMMAND>
<COMMAND>FIELD(Vartex_Description).value=%Text%</COMMAND>
</THEN>
<ELSE>
4.3 Process Data import
Via right click menu “Fill include from data source” access dialog, choose required Template and
Data source.
52
Choose if you would like to “Add data to Part” or “Rewrite part” and click on button “Fill”.
Import process will start and actually processed line is shown and marked in Data Preview grid. To
close dialog please press „Cancel“ button.
4.4 Run generation process from command line
Since version 2.1.8 buil 1 there is possible to run generation process as batch from command line e.g.
as Scheduled task in overnight job.
4.4.1 Filldata
With “filldata” command you can automatically fill Include content from data source. E.g. imoscc.exe
filldata -itemID:325310 -templateID:212 -dataID:35 -overwrite
Parametr –itemID: is taken from Catalog tree in right upper corner as shown on image bellow.
53
Parametr –templateID: is taken from Select Template pull down menu
Parametr –dataID: is taken from Select Data Source pull down menu
Parametr –overwrite/append
4.4.2 CADxml
With CADxml you can automatically generate all your CAD data. E.g. imoscc.exe CADxml -itemID:18
will generate whole catalog.
54
4.4.3 NETxml
With NETxml you can automatically generate all your NET data. E.g. imoscc.exe NETxml -itemID:18
will generate whole catalog. All settings are taken from “Program parametrs”