Skip to Navigation

4.4. XML Config Options

If you want to add a config option:


<ConfigItem Name="Ticket::Hook" Required="1" Valid="1">
    <Description Lang="en">The identifyer for a ticket. The default is Ticket#.</Description>
    <Description Lang="de">Ticket-Identifikator. Als Standard wird Ticket# verwendet.</Description>
    <Group>Ticket</Group>
    <SubGroup>Core::Ticket</SubGroup>
    <Setting>
        <String Regex="">Ticket#</String>
    </Setting>
</ConfigItem>
        

If "required" is set to "1", the config variable is included and cannot be disabled.

If "valid" is set to "1", the config variable is active. If it is set to "0", the config variable is inactive.

The config variable is defined in the "setting" element.

4.4.1. Types of XML Config Variables

The XML config settings support various types of variables.

4.4.2. String

A config element for numbers and single-line strings. Checking the validity with regex is possible. The check attribute checks elements of the file system. This contains files and directories.


<Setting>
    <String Regex="" Check="File"></String>
</Setting>
            

4.4.3. Textarea

A config element for multiline text.


<Setting>
    <TextArea Regex=""></TextArea>
</Setting>
            

4.4.4. Options

This config element offers preset values as a pull-down menu.


<Setting>
    <Option SelectedID="Key">
        <Item Key=""></Item>
        <Item Key=""></Item>
    </Option>
</Setting>
            

4.4.5. Array

With this config element arrays can be displayed.


<Setting>
    <Array>
        <Item></Item>
        <Item></Item>
    </Array>
</Setting>
            

4.4.6. Hash

With this config element hashes can be displayed.


<Setting>
    <Hash>
        <Item Key=""></Item>
        <Item Key=""></Item>
    </Hash>
</Setting>
            

4.4.7. Hash with SubArray, SubOptions, SubHash

A hash can contain content arrays, hashes or pull-down menus.


<Setting>
    <Hash>
        <Item Key=""></Item>
        <Item Key="">
            <Hash>
                <Item Key=""></Item>
                <Item Key=""></Item>
            </Hash>
        </Item>
        <Item Key="">
            <Array>
                <Item Key=""></Item>
                <Item Key=""></Item>
            </Array>
        </Item>
        <Item Key="">
            <Option SelectedID="Key">
                <Item Key=""></Item>
                <Item Key=""></Item>
            </Hash>
        </Item>
        <Item Key=""></Item>
    </Hash>
</Setting>
            

4.4.8. FrontendModuleReg (NavBar)

Module registration for Agent Interface.


<Setting>
    <FrontendModuleReg>
        <Description>Logout</Description>
        <Title></Title>
        <NavBarName></NavBarName>
        <NavBar>
            <Description>Logout</Description>
            <Name>Logout</Name>
            <Image>exit.png</Image>
            <Link>Action=Logout</Link>
            <NavBar></NavBar>
            <Type></Type>
            <Block>ItemPre</Block>
            <AccessKey>l</AccessKey>
            <Prio>100</Prio>
        </NavBar>
    </FrontendModuleReg>
</Setting>
            

4.4.9. FrontendModuleReg (NavBarModule)

Module registration for Admin Interface


<Setting>
    <FrontendModuleReg>
        <Group>admin</Group>
        <Description>Admin</Description>
        <Title>User</Title>
        <NavBarName>Admin</NavBarName>
        <NavBarModule>
            <Module>Kernel::Output::HTML::NavBarModuleAdmin</Module>
            <Name>Users</Name>
            <Block>Block1</Block>
            <Prio>100</Prio>
        </NavBarModule>
    </FrontendModuleReg>
</Setting>