SAPHIR 2 - Manual

S emi
A utomated
P roject
H andbook
I nscribing
R outine
Datum

2 September 13, 2011

Ersteller
Sergej Gerlach

Version
1.4

Festo AG & Co. KG

Postfach
73726 Esslingen
www.festo.com
Telefon 0711 347-57472
Telefax 0711 347-
[email protected]
Ruiter Straße 82
73734 Esslingen
Changes are highlighted.

1 Introduction ........................................................................................................ 3
1. 1 What is SAPHIR? .................................................................................................. 3
1. 2 Functions of SAPHIR 2 ......................................................................................... 3

2 Quick Start SAPHIR 2 ......................................................................................... 4

3 Important notes .................................................................................................. 6

3. 1 Load Projects and tree-templates ....................................................................... 6
3. 2 Local copy of the xDKI database ......................................................................... 6

4 Functions in detail .............................................................................................. 7

4. 1 General ............................................................................................................... 7
4. 2 Settings ............................................................................................................... 8
4. 3 Selection ............................................................................................................. 9
4. 4 Basket ............................................................................................................... 12
4. 5 Finishing............................................................................................................ 16
4. 6 Product information .......................................................................................... 23

5 Document Management Information ............................................................... 26

Festo AG & Co. KG SAPHIR 2 - Manual 1.4 2

1 Introduction

1. 1 What is SAPHIR?

SAPHIR was developed to create project handbooks based on the xDKI database. In the
second version more design options are possible, but the basic function is the same:
Product information are collected and can be processed in the output Word document.

1. 2 Functions of SAPHIR 2

 Bilingual user interface

 Easier user interface for better orientation
 Support of all available languages of the xDKI (current 24)
 Support of all sale regions
 Work with the familiar xDKI Product-tree, with preview for a node
 Selection of products and product series
 Selection of accessories
 Create own tree, save and load templates
 Export the tree to a document
 Save, load and send the project
 Save and load a default address of the front-page
 Filter the results
 Quick import via part number
 Import of list with Festo part numbers
 Import of columns, assigning information to part numbers
 Sort of the basket by xDKI(default), or own
 Add comments to parts and/or product series
 Export the part numbers of the basket to a list
 Set features for products and product series, values are summarized and
displayed
 Multiple export in Word with the following options:
o Product Series
- Online-link to the xDKI on the image
- Processed comment column, optional show / hide
- Add PDF Documentation
o Products
- Imported additional column, optional show / hide
- Processed comment column, optional show / hide
- Set features, optional show / hide
- Related internet links by icons
- Product picture, line drawing and symbol
o 4 Layout- variants for the output document
o Customer Columns Layout, the column names can be adapted and their
order can be changed
o Select the export template
 Show more product details

Festo AG & Co. KG SAPHIR 2 - Manual 1.4 3

2 Quick Start SAPHIR 2

The Normal-Mode of the UI shows only the main functions of the program.

To work with SAPHIR only the xDKI is necessary. After the start of the program, the
database and the language must be selected.

In Selection click on the desired node in the tree, select the products in the list and click
on the button Add Product(s) to Basket.

Festo AG & Co. KG SAPHIR 2 - Manual 1.4 4

 1

Start in Finishing the export with a click on the button Create Word-Document.

Festo AG & Co. KG SAPHIR 2 - Manual 1.4 5

3 Important notes

3. 1 Load Projects and tree-templates

The program is based on the NodeID. This changes with each xDKI version and
unfortunately there is no way to transfer these clearly distinguished between different
versions. As a result, projects and product tree templates must be opened with the same
xDKI version.
This problem can be solved through the export of parts from the basket and an import
into a new project.
The product tree works with another xDKI version not correct.

3. 2 Local copy of the xDKI database

If a local copy of a database is created, not just the file DKI3RUN_2K.mdb also the
databases for the documentation (Doc_DE_2K.mdb e.g. for German) is necessary,. If
these do not exist and links to documentation are required an error message will be
shown.
All databases must be stored in the same folder.

If additional PDF documentation must be available locally and they are not downloaded
from the Internet, xPAC's in the relevant language must be located in this folder too.

