Peoplecode to zip/archive files

Following is a way to archive, compress or zip up files via peoplecode. Alternative would be to use command line calls to products like winzip, 7-zip etc. For this test I am running PT 8.59.x. The same should also be possible in slightly older Peopletools releases too, like PT 8.56.x

Oracle provides java classes that can be used for this task. This method will create a new archive file and add files to the root location of the archive or zip file. 

The solution uses the following three java classes that are delivered with PeopleTools

1. java.io.FileOutputStream

2. java.util.zip.ZipOutputStream

3. java.util.zip.ZipEntry

/* initialize Java Obejct &myArchive */
Local JavaObject &myArchive = CreateJavaObject("java.util.zip.ZipOutputStream", CreateJavaObject("java.io.FileOutputStream", &zipFileName, True));

In the above line of code &zipFileName is the complete path of the archive file that we will create.

&fileNametoAdd - will have the complete path to the file that we will be adding to the archive. 

In order to get the filename value from the file path do the following.

&FilePath = Split(&fileNametoAdd, "\");
&fname = &FilePath [&FilePath.Len];

Local JavaObject &ArchiveEntry = CreateJavaObject("java.util.zip.ZipEntry", &fname);

/* Add Archive entry to OutputStream */

&myArchive.putNextEntry(&ArchiveEntry);

/* now add the file to the archive */

/* Read source file into input stream */

Local JavaObject &in = CreateJavaObject("java.io.FileInputStream", &fileNametoAdd);

/* Java Array that will read bytes from input file */

Local JavaObject &filebuffer = CreateJavaArray("byte[]", 1024);

Local number &byteCount = &in.read(&filebuffer);

   

/* Read bytes from input file and load it byte array  - Do until all bytes are read*/

While &byteCount > 0

      /* Write Bytes of Data to corresponding Archive Output Stream */

      &myArchive.write(&filebuffer, 0, &byteCount);

      &byteCount = &in.read(&filebuffer);

End-While;

   

/* Close input stream */

&in.close();

/* Close archive */

&myArchive.close();

Securing PDF

Following is a way to secure pdf files generated via non-BI Publisher technology like SQR. For this test I am running PT 8.59.x. Should be available in slightly older Peopletools releases too, like PT 8.56.x

Oracle provides java classes that can be used for securing a pdf file. This method will add a password to the pdf file, so that a password is prompted to the user while opening the pdf as well as adds a digital signature to the pdf. This class does both so if the requirement is to only password protect a pdf file, we still have to add a signature but make it small or invisible. 

This method also requires a digital certificate signed by one of the approved adobe certificate authorities called as AATL. The certificate has to be pfx format (can be converted using tools like openssl). If a self-signed certificate is used, the process still works but the end user will receive a warning banner in adobe reader once the document is opened and will have to manually trust the certificate by adding it to the adbobe trust store. 

The solution uses two java classes that are delivered with PeopleTools

1. java.util.Properties

2. oracle.xdo.common.pdf.signature.PDFSignature

Local JavaObject &jProp = CreateJavaObject("java.util.Properties");

&jProp.setProperty("signature-enable", "True");
&jProp.setProperty("pdf-security", "True");
&jProp.setProperty("pdf-open-password", &EncryptPswd);
&jProp.setProperty("pdf-permissions-password", &EncryptPswd);
&jProp.setProperty("pdf-changes-allowed", "0");

&EncryptPswd is the password that will be used to open the pdf file. 

&inFile is the complete path to the source pdf file and &outFile is the complete path of the secured pdf file. 

Local JavaObject &pdfSignature = CreateJavaObject("oracle.xdo.common.pdf.signature.PDFSignature", &inFile, &outFile);
   
&pdfSignature.setConfig(&jProp);
&pdfSignature.setLocale("en");

&digPswd is the password of the pfx digitial certificate file and &digSign is the complete path to the pfx file. Make sure the paths use "//" insread of "/" or "\\" instead of "\".

&pdfSignature.init(&digPswd, &digSign);

Following plots the signature in the pdf file. If a signature is not needed then make it small or invisible. Adjust the values as required. 

&xCord = 0;

&yCord = 0;

&width = 0;

&height = 0;

&pageIndex = 1;

&sReason can be some text or blank if none is required.

      
Local JavaObject &jFloatArray = CreateJavaObject("float[]", &xCord, &yCord, &width, &height);
&pdfSignature.addSignatureField(&pageIndex, &jFloatArray, "PSoftSign");
&pdfSignature.sign("PSoftSign", &sReason);
&pdfSignature.cleanup();

clean-up memory once done.

&jProp = Null;

&pdfSignature = Null;

&jFloatArray = Null;

/* delete the un-encrypted file */

Local object &delFile = CreateJavaObject("java.io.File", &inFile);

&delFile.delete();

JSON Parser

PeopleSoft has undocumented JSON related API and this post covers some of the routines that I have tried to dynamically parse a json response. I think this API calls were made available in PT 8.56.x as part of PeopleSoft's inbuilt integration with ElasticSearch. 

I am making a RESTful web service call to a service hosted by a 3rd party vendor from PeopleSoft; so PeopleSoft is a consumer of the service. Focus here is to parse the response from the service so I am not covering how the service is setup and the request part of the service. 

So I have two types of responses. Response 1 as shown below 

{

    "error": {

        "message": "Some message text",

        "detail": "detail text about the error"

    },

    "status": "failure"

}

and Response 2 as follows.

{

   "import_set":"Import set value",

   "staging_table":"tablename",

   "result":[

      {

         "status":"updated",

         "error_message":"Unable to format 01-01-2019 using format string yyyyMMdd  for field hire_dt"

      }

   ]

}

In Response 1, I has 2 children, viz "error" and "status", whereas Response 2 has 3 children, import_set, staging_table and result.

In Response 1, "error" is a JSonObject which has 2 more children, message and detail. In Response 2, "result" is a JSonArray which has 2 children status and error_message.

Local string &content, &propName, &propValue;

Local JsonParser &parser;

Local JsonObject &jsonRoot, &jsonDetails;

Local JsonArray &jArray;

Local boolean &ret; 

Local number &i, &j, &k, &l;

&parser = CreateJsonParser(); /* this is the undocumented API */

&ret = &parser.Parse(&content); /* &content is the json response as a string */

&jsonRoot = &parser.GetRootObject();

For &i = 1 To &jsonRoot.GetChildCount()
/* for Response 1, following will get status tag and its value */
/* for Response 2, following will get import_set, staging_table and its values */

   &propName = &jsonRoot.GetPropertyNameAt(&i);

   &propValue = &jsonRoot.GetProperty(&propName);

   /* if there is a nested value then its either JsonArray or JsonObject */

   Evaluate &propValue

   When = "JsonArray"
/* this will return status and error_message which are in Response 2 */

      &jArray = &jsonRoot.GetJsonArray(&propName);

      For &j = 1 To &jArray.Length()

         &jsonDetails = &jArray.GetJsonObject(&j);

         For &k = 1 To &jsonDetails.GetChildCount()

            &propName = &jsonDetails.GetPropertyNameAt(&k);

            &propValue = &jsonDetails.GetProperty(&propName);

         End-For;

      End-For;

      Break;

   When = "JsonObject"
/* this will return message and detail which are in Response 1 */

      &jsonDetails = &jsonRoot.GetJsonObject(&propName);

      &numCnt = &jsonDetails.GetChildCount();

      For &l = 1 To &jsonDetails.GetChildCount()

         &propName = &jsonDetails.GetPropertyNameAt(&l);

         &propValue = &jsonDetails.GetProperty(&propName);

      End-For;

      Break;

   When-Other;

      /* when not JsonArray or JsonObject, get prop name and value which is at root level */

      Break;

   End-Evaluate;

End-For;

Hope this helps.