NAME

Kernel::System::ProcessManagement::Activity – Activities lib

DESCRIPTION

All Process Management Activity functions.

PUBLIC INTERFACE

new()

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

    my $ActivityObject = $Kernel::OM->Get('Kernel::System::ProcessManagement::Activity');

ActivityGet()

    Get Activity info
    Returned activity dialogs are limited to given interface

    my $Activity = $ActivityObject->ActivityGet(
        ActivityEntityID => 'A1',
        Interface        => ['AgentInterface'],   # ['AgentInterface'] or ['ExternalInterface'] or ['AgentInterface', 'ExternalInterface'] or 'all'
    );

    Returns:

    $Activity = {
          Name           => 'Activity 3',
          Type           => 'UserTask', # or 'ScriptTask' or 'ServiceTask'
          CreateTime     => '08-02-2012 13:37:00',
          ChangeBy       => 2,
          ChangeTime     => '09-02-2012 13:37:00',
          CreateBy       => 3,
          ActivityDialog => {
              1 => 'AD5',
              3 => 'AD7',
              2 => 'AD6',
            },
        };

ActivityList()

    Get a list of all Activities

    my $Activities = $ActivityObject->ActivityList();

    Returns:

    $ActivityList = {
        'A1' => 'Activity 1',
        'A2' => 'Activity 2',
        'A3' => '',
    };

ActivityStatusSet()

    Sets current status for non-user activity execution.

    Standard status codes are:
    - '-1' = 'Started'
    -  '0' = 'Finished successfully'
    -  '1' = 'Generic Error'

    Other status codes might be defined and used.

    my $Success = $ActivityObject->ActivityStatusSet(
        TicketID   => 1,
        StatusCode => '-1',
        UserID     => 1,
    );

    Returns:

ActivityStatusGet()

    Gets current status for non-user activity execution.

    my $Status = $ActivityObject->ActivityStatusGet(
        TicketID   => 1,
        UserID     => 1,
    );