Kernel::System::ITSMChange::Template - template lib
All functions for templates in ITSMChangeManagement.
new()
create an object
use Kernel::Config;
use Kernel::System::Encode;
use Kernel::System::Log;
use Kernel::System::DB;
use Kernel::System::Main;
use Kernel::System::Time;
use Kernel::System::ITSMChange::Template;
my $ConfigObject = Kernel::Config->new();
my $EncodeObject = Kernel::System::Encode->new(
ConfigObject => $ConfigObject,
);
my $LogObject = Kernel::System::Log->new(
ConfigObject => $ConfigObject,
EncodeObject => $EncodeObject,
);
my $MainObject = Kernel::System::Main->new(
ConfigObject => $ConfigObject,
EncodeObject => $EncodeObject,
LogObject => $LogObject,
);
my $TimeObject = Kernel::System::Time->new(
ConfigObject => $ConfigObject,
LogObject => $LogObject,
);
my $DBObject = Kernel::System::DB->new(
ConfigObject => $ConfigObject,
EncodeObject => $EncodeObject,
LogObject => $LogObject,
MainObject => $MainObject,
);
my $TemplateObject = Kernel::System::ITSMChange::Template->new(
ConfigObject => $ConfigObject,
EncodeObject => $EncodeObject,
LogObject => $LogObject,
DBObject => $DBObject,
TimeObject => $TimeObject,
MainObject => $MainObject,
);
TemplateAdd()
Add a new template.
my $TemplateID = $TemplateObject->TemplateAdd(
Name => 'The template name',
Content => '[{ ChangeAdd => { ... } }]', # a serialized change, workorder, ...
Comment => 'A comment', # (optional)
TemplateType => 'ITSMChange', # alternatively: TemplateTypeID
TemplateTypeID => 1, # alternatively: TemplateType
ValidID => 1,
UserID => 1,
);
TemplateUpdate()
Update a template.
my $Success = $TemplateObject->TemplateUpdate(
TemplateID => 1234,
Name => 'The template name', # (optional)
Comment => 'A comment', # (optional)
Content => '[{ ChangeAdd => { ... } }]', # (optional) a serialized change, workorder, ...
ValidID => 1, # (optional)
TypeID => 1, # (optional)
UserID => 1,
);
TemplateGet()
Returns a hash reference of the template data for a given TemplateID.
my $TemplateData = $TemplateObject->TemplateGet(
TemplateID => 123,
UserID => 1,
);
The returned hash reference contains following elements:
$TemplateData{TemplateID}
$TemplateData{Name}
$TemplateData{Comment}
$TemplateData{Content}
$TemplateData{TypeID}
$TemplateData{Type}
$TemplateData{ValidID}
$TemplateData{CreateTime}
$TemplateData{CreateBy}
$TemplateData{ChangeTime}
$TemplateData{ChangeBy}
TemplateList()
return a hashref of all templates
my $Templates = $TemplateObject->TemplateList(
Valid => 0, # (optional) default 1 (0|1)
CommentLength => 15, # (optional) default 0
TemplateType => 'ITSMChange' # (optional) or TemplateType
TemplateTypeID => 1, # (optional) or TemplateTypeID
UserID => 1,
);
returns
$Templates = {
1 => 'my template',
3 => 'your template name',
};
If parameter CommentLength is passed, an excerpt (of the passed length)
of the comment is appended to the template name.
If the parameter TemplateType or TemplateTypeID is passed, then the
list of templates is restricted to the given type.
TemplateSearch()
Returns either a list, as an arrayref, or a count of found template ids.
The count of results is returned when the parameter Result = 'COUNT'> is passed.
The search criteria are logically AND connected. When a list is passed as criterium, the individual members are OR connected. When an undef or a reference to an empty array is passed, then the search criterium is ignored.
my $TemplateIDsRef = $TemplateObject->TemplateSearch(
Name => 'Sample template', # (optional)
Comment => 'just an example', # (optional)
TemplateTypeIDs => [ 11, 12 ], # (optional)
TemplateTypes => [ 'ITSMChange', 'CAB' ], # (optional)
CreateBy => [ 5, 2, 3 ], # (optional)
ChangeBy => [ 3, 2, 1 ], # (optional)
# templates with created time after ...
CreateTimeNewerDate => '2006-01-09 00:00:01', # (optional)
# templates with created time before then ....
CreateTimeOlderDate => '2006-01-19 23:59:59', # (optional)
# templates with changed time after ...
ChangeTimeNewerDate => '2006-01-09 00:00:01', # (optional)
# templates with changed time before then ....
ChangeTimeOlderDate => '2006-01-19 23:59:59', # (optional)
OrderBy => [ 'TemplateID', 'Name' ], # (optional)
# ignored when the result type is 'COUNT'
# default: [ 'TemplateID' ],
# (TemplateID, Name, Comment, TemplateTypeID,
# CreateTime, CreateBy, ChangeTime, ChangeBy)
# Additional information for OrderBy:
# The OrderByDirection can be specified for each OrderBy attribute.
# The pairing is made by the array indices.
OrderByDirection => [ 'Down', 'Up' ], # (optional)
# ignored when the result type is 'COUNT'
# default: [ 'Down' ]
# (Down | Up)
UsingWildcards => 1, # (optional)
# (0 | 1) default 1
Result => 'ARRAY' || 'COUNT', # (optional)
# default: ARRAY, returns an array of template ids
# COUNT returns a scalar with the number of found templates
Limit => 100, # (optional)
# ignored when the result type is 'COUNT'
UserID => 1,
);
TemplateDelete()
Delete a template.
my $Success = $TemplateObject->TemplateDelete(
TemplateID => 123,
UserID => 1,
);
TemplateTypeLookup()
Return the template type id when the template type name is passed. Return the template type name when the template type id is passed. When no template type id or template type name is found, then the undefined value is returned.
my $TypeID = $TemplateObject->TemplateTypeLookup(
TemplateType => 'my template type name',
);
my $TxpeName = $TemplateObject->TemplateTypeLookup(
TemplateTypeID => 42,
);
TemplateSerialize()
This method is in fact a dispatcher for different template types. Currently ITSMChangeManagement supports these template types:
ITSMChange ITSMWorkOrder CAB ITSMCondition
The method returns a datastructure, serialized with Data::Dumper.
my $ChangeTemplate = $TemplateObject->TemplateSerialize(
TemplateType => 'ITSMChange',
StateReset => 1, # (optional) reset to default state
UserID => 1,
# other options needed depending on the template type
ChangeID => 123,
);
TemplateDeSerialize()
This method deserializes the template content. It returns the
ID of the main
element that was created based on the template.
my $ElementID = $TemplateObject->TemplateDeSerialize(
TemplateID => 123,
UserID => 1,
);
This software is part of the OTRS project (http://otrs.org/).
This software comes with ABSOLUTELY NO WARRANTY. For details, see the enclosed file COPYING for license information (AGPL). If you did not receive this file, see http://www.gnu.org/licenses/agpl.txt.