Effector 6.3 developer manual

XML reference 6.3

Effector Studio 6.3 summary

Effector Studio 6.3 manual

Effector 6.2 developer manual

XML reference 6.0

Effector Studio 3.2 summary

Effector Studio 3.2 manual

Profile

Contains the list of available menu items. The default screen and the quick links can also be defined here. Typically, there is only one of it that can be found in the Profile directory of the XML package.

/Profile

Root element. Mandatory.

Example

<?xml version="1.0" encoding="utf-8"?>
<Profile xmlns="http://effector.hu/schema/ns/Profile">
    <DefaultScreen type="Constant" return="string" default="">MMExample/ScreenCompanies</DefaultScreen>
    <Menu>
        <Item>
            <Caption>Example</Caption>
            <ResourceName>MMExample</ResourceName>
            <Visible type="SQL" return="Boolean" default="false">
                <![CDATA[SELECT dbo.[ofn_FSYS_LHC_GetMenuVisibility] ('MMExample', '', '[##Session.UserID##]')]]>
            </Visible>
        </Item>
        <Item>
            <Caption>ReleaseTest</Caption>
            <ResourceName>MMReleaseTest</ResourceName>
            <Visible type="SQL" return="Boolean" default="false">
                <![CDATA[SELECT dbo.[ofn_FSYS_LHC_GetMenuVisibility] ('MMReleaseTest', '', '[##Session.UserID##]')]]>
            </Visible>
        </Item>
        <Item>
            <Icon>efi-m-licenc</Icon>
            <Caption>Licence manager (client)</Caption>
            <ResourceName>MMLicenseHandler</ResourceName>
            <Visible type="SQL" return="Boolean" default="false">
                <![CDATA[ SELECT dbo.[ofn_FSYS_LHC_GetMenuVisibility] ('MMLicenseHandler', NULL, '[##Session.UserID##]')]]>
            </Visible>
        </Item>
    </Menu>
    <LoadHomeViewAfterLogin>true</LoadHomeViewAfterLogin>
</Profile>

/Profile/DefaultScreen (RuleValueType)

Mandatory. We store the initial view in this tag, that needs to be given in the following format: MMName/ScreenName.

Example <DefaultScreen type="Constant" return="string" default="">MMExample/ScreenCompanies<DefaultScreen>

/Profile/MenuType (Enumeration)

Optional. Default: Top

In desktop view this serves to set whether a top or side menu should appear.

Its possible values:

- `Compact`
- `Side`
- `Top`

Example <MenuType>Top</MenuType>

/Profile/Menu

Collection. The list of menu items belonging to the Profile.

Example

<Menu>
    <Item>
        <Icon>efi-m-licenc</Icon>
        <Caption>Example</Caption>
        <CssClass></CssClass>
        <ResourceName>MMExample</ResourceName>
        <Visible type="SQL" return="boolean" default="false">true</Visible>
    </Item>
</Menu>

/Profile/Menu/Item

An element of the collection. The node describing a given menu item element.

/Profile/Menu/Item/Icon (String)

Optional. The name of the CSS class belonging to the menu item.

/Profile/Menu/Item/ResourceName (String)

Mandatory. Its value is the name of the file of the menu item without the .xml extension.

/Profile/Menu/Item/Caption (String)

Mandatory. Its value is the menu item's name to be displayed.

/Profile/Menu/Item/CssClass (String)

Optional. The name of the CSS class of the formatting that applies to the menu item.

/Profile/Menu/Item/Visible (RuleValueType)

Optional. It is used to set the visibility of the menu item.

Example

<Visible type="SQL" return="boolean" default="false">
    <![CDATA[SELECT dbo.[ofn_FSYS_LHC_GetMenuVisibility] ('', '', '[##Session.UserID##]')]]>
</Visible>

/Profile/QuickLaunch

Optinal.

Collection. It defines fixed menu items in the drop-down list.

Example

Password change ScreenNewUser MMbasedata true ID Out Profile change ScreenIDEPeopleEdit MMIDE true People_ID Out SELECT '[##Session.UserID##]' JumpType Param SELECT 'NoAction'

/Profile/QuickLaunch/Item

An element of the collection. The node describing a given QuickLaunch element.

Attributes:

  • id - needs to be unique in the whole XML. Mandatory attribute!

/Profile/QuickLaunch/Item/Caption (String)

Its content will be the caption of the menu item.

/Profile/QuickLaunch/Item/ReferencedMinorMenu (String)

The name of the menu item that contains the screen to be opened.

/Profile/QuickLaunch/Item/Screen (String)

The name of the screen to be opened.

/Profile/QuickLaunch/Item/Visible (RuleValueType)

Opcional. Visibility of items can be ruled.

Example

<Visible type="SQL" return="boolean" default="false">true</Visible>

/Profile/QuickLaunch/Item/Filters

Collection. The definitions of the filters that are needed to open the screen.

/Profile/QuickLaunch/Item/Filters/Filter

An element of the collection. The definition of a given filter.

/Profile/QuickLaunch/Item/Filters/Filter/Name (String)

Name identifying the filter.

/Profile/QuickLaunch/Item/Filters/Filter/Type (String)

The type of the filter. (Usually Out or Param.)

/Profile/QuickLaunch/Item/Filters/Filter/Value (RuleValueType)

The value of the filter.

/Profile/IsSkinSwitchingEnabled (Boolean)

Optional. It defined whether changing the skin is allowed. Its default is true.

Example

<IsSkinSwitchingEnabled>false</IsSkinSwitchingEnabled>

/Profile/ShowMenuIcons (Boolean)

Optional. Are the icons visible in the menu? Default: false

/Profile/LoadHomeViewAfterLogin (Boolean)

Optional. It defines whether the screen set under Home should be loaded. Its default is false.

/Profile/CustomLogoUrl (String)

Optional. The path of a file containing a unique logo.

Example

<CustomLogoUrl>ui/gfx/custom_logo.png</CustomLogoUrl>

/Profile/IsNotificationEnabled (Boolean)

Optional. It enables the notification system. Its default is false.

/Profile/NotificationScreen (String)

Optional. It can be used to define a screen to display when clicking on the notification icon.

/Profile/IsChangeUserProfileEnabled (Boolean)

Optional. It enables the changeability of the user profile. Its default is true.

/Profile/IsUserDefinedMenuEnabled (Boolean)

Optional. It defines whether the menu layout can be changed in the user profile. Its default is false.

  • Last update: 2 weeks 4 days ago
  • Effector