custom print

[gtsak]

Hello!

I want to create a new CUSTOM print template (let's call it print2) and a new button that will call "print2". "print2" will get custom info from the ticket and print them based on the newly created template. What is the proper way to create this new "print2" template and button since i don't want to change the default print functionality.

[RStraub]

You would need two things:

1) A custom (or extended) .xml file in ~otrs/Kernel/Config/Files/ which has a modified entry like the original one found in Ticket.xml:

Code: Select all

    <ConfigItem Name="CustomerFrontend::Module###CustomerTicketPrint" Required="0" Valid="1">
        <Description Translatable="1">Frontend module registration for the customer interface.</Description>
        <Group>Ticket</Group>
        <SubGroup>Frontend::Customer::ModuleRegistration</SubGroup>
        <Setting>
            <FrontendModuleReg>
                <Description Translatable="1">Customer Ticket Print Module.</Description>
                <NavBarName></NavBarName>
                <Title Translatable="1">Print</Title>
            </FrontendModuleReg>
        </Setting>
    </ConfigItem>

2) A modified perl module that gathers all the needed data, like the original one here:
~otrs/Kernel/Modules/CustomerTicketPrint.pm


In that perl module, the "layout" is defined and renders the pdf. You can see some of the "hardcoded" line movement with commands like these:

Code: Select all

        # set new position
        $PDFObject->PositionSet(
            Move => 'relativ',
            Y    => -15,
        );

[gtsak]

Thank you for that but i have 1 more question.
How will i create the button that will call the .xml file for this custom print?

[RStraub]

The .xml will be parsed as soon as otrs rebuilds its sysconfig (easy to do so, when you click on "SysConfig" in the Admin tab).

If written correctly, the new button should appear in the menu module.

[gtsak]

I have created a new entry in Ticket.xml called "Print 2" but there is no button available. We tried to create a new ticket as a customer and there wants a new button... In Frontend:Customer:ModuleRegistration i can see the entry as defined it in the Ticket.xlm file, see attached. (i think i am missing something like link between the new Print and the the menus)

[RStraub]

You are right. I assumed the customer frontend is built similar to the agent one. But the print button is hardcoded.

Take a look here:
https://github.com/OTRS/otrs/blob/maste ... m.pm#L1481

You'd need to copy that block a second time, e.g.:

Code: Select all

    # print option
    if ( $ConfigObject->Get('CustomerFrontend::Module')->{CustomerTicketPrint2} )
    {
        $LayoutObject->Block(
            Name => 'Print2',
            Data => \%Param,
        );
    }

Then add a new block here:
https://github.com/OTRS/otrs/blob/maste ... oom.tt#L34

e.g.:

Code: Select all

[% RenderBlockStart("Print2") %]
                <li>
                    <a href="[% Env("Baselink") %]Action=CustomerTicketPrint2;TicketID=[% Data.TicketID | uri %]" class="Print AsPopup" title="[% Translate("Print") | html %]">
                        <i class="fa fa-print"></i>
                        <span>[% Translate("Print (Custom)") | html %]</span>
                    </a>
                </li>
[% RenderBlockEnd("Print2") %]

Clicking on that new button will redirect you to the CustomerTicketPrint2.pm module where you can modify the layout.

[gtsak]

i also need the print2 button on the agent interface. Same Steps but for the agent files?

[RStraub]

Slightly different from what I see. Take a look into AgentTicketZoom, where you will find this block:

Code: Select all

    # check if print link should be shown
    if (
        $ConfigObject->Get('Frontend::Module')->{AgentTicketPrint}
        && $AclActionLookup{AgentTicketPrint}
        )
    {
        my $OK = $TicketObject->TicketPermission(
            Type     => 'ro',
            TicketID => $Ticket{TicketID},
            UserID   => $Self->{UserID},
            LogNo    => 1,
        );
        if ($OK) {

            push @MenuItems, {
                ItemType    => 'Link',
                Description => Translatable('Print this article'),
                Name        => Translatable('Print'),
                Class       => 'AsPopup PopupType_TicketAction',
                Link =>
                    "Action=AgentTicketPrint;TicketID=$Ticket{TicketID};ArticleID=$Article{ArticleID};ArticleNumber=$Article{Count}"
            };
        }
    }

You could simple copy the last (the push one) block again:

Code: Select all

            push @MenuItems, {
                ItemType    => 'Link',
                Description => Translatable('Print (2) this article'),
                Name        => Translatable('Print (2)'),
                Class       => 'AsPopup PopupType_TicketAction',
                Link =>
                    "Action=AgentTicketPrint2;TicketID=$Ticket{TicketID};ArticleID=$Article{ArticleID};ArticleNumber=$Article{Count}"
            };

Then of course you need a "AgentTicketPrint2.pm and AgentTicketPrint2.tt

[gtsak]

Can you please make a summary with the files i need to change (eg. A -> B -> C. Just the files, not the changes i need to make in the files) ? 1 for the customer interface and 1 for the agent cause i tried all of the above and they are not working which means i am missing something and i think its on the files i need to change manually.

Thanks for your time.

[RStraub]

Where do you fail? On the agent interface or on the customer interface?

Are there errors in the log?

[gtsak]

There are no errors in the log file relevant to the changes i made and none of the changes i made, work. so, if you please, make me a summary cause i am a bit lost (only the files that need changes). Thank you.

[RStraub]

For the customer frontend as described in my previous post you need:

1) Modified "Kernel/Modules/CustomerTicketZoom.pm", where you add this block below the existing "print" block:

Code: Select all

        $LayoutObject->Block(
            Name => 'Print2',
            Data => \%Param,
        );

2) Modified "Kernel/Output/HTML/Templates/Standard/CustomerTicketZoom.tt" where you add this block below the existing "Print" block:

Code: Select all

[% RenderBlockStart("Print2") %]
                <li>
                    <a href="[% Env("Baselink") %]Action=CustomerTicketPrint2;TicketID=[% Data.TicketID | uri %]" class="Print AsPopup" title="[% Translate("Print") | html %]">
                        <i class="fa fa-print"></i>
                        <span>[% Translate("Print2") | html %]</span>
                    </a>
                </li>
[% RenderBlockEnd("Print") %]

3) A copy of "Kernel/Modules/CustomerTicketPrint.pm" which you have to rename (in the file and the filename) to Kernel/Modules/CustomerTicketPrint2.pm

4) Register the CustomerTicketPrint2.pm in a .xml file in Kernel/Config/Files

[gtsak]

and what about the agent interface?

[gtsak]

i made all the changes in the files you told me to change, but it doesn't work. No errors are logged and no buttons are created.

[RStraub]

That is weird, because I tested it on my server and it works there :/

[gtsak]

i think we are missing something important. I dont know where the button is supposed to be.

[gtsak]

I forgot to mention we are using KIX4OTRS module. We tried changing the same files as you mentioned above but KIX4OTRS (KIX4OTRS/Kernel/..) was missing CustomerTicketPrint and thse modules in Ticket.pm. Is there a possibility KIX4OTRS is the problem?

[RStraub]

Oh, that might be. I think KIX adds alot of new templates that "overwrite" the default (or even custom) ones.

[gtsak]

do you know what i need to do if i am using KIX?

[RStraub]

No sorry - don't have KIX. You could check if the files I mentioned are also in the folder KIX4OTRS/[ SamePathStructure ] and change them there.