Festo AG & Co. KG SAPHIR 2 - Manual 1.4 6

4 Functions in detail

4. 1 General

The user interface language can be switched between German and English. The change is
affected only after a restart of the program. The database language is independent of this
choice.

The Mode Normal shows the main functions, so the start with the program is easy.

The project can be saved and send as an email (the arrow next to Save Project ) in any
part of the program.

Help will open this manual.

Festo AG & Co. KG SAPHIR 2 - Manual 1.4 7

4. 2 Settings

1 Settings for the database are made here. In addition, the user can choose three
different options to determine a database:

 Own database, for a local copy of any database

 xDKI database, the path comes from the registry
 Server database, for SAPHIR created database with all 24 languages /1/

The choice of language and region /2/ can be done here, also information about the
current database (location, creation date and numbers of nodes) are displayed on this
position. The database contains the full product range. By setting the region, the
selection will be reduced. There are currently the regions World, Europe, USA and Brazil
available.
If the language is changed during a project, the items in the basket will be translated.

A check of the actuality of the local database can also be made. This "update" refers to
the local copy and the file on the Z drive. If an outdated version is found the two folders
are opend and the old version must be replaced by the new one.

2 The program starts with an empty project. To load an empty project the user has to
click New, all changes get lost. A project can be opened.

3 In the document settings, the front page information is requested. The entered
address can be saved as default; it will be loaded with each new project.

1 Performance losses due to the network connection, the better way is a local copy of
this database
2 Some nodes are not displayed. 0 All, 1 Europe, 2 USA, 3 Brazil

Festo AG & Co. KG SAPHIR 2 - Manual 1.4 8

4. 3 Selection

In the selection, there are two working areas. The first is the product tree you can adjust
and select nodes. The second is the selection of the products / product series for the
basket.

The user has the following options:

 Export the tree in a word document
 Hide/show the checkboxes
 Highlight selected nodes
 Hide all not selected nodes
 Show all nodes
 Save and load templates

Festo AG & Co. KG SAPHIR 2 - Manual 1.4 9

  (De)select nodes
 Hide Node
 (De)select all nodes
 Expand/collapse nodes

The edited tree can be saved as a template and always be loaded.

Through the selection product(s) and product series the user can choose to add products
or product series to the basket.

To add an item to the basket a node must be selected and then the selection of these
products is displayed.
In the product series, the end nodes of the selected entry are displayed.
If only the series of a product is required the CTRL key must be pressed while adding
items to the basket.

For each node there is an overview with an image, the title and features, technical
parameters or descriptions.

In the displayed list (products or product series) the desired entries can be selected and
added with a button click to the basket.

To get faster to the target in the selection, the columns can be sorted by part number or
order code. This is done by a left click of the mouse on the column title.

A multi-filter allows restricting the result. This starts by right-clicking on the appropriate
column title.

Festo AG & Co. KG SAPHIR 2 - Manual 1.4 10

The following options are available:

…xxx... contains
xxx… begins with
…xxx ends with
= equal to
<> not equal to
…|xxx... contains not
|xxx… begins not with
…|xxx ends not with

For the filtering of columns with the type number the following options are available:

= equal to
<> not equal to
> greater than
< less than
<= less than or equal to
>= greater than or equal to

These three conditions can be linked with AND or OR, the OR-join is preferred. The
conversion can be done via click on the word.
The filter is only for this choice and must be reactivated for the next use. Yellow filter
symbols kill the filter.

Through the “quick filter” at the bottom the filtering of a column is possible, for products
by order code and product series by name. A combination of both filters is not possible.

Festo AG & Co. KG SAPHIR 2 - Manual 1.4 11

4. 4 Basket

1 2 3 4 5 6 7

In this step, the selected items are being prepared for export. The column width is set
automatically by the contents of the cells. The order of the columns can be changed to get
a better view. The background color of product series is gray.
By using the context menu (right click in the basket on an entry) a change of the view is
possible. The images will be resized and all products will be shown/hidden.

By deleting (context menu or Delete Key) the selected entries are deleted. If a series is
selected, all associated products will be deleted.

1 Single parts can be added directly by part number.

2 In the Import dialog it is possible to add multiple numbers, e.g. from the clipboard.

