{ 
  "a_first_name": "John",
  "a_last_name": "Smith",
  "a_number": 42,
  "a_boolean": true
}

{
  "customers": [
    {
      "name": "John Smith",
      "age": 23,
      "is_last_bill_paid": true
    },
    {
      "name": "Alice Martin",
      "age": 34,
      "is_last_bill_paid": false
    },
    {
      "name": "Joe West",
      "age": 45,
      "is_last_bill_paid": false
    },
    {
      "name": "Mary Moss",
      "age": 56,
      "is_last_bill_paid": true
    }
  ]
}

{
  "days": [
    {
      "day_of_week": "Monday",
      "steps": 1023,
      "calories": 145
    },
    {
      "day_of_week": "Tuesday",
      "steps":2345,
      "calories": 267
    },
    {
      "day_of_week": "Wednesday",
      "steps": 3101,
      "calories": 345
    },
    {
      "day_of_week": "Thursday",
      "steps": 4523,
      "calories": 412
    },
    {
      "day_of_week": "Friday",
      "steps": 4321,
      "calories": 389
    }
  ]
}

Document Generator supports the following units of measure for images:

• px (pixels)
• in (inches)
• cm (centimeters)
• % (percentage)

• The original size is preserved.

If only one image dimension is provided, Document Generator calculates a scaled value for the missing dimension to preserve the aspect ratio. For instance:

• If you provide a width, but no height, a scaled height will be calculated based on the image's native dimensions and the provided width.
• If you provide a height, but no width, a scaled width will be calculated based on the image's native dimensions and the provided height.

Document Generator supports the following image formats:

• PNG
• JPG
• GIF
• BMP

• source: must be set to OBJECT_STORAGE
• objectName: The path and name of the file
• namespace: The namespace of your object storage bucket
• bucketName: The name of the bucket that contains the file
• mediaType: The Media Type (MIME) of the image

• source: must be set to URL
• url: the image URL in string format

Note: to use images from the Internet, Document Generator needs outbound access to the Internet. For example, if Document Generator is running in a private subnet in OCI, you could set up a NAT Gateway to allow Document Generator to connect to the Internet.

Document Generator also supports images provided as Data URLs. The image must be Base64-encoded.

• source: must be set to URL
• url: the image URL in string format

{
  "verticalSize": 10,
  "horizontalSize": 20
}

{
  "barcodeType": "CODE_128",
  "data": "12345",
  "moduleWidth": 2,
  "quietZone": {
    "verticalSize": 10,
    "horizontalSize": 10
  },
  "scale": 0.5,
  "rotation": "DEGREES_90",
  "altText": "Code 128",
  "barHeight": 80,
  "fontSize": 10,
  "allowedCodeSets": "AB"
}

{
  "barcodeType": "CODE_39",
  "data": "12345?",
  "barHeight": 80,
  "fontSize": 10,
  "moduleWidthRatio": 3,
  "isExtended": true,
  "checkDigitType": "MOD_43"
}

{
  "barcodeType": "DATA_MATRIX",
  "data": "The quick brown fox jumped over the lazy dog.",
  "shape": "SQUARE",
  "size": 20
}

{
  "barcodeType": "EAN",
  "data": "12345",
  "barHeight": 80,
  "fontSize": 10
}

{
  "barcodeType": "QR",
  "data": "https://docs.oracle.com/en-us/iaas/Content/Functions/Tasks/functions_pbf_catalog_document_generator.htm"
}

{
  "barcodeType": "PDF417",
  "data": "12345",
  "rowHeight": 6
}

{
  "barcodeType": "UPC",
  "data": "12345"
}

{
  "barcodeTypes": [
    {
      "name": "Code 39",
      "barcodes": [
        {
          "label": "default with alt text",
          "barcode": {
            "barcodeType": "CODE_39",
            "data": "12345",
            "altText": "an example Code 39 barcode"
          }
        },
        {
          "label": "module width 2",
          "barcode": {
            "barcodeType": "CODE_39",
            "data": "12345",
            "moduleWidth": 2
          }
        }
      ]
    },
    {
      "name": "Code 128",
      "barcodes": [
        {
          "label": "default with alt text",
          "barcode": {
            "barcodeType": "CODE_128",
            "data": "12345",
            "altText": "an example Code 128 barcode"
          }
        },
        {
          "label": "module width 2",
          "barcode": {
            "barcodeType": "CODE_128",
            "data": "12345",
            "moduleWidth": 2
          }
        }
      ]
    }
  ]
}

{
  "color": {
    "colorType": "OPAQUE_HEX_RGB",
    "value": "FFFF00"
  }
}

{
  "top": {
    "borderStyle": "MEDIUM",
    "color": {
      "colorType": "OPAQUE_HEX_RGB",
      "value": "FFFF00"
    }
  }
}

{
  "font": {
    "familyName": "Cookie",
    "sizeInPoints": 20,
    "color": {
      "colorType": "OPAQUE_HEX_RGB",
      "value": "FF0000"
    },
    "isBold": true,
    "isItalic": true,
    "isStrikethrough": true,
    "underline": "DOUBLE",
    "textPosition": "SUPERSCRIPT"
  }
}

{
  "horizontalAlignment": "RIGHT"
}

{
  "verticalAlignment": "TOP"
}

{
  "background": {
    "backgroundType": "SINGLE_FILL_COLOR",
    "color": {
      "colorType": "OPAQUE_HEX_RGB",
      "value": "DDDDDD"
    }
  }
}

{
  "top": {
    "borderStyle": "MEDIUM",
    "color": {
      "colorType": "OPAQUE_HEX_RGB",
      "value": "FFFF00"
    }
  },
  "bottom": {
    "borderStyle": "DASHED",
    "color": {
      "colorType": "OPAQUE_HEX_RGB",
      "value": "FF00FF"
    }
  },
  "left": {
    "borderStyle": "DOTTED"
  },
  "right": {
    "borderStyle": "MEDIUM_DASHED"
  }
}

{
  "cookieBold": {
    "font": {
      "familyName": "Cookie",
      "sizeInPoints": 20,
      "isBold": true
    }
  },
  "products": [
    {
      "name": "Winter Gloves",
      "remaining": 444,
      "s1": {
        "font": {
          "underline": "DOUBLE"
        }
      },
      "s2": {
        "background": {
          "backgroundType": "SINGLE_FILL_COLOR",
          "color": {
            "colorType": "OPAQUE_HEX_RGB",
            "value": "DDDDDD"
          }
        }
      }
    },
    {
      "name": "Snow Shovel",
      "remaining": 11,
      "s2": {
        "font": {
          "color": {
            "colorType": "OPAQUE_HEX_RGB",
            "value": "FF0000"
          }
        },
        "background": {
          "backgroundType": "SINGLE_FILL_COLOR",
          "color": {
            "colorType": "OPAQUE_HEX_RGB",
            "value": "BBBBBB"
          }
        }
      }
    }
  ]
}

Consider cell B3. The template contains {name}{cs:cookieBold}{cs:s1}.

• The yellow background fill comes from the original cell styling.
• {name} resolves to "Winter Gloves" from the data.
• {cs:cookieBold} applies the Cookie font from the cookieBold style defined at the root of the data.
• {cs:s1} applies the double underline from the s1 style for Winter Gloves.

{
  "value1": 22,
  "value2": 33,
  "formula1": "A3+B3",
  "formula2": "3 * 2",
  "formula3": "A3 * 2",
  "formula4": "SUM(A3:B3)",
  "items": [
    {
      "itemName": "Gloves",
      "quantity": 3,
      "unitPrice": 22,
      "total": "B11 * C11"
    },
    {
      "itemName": "Pants",
      "quantity": 2,
      "unitPrice": 55,
      "total": "B12 * C12"
    }
  ]
}

{
  "external_link": {
    "type": "EXTERNAL",
    "url": "https://www.oracle.com",
    "url_text": "Link to Oracle.com"
  },
  "internal_link": {
    "type": "INTERNAL",
    "link": "Sheet1!D6",
    "link_text": "Link to cell D6"
  },
  "links": [
    {
      "name": "External link",
      "link": {
        "type": "EXTERNAL",
        "url": "https://www.oracle.com",
        "url_text": "This is an external link to oracle.com in a Loop"
      }
    },
    {
      "name": "Internal link",
      "link": {
        "type": "INTERNAL",
        "link": "Sheet1!D6",
        "link_text": "This is an internal link to cell D6 in a Loop",
        "tooltip": "Hello from tooltip!"
      }
    }
  ]
}

{
  "movies": [
    {
      "name": "Arrival",
      "actors": [
        {
          "name": "Amy Adams"
        },
        {
          "name": "Jeremy Renner"
        }
      ],
      "pageBreak_condition": true
    },
    {
      "name": "Groundhog Day",
      "actors": [
        {
          "name": "Bill Murray"
        },
        {
          "name": "Andie MacDowell"
        }
      ],
      "pageBreak_condition": false
    },
    {
      "name": "Notting Hill",
      "actors": [
        {
          "name": "Hugh Grant"
        },
        {
          "name": "Julia Roberts"
        },
        {
          "name": "Rhys Ifans"
        }
      ],
      "pageBreak_condition": false
    }
  ]
}

{
  "hideRowTrue": true,
  "customers": [
    {
      "name": "John Smith",
      "age": 23,
      "is_last_bill_paid": true
    },
    {
      "name": "Alice Martin",
      "age": 17,
      "is_last_bill_paid": false
    },
    {
      "name": "Joe West",
      "age": 36,
      "is_last_bill_paid": false
    },
    {
      "name": "Monica Richard",
      "age": 16,
      "is_last_bill_paid": true
    },
    {
      "name": "Mary Moss",
      "age": 18,
      "is_last_bill_paid": true
    }
  ]
}

Rows 7 and 9 are hidden because the age of Alice Martin and Monica Richard is less than 18.

{
  "hideColTrue": true,
  "customers": [
    {
      "name": "John Smith",
      "age": 23,
      "is_last_bill_paid": true
    },
    {
      "name": "Alice Martin",
      "age": 18,
      "is_last_bill_paid": false
    },
    {
      "name": "Mary Moss",
      "age":17,
      "is_last_bill_paid": true
    }
  ]
}

Column D is hidden because the age of Mary Moss is less than 18.

{
  "name": "World"
}

In this example, both sheets in the template contain a tag:

In the output, only the tag in the second worksheet is resolved:

{
  "region": "Midwest",
  "customers": [
    {
      "name": "Alice"
    },
    {
      "name": "Bob"
    }
  ]
}

The worksheet contains a sheet generation tag, {!customers}, which refers to the customers array in the JSON data. It also contains two basic tags in the worksheet grid and another in the worksheet name.

In the output:

• There is one worksheet per customer.
• The basic tag {name} is replaced by the name of the current customer from the JSON array, including in the worksheet name.
• The basic tag {region} is replaced by the region specified at the root level of the JSON data.

The three loop levels in the data are genres, movies, and actors.

{
  "genres": [
    {
      "name": "Comedy",
      "movies": [
        {
          "name": "Groundhog Day",
          "actors": [
            {
              "name": "Bill Murray",
              "birth_year": 1950
            },
            {
              "name": "Andie MacDowell",
              "birth_year": 1958
            }
          ]
        },
        {
          "name": "Notting Hill",
          "actors": [
            {
              "name": "Hugh Grant",
              "birth_year": 1960
            },
            {
              "name": "Julia Roberts",
              "birth_year": 1967
            },
            {
              "name": "Rhys Ifans",
              "birth_year": 1967
            }
          ]
        }
      ]
    },
    {
      "name": "Science Fiction",
      "movies": [
        {
          "name": "Arrival",
          "actors": [
            {
              "name": "Amy Adams",
              "birth_year": 1974
            },
            {
              "name": "Jeremy Renner",
              "birth_year": 1971
            }
          ]
        },
        {
          "name": "The Matrix",
          "actors": [
            {
              "name": "Keanu Reeves",
              "birth_year": 1964
            },
            {
              "name": "Carrie-Anne Moss",
              "birth_year": 1967
            },
            {
              "name": "Laurence Fishburne",
              "birth_year": 1961
            }
          ]
        }
      ]
    }
  ]
}

• All tags in loops are resolved in the context of their loop. In this example, the {name} basic tag is used in each loop with a different meaning (genre name, movie name, actor name).

{
  "chart_title": "Revenue/Expense",
  "months": [
    {
      "month": "January",
      "revenue": 23,
      "expense": 19
    },
    {
      "month": "February",
      "revenue": 24,
      "expense": 22
    },
    {
      "month": "March",
      "revenue": 25,
      "expense": 18
    }
  ]
}