Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Annual School Census PDF Developer Manual ======

More like notes for now. Technology for the new version of the PDF surveys are developed in iText C#.

===== REST API =====

The REST interface has these methods, which are not authenticated yet, so you can use them directly from the browser address bar.
 
This repairs some structural issues in the older template of the PDF survey (i.e. 2024). This was executed ones and should never be needed again.

<code>
/api/pdfSurvey/fix/<<year>>?version=<<SEC|PRI>>
</code>
 
The following one takes a survey, reload its data into the current version of the form. This was used to reload data into "fixed PDF templates.

<note important>Will it retain other uses? Or does the generate version handle all future cases?</note>

<code>
/api/pdfSurvey/reload/<<schno>>/<<surveyYear>>?TargetYear
</code>
 
Create a new survey using the school No and survey year template, reading the data from the database. Note the PDF survey template must be in ''C:\inetpubwww\<<context>>\assets\<<context>>''

<code>
/api/pdfSurvey/generate/<<schno>>/<<surveyYear>>
</code>

===== Lookups Handling =====

A nice pdf way to handle these lookups would be to convert them objects of type PdfArray, and store these arrays as indirect objects. Then, in dropdown lists, you can refer to the PdfArray in the /Opt key of the dropdown, potentially reusing the array in each and every dropdown that needs them. This eliminates repetition, and simplifies the generation of the dropdowns.

Here’s some sample code from ChatGPT which transforms the JSON returned by lookups/core into a Dictionary of PdfArrays - you could then get the required lookup set from this Dictionary as a PDfArray, and assign it to the /Opt property of a dropdown 

<code csharp>
using System;
using System.Collections.Generic;
using iText.Kernel.Pdf;
using iText.Forms;
using iText.Forms.Fields;
using Newtonsoft.Json.Linq;

class Program
{
    static void Main()
    {
        // Sample JSON
        string json = "{\"schoolTypes\":[{\"C\":\"STECE\",\"N\":\"ECE\"},{\"C\":\"ST6-8\",\"N\":\"Grade 6-8\"},{\"C\":\"STK-9\",\"N\":\"Grade ECE-9\"}]}";

        // Parse JSON
        JObject parsedJson = JObject.Parse(json);

        // Create a PDF document
        PdfDocument pdfDoc = new PdfDocument(new PdfWriter("DropdownWithMakeIndirect.pdf"));

        // Add a page for demonstration
        pdfDoc.AddNewPage();

        // Create a dictionary to hold the indirect references
        Dictionary<string, PdfObject> pdfArrayIndirectObjects = new Dictionary<string, PdfObject>();

        foreach (var property in parsedJson.Properties())
        {
            // Create a PdfArray for the current property
            PdfArray outerArray = new PdfArray();

            foreach (var item in property.Value)
            {
                // Create a PdfArray for each item (C, N)
                PdfArray innerArray = new PdfArray();
                innerArray.Add(new PdfString(item["C"]?.ToString()));
                innerArray.Add(new PdfString(item["N"]?.ToString()));

                // Add the inner array to the outer array
                outerArray.Add(innerArray);
            }

            // Make the outer array indirect using MakeIndirect
            PdfObject indirectObject = outerArray.MakeIndirect(pdfDoc);
            pdfArrayIndirectObjects[property.Name] = indirectObject;
        }

        // Example: Use the schoolTypes entry to set the /Opt key of a dropdown field
        if (pdfArrayIndirectObjects.ContainsKey("schoolTypes"))
        {
            PdfAcroForm form = PdfAcroForm.GetAcroForm(pdfDoc, true);

            // Create a dropdown field
            PdfFormField dropdown = PdfFormField.CreateComboBox(pdfDoc, new iText.Kernel.Geom.Rectangle(100, 700, 200, 20), "dropdownField", "");

            // Assign the indirect array reference to the /Opt key
            dropdown.Put(PdfName.Opt, pdfArrayIndirectObjects["schoolTypes"]);

            // Add the field to the form
            form.AddField(dropdown);
        }

        // Close the document
        pdfDoc.Close();

        Console.WriteLine("PDF created with dropdown field using MakeIndirect.");
    }
}
</code>