OTRS 8.0 API Reference Perl

Description manuals and libraries
OTRS 8.0 API Reference Perl > Perl Modules > Kernel::System::ProcessManagement::Modules::KBADataPull

NAME

Kernel::System::ProcessManagement::Modules::KBADataPull - A module to fetch data from a linked KBA.

DESCRIPTION

All KBADataPull functions.

PUBLIC INTERFACE

new()

Don't use the constructor directly, use the ObjectManager instead:

    my $KBADataPullObject = $Kernel::OM->Get('Kernel::System::ProcessManagement::Modules::KBADataPull');

Run()

    Run Data

    my $Success = $KBADataPullObject->Run(
        UserID                          => 123,
        Ticket                          => \%Ticket,  # required
        ProcessEntityID                 => 'P123',
        ActivityEntityID                => 'A123',
        SequenceFlowEntityID            => 'T123',
        SequenceFlowActionEntityID      => 'TA123',
        Config => {

            ConfigSearchKeyValueList {

                ItemID => '4',                                           # (optional)
                ItemID => '4,5,6'                                        # (optional)

                ExcludeItemID => '4',                                    # (optional)
                ExcludeItemID => '4,5,6',                                # (optional)

                Number    => '*134*',                                    # (optional)
                Title     => '*some title*',                             # (optional)

                # is searching in Number, Title, Keyword and Field1-6
                What      => '*some text*',                              # (optional)

                Keyword   => '*webserver*',                              # (optional)
                States    => '1=internal'                                # (optional)
                States    => '1=internal,2=external'                     # (optional)
                LanguageIDs => '4,5,6',                                  # (optional)
                CategoryIDs => '7,8,9',                                  # (optional)
                ValidIDs    => '1,2,3',                                  # (optional) (default 1)

                Approved    => 1,                                        # (optional) 1 or 0,

                # Votes (optional)
                Votes => 'Equals=123',
                Votes => 'GreaterThan=123',
                Votes => 'GreaterThanEquals=123',
                Votes => 'SmallerThan=123',
                Votes => 'SmallerThanEquals=123',

                # Rate (optional).
                Rate => 'Equals=75',
                Rate => 'GreaterThan=75',
                Rate => 'GreaterThanEquals=75',
                Rate => 'SmallerThan=75',
                Rate => 'SmallerThanEquals=75',

                # create FAQ item properties (optional)
                CreatedUserIDs => '1,12,455,32'

                # change FAQ item properties (optional)
                LastChangedUse

                # DynamicFields (optional) as single or comma separated values.
                DynamicField_FieldNameB => 'Equals=123,456',
                DynamicField_FieldNameC => 'Like=value*',
                DynamicField_FieldNameD => 'GreaterThan=2001-01-01 01:01:01',
                DynamicField_FieldNameE => 'GreaterThanEquals=2001-01-01 01:01:01',
                DynamicField_FieldNameF => 'SmallerThan=2002-02-02 02:02:02',
                DynamicField_FieldNameG => 'SmallerThanEquals=2002-02-02 02:02:02',

                # FAQ items created more than 60 minutes ago (item older than 60 minutes)  (optional)
                ItemCreateTimeOlderMinutes => 60,
                # FAQ item created less than 120 minutes ago (item newer than 120 minutes) (optional)
                ItemCreateTimeNewerMinutes => 120,

                # FAQ items with create time after ... (item newer than this date) (optional)
                ItemCreateTimeNewerDate => '2006-01-09 00:00:01',
                # FAQ items with created time before ... (item older than this date) (optional)
                ItemCreateTimeOlderDate => '2006-01-19 23:59:59',

                # FAQ items changed more than 60 minutes ago (optional)
                ItemChangeTimeOlderMinutes => 60,
                # FAQ items changed less than 120 minutes ago (optional)
                ItemChangeTimeNewerMinutes => 120,

                # FAQ item with changed time after ... (item changed newer than this date) (optional)
                ItemChangeTimeNewerDate => '2006-01-09 00:00:01',
                # FAQ item with changed time before ... (item changed older than this date) (optional)
                ItemChangeTimeOlderDate => '2006-01-19 23:59:59',

                # LinkType (Optional)
                # LinkType => 'ParentChild=Target'      # 'ParentChild=Source', 'Normal=Target', etc.
            }

            ConfigDropdown => {
                Behavior => 'NoCopy',       #  'NoCopy', 'CopyFirstLinked' or 'CopyLastLinked' only
            },

            UserID => 123,     # optional,to override the UserID from the logged user

            # Value set:
            #   * Key is the attribute of the process ticket where the data will be set
            #   * Value is the value to be set, supporting smart tags <OTRS_KBA_*> from the resulting linked KBA
            #     after match and behavior filters
            #
            #   Example:
            #   * To set process ticket title to be exactly the linked KBA category:
            #     Title => '<OTRS_KBA_Category>',
            #   * To set the process ticket dynamic field NameX to an static value (not real pull):
            #     DynamicField_NameX => 'someValue',
        }
    );

    - `Ticket` contains the result of TicketGet including DynamicFields.