Festo AG & Co. KG SAPHIR 2 - Manual 1.4 12

3 By importing a csv list of Festo part numbers they will be added to the basket. If the list
contains several columns, only the first will be imported.

Figure 4.1 Example of a CSV file

Festo AG & Co. KG SAPHIR 2 - Manual 1.4 13

4 The table can be extended with any columns or products via another csv import.
Different configurations of a product are possible.

1. File Settings
under PartNo: is the column with the Festo Part number expected.
2. Additional Columns
the columns to import can be selected
3. Import Settings
without choice => Columns and values are added to the products in your basket
Add Parts to Basket => Entries from the list are imported into the basket
Allow Product Configurations => identical part numbers can be imported multiple
times
4. Status Log
After importing the error rows can be exported at this point

5 The default sorting is done according to the xDKI; in addition the products can be
sorted in a product series by part number, order code or name. A more individual order
sorting is possible via unique ID. With using drag & drop the items can be reordered in
the basket, the Sort button needs to be activated.
The sorting should be done only after the completion of the selection!

6 The edit of the basket must be done aware and will be activated by the button Edit
Items. In edit mode all entries can be changed. Remove sizes from the description, add
comments, change the order code ...
Additionally it is now possible to change the customer columns by right-clicking the
column header.

7 The part numbers from the basket can be exported into a list. On this way an old
project is usable with a new database.

Festo AG & Co. KG SAPHIR 2 - Manual 1.4 14

Features can be set and cleared for a group of products, or even just for a specific
product. The features of a group are overwriting those of products; this does not affect
later inserted parts. This order should be observed:
Parts in the basket -> Features set for a group -> Add features for products.

Figure 4.2 Features of a product Figure 4.3 Features of a series

If the feature is found on several entries, the values are summarized in one line. This
applies to both cases.
In product selection the change is effective immediately. In the summary the modification
must be acknowledged by a click on the button apply.
The call of this dialogue is either via the context menu in the basket or a mouse click on
the checkbox in the Feat. column. This shows the status of the selected features. For each
box three states are possible: selected, grayed out and not selected. These represent the
states:

 Features set

 Features (not identical with those of the group)

 No features set

For each detail table column headings with the feature titles will be generated. So it is
possible to select the features at the product level individually.

Festo AG & Co. KG SAPHIR 2 - Manual 1.4 15

4. 5 Finishing

In finishing there are a lot of possible alternatives for the document. The user has many
available variations to the document according to his wishes.
The online link (Product series) is the only option that does not add a new column in the
document, but the image is necessary.
The options comment (series / products), additional columns and features are only
enabled if values in the basket done. This means, as soon as the first feature is set, it can
be selected at this point.
For a basket only with series the option “All Related Products” is selected
automatically. The column “Ordercode” in the Group-Table is deselected.
The settings on the tab “Finishing” are stored on the computer. Exceptions are the lists
(language of the documentation, the column layout and the template). The button
“Reset Settings” restores the default values.

Festo AG & Co. KG SAPHIR 2 - Manual 1.4 16

The finishing is divided into six areas.
 Product Series
- Online link in the xDKI over the image to the series
- Comment column, optional show / hide
- Add PDF Documentation, as a link to the Internet or on locally
downloaded/extracted PDFs. For the documentation all products of this
node or only the products in the basket are considered (especially
interesting for accessories). Different languages can be selected. /3/
The name of the links in the document can be displayed according to
the language.
 Products
- Imported additional columns, optional show/hide
- Processed comment column, optional show / hide
- Set features, optional show / hide
- Related internet links on icons to:
 xDKI (to the product or the configurator)
 Documentation (all languages)
 CAD
 Datasheet (all features)
 Accessories
 Spare parts
 Layout Word-Document
- List Items, first all product series and then all parts
- Group Items, list the associated parts after the product series
- Only Product Series, list all product series and ignore the parts
- Compact, products are listed in the product series table
 Customer Columns Layout, It is possible to...
- change the column names; select an entry -> edit name -> click ok
- change the order; move the selected entry with the arrow
- hide specific columns; remove the check mark in front of the name
- clear tables. Cells with the same content will be connected.
- Optionally, the empty columns can be deleted
 Word Template,
