7. Generate Document step

DOCX and PPTX Templates

The GenerateDocumentWordPPT step is associated with the Vlocity Template object-document-creation-docx-template.

Vlocity passes the generation through a VisualForce page "ObjectDocumentCreationDocXTemplate" embedded in an iframe. You can override this template to meet other requirements.

JSON

baseCtrl.prototype.setDocXIPScope = function(scp) {
 'use strict';
 var afterSlash = '/' + window.location.href.split('.com/')[1].split('/')[0];
 window.VlocOmniSI = scp;
 if (afterSlash === 'apex') {
  afterSlash = '';
 }
 scp.applyCallResp({
  urlPrefix: window.location.origin + afterSlash
 });

 window.bpTreeResponseSent = false;
 window.addEventListener('message', function(event) {
  if (event.data && event.data.constructor === Object && event.data.hasOwnProperty('docGenContentVersionId')) {
   window.VlocOmniSI.applyCallResp(event.data);
  }
  if (event.data && event.data.constructor === Object && event.data.hasOwnProperty('GET_BPTREE_RESPONSE')) {
   if (!window.bpTreeResponseSent) {
    var fContentWindow = document.getElementById('obj-doc-creation-docx-os-iframe').contentWindow;
    fContentWindow.postMessage({
     'clmDocxBpTreeResponse': baseCtrl.prototype.$scope.bpTree.response
    }, '*');
    window.bpTreeResponseSent = true;
   }
  }
 }, false);
};

You download the generated document in Microsoft Word, PPT, or PDF by using the Download Word, Download PPT, or Download PDF button. You can configure the buttons to allow downloads of only certain file types.

To do this, you edit the documentType and set different parameters to control what the user can download. If you don't see the documentType, go to Step 5 and add it. You can use the following parameters:

• All: This is the default parameter. Users can download both Microsoft Word and PDF files.

• Word: Users can download only the Word file.

• PPT: Users can download only the PowerPoint file.

• PDF: Users can download only the PDF file.

The page in the iFrame generates the documents and attaches them to the object. Vlocity always stores the documents generated through DOCX or PPTX templates in Salesforce ContentVersion.

You can find the list of documents generated through this Omniscript in the Notes & Attachments related list. The file type for documents generated with DOCX or PPTX templates is Type = File because the document is stored in Salesforce ContentVersion.

Vlocity executes GenerateDocumentWordPPT step only for Microsoft DOCX or PPTX templates. You can configure it by editing the step filter.

Vlocity Web Templates

The GenerateDocumentWebTemplate step is associated with the Vlocity Template object-document-creation-default.

Vlocity generates documents through a Visualforce page "ObjectDocumentCreationNew," which is embedded in an iFrame. You can override this template to meet other requirements.

JSON

baseCtrl.prototype.setIPScope = function(scp) {
    'use strict';
    var afterSlash = '/' + window.location.href.split('.com/')[1].split('/')[0];
    window.VlocOmniSI = scp;
    if (afterSlash === 'apex') {
        afterSlash = '';
    }
    scp.applyCallResp({
        urlPrefix: window.location.origin + afterSlash
    });

    window.addEventListener('message', function(event) {
        if (event.data && event.data.constructor === Object && event.data.hasOwnProperty('docGenAttachmentId')) {
            window.VlocOmniSI.applyCallResp(event.data);
        }
    }, false);
};

You can download the generated document in Microsoft Word, PowerPoint, or PDF by using the Download Word, Download PPT, or Download PDF button. You can configure the buttons to allow downloads of only certain file types.

In the Generic Document Generation Omniscript, choose Generate Document. Generate DocumentWebTemplate. Edit as JSON. Edit the documentType and set different parameters to control what the user can download. If you don't see the documentType, go back to Step 5 and add it. you can use the following parameters:

• All: This is the default parameter. Users can download both Microsoft Word and PDF files.

• Word: Users can download only the Word file.

• PPT: Users can download only the PowerPoint file.

• PDF: Users can download only the PDF file.

Users must click a Generate button (Generate Word or Generate PPT) to start generating documents. Vlocity saves the generated documents on the Notes & Attachments for the object. Go to the list of documents generated by this Omniscript in the Notes & Attachments list. The documents generated for Web Templates have the type of Attachment.

The GenerateDocumentWebTemplate step executes only for Vlocity Web Templates. You can configure it by editing the step filter.