question Re: PDF Generation in Geneva in Developer forum

PDF Generation in Geneva

syed_faheem — Thu, 21 Apr 2016 01:40:45 GMT

This document will cover details on PDF Generator Plugin provided in Geneva as well as Enhancement that I have made to this solution.

1. PDF Generator Plugin

PDF generation feature has been added in Geneva as plugin, which provides the ability to generate PDF documents as per your own layout and data.

PDF Generator

New in Geneva application

com.snc.pdf_generator

Provides a tool to generate PDF documents.

This plugin has been used in Human Resources application to generate 'Employee Verification Letters' which is covered in Configure the employment verification letter and Complete an employment verification request articles in Geneva documentation.

However documentation lacks the details on use of this plugin for any other custom application or OOTB tables i.e. Incidents etc.

If you have been familiar with walter.brame's (fantastic) PDF Generator, this plugin is based on the same scripts. Basically this plugin provides you the ability to generate PDF of any document i.e. Letter which an end user can draft & design in ServiceNow with the data coming form record it is related to.

In order to utilize this for your application, you will need to create a script include similar to 'GeneralHRForm' and a document template table similar to 'hr_document_template' (both introduced with HR application in Geneva).

In Script Include you would be able to configure various aspects of this solution including variables which need to be replaced while PDF generation and document template table keeps all the customized templates which you could format as per your need using HTML editor.

Figure 1 - HR Document Template Record

Figure 2 - PDF Letter Generated

This solution has some limitations around variables you could use in templates as well as some other aspects. While working on it for a customer I have come up with some enhancements, which I would like to share with you in next section.

2. Enhancements

If you are looking to implement PDF letter generation functionality using solution provided for 'Employee Verification Letter' in HR Application, you would find few limitations and I have developed following enhancements to it.

a) Dynamic Variables Parsing

Problem

When you are configuring document template you would notice that variables are being entered as {{Name]}} or {{Position}}. These variables are parsed by following method in 'GeneralHRForm' script include.

Figure 3 - OOTB Script Include Method