the document for the export is selected.
Additionally the document can be saved with macros, for more
information read chapter 4. 6 Word-Macro (page 23).
 Create Word-Document,
this button will open a Word file in the background and starts exporting
to them. The progress of the job is shown. After completion the
document will be maximized.

3 If the document appears not the desired link, there is no PDF available

Festo AG & Co. KG SAPHIR 2 - Manual 1.4 17

The combination of the STRG key and a double click on the empty space in Word
Template will show tree textboxes. A double click on this space hides them.

Now it is possible to change the size of the pictures (in pixel) and the width of the table
(in cm) in the document.

The following example shows the consequences of the settings. Except of the additional
columns and pictures by products all the possible options were selected. As layout option
the parts are grouped by Group Items. A sorting and renaming of columns was omitted at
this point.

In the series table, the columns name, note, picture and comment were taken from the
basket. The ordercode is generated from the order codes of the associated products (up
to the first dash). As desired there is a link on the picture to the online xDKI to DGCI. In
the documentation column the PDF documents are linked in German and English.
In the products table, the first four columns have been copied from the basket. The two
features Theoretical force at 6 bar, return stroke and Piston diameter have been added
with their values. In the column Links are six symbols that include hyperlinks to additional
pages.
The representation of additional columns is consistent with the comment columns.

Festo AG & Co. KG SAPHIR 2 - Manual 1.4 18

For the Word layout are three options available. Depending on the requirements the best
design can be selected.
List Items
After the collection of all series, the parts are grouped by the different categories and
with the node name as caption. This is the classical/historical view; the reader gets an
overview and can find out the details as required below in the document.
The first nodes of the tree are giving a rough structure for the document.

Festo AG & Co. KG SAPHIR 2 - Manual 1.4 19

Group Items
All information of a product series and the associated products are one after the other.
Immediately after the summary the details can be found.

Festo AG & Co. KG SAPHIR 2 - Manual 1.4 20

Only Product Series
All the products in the basket are ignored and only the series are shown.

Festo AG & Co. KG SAPHIR 2 - Manual 1.4 21

Compact

The corresponding products of the series are summarized in a single table.

The images at the product level can all be selected, but it is no good result, because the
product rows are designed in the table for just one line.
In the following list the result of the selection is visible.

All

Product Picture

Line Drawing

Line Drawing (small)

Symbol

Festo AG & Co. KG SAPHIR 2 - Manual 1.4 22

4. 6 Word-Macro

Macros are small programs/scripts that can do automated tasks. For example: all
tables get the same column width.

With the chosen option „With Macro“, there are two additional buttons below the title
on the first page.

 Start Macro – opens another window to run the macros

 Remove Buttons – removes the buttons from the document and saves it as a
normal document without macros (.docx), the original file will remain

Via Alt + M the window for the macros can be called in the document.

The macros must be activated to get a working document.

Festo AG & Co. KG SAPHIR 2 - Manual 1.4 23

4. 8 Product information

By a double click on a product row (in selection or basket) this dialog will be shown.
It is possible to:
 Find accessories
In the list Categories can be selected (Right click on the header text
category).

 Products for which the selected part number is accessories

 Product details

Festo AG & Co. KG SAPHIR 2 - Manual 1.4 24

 Pictures can be e.g. inserting in a word-document via drag and drop or copied
in the clipboard by a right click.

 Product series
All nodes where the part belongs are listed.
The picture is linked to the xDKI.
The navigation in the types tree is similar to the product tree.

Festo AG & Co. KG SAPHIR 2 - Manual 1.4 25

5 Document Management Information

Version Date Type of Changing Pages

1.0 08/26/2010 Created all
1.1 12/02/2010 Edit, new functions and pictures 1, 3-5, 7-17, 21-23
1.2 01/03/2011 Edit, new functions and pictures 13, 16, 5, 12, 15, 22
1.3 04/29/2011 Edit, new functions and pictures 3, 14, 17, 22
1.4 09/13/2011 new functions 16, 17, 23

Festo AG & Co. KG SAPHIR 2 - Manual 1.4 26