Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
879d432
replaced develop with main
Aug 5, 2024
6a5c3e7
Merge pull request #934 from AdobeDocs/faqs
hitesh-kumar-mahour Aug 5, 2024
c8562bd
PDF Embed API - Release notes - August 2024
paras-n Aug 22, 2024
66eccf5
Merge remote-tracking branch 'origin/main' into PDFEmbedAPI_August24
paras-n Aug 22, 2024
70ba2cd
Merge pull request #941 from AdobeDocs/PDFEmbedAPI_August24
paras-n Aug 22, 2024
970a9b1
Develop (#950)
jasnoors Sep 4, 2024
e689f50
twm functions documentation
NamanChhabra Sep 11, 2024
e9aa50f
updated language for documentation
NamanChhabra Sep 11, 2024
9b6a056
Merge pull request #954 from AdobeDocs/twm_functions_support
NamanChhabra Sep 11, 2024
52614b3
release note update
NamanChhabra Sep 12, 2024
6664784
updated Table Tag
NamanChhabra Sep 12, 2024
e915b42
Merge pull request #955 from AdobeDocs/release_note_update
NamanChhabra Sep 12, 2024
19536d0
Added some additional information in protect pdf description
Sep 24, 2024
87a32ee
Merge pull request #957 from AdobeDocs/protect-main-changes
amitsingh1009 Sep 24, 2024
665c5b1
Adding Developer Docs for Watermark and Checker
Oct 8, 2024
d7db31b
update
Oct 8, 2024
72516e1
update
Oct 8, 2024
2347896
fix linters
Oct 8, 2024
e1954d8
fix linters
Oct 8, 2024
3f1a300
Merge branch 'develop' into watermark_and_checker_docs
SufiaAshraf Oct 8, 2024
de583f6
update samples
Oct 9, 2024
b996274
update
Oct 9, 2024
0a17bc1
review
Oct 10, 2024
6b0962d
release note
Oct 10, 2024
9a5eb98
alpha sorting of how-tos
Oct 16, 2024
1ff0b84
update syntax
Oct 16, 2024
21ab0da
update
Oct 16, 2024
4eb0fbf
Py Quickstarts Fix
Oct 17, 2024
2a75099
add more samples for watermark and checker
Oct 17, 2024
c551022
update
Oct 17, 2024
033b7aa
syntax fix
Oct 22, 2024
c0c9af8
DCSV-97016 bug fix
jasnoors Nov 4, 2024
1f114c5
release 4.2.0
Nov 5, 2024
1c3ddb0
updated version for sdk watermark and a11y operations
Nov 5, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 40 additions & 40 deletions gatsby-config.js
Original file line number Diff line number Diff line change
Expand Up @@ -202,88 +202,88 @@ module.exports = {
path: 'overview/pdf-services-api/howtos/webhook-notification.md'
},
{
title: 'SDK Utilities',
path: 'overview/pdf-services-api/howtos/sdk-utilities.md'
title: 'Combine PDF Files',
path: 'overview/pdf-services-api/howtos/combine-pdf.md'
},
{
title: 'Compress PDFs',
path: 'overview/pdf-services-api/howtos/compress-pdf.md'
},
{
title: 'Create PDF',
path: 'overview/pdf-services-api/howtos/create-pdf.md'
},
{
title: 'Delete Pages',
path: 'overview/pdf-services-api/howtos/delete-pages.md'
},
{
title: 'Export PDF',
path: 'overview/pdf-services-api/howtos/export-pdf.md'
},
{
title: 'Combine PDF Files',
path: 'overview/pdf-services-api/howtos/combine-pdf.md'
title: 'Extract PDF',
path: 'overview/pdf-services-api/howtos/extract-pdf.md'
},
{
title: 'OCR PDF',
path: 'overview/pdf-services-api/howtos/ocr-pdf.md'
title: 'Get PDF Properties',
path: 'overview/pdf-services-api/howtos/pdf-properties.md'
},
{
title: 'Compress PDFs',
path: 'overview/pdf-services-api/howtos/compress-pdf.md'
title: 'Insert Pages',
path: 'overview/pdf-services-api/howtos/insert-pages.md'
},
{
title: 'Linearize PDF',
path: 'overview/pdf-services-api/howtos/linearize-pdf.md'
},
{
title: 'Protect PDF',
path: 'overview/pdf-services-api/howtos/protect-pdf.md'
},
{
title: 'Remove Protection',
path: 'overview/pdf-services-api/howtos/remove-protection.md'
},
{
title: 'Insert Pages',
path: 'overview/pdf-services-api/howtos/insert-pages.md'
title: 'OCR PDF',
path: 'overview/pdf-services-api/howtos/ocr-pdf.md'
},
{
title: 'Replace Pages',
path: 'overview/pdf-services-api/howtos/replace-pages.md'
title: 'PDF Accessibility Auto-Tag',
path: 'overview/pdf-services-api/howtos/pdf-accessibility-auto-tag-pdf.md'
},
{
title: 'Delete Pages',
path: 'overview/pdf-services-api/howtos/delete-pages.md'
title: 'PDF Accessibility Checker',
path: 'overview/pdf-services-api/howtos/pdf-accessibility-checker-api.md'
},
{
title: 'Reorder Pages',
path: 'overview/pdf-services-api/howtos/reorder-pages.md'
title: 'PDF Electronic Seal',
path: 'overview/pdf-services-api/howtos/electronic-seal-api.md'
},
{
title: 'Rotate Pages',
path: 'overview/pdf-services-api/howtos/rotate-pages.md'
title: 'PDF Watermark',
path: 'overview/pdf-services-api/howtos/pdf-watermark-api.md'
},
{
title: 'Split PDF',
path: 'overview/pdf-services-api/howtos/split-pdf.md'
title: 'Protect PDF',
path: 'overview/pdf-services-api/howtos/protect-pdf.md'
},
{
title: 'Extract PDF',
path: 'overview/pdf-services-api/howtos/extract-pdf.md'
title: 'Remove Protection',
path: 'overview/pdf-services-api/howtos/remove-protection.md'
},
{
title: 'Get PDF Properties',
path: 'overview/pdf-services-api/howtos/pdf-properties.md'
title: 'Reorder Pages',
path: 'overview/pdf-services-api/howtos/reorder-pages.md'
},
{
title: 'PDF Accessibility Auto-Tag',
path: 'overview/pdf-services-api/howtos/pdf-accessibility-auto-tag-pdf.md'
title: 'Replace Pages',
path: 'overview/pdf-services-api/howtos/replace-pages.md'
},
{
title: 'PDF Electronic Seal',
path: 'overview/pdf-services-api/howtos/electronic-seal-api.md'
title: 'Rotate Pages',
path: 'overview/pdf-services-api/howtos/rotate-pages.md'
},
{
title: 'PDF Watermark',
path: 'overview/pdf-services-api/howtos/pdf-watermark-api.md'
title: 'Split PDF',
path: 'overview/pdf-services-api/howtos/split-pdf.md'
},
{
title: 'PDF Accessibility Checker',
path: 'overview/pdf-services-api/howtos/pdf-accessibility-checker-api.md'
title: 'SDK Utilities',
path: 'overview/pdf-services-api/howtos/sdk-utilities.md'
}
]
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ To complete this guide, you will need:
</PropertyGroup>

<ItemGroup>
<PackageReference Include="Adobe.PDFServicesSDK" Version="4.0.0" />
<PackageReference Include="Adobe.PDFServicesSDK" Version="4.1.0" />
<PackageReference Include="log4net" Version="2.0.17" />
</ItemGroup>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ To complete this guide, you will need:
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>11</maven.compiler.source>
<maven.compiler.target>11</maven.compiler.target>
<pdfservices.sdk.version>4.1.0</pdfservices.sdk.version>
<pdfservices.sdk.version>4.2.0</pdfservices.sdk.version>
</properties>

<dependencies>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -204,9 +204,30 @@ with open(output_file_path, "wb") as file:
Here's the complete application (`src/documentmerge/merge_document_to_pdf.py`):

```python
import json
import logging
import os
from datetime import datetime

from adobe.pdfservices.operation.auth.service_principal_credentials import ServicePrincipalCredentials
from adobe.pdfservices.operation.exception.exceptions import ServiceApiException, ServiceUsageException, SdkException
from adobe.pdfservices.operation.io.cloud_asset import CloudAsset
from adobe.pdfservices.operation.io.stream_asset import StreamAsset
from adobe.pdfservices.operation.pdf_services import PDFServices
from adobe.pdfservices.operation.pdf_services_media_type import PDFServicesMediaType
from adobe.pdfservices.operation.pdfjobs.jobs.document_merge_job import DocumentMergeJob
from adobe.pdfservices.operation.pdfjobs.params.documentmerge.document_merge_params import DocumentMergeParams
from adobe.pdfservices.operation.pdfjobs.params.documentmerge.output_format import OutputFormat
from adobe.pdfservices.operation.pdfjobs.result.document_merge_result import DocumentMergePDFResult

# Initialize the logger
logging.basicConfig(level=logging.INFO)

# This sample illustrates how to merge the Word based document template with the input JSON data to generate
# the output document in the PDF format.
#
# Refer to README.md for instructions on how to run the samples.

class MergeDocumentToPDF:
def __init__(self):
try:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,9 @@ JSON representation of the input data:

## Inline images supported attributes

[Click here](../document-generation-api/inlineimages.md) to refer documentation on how to add Inline Images.
You may find documentation for using inline images [here](../document-generation-api/inlineimages.md).

Formatting for image can be provided using the attributes of the img tag.
Formatting for images can be provided using the attributes of the img tag.

- The img tag supports the height and width attributes.

Expand Down
37 changes: 33 additions & 4 deletions src/pages/overview/document-generation-api/templatetags.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,9 @@ A placeholder(text tags) gets replaced by the actual input data.
<InlineAlert slots="text"/>

A placeholder variable can only be applied to an input field of type
string, number or boolean. <br/> Formatting applied to the placeholder
variable in the document template will be retained in the output
document.<br/>
For more simplified styling and formatting for the placeholder tag from the input json data, please refer [styling and formatting](../document-generation-api/stylingformattingtags.md) section:
string, number or boolean.<br/> Please refer to the **Arrays** section to use array as a placeholder variable.<br/> Formatting applied to the placeholder
variable in the document template will be retained in the output document.<br/>
For more simplified styling and formatting for the placeholder tag from the input json data, please refer [styling and formatting](../document-generation-api/stylingformattingtags.md) section.

JSON representation of the input data:

Expand Down Expand Up @@ -74,6 +73,22 @@ A prefix value can be specified for the placeholder variable. Doing so will appe
this value before the result of the tag.

![Placeholder tags with prefix image set](../images/placeholder_prefix.png)

**Arrays**

To work with arrays, please refer to the [JSONata Functions](#jsonata-functions) section.

JSON representation of the input data:

```json
{
"companyName": "Tech Corp",
"discountCoupons": ["SummerSale", "BlackFriday", "NewYearSpecial"]
}
```

![working_with_arrays](../images/working_with_array.png)

## Images

To dynamically insert an image in the document, add any image as
Expand Down Expand Up @@ -447,6 +462,20 @@ Here is the list of [supported aggregation functions](https://docs.jsonata.org/a
aggregate numerical calculation can only be applied to a list of
numbers.

## JSONata Functions
The Document Generation API supports various JSONata functions, including:

- [String Functions](https://docs.jsonata.org/string-functions)
- [Numeric Functions](https://docs.jsonata.org/numeric-functions)
- [Aggregation Functions](https://docs.jsonata.org/aggregation-functions)
- [Boolean Functions](https://docs.jsonata.org/boolean-functions)
- [Array Functions](https://docs.jsonata.org/array-functions)
- [Date/Time Functions](https://docs.jsonata.org/date-time-functions)
- [Higher Order Functions](https://docs.jsonata.org/higher-order-functions)


It is recommended to test these functions before incorporating them into your template.

## Adobe Sign

Adobe Sign text tags can be placed anywhere within the contents of the document template.
Expand Down
Binary file added src/pages/overview/images/working_with_array.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -637,7 +637,7 @@ For security reasons you may wish to confirm the installer's authenticity. To do
1. After downloading the package zip, run following command

```
pip hash <download_dir>/pdfservices-sdk-4.0.0.tar.gz
pip hash <download_dir>/pdfservices-sdk-4.1.0.tar.gz
```

1. Above command will return the hash of downloaded package.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ To complete this guide, you will need:

<ItemGroup>
<PackageReference Include="log4net" Version="2.0.17" />
<PackageReference Include="Adobe.PDFServicesSDK" Version="4.0.0" />
<PackageReference Include="Adobe.PDFServicesSDK" Version="4.1.0" />
</ItemGroup>

<ItemGroup>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ To complete this guide, you will need:
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>11</maven.compiler.source>
<maven.compiler.target>11</maven.compiler.target>
<pdfservices.sdk.version>4.1.0</pdfservices.sdk.version>
<pdfservices.sdk.version>4.2.0</pdfservices.sdk.version>
</properties>

<dependencies>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ This defines what our output directory will be and optionally deletes it if it a
4) Now, let's create an asset from source file and upload.

```python
file = open('src/resources/autotagPDFInput.pdf', 'rb')
file = open('./autotagPDFInput.pdf', 'rb')
input_stream = file.read()
file.close()

Expand Down Expand Up @@ -140,19 +140,30 @@ with open(output_file_path, "wb") as file:
Here's the complete application (`autotag.py`):

```python
import logging
import os
from datetime import datetime

from adobe.pdfservices.operation.auth.service_principal_credentials import ServicePrincipalCredentials
from adobe.pdfservices.operation.exception.exceptions import ServiceApiException, ServiceUsageException, SdkException
from adobe.pdfservices.operation.io.cloud_asset import CloudAsset
from adobe.pdfservices.operation.io.stream_asset import StreamAsset
from adobe.pdfservices.operation.pdf_services import PDFServices
from adobe.pdfservices.operation.pdf_services_media_type import PDFServicesMediaType
from adobe.pdfservices.operation.pdfjobs.jobs.autotag_pdf_job import AutotagPDFJob
from adobe.pdfservices.operation.pdfjobs.result.autotag_pdf_result import AutotagPDFResult

# Initialize the logger
logging.basicConfig(level=logging.INFO)


#
# This sample illustrates how to generate a tagged PDF.
#
# Refer to README.md for instructions on how to run the samples.
#

class AutoTagPDF:
def __init__(self):
try:
file = open('src/resources/autotagPDFInput.pdf', 'rb')
file = open('./autotagPDFInput.pdf', 'rb')
input_stream = file.read()
file.close()

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -686,7 +686,7 @@ For security reasons you may wish to confirm the installer's authenticity. To do
1. After downloading the package zip, run following command

```
pip hash <download_dir>/pdfservices-sdk-4.0.0.tar.gz
pip hash <download_dir>/pdfservices-sdk-4.1.0.tar.gz
```

2. Above command will return the hash of downloaded package.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ To complete this guide, you will need:
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>11</maven.compiler.source>
<maven.compiler.target>11</maven.compiler.target>
<pdfservices.sdk.version>4.1.0</pdfservices.sdk.version>
<pdfservices.sdk.version>4.2.0</pdfservices.sdk.version>
</properties>

<dependencies>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -205,9 +205,32 @@ with open(output_file_path, "wb") as file:
Here's the complete application (`src/electronicseal/electronic_seal.py`):

```python
import logging
import os
from datetime import datetime

from adobe.pdfservices.operation.auth.service_principal_credentials import ServicePrincipalCredentials
from adobe.pdfservices.operation.exception.exceptions import ServiceApiException, ServiceUsageException, SdkException
from adobe.pdfservices.operation.io.cloud_asset import CloudAsset
from adobe.pdfservices.operation.io.stream_asset import StreamAsset
from adobe.pdfservices.operation.pdf_services import PDFServices
from adobe.pdfservices.operation.pdf_services_media_type import PDFServicesMediaType
from adobe.pdfservices.operation.pdfjobs.jobs.eseal_job import PDFElectronicSealJob
from adobe.pdfservices.operation.pdfjobs.params.eseal.csc_auth_context import CSCAuthContext
from adobe.pdfservices.operation.pdfjobs.params.eseal.csc_credentials import CSCCredentials
from adobe.pdfservices.operation.pdfjobs.params.eseal.document_level_permission import DocumentLevelPermission
from adobe.pdfservices.operation.pdfjobs.params.eseal.electronic_seal_params import PDFElectronicSealParams
from adobe.pdfservices.operation.pdfjobs.params.eseal.field_location import FieldLocation
from adobe.pdfservices.operation.pdfjobs.params.eseal.field_options import FieldOptions
from adobe.pdfservices.operation.pdfjobs.result.eseal_pdf_result import ESealPDFResult

# Initialize the logger
logging.basicConfig(level=logging.INFO)

# This sample illustrates how to apply electronic seal over the PDF document using default appearance options.
#
# Refer to README.md for instructions on how to run the samples.

class ElectronicSeal:
def __init__(self):
try:
Expand Down
2 changes: 1 addition & 1 deletion src/pages/overview/pdf-embed-api/howtos.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ viewer.

<InlineAlert slots="text"/>

The timeout for file rendering is 60 seconds. If the file exceeds this limit there will be a `Preview Rendering Failed` error.
The timeout for file rendering is 5 minutes. If the file exceeds this limit there will be a `Preview Rendering Failed` error.

## Passing file content

Expand Down
5 changes: 5 additions & 0 deletions src/pages/overview/pdf-embed-api/releasenotes.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@ the changes below for each release.

## Change history

### August 14, 2024
| Change | Description |
|---------|----------------------------------------------------------------------|
| Changed | Updated rendering timeout to five minutes to preview complex pdf files. |

### June 27, 2024
| Change | Description |
| ------ | ---------------------------------------------------------------------- |
Expand Down
2 changes: 1 addition & 1 deletion src/pages/overview/pdf-extract-api/gettingstarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -637,7 +637,7 @@ For security reasons you may wish to confirm the installer's authenticity. To do
1. After downloading the package zip, run following command

```
pip hash <download_dir>/pdfservices-sdk-4.0.0.tar.gz
pip hash <download_dir>/pdfservices-sdk-4.1.0.tar.gz
```

1. Above command will return the hash of downloaded package.
Expand Down
Loading
Loading