How to call DocMerge from a Hook ?

nobody did that ??

Hi Frédéric Rinaldi,

I had a quick chat with engineering and they believe you can achieve what you need through DocMergeApi, as for error handling, most (if not all) are coming directly from the DocMerge service.

Perhaps if you share a little more about your use case, I can get a better answer from the team.

rafa

Hi Rafael Fernandes,

Thanks for your feedback.

Here is our use case

• we need to generate a mail for several customers
• using DocMerge, I can generate a single document merging all record for printing --> that is OK
• I also need to generate a single document for each customer, in ordre to archive the document in the EDM solution

we were thinking about doing this using BPM but we face several issues without any way to be sure that the document was correctly generated.

So we would like to trigger a hook and create several individual job action to perform the docmerge.

Best regards,

Fred

Hi Frédéric Rinaldi,

Here is some ideas we came up with:

You can create the hook and call the merge function from the DocumentMergeApi. Just instantiate the class and call the function. The function should receive the proper arguments. They can be identified from the code inside the function

   $data = [
            'mergeType' => $request->getValidInputPost('mergeType'),
            'useRevision' => $request->getValidInputPost('useRevision') ?? true,
            'templateName' => $request->getValidInputPost('templateName'),
            'templateId' => $request->getValidInputPost('templateId', 'Assert\Guid'),
            'recordId' => $request->getValidInputPost('recordId', 'Assert\Guid'),
            'recordModule' => $request->getValidInputPost('recordModule'),
            'parentId' => $request->getValidInputPost('parentId'),
            'parentModule' => $request->getValidInputPost('parentModule'),
            'maxRelate' => $request->getValidInputPost('maxRelate') ?? static::MAX_RETRIEVE,
        ];

Hi Frédéric Rinaldi,

Here is some ideas we came up with:

You can create the hook and call the merge function from the DocumentMergeApi. Just instantiate the class and call the function. The function should receive the proper arguments. They can be identified from the code inside the function

   $data = [
            'mergeType' => $request->getValidInputPost('mergeType'),
            'useRevision' => $request->getValidInputPost('useRevision') ?? true,
            'templateName' => $request->getValidInputPost('templateName'),
            'templateId' => $request->getValidInputPost('templateId', 'Assert\Guid'),
            'recordId' => $request->getValidInputPost('recordId', 'Assert\Guid'),
            'recordModule' => $request->getValidInputPost('recordModule'),
            'parentId' => $request->getValidInputPost('parentId'),
            'parentModule' => $request->getValidInputPost('parentModule'),
            'maxRelate' => $request->getValidInputPost('maxRelate') ?? static::MAX_RETRIEVE,
        ];

Thanks Rafael Fernandes ; I will try.

Hi Rafael Fernandes,

I tried with the following code:

<?php

    $api = new DocumentMergeApi();
    $args = [
        'mergeType' => 'convert',
        'useRevision' => 1,
        'templateName' => 'test',
        'templateId' => '9a7a7546-e5c8-11ed-af10-0242ac11002e',
        'recordId' => '497703a6-efd9-11ed-88c2-0242ac11002a',
        'recordModule' => 'Accounts',
    ];
    $service = new RestService();
    $merge_req_id = $api->merge($service, $args);

I can see the document_merge record in the DocMerge popup as well as in the document_merges db table.

But it ends up with an error in the sugarcrm.log:

Exception in Controller: SugarException: Server error: `POST https://document-merge-eu-west-2-prod.service.sugarcrm.com/merge` resulted in a `504 Gateway Time-out` response:
 (truncated...)
 in /var/www/html/modules/DocumentMerges/clients/base/api/DocumentMergeApi.php:141

I launched the same document generation using the interface and it went well. I don't see any difference in the 2 document generations (looking at the db records and at the parameters send to the api).

Any idea about what is going wrong?

Thank you,

Sylvain

Hi Frédéric Rinaldi,

Here's the feedback I got from engineering:

Example code should be inside the bpm modules/pmse_Inbox/engine/PMSEElements/PMSEDocumentMerge.php

public function merge($data, \SugarBean $bean, $flowData): void
    {
        $convert = $data->act_convert_to_pdf ?? false;
        $templateId = $data->act_document_template->value;
        $templateName = $data->act_document_template->text;
        $recordId = $bean->id;
        $recordModule = $bean->module_dir;

        $mergeType = $this->getMergeType($convert, $templateId);
        if ($mergeType) {
            $docMerge = new DocumentMergeApi();
            $api = new \RestService();
            $docMerge->merge($api, [
                'mergeType' => $mergeType,
                'templateId' => $templateId,
                'templateName' => $templateName,
                'useRevision' => true,
                'recordId' => $recordId,
                'recordModule' => $recordModule,
                'flowData' => json_encode($flowData),
            ]);
        } else {
            throw new PMSEElementException("Document Merge: No merge type", $mergeType, $this);
        }
    }

Hi Rafael Fernandes ,

Do you know if it is possible to set the name of the file that is generated?  Right now, it concatenates the Name of the record and the name of the Document Template.  I'd like to be able to set a custom filename result.

Thank you,
Justin Kuehlthau

Justin Kuehlthau ,

You can set a prefix and a suffix in the UI (see image below), but it will be static, meaning you cannot set something-{name}-contract.docx.

rafa