General

Description

The General tab enables configuring the basic properties of a FlexPart.

Settings

Field Description
Short Name/Name/Description The localizable names and description of the FlexPart. These fields are used, for example, to represent the FlexPart within the hosting application (for more information, refer to the User Interface Overview topic in the DELMIA Apriso Desktop Client Help).
Type Enables to choose the following FlexPart types:
  • Dashboard
  • FlexView
  • M&M Screen (Monitoring and Maintenance Screen)
  • Operation
  • Report
  • Screen
  • Offline Screen
  • Web Dynamic Grid

FlexParts of the FlexView and M&M Screen types cannot be used on mobile devices.

Alias The user-defined alias of the FlexPart (required). The string provided in this field will be used as the distinctive part of an automatically generated URL address for the FlexPart. For example, if the alias provided by the user is "ProductionReport", then the generated URL may take the following form: http://<server name>/Apriso/Portal/UIService.aspx?alias=ProductionReport

Only alphanumeric characters are allowed for creating an alias.

Context Enables linking the FlexPart to a predefined FlexPart context entity. The context is used to group FlexParts for easier identification. The DELMIA Apriso Desktop Client Find a Screen mechanism returns results based on this field as well.
Keywords A localizable space-separated list of keywords that facilitate identification of the FlexPart. The DELMIA Apriso Desktop Client Find a Screen mechanism returns results based on this field as well.
Prefer full screen Tells the application hosting (displaying) it that the FlexPart "prefers" to be displayed taking up the whole available space. It should be used for screens that make up an independent functional parts, containing all necessary navigation e.g. for FlexPart of Screen type (see Process Builder Help for details). Note that it is still up to the host application to respect this preference or not.
Display in Mobile Applications Determines whether the FlexPart should be displayed in mobile applications
URL This read-only field displays an auto-generated link to the FlexPart. The form of the link is dependent on the alias defined by the user (see the Alias option above for details). To use the generated URL, simply paste it in the browser address bar after the server's name. The URL can be transformed into a canonical URL, the form of which will be: http://<server name>/Apriso/Portal/UI/<alias>. A canonical URL can be used in the same form on mobile devices as well.

For FlexParts to be displayed correctly, when logging in to DELMIA Apriso, use the same server address as is set in the "PortalLink" key located in the "Portal" section of the CentralConfiguration.xml file (see Central Configuration Documentation). If the server address in Central Configuration contains the domain name, you should also use the address with the domain name in the browser.

If the Prefer full screen check box is selected and a Screen entity has no custom Header linked, the "&fs=true" element will be added to the URL link and the default Portal Header will appear in runtime.

On Oracle systems, which are case-sensitive, please ensure that the alias in the URL has exactly the same format as that in the FlexPart definition.

Copy to Clipboard button

  • Copies the generated URL address to the clipboard for easier and more convenient usage
Desktop icon/Mobile icon Allows for choosing an icon for the FlexPart that will be displayed on desktop machines/mobile devices (localizable). Press to customize the background color of the icon preview.

Field Only Available for the FlexView Type

Field Description
Portal Tab Enables linking a Portal tab from the list.

Field Only Available for the M&M and Web Dynamic Grid Screen Types

Field Description
Screen Enables linking an M&M screen from the list.

Fields Only Available for the Operation Type

Field Description
Operation code Enables linking an Operation from the list.
Operation Revision Enables choosing a static revision of a linked Operation or allows for selecting its default runtime revision determination.

Fields Only Available for the Report Type

Field Description
Allow report configuration in runtime This option will display the report configuration when running the FlexPart before displaying the actual report.
Configure report here (view-only in runtime) Enables the below report configuration options. In runtime the report itself will be displayed based on these settings.
Report Enables linking a report from a list.
Report format The FlexPart report can be displayed in many different formats. This drop-down allows the user to choose the desired format from the list.

Fields Only Available for the Screen Type

Field Description
Screen Name Enables linking a Screen from the list.
Screen Revision Enables choosing a static revision of a linked Screen or allows for runtime revision determination.
Runtime Mode
  • Server
  • Client
Determines whether the Screen should be displayed in the Screen Flows server mode or client mode. For details, refer to the Process Builder Help.

Parameters (Operation, Report, and Web Dynamic Grid Type)

This parameters grid is available only for resources with Inputs or parameters set in the grid query. The FlexParts screen allows the user to control the values of the resource Inputs or query parameters. For more information on customizing these parameters, see Parameters.

Field Description
Name The name of the Input or the grid query parameter (only non-system parameters are visible and configurable).
Allow Override Indicates if the Input or parameters can be modified from the level of the browser's address bar by manually adding parameters after the resource's URL.
Type Displays the Input or the grid query parameter data type.
Value Displays the Input or the grid parameter value. The user may customize the value by replacing it with a custom one.

Parameters (Screen Type)

This parameters grid is available only for Screens. It is populated automatically with external parameters that were enabled for the given Screen in the DELMIA Apriso Process Builder. The FlexParts screen allows the user to control the values of the external parameters as well as to add new parameters, which will be used elsewhere in the screen flow initiated from the linked Screen.

The following actions can be performed on the parameters grid:

Icon Action Type Description
Add Used to add a new parameter manually. Clicking this icon opens the Screen Parameter Editor dialog window, where you can specify the name and type of the new parameter.
Remove Available only for the custom parameters, which were added manually to the grid. Used to remove a custom parameter from the grid. Parameters marked as external parameters in Process Builder are populated automatically, and cannot be removed from the grid.
Properties Available only for the custom parameters, which were added manually to the grid. Used to edit or check the properties of the selected parameter. Clicking this icon opens the Screen Parameter Editor dialog window.

 

Field Description
Enable When checked, the value specified in the FlexPart configuration will be used, instead of the value set in DELMIA Apriso Process Builder
Allow override Enabled overriding the parameter value, e.g., via Inputs of the FlexPart Business Control or the URL.
Variable Type Enables choosing between the External and Global variable type (for more information, refer to the Portal Session Variables Handling topic in the Process Builder Online Help).
Name The name of the parameter (only those parameters, which were marked as "External" in DELMIA Apriso Process Builder are visible and configurable.
Type Displays the parameter data type.
Value Displays the parameter value. The user may customize the value by replacing it with a custom one.

Initial Profile

The Initial Profile section is available only for Web Dynamic Grid screen types.

Field Description
Profile drop-down Enables choosing from available system profiles (for more information, refer to the Runtime Profiles topic in the Process Builder Help).
Allow override If selected, it is possible to override the default profile settings (with the use of a URL).

FlexParts also supports the following predefined Parameters:

Field Description
LoginName If the Central Configuration file is configured to allow automatic login (that is, SwipeAuthentication is enabled and the NoPasswordLoginRole key is set with the appropriate role), the LoginName parameter can be added to the FlexPart URL. This will enable logging in without providing credentials. For example: http://<server name>/Apriso/Portal/UI/<alias>?LoginName=JohnSmith. For more information on the Central Configuration settings, refer to the Central Configuration Documentation.
Theme If the theme parameter is provided, it will override the current theme (common for the Portal, login screen, and Function Interpreter), which is defined in the Central Configuration. The correct value of this parameter is the name of the theme folder from \\<server name>\c$\Program Files\Dassault Systemes\DELMIA Apriso 2020\WebSite\Portal\Styles\. For details on themes and appearance, please refer to the Portal Implementation Guide.

For more information on predefined parameters, please refer to the Portal Implementation Guide.