NAME
Kernel::System::GenericAgent – to manage the generic agent jobs
DESCRIPTION
All functions to manage the generic agent and the generic agent jobs.
PUBLIC INTERFACE
new()
Don't use the constructor directly, use the ObjectManager instead:
my $GenericAgentObject = $Kernel::OM->Get('Kernel::System::GenericAgent');
JobRun()
run a generic agent job
$GenericAgentObject->JobRun(
Job => 'JobName',
OnlyTicketID => 123, # (optional) for event based Job execution
SleepTime => 100_000 # (optional) sleeptime per ticket in microseconds
UserID => 1,
);
JobList()
returns a hash of jobs
my %List = $GenericAgentObject->JobList();
JobGet()
returns a hash of the job data
my %Job = $GenericAgentObject->JobGet(Name => 'JobName');
JobAdd()
adds a new job to the database
$GenericAgentObject->JobAdd(
Name => 'JobName',
Data => {
Queue => 'SomeQueue',
...
Valid => 1,
},
UserID => 123,
);
JobDelete()
deletes a job from the database
my $Success = $GenericAgentObject->JobDelete(
Name => 'JobName',
UserID => 123,
);
returns:
$Success = 1; # or false in case of a failure
JobUpdate()
update a job
$GenericAgentObject->JobUpdate(
Name => 'JobName',
OldName => 'JobName'
Data => {
Queue => 'SomeQueue',
...
Valid => 1,
},
UserID => 123,
);
JobEventList()
returns a hash of events for each job
my %List = $GenericAgentObject->JobEventList();