parseBody : function(docBody, instance){
                                   var parsedBody = docBody;
                                   var gr = new GlideRecord(this.tableName);
                                   gr.get(this.tableId);
                                   
                                   var date = gs.now();
                         parsedBody = parsedBody.replace(/\{\{Date\}\}/gi, date);
                         parsedBody = parsedBody.replace(/\{\{Name\}\}/gi, gr.hr_profile.name);
                         parsedBody = parsedBody.replace(/\{\{Position\}\}/gi, gr.hr_profile.position.position);
                         parsedBody = parsedBody.replace(/\{\{Time type\}\}/gi, gr.hr_profile.time_type.getDisplayValue());
                         parsedBody = parsedBody.replace(/\{\{Employment start date\}\}/gi, gr.hr_profile.employment_start_date);                                                     
                                   
                                   parsedBody = parsedBody.replace(/\{\{Work email\}\}/gi, gr.hr_profile.work_email);
                                   parsedBody = parsedBody.replace(/\{\{Work phone\}\}/gi, gr.hr_profile.work_phone);
                                   parsedBody = parsedBody.replace(/\{\{Prefix\}\}/gi, gr.hr_profile.introduction);
                                   parsedBody = parsedBody.replace(/\{\{Nationality\}\}/gi, gr.hr_profile.nationality);
                                   parsedBody = parsedBody.replace(/\{\{Manager\}\}/gi, gr.hr_profile.manager.name);
                                   parsedBody = parsedBody.replace(/\{\{Department\}\}/gi, gr.hr_profile.department.name);
                                   parsedBody = parsedBody.replace(/\{\{Employee number\}\}/gi, gr.hr_profile.employee_number);
                                   parsedBody = parsedBody.replace(/\{\{Employment status\}\}/gi, gr.hr_profile.employment_status);
                                   parsedBody = parsedBody.replace(/\{\{Employment type\}\}/gi, gr.hr_profile.employment_type);
                                   parsedBody = parsedBody.replace(/\{\{Gender\}\}/gi, gr.hr_profile.gender);
                                   
                                   // convert to the right image path 
                                   parsedBody = parsedBody.replace(/\/sys_attachment.do\?sys_id=(\w{32})/gi, '/$1.iix');
                                   parsedBody = parsedBody.replace(/\/sys_attachment.do\?sys_id&#61;(\w{32})/gi, '/$1.iix');
                                   parsedBody = parsedBody.replace(/src="\//gi, 'src="' + instance);
                                   return parsedBody;
                 },

You would notice that variable parsing is hard-coded in the method, which poses a limitation that user can only use variables that have parsing code available in script include method 'parseBody'. Any new variable would require code change and may result in recurring code maintenance job for System Administrators.

Solution

For this solution lets consider we are developing Letter generation solution for an Incident record and have already created following script include and document template table.

Script Include: GeneralIncidentForm

Document template table: x_snc_letters_letter_template

Now we need to follow below steps:

Step 1: Add a new field called 'Table' to the document template form as below:

Figure 4 - Adding table field

Step 2: Changed field type for 'Body' field from 'HTML Translated' to 'HTML Script'.

Figure 5 - Body field type change

Step 3: Set 'Use dependent field' to checked and 'Dependent field' to 'Table' (i.e. new field you created)

Figure 6 - Setting dependent field

This will change your form to look like below:

Figure 7 - Enhanced document template form

This form would now provide the similar functionality as we have for creating email templates i.e.

You can select table from the table dropdown, i.e. in this case 'Incident'
'Select variable' section on right of 'Body' field populates all the fields from Incident table (which was selected in table field above).
You can select any field from variable list, which would be added to template body.
You can drill down / dot-walk to a lower level of field and add it to the body.
Notice that variables are now enclosed in ${}.

Step 4: Now we need to modify script include to parse these variables dynamically. Replace the parseBody method with code given below:

Figure 8 - Enhanced Script Include Method

parseBody : function(docBody, instance){
                                   var parsedBody = docBody;
                                   var gr = new GlideRecord(this.tableName);
                                   gr.get(this.tableId);
                                   
                                   var date = gs.now();
                                   parsedBody = parsedBody.replace(/\$\{date\}/gi, date);
                                   parsedBody = parsedBody.replace(/\$\{letterid\}/gi, this.letterid);
                                   
                                   // parsing of variables dynamically
                                   var sampleString=docBody.toString();
                                   var reg = new SNC.Regex('/\\$\\{(.*?)\\}/i');
                                   var match = reg.match(sampleString);
                                   var count =0;
                                   var variables = [];
                                   var values = [];
                                   var tmpValue;
                                   while (match != null) {
                                                     variables.push(match.toString().substring(match.toString().indexOf(',')+1));
                                                     match = reg.match();
                                                     
                                                     values.push(variables[count]);
                                                     if(gr.getDisplayValue(values[count])==null || JSUtil.nil(gr.getDisplayValue(values[count]))){
                                                                       tmpValue='';
                                                     }
                                                     else
                                                                       {
                                                                       tmpValue=gr.getDisplayValue(values[count]);
                                                                       
                                                     }
                                                     parsedBody = parsedBody.replace('${'+variables[count]+'}', tmpValue);
                                                     count++;
                                   }
                                   
                                   // convert to the right image path
                                   parsedBody = parsedBody.replace(/\/sys_attachment.do\?sys_id=(\w{32})/gi, '/$1.iix');
                                   parsedBody = parsedBody.replace(/\/sys_attachment.do\?sys_id&#61;(\w{32})/gi, '/$1.iix');
                                   parsedBody = parsedBody.replace(/src="\//gi, 'src="' + instance);
                                   
                                   return parsedBody;
                 },

And when you generate PDF, solution would be able to parse any variable you have included in the document template.

Here is the out put.

Figure 9 - Final generated letter

b) Miscellaneous enhancements

Following minor enhancements were also made and are included in attached script include code.

i) Removal of hard coded references for template table and source table form script include and passing them as parameter.

ii) Setting file name in script include as you like.

iii) and couple of more.

Apart from this I have also developed a solution of 'Letters & Correspondence Management' which covers:

Creating draft letter, approval and then generation of PDF
Having ability to select from multiple pre-drafted letter templates
Ability to generate latter / template with data coming from any ServiceNow table.
and more.

This solution will be available on Share portal soon.

Please share your feedback on this solution and how could this be improved.

Message was edited by: Syed Faheem

Re: PDF Generation in Geneva

amitpatil — Thu, 28 Apr 2016 03:49:09 GMT

Hi Syed,

The HTML script type is not available OOB as a field type from object class. There are ways to make it available although trying that does not always work- I tried this on my personal dev instance and it corrupted the body field on the custom form ( Letters Template)

Anything I put inside the body does not get saved .

Regards,

Amit

Re: PDF Generation in Geneva

syed_faheem — Fri, 29 Apr 2016 02:08:32 GMT

Hi Amit,

Try deleting the field and recreate it.

Re: PDF Generation in Geneva

amitpatil — Fri, 29 Apr 2016 04:21:37 GMT

Thanks Syed.

After I faced this issue I deleted the custom table and created a new one which extends the existing hr_document_template table. After this I made the changes you suggested. The form is ok now. I just need to get the pdf generated now .I have imported the script include you wrote ( as part of the zip file ) . I tried calling it using a UI action on incident although it does not generate the PDF.

Can you please share the UI action as well?

Thanks ,

Amit

Re: PDF Generation in Geneva

syed_faheem — Fri, 29 Apr 2016 04:51:04 GMT

Hi Amit,

Please use below code to call script include in your UI action.

// setting parameter values

var tempTable='x_snc_letters_letter_template';

var tempName='Incident Notification Letter';

var sourceTable= current.getTableName();

// calling script include function

global.GeneralIncidentForm.generate(current.sys_id, sourceTable, tempTable, tempName);

action.setRedirectURL(current);

Re: PDF Generation in Geneva

amitpatil — Fri, 29 Apr 2016 06:40:02 GMT

Thanks a lot Syed !

It generates the PDF now. I had to create 'Name' field on the 'Letters template' as it is being verified to generate the letter.

The generated letter come with the name 'Employee Verification Letter for Undefined' as shown below. Any clue? The content is fine though.

Re: PDF Generation in Geneva

syed_faheem — Sun, 01 May 2016 01:26:07 GMT

Hi Amit,

File name is being set line 158 of script include GeneraForm as below

this.fileName = 'Employee Verification Letter for ' + this.glideRecord.opened_for.name;

you can modify this here.

Cheers

Syed.

Re: PDF Generation in Geneva

sergiogomez — Wed, 04 May 2016 19:37:47 GMT

Hello Syed,

I was wondering how is it possible to make the 'HTML Script' available as a file type?

Thank you

Re: PDF Generation in Geneva

amitpatil — Fri, 06 May 2016 03:18:32 GMT

Hi Sergio , Please try following ( at your own risk ! This approach is not recommended by servicenow .One of my colleagues shared it with me )

Change the Reference Qualifier of the 'Reference \ internal_type' field in the 'Dictionary Entry \ sys_dictionary' table.

The attached screenshot shows the OOB field setup.

Simply modify the 'Use reference qualifier' field to 'Simple', leave everything else as it is, and Save the record.

You can now create fields of many more field-types.

Maybe best-practice is to change the Reference Qualifier back to how it was originally.

Re: PDF Generation in Geneva

amitpatil — Fri, 06 May 2016 03:27:06 GMT

Hi Syed,

Thanks for responding to my query.

Changing the file name in GeneralForm will fix the issue although may be for Incident Letter. Is there any way that this can be made dynamic ?

Curious to know why it is not picking up the file name from the script include .

generalForm.start(); calls in the GeneralForm script include and that's why it sets the name as 'Employee Verification Letter...'

But then I did not understand why generaHRForm.start(); is there for... Also if we have _getDocTempleInfo function which sets the file name , why it is not being applied ( as specified above that it will overwrite the functions from other scripts?)

Thanks,

Amit

Re: PDF Generation in Geneva

sergiogomez — Fri, 06 May 2016 20:09:45 GMT

Thank you very much, I will try that (at my own risk )

Re: PDF Generation in Geneva

kentespenhain — Tue, 10 May 2016 10:49:02 GMT

Hi Syed,

Thats a nice enhancement! A tad easier to edit the document template now.

I have tried to insert pagebreaks in a document, but i can't figure out how. There are lot of references to pagebreaks, newDocument page_break, etc. in the various script includes.

Do you how to insert forced page breaks?

Re: PDF Generation in Geneva

bhavu81 — Tue, 10 May 2016 18:11:22 GMT

can you please provide more information on creating table and where to find HTML Script field i found HTML and HTML Translated

Re: PDF Generation in Geneva

syed_faheem — Wed, 11 May 2016 23:58:50 GMT

Hi Bhavana,

If you have HR plugin installed on your geneva instance, you can extend table or create a similar table to 'hr_document_template' to create your template table.

To enable HTML Script field please follow the process amitpatil mentioned above on May 6, 2016 1:18 PM.

Cheers

Syed

Re: PDF Generation in Geneva

syed_faheem — Thu, 12 May 2016 00:06:41 GMT

Hi kentespenhain

I have not tried inserting Page Breaks via code, however i have tried to insert page break in the document template via HTML code which wasn't successful. Apparently HTML scripts we have in geneva does not fully cater for HTML codes, i.e. you cant set background colour and have it printed in PDF.

Its worth exploring what we can do in terms of page break, if you find any solution please share it here .

Cheers

Syed.

Re: PDF Generation in Geneva

kentespenhain — Thu, 12 May 2016 11:33:54 GMT

I took at "step back" and looked at Walter Brames version.

In the Generalform2 Script include

if (table.html.indexOf('{!Page_Break}') != -1) {

table.html = table.html.replaceAll('{!Page_Break}', '');

this.document.document.newPage();

}

However i wasent't able to get it to work properly. 😕

Re: PDF Generation in Geneva

bhavu81 — Thu, 12 May 2016 13:02:03 GMT

Thank you Syed but currently i am trying on Geneva demo service now version

v have eureka but will be upgrading soon then i can try on our own instance

Re: PDF Generation in Geneva

bhavu81 — Thu, 12 May 2016 16:00:31 GMT

Hi Syed ,

i am trying to call this script within pdf template is it possible??

<mail_script>

attachLinks();

function attachLinks() {

//Check for any attachments and add attachment links if they exist

var gr = new GlideRecord('sys_attachment');

gr.addQuery('table_sys_id',current.sys_id);

gr.query();

if(gr.hasNext()){

template.print('Attachments: \n');

while (gr.next()) {

var attachLink = '<a href="' + gs.getProperty("glide.servlet.uri") + gs.generateURL(gr.getTableName(),gr.sys_id) + '">' + gr.file_name + '</a>';

template.print(attachLink + '\n');

}

template.print('<hr/>');

}

</mail_script>

my requirement is pdf document will show the document list attached with that particular incident

Re: PDF Generation in Geneva

syed_faheem — Thu, 12 May 2016 23:22:34 GMT

I dont think you can use <mail_script> in document template.

However you can look into developing some script in script include which could return the list. Have a look at below code in parseBody method.

		parsedBody = parsedBody.replace(/\$\{date\}/gi, date);
		parsedBody = parsedBody.replace(/\$\{letterid\}/gi, this.letterid);

you could build a variable similar to this i.e ${attachlinks} and script in parseBody to return the values you want.

Cheers

Syed.

Re: PDF Generation in Geneva

syed_faheem — Thu, 12 May 2016 23:36:27 GMT

Hi Ken,

I dont think it would be supported as Walter Brame's code has been modified and in Geneva and it does not support full functionality yet. As per my knowledge product development would fill up these gaps in next 2 releases.

Cheers

Syed.