proframework prodocument - pronovia · screen sections the size of the right and left screen...

User Manual

ProDocument

ProFramework

2

Imprint

Legal Notice

Issue June 2019 / B.00.0All rights reserved.

Copyright and Usage Rights

This document is copyrighted and may not be modified without the prior written consent of the publisher.Reproduction and distribution is permitted only with the following legal notice:© 2019 ProNovia AGChanges and updates without notice.Microsoft is a registered trademark of Microsoft Corporation.SAP is registered trademark of SAP AG.ProNovia is a registered trademark of ProNovia AG.

Disclaimer

ProNovia AG assumes no responsibility for any typographical, technical, or other inaccuracies, errors, oromissions and their consequences. Liability in respect of the software described herein, please see oursoftware terms.

ProNovia AGP.O. BoxCH-8180 BülachFon +41 44 860 13 06www.pronovia.cominfo [at] pronovia.com

Publisher/Contact

ProNovia A G | P .O . Box | 8180 Bülach | Switzerland | pronovia.com

mailto:

ProNovia AG | P .O . Box | 8180 Bülach | Switzerland | pronovia.com 3

Table of Content

Introduction 41

Other Documents1.1 4

Prerequisites1.2 4

Symbols in this document1.3 4

About «Application Framework» 52

Start of the Application2.1 5

ProFramework Interface2.2 6

Interface Sections2.2.1 6

Interface Adjustments2.2.2 6

Layout Manager2.2.3 6

Global Application Functions2.2.4 6

Personal Settings2.2.5 6

Validities2.3 12

Introduction to Widgets2.4 12

Widget Types2.4.1 12

Adjustment of Widgets2.4.2 12

Operation2.4.3 12

Widgets 203

Navigation3.1 20

Object Selection3.2 21

Change Documents3.3 24

Baslining3.4 24

Introduc tion

ProDocument

ProNovia AG| P .O . Box | 8180 Bülach | Switzerland | pronovia.com 4

1 Introduction

This document describes the general use of ProFramework.

This manual describes ProFramework disregarding the field of application, the data used,process, modifications and enhancements.

All information displayed are exemplary and can alter from your environment.

Please follow your company internal rules and procedures regarding the applications, processesand data.

1.1 Other Documents

All relevant and available documents are found in the ProNovia Support Center: http://support.pronovia.ch.

1.2 Prerequisites

Prerequisites for using ProNovia products:

· ProNovia products to be used must be installed and setup correctly on the relevant systems.

· ProNovia products must be properly integrated, activated and configured. Details see documentProBasicLib, Integration and Enhancement Manual.

· To use ProNovia products, valid licenses for each product must be loaded on each system. Details seedocument ProBasicLib, Integration and Enhancement Manual.

· The necessary permissions for the display and maintenance of SAP objects must be present.

1.3 Symbols in this document

In this document following symbols may be used:

Important or critical hint, to pay special attention to.

Additional information.

BusinessAddIns (BAdi) are available. They are described in the corresponding Installation andEnhancement Manual.

Function protected by SAP authorization.

http://support.pronovia.ch

A bout «A pplication Framework»

ProDocument


2 About «Application Framework»

ProFramework is the new basis for a flexible and intuitive multi object application in SAP. This newMiddleware allows complex development and configuration of cross-object, modular and modernapplications. Best user experience is guaranteed, independent from the UI-technology being used. Thenewly developed ProFramework will therefore be the new platform for all future ProNovia products andproduct releases.

Objectives

· modular, cross-object applications

· maximum performance

· adjustment options for clients and users

· support of SAP GUI ans Web Dynpro (dual strategy)

User Experience

· uniform, consistent look

· uniform behaviour

· uniform operation

Implementation

ProFramework enables users to edit SAP objects documents in a very simple and intuitive way. The userinterface consists of different object related sub screens, so called widgets.

A Widget

· stands for flexible, independent reusable screen sections with object specific and context sensitivefunctionality.

· provides specific information,

· offers functions for its content,

· is able to interact with other widgets (within the same ProNovia product), e.g. when a file is moved fromwidget File Explorer into widget ProDoc-Browser by drag & drop, a document info record will be createdin a SAP DMS structure,

· can be displayed individually and customer specifically on the screen (see Introduction to Widgets ).

2.1 Start of the Application

An application is a flexible, very adjustable interface to view and/or edit various objects. The configurationof the application is done in the Customizing. This includes numerous options, e.g. the definition of allobjects, which can be viewed and/or edited, widget selection and definition, layouts of interfaces andpossible functions.

The following ProNovia applications are already based on ProFramework:

· ProDocument

· ProPLMClient

· ProObjectLifecycle

12


ProDocument


· ProConfiguration

· ProAdmin

· ProMaterial

· ProStructure

The following applications provide functions, widgets and data integrated into other ProFrameworkapplications:

· ProBaseline

· ProConfiguration

· ProMaterialData

Any application, based on ProFramework is started with an application specific transactions:from /PRONOVIA/XYZ1 to /PRONOVIA/XYZ9 resp. /PCH/XYZ1 bis /PCH/XYZ9. (XYZ stands for productacronym). These transactions have different customized interface definitions assigned.

Transactions from a reserved name space in the SAP command field must begin with /N. Wheninserting the transaction into the SAP Easy Access menu no prefix is necessary.

Please regard the valid transactions for the applications in your company. Also customerspecific transactions are possible in the client's name space.

2.2 ProFramework Interface

When calling the transaction, the interface of the specific application is displayed. The opticalappearance and characteristics are dependent on the customizing settings and can be changedindividually. Therefore illustrations used in this manual may be different from what you see in your clientspecific implementation.


ProDocument


2.2.1 Interface Sections

The user interface of ProFramework is divided into the following sections:

Section Description

1 Menu bar

Menu functions for the relevant application.

2 Function bar

Push buttons for general functions.

3 Left screen section (auxiliary section)

User-defined arrangement of widgets according to customizing or personal settings ofthe UI Layout Managers.

4 Central screen section

User-defined arrangement of widgets according to customizing or personal settings.


ProDocument


2.2.2 Interface Adjustments

In general, the interface layout for each application is configured in the central customizing. Thesesettings are defining the content of the left and right (middle) section. The visibility and order can be setuser specifically, see also Personal Settings and Layout Manager . User specific settings canalways be reset to default settings.

Screen sections

The size of the right and left screen section can be changed by moving the separation line to the left orright side. The last position of the vertical separation line will be saved on exit.

Widget Display

Size changes Place cursor between widgets and move.

Widget will be minimized, Only the title bar will be displayed, no other content.

Widget will be maximized and using the entire available space.

Widget will be set back to the normal state (only available when widget was minimizedor maximized).

All layout changes will be saved user specifically, if the application is quit regularly with

command End .

11 9


ProDocument


2.2.3 Layout Manager

The interface can be adjusted individually with the layout manager. The settings are defining the contentof the left and central (right) section. Visibility and order of widgets can be set user specifically. Themanagement is exclusively effective for the current layout. All user specific settings can be reset todefault setting at any time.

Widgets (and groups) are moved with drag & drop. Via context menu each single widgets can bemaximized, minimized, hidden or shown. With push button New group single widgets can be grouped,and are viewed in tabs. If only one single widget remains in a group, the group will be automaticallydeleted after saving.

Push Button Description

Creates a new widget group.

Resets all settings as defined in the customizing.

When changes are made in the central customizing, the combination userand standard settings may result in an incorrect display. In this case, thelayout must be reset with this function.

Saves changes to current layout and quit layout manager.

Ends layout manager without saving the changes.

All individual changers of the layout are only saved, when the application is quit with the exit

command .


ProDocument


2.2.4 Global Application Functions

The following functions are additionally available in the application function bar and/or some widget titlebars.

Push Button Description

One step back in the navigation (only available after previousnavigation).

One step forward in navigation (only available after previous backstep).

Pop-up menu with navigation history.

Data refresh in one specific or all widgets.

Configuration of Personal Settings .

Start of Layout Manager .

Start of definition of Validities for all objects.

Cancel maintenance of current object. Only available whenobject is edited or created.

Exit application.

Search in a widget. Only possible for certain widgets.

Search next. Search the current search term in the last widget asearch has been started.

11

9

12


ProDocument


2.2.5 Personal Settings

With this options, the user can configure his personal settings. Some options may be limited by thecustomizing and therefore not available.

2.2.5.1 General

Confirmation prompt on exit

If activated, a confirmation prompt will be required on exit.

Set validity daily to actual date

If activated, then daily of the first start of any ProFramework application the validity option is set to "Keydate" with date = today's date.

2.2.5.2 Display Mode

2.2.5.2.1 General Display Settings

Hide initial fields

If activated, all initial fields without values will be completely hidden.

Empty characteristics are only influenced by special setting Classification

Document versions to display

Defines which document versions will be displayed. This is relevant for linked documents and widgetFolder and Document Parts. Possible options:

· Show all document versions

· Show highest document version: only highest version of document info record.

· Show highest released document version: if the highest version is not released, the highest releasedversion is shown.

Format key figure

Different format options can be used to emphasize key fields. Format options can only be used in somewidgets.

Compact display

Reduction of line space in a list displayed in a widget.

Document key starting with number

If activated, the document key starts with a number. Otherwise the document key starts with documenttype, number, part document, document version etc.

2.2.5.3 Behaviour

Enable single click


ProDocument


If activated, a single click is sufficient to trigger an action. This function is indicated by underlining theobject when hovering the cursor over the respective object. However drag & drop actions will then berestricted to sections which are not single-click sensitive (e.g. object icons).

2.3 Validities

The explosion and display of a structure is always based on a validity range (BOM, document structureetc.). The validity is required for explosions, where-used lists etc. (example widget Object Relations). Thedefined validity range will be saved in the user data of ProFramework and will be set accordingly onrestart. The currently used validity is indicated in text format as push button in the function bar. The pushbutton also serves to change the validity (bop-up menu).

Date Range

Date range can be set. Structures and usages are evaluated for this date range. If this option is selected,it remains valid until the next setting. Object changes have no influence on the selected validity.

Current Date (Key Date)

The validity range is identical to the current date. Valid from date and Valid to date are identical (keydate).

Todays Object Validity / Highest Object Validity

The specific validity is determined for the relevant object. In case several validities are possible (e.g.different document versions or material revisions), the today valid, respectively the highest validity will beselected. For objects without validity, the range for key date 31.12.9999 is used. Any object change setsa new validity.

2.4 Introduction to Widgets

Specific characteristics of various widgets of ProFramework will be described below. A widget stands forflexible, independent reusable screen sections with object specific and context sensitive functionality.

A widget:

· provides specific information,

· offers functions for its content,

· is able to interact with other widgets (within the same ProNovia product), e.g. when a file is moved fromwidget File Explorer into widget DMC-Browser by drag & drop, a document info record will be created ina SAP DMS structure,

· can be displayed individually and customer specifically on the screen (see Adjustment of Widgets ).

Widget titles are defined in the customizing. The widget names in the illustrations may thereforebe different from the names in your company's solution.

2.4.1 Widget Types

Widgets are always based on a certain type, which are different in appearance, content and general(context independent) functions.

17


ProDocument


2.4.1.1 Tree Widgets

Tree widgets are displaying simple, hierarchic data (e.g. widget Folder Browser.). They supportdrag & drop functions for suitable objects and provide context menu functions in the empty area or singlenodes.

These general functions are provided. However it depends on the widget, whether the functions are active.

Search/Search next

Context menu function Search allows a text search within the loaded nodes. hits will be marked. Withfunction Search next the next hit is marked.

Save expanded nodes

Some widgets allow saving the state of the expanded nodes. When saved, the nodes will be displayedagain in their expanded state on restart.

It is not possible to save all nodes in the expanded state. Mainly available for unique structurenodes with text names.

Multi-level expansion on nodes

On expandable nodes, a context menu function is offered which allows to expand the node on multiplelevels. The availability and the maximum expansion depth depends on the widget settings. The expansiondepth is based on the node on which the function was executed. Multiple selection is possible. Inaddition to the option of expanding all nodes, you can also expand the tree to exactly one level (Displayone level below) or exactly two levels (Display two levels below). All nodes on the last level to bedisplayed are closed. If, for example, two levels below shall be displayed, all nodes on level two areclosed so that only level one and two are displayed.

The availability of the Display All function can be restricted for specific widgets. Instead, afunction Display <n> levels below is offered.

For specific widgets, it is possible that certain nodes are not expanded even though themaximum expansion depth has not yet been reached (for example, in recursions).

2.4.1.2 Hierarchic Lists

Hierarchic lists are showing their data in tables. They are based on Based on SAP ControlCOLUMNTREE model. The data can be sorted hierarchically (e.g. widget Object Selection ). Thesewidget are supporting drag & drop for suitable objects. Context menu functions are available for singlenodes and within the empty area.

The column layout, including the sorting and filter can be adjusted by the user. A default layout isdefined in the customizing. Different functions are provided in column titles and context menus. They aredescribed in the next topics.

General functions Search/search next and Save expanded nodes are also provided. See Tree Widgets

Search/Search next

Context menu function Search allows a text search within the loaded nodes. hits will be marked. Withfunction Search next the next hit is marked.

21

13


ProDocument


Save expanded nodes

Some widgets allow saving the state of the expanded nodes. When saved, the nodes will be displayedagain in their expanded state on restart.

It is not possible to save all nodes in the expanded state. Mainly available for unique structurenodes with text names.

Multi-level expansion on nodes

On expandable nodes, a context menu function is offered which allows to expand the node on multiplelevels. By default, you can expand 2 levels, 3 levels, and to maximum. The availability and the maximumexpansion depth depends on the widget settings. The expansion depth is based on the node on whichthe function was executed. Multiple selection is possible. For specific widgets, it is possible that certainnodes are not expanded even though the maximum expansion depth has not yet been reached (forexample, in recursions).

2.4.1.2.1 Adjustment of Columns

Column width as well as order can be directly changed on the screen.

Change column width

Click, hold and move the separator between two columns. The changes will affect the left columns.

Change column order

Click, hold and move the column title to move the column.

The first (hierarchic) column cannot be moved.

Show/hide columns

With context menu option Change layout on the column title columns the visibility and the sort order canbe changed individually.

Optimize column width

With context menu function Optimize column width, all columns will be adjusted so title as well ascontext can be read completely.


ProDocument


2.4.1.2.2 Sort Options

The content of single columns can be sorted ascending or descending. A single click into the columntitle will initiate the sort function. A second click will reverse the sort order.

Icon and , left from the column title, are indicating, which columns are currently sorted. The sortorder can also be configured via Context Menu Functions . Functions are also provided to remove thesorting of one specific column or to reset all table sortings.

Sort options are only available in widgets, when sorting is useful.

For some widgets a specific sort order is pre-set and not to be changed, in order to guaranteeconsistent display of the data. In widget Folder the folders will always be listed before thedocuments. Sorting is therefore limited to the object types.

Sorting multiple columns

With context menu Change layout on the column title, the sort criteria can be change for multiplecolumns, too.

2.4.1.2.3 Filter Options

With filters the data display can be restricted. As some columns show different object, also the filter maybe separated into different object types. This way it is possible to filter a column only on one specificobject type.

Example: A widget shows folders and documents in column Type. The filter definition will not provide filterType but filter Document type and Folder type. This way it is possible to view documents filtered by theirdocument type, without hiding the folders.

Filter my lead to inconsistent display states in widgets. Therefore filter options are not availablein all widgets.

It is not possible to filter all columns.

Filters can be maintained by two ways.

Quickfilter

Filter criteria are depending on possible values in a column. One criteria can be selected and the columnwill be filtered accordingly. Quickfilter are not available for all columns. If a columns is multiply used, asub menu with a selection of filter criteria appears, and the relevant criteria can be selected.

18


ProDocument


Enhanced filters

Context menu option Change filter starts a filter dialogue. Filters are defined in two steps:

1. Define the filter criteria (Move columns from the left to the right side)

2. Determine values for the filter criteria

2.4.1.2.4 Layout Management

Individually adjusted and defined layouts can be safe for later use, change or set as initial layout. Besidesvisibility and sequence of columns, also the sort order and filter criteria can be saved. Change layoutsremain within the application until the application is closed. If the layout is not saved before exit, the lastsaved layout state will be loaded on restart.


ProDocument


Save layout

With context menu function Save layout as... the new layout configuration can be saved. If a saved layoutloaded used, function Save layout can be used. The new layout will replace the old version.

Within the save-dialogue the layout can be saved as private user layout or as global layout. The name fora global layout must start with a "/".

Management of global layouts and/or the settings of global default layouts require authorizationfor activity 23 of authorization object 23.

If a global layout is being loaded, used and changed, however the user has no adequateauthorization, context menu function Save layout will not be available.

Select layout

Any existing layout can be loaded directly with context menu function Select layout. In a sub menu allavailable layout will be listed for selection.

Manage layouts

Function Manage layouts... allows managing private and global layouts, depending on the authorizations.Layouts can be deleted or set as default layouts. The global layout will be set as default layout for allusers without private layouts.

2.4.1.3 Form Widget

A form widget shows data in a form, editing of data may be possible.

Example: Widget Navigation

These general functions are provided. However it depends on the widget, whether the functions are active.

Save/Reset form state

Some widgets allow saving the state of the expanded container blocks. When saved, the blocks will bedisplayed again in their expanded state on restart.

2.4.1.4 List Display

List displays are displaying data in columns and rows and is based on SAP standard list viewer.However, this display type is not used in current ProNovia applications, therefore it is not furtherdescribed, additional information can be found in SAP standard documentation.

2.4.2 Adjustment of Widgets

The graphic representation of single screen sections, including their content as well as the representationof the data can be adjusted and managed individually. The options available are depending on the widgettype. For example, if a widget is moved from the right to the left screen section, the display of objectsand data will be transferred identically.

Objects

Any standard SAP objects can be integrated into the ProFramework. Each object provides differentfunctions in the various widgets, they can be used via context menu or drag & drop actions. The availableobjects, tabs and functions can be configured via settings and enhancements.

20


ProDocument


2.4.3 Operation

2.4.3.1 Application Functions

All functions, which are provided in the application function bar and widgets are explained in detail inchapter Global Application Functions .

2.4.3.2 Title Functions

Depending on the widget, special title functions are available in the title bar of the widget.

Pushbutton

Description

Minimize widget. Display of title line only.

Maximize widget. Widget uses entire available space.

Back to normal state. Available only if widget is minimized or maximized.

Activate filter. The document display is restricted acc. to customizing settings.

Deactivate filter.

Refresh widget data.

Lock date/display. Widget content will not be changed, when changes in other widgetswould cause changes.

Release content.

Expand all nodes. The function may be limited to a number of levels because of possiblerecursion or huge data amount.

Collapses all nodes.

Open sub menu with several functions.

2.4.3.3 Context Menu Functions

To start the context menu place the mouse cursor on an object and click the right mouse button.

For multiple selection see Multiple Selection .

Example:

· Function Add to selection adds objects to an object list. This function is possible for all object types,therefore this function will always be available.

· Function Delete originals is only available, if only originals have been selected. This function is providedas soon as one original can be deleted.

· Function Status change can only be executed, if only objects of the same type have been selectedand if they have at least one identical successor status.

10

19


ProDocument


2.4.3.4 Drag & Drop

Objects and structures which are supported by ProFramework can be moved from one widget to anotherusing drag & drop. This can initiate various actions, such as the creation of a new document info record,creation and assignment of a new document original to an existing document info record, etc.

Drag & drop is supported on single objects or multiple objects. For multiple selection see MultipleSelection . However the target widget must accept all object types.

As soon as any object has been grabbed by the mouse, the cursor icon changes, depending whether theelement supports the drop-function. The simultaneous use of Ctrl-key changes into the copy mode,which is indicated by the icon used.

Drag & drop action is possible. The object can be moved.

Drag & drop action is possible. The plus symbol stands for a copy-process.

Dropping is not possible.

Which mode is possible depends on the source as well as the target widget. If only move mode ispossible, pressing the Ctrl-key has no influence. If only the copy mode is possible, the specific icon willindicate it without pressing the Ctrl-key.

2.4.3.5 Multiple Selection

In tree-widgets and hierarchic lists multiple selection is possible. After the selection, common contextmenu functions can be used or drag & drop actions can be started.

To select multiple objects press the Ctrl-key when clicking on the objects to select. Or click on the firstobject and then press Shift-key and click on the last object to select a block of objects. Multipleselection is only possible on objects within one widget.

2.4.3.6 Single/Double Click

In general one cursor click on any object or function in a tree-widget or hierarchic list starts a contextdependent reaction.

If option

· Single-click is active, the context will be underlined, as soon as the mouse cursor hovers the element.

· Single-click is inactive, one click selects the object (cell or line), the double-click starts the actions.

Which contents provide the single-click option cannot be controlled and depends on the widget. However,in the user settings the single-click can be deactivated generally. This way, drag & drop actions can behandled easier (see Behaviour ).

19

11

Widgets

ProDocument


3 Widgets

3.1 Navigation

In widget Navigation the user can navigate between different objects and object types. A dropdown menulists all available objects, depending on the application and the customizing settings. The search key isautomatically changed according to the selected object. If the key is changed, also the object will bechanged after pressing Enter.

Title Functions

PushButton

Description

Adds current object to widget Object Selection .

For further title function see also Title Functions and Global Application Functions .

21

18 10

Widgets

ProDocument


3.2 Object Selection

In Widget Object selection objects can be selected, displayed and saved in a list. Objects can be added

· by drag & drop

· via context menu function Add to selection

· with title function Search , which opens a search dialogue for the currently used object type.

· Via menu in widget Navigation

These selection lists can be

· saved, loaded or deleted

· kept personal or used also by other users

· sent by SAP mail

· built from files or MSC selection

Title Functions

Special Title Functions

PushButton

Description

Start search dialogue for currently selected object.

Opens submenu with various document functions.

Function Description

Delete list All objects will be deleted directly from the list without furtherconfirmation. Afterwards the selection list will appear empty. Thisfunction only deletes the displayed section part (objects or folders).

This function does not delete saved selection lists.

20

Widgets

ProDocument


Load selection Depending on the last loaded selection and the changes, theoptions below will be provided. Depending on the chosen option oneof the selections will be loaded.

· Option Load last automatically saved selection…: The lastautomatically saved selection will be loaded unchanged.

· Option Object selection <Name>: Opens last selection savenand currently changed selection.

· Option Load selection…: The selection list to be loaded can bechosen from a list.

· Option Get selection from file…: Allows loading a selection ofobjects, where the object keys are saved in a text files. SeeCreate a selection with a text file .

· Option Import MSC material / document selection…: This optionallows importing and displaying objects, which are saved in aMSC selection. Only available if MSC is installed.

Save selection Depending on the last loaded selection and the changes made onit, following options will be provided:

· Save the current selection, which will also be savedautomatically when exiting ProFramework (only if changes havebeen made).

· Overwrite the last loaded selection with the current selection(only if an own selection was loaded and changed).

· Save to a selection which can be chosen or defined.

Notes:

It is possible to save personal or general selection lists:

· Personal selection lists can be loaded, updated or deleted by theoriginator.

· General selection lists can be loaded by all users (except if noauthority by authority group). Deleting and changing is onlypossible for the originator.

A selection list is uniquely identified by its description and type.

A selection list can also be assigned to a laboratory/office or itsuse can be restricted by an authorization group. In order to set acertain authorization group special authorizations must beavailable, too.

· Save selection in a file with internal format for later import.

· Save selection in a file with external format (select separatoretc.)

21

Widgets

ProDocument


Delete selection A selection list can be selected for deletion. After a confirmationthe selection list will be deleted. Only personal lists can bedeleted, except special authorizations are available.

Maintain selectiontypes

Calls maintenance dialog for selection list types. Requires specialauthorization.

Create selection via file

If a selection list shall be generated using a text file, the content must follow the format as describedbelow.

General Configuration

[<SAP Object type 1>]

<Object key 1>

<Object key 2>

...

<Object key n>

[<SAP Object type n>]

...

If no object type is defined ahead of the first object, the objects will be checked according to the currentobject of the ProNovia SAP DocumentManagementClient user interface.

The table lists all supported SAP object types. As a separator (</>) for keys with several parts, thefollowing strings are allowed: „;“ (semicolon), „/“ or tab.

Widgets

ProDocument


3.3 Change Documents

The Change Documents widget displays the SAP change documents for the current object, grouped bytable/area. Functionalities for filtering, sorting and searching are available.

3.4 Baslining

Two widgets are provided for baselining with the product ProBaseline:

· Widget Selection

· Widget Tree output

For details, refer to the ProBaseline, User Manual.