Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

This element is used to display a text box used for search on the page.

...

NameDescriptionValue
id

Unique Identifier

Any
nameA name that describes the search textbox.Any
visiblemodesThe modes the search textbox should be visible.A comma-separated list of the modes read / new / edit
visibilityconditionsThe conditions that should be met in order to display the search textbox.'[[pagefunction, datatype, datapath ]]' operator(==,!=) 'value'
readonlyIf is true then  search textbox cannot change value.true,false
readonlyconditions

The conditions that should be met in order to display

the text box in read only mode.

'[[pagefunction, datatype, datapath ]]'
datapathThe data path field nameNeeds to correspond to the CRMDO object field.
datatypeThe type of datapath fieldalias,java.lang.Integer, java.lang.String,...
refreshThe page parts that should be refreshed when the search textbox change.

page

mainmenu

main

details

tab,tabID

component,is_on_tab:is_on_menu:tabID:componentID

element,is_on_tab:is_on_menu:tabid:componentID:elementID

section,sectionID

area,areaID

valueThe value to show'[[pagefunction, datatype, datapath ]]'
disabletimerIf its true then quick search starts when the user press 'enter'true, false
modalrefIf no modal is specify in Search Textbox then modalref is mandatory

modal name, component id

example: <modalref>AccountQuickSearch,false:false:null:toAccount</modalref>

modalthe modal to start searchingas specify in modal
dataformattingSpecific formatting of data
MINIMUMDIGITS:6
To define the minimum number of digits for the quick search:

SEARCHSTARTMSEC:500 
To define the time in milliseconds between the last key pressed
and the start of the quick search. A value between 500 and 10000 is allowed.
  This value is available also in MPSETTINGS to overwrite the default of 2000 msec.
urlif url is specify the text in read mode is a linkAny

Example

...

Expand

...

title

...

Search Textbox

...

Image Added

...

Code Block

...

theme

...

Eclipse

...

codetrue
language
xml
titleSearch Textbox
linenumbers
<searchtextbox>
    <id>slbWriteOffAccount</id>
    <value>[[getValue,java.lang.String,writeOffAccount/name]]</value>
    <modal>
        <id>mdlWriteOffAccount</id>
        <type>quicksearch</type>
        <refresh>page</refresh>
        <datasetname>accounts.loadsystemaccounts</datasetname>
        <datasetreturnhiddenfield>ACCRECID</datasetreturnhiddenfield>
        <datasetsearchtable>ACCOUNTSRECEIVABLE</datasetsearchtable>
        <datasetsearchfield>ACCRECNUM;ACCRECNAME</datasetsearchfield>
        <assignments>
            <assignment>
                <classname>com.crm.dataobject.accounts.CRMDOAccountReceivable</classname>
                <datapath>writeOffAccount</datapath>
                <value>id</value>
                <datatype>load</datatype>
            </assignment>
        </assignments>
    </modal>
</searchtextbox>

...

Expand

...

titleSearch Textbox

...

Image Removed

 

code with disable timertrue
With Disable Timer

Image Added

Code Block
themeEclipse
languagexml
titleSearch Textbox
linenumbers
With Disable Timer
<searchtextbox>
    <id>stbFirstName</id>
    <datapath>searchBy</datapath>
    <datatype>alias</datatype>
    <visibilityconditions>'[[getValue,java.lang.String,searchByOption]]'=='FIRST_NAME'</visibilityconditions>
    <disabletimer>true</disabletimer>
    <modal>
        <id>mdlFirstName</id>
        <type>quicksearch</type>
        <refresh>page</refresh>
        <datasetname>contactinfo.load</datasetname>
        <datasetreturnhiddenfield>CIID</datasetreturnhiddenfield>
        <datasetsearchtable>CONTACTINFORMATION</datasetsearchtable>
        <datasetsearchfield>CIFIRSTNAME;NAME;CIIDNUM;CISOCIALSECNUM;LIFECYCLESTATE</datasetsearchfield>
        <filter> (
        UPPER(CONTACTINFORMATION.CIFIRSTNAME) [[getValue,java.lang.String,searchByOperator]] 
        UPPER(concat('[[getAlias,java.lang.String,searchBy]]', 
        CASE 
            WHEN '[[getValue,java.lang.String,searchByOperator]]' = 'LIKE' 
            THEN '%' 
            ELSE '' 
        END)))
        </filter>
        <assignments>
            <assignment>
                <datapath>modal</datapath>
                <datatype>alias</datatype>
            </assignment>
        </assignments>
        <onclosefunction>
            <functions>
                <function>
                    <type>ejb</type>
                    <classname>ejb/CRMUICommunicationCentre</classname>
                    <functionname>readFromSearchBy</functionname>
                    <resultaction>replace</resultaction>
                    <datatype>root</datatype>
                    <parameters>
                        <parameter>
                            <value>[[getDTO]]</value>
                            <datatype>java.lang.Object</datatype>
                        </parameter>
                        <parameter>
                            <value>[[getValue,java.lang.String,searchByOption]]</value>
                            <datatype>java.lang.String</datatype>
                        </parameter>
                        <parameter>
                            <value>[[getAlias,java.lang.String,modal]]</value>
                            <datatype>java.lang.String</datatype>
                        </parameter>
                    </parameters>
                </function>
            </functions>
        </onclosefunction>
    </modal>
</searchtextbox>

 

...