360Works Scribe 4.1 User Guide

  ScribeDifferenceReport[Select; Some Text: "This is some text";Other Text: "This is some other text"]
 

This function will return a report like the one below :

 additions: 2 214
 modifications: 0 0
 deletions: 1 47
 

• 2 blocks were added, for a total of 214 characters
• No modifications
• 1 deletion, of 47 characters

Custom Options

 Set Field[myTable::Differences; ScribeDifferencesBetween("This is some text";"This is some other text";"verbose=true")]
 

 ScribeDocLoad[Container or URL: myTable::myDocument] //load the document first
 ScribeDocAppend[Data: myTable::myOtherDocument] //append another document directly after the end of the first
 Set Field[myTable::NewDoc;ScribeDocSaveContainer("new.docx")]
 

Optional arguments:

newPage=true: force a page break before the appended document

 ScribeDocLoad[Container or URL: myTable::myDocument] //load the document first
 Set Variable[$append; Value: ScribeDocAppend(myTable::myOtherDocument;"newPage=true")]
 Set Field[myTable::NewDoc;ScribeDocSaveContainer("new.docx")]
 

 Set Variable[$fields; Value: ScribeDocListFields]
 

PDF Support

Word Support (Office 2007 format or later. Works with .docx files only.)

Excel Support (Office 2007 format or later. Works with .xlsx files only.)

  ScribeDocLoad[Container or URL: Documents::myDocument]
 

PDF Support

• PDFPageCount - The number of pages.
• PDFTitle - The document's title.
• PDFAuthor - The name of the person who created the document.
• PDFSubject - The Subject of the document.
• PDFKeywords - Keywords associated with the document.
• PDFCreator - The name of the application that created the document.
• PDFProducer - If the document was converted to PDF from another format, the name of the application that converted it to PDF.
• PDFCreationDate - The date and time the document was created, in human-readable form.
• PDFModDate - The date and time the document was most recently modified, in human-readable form.
• PDFImageCount - The Number of images in the PDF.
• PDFImage[n] - The nth image in the PDF file.
• PDFMetadata - The XMP metadata associated with this PDF, if applicable.
• PDFAttachmentNames - A return-separated list of attachments in the PDF.
• PDFAttachment - A single attachment. You must pass in a 'filename' parameter indicating the name of the attachment you want.

Word Support (Office 2007 format or later. Works with .doc and .docx files.)

     ScribeDocReadValue("Table1!C15")
 

Excel Support (Office 2007 format or later)

To specify a sheet other than the first sheet, include the sheet name followed by an exclamation point, e.g. "Sheet 2!BB42".

ScribeDocReadValue("A1:C15" ; "fieldSeparator=|")

ScribeDocReadValue("MaxRow()" ; "worksheet=Second Sheet" )

Set Variable[$c3Formula; Value: ScribeDocReadValue( "C3" ; "formula" )] // SUM(A1,B1)
     

Set Variable[$c3Comment; Value: ScribeDocReadValue( "C3" ; "commentText" )]
     

Set Variable[$c3BackgroundColor; Value: ScribeDocReadValue( "C3" ; "background" )]
     # $c3BackgroundColor is a numeric color value, we can use it to style some text
     TextColor ( myTable::sampleField ; $c3BackgroundColor )
     

XML Support

The newName parameter tells Scribe what to name the container field value. This can take two forms:

• It can be empty, like this: ScribeDocSaveContainer(""). That tells Scribe to keep the original filename.
• It can be just a filename, like this: ScribeDocSaveContainer("MyNewFile.doc"). That tells Scribe to return a container field with this new filename.

The optional flatten parameter can be used with PDF forms to save a "flattened" version of the form, this would make the form fields unenterable.

The optional type parameter can be set to "file" to explicitly save a file container instead of an image.

PDF Password support (new in Scribe 2.0), pass a "password" parameter to password-protect the saved PDF. You can optionally specify separate "userPassword" and "ownerPassword" parameters.

For example, if you've done a find and replace operation on a Word document and would like to store it into a container field called 'ResultContainer' while retaining the original filename, you would do it this way:

 Set Field[ Results::ResultContainer; ScribeDocSaveContainer("") ]
 

The path parameter tells Scribe where to save the file to. This can take several forms:

• It can be empty, like this: ScribeDocSaveFile(""). That tells Scribe to save the modified file into a temporary directory, keeping the original filename.
• It can be just a filename, like this: ScribeDocSaveFile("MyNewFile.doc"). That tells Scribe to save the modified file into a temporary directory, with a new filename.
• It can be just a directory, like this: ScribeDocSaveFile( Get (DesktopPath) ). That tells Scribe to save the modified file into the specified directory, keeping the original filename.
• It can be a full path with a filename, like this: ScribeDocSaveFile( Get(DesktopPath) & "MyNewFile.doc" ). That tells Scribe to save the modified file into the specified directory with a new filename.

The optional flatten parameter can be used with PDF forms to save a "flattened" version of the form, this would make the form fields unenterable.

PDF Password support (new in Scribe 2.0), pass a "password" parameter to password-protect the saved PDF. You can optionally specify separate "userPassword" and "ownerPassword" parameters.

 Set Variable[$save; Value: ScribeDocSaveFile("";"password=myPassword123")]//saves the pdf with original file name and a password
 

This can be used with the 'Insert File' script step to insert the file into a container field in FileMaker.You can also save directly to a container field using ScribeDocSaveContainer

 Set Variable[$save; Value: ScribeDocSaveFile("";"password=myPassword123")]
 Insert File[Insert;myTable::myDocument;$save]//inserts file at path in $save into myDocument container field
 

// * Word documents support image replacement in Scribe 2.0, you can pass a container as the replaceValue, and an image will be inserted into your Word document. // *

Image Support in Microsoft Word Files

Word documents support image replacement in Scribe 2.0. Pass a container as the replaceText to add it to the Word document.

ScribeDocSubstitute("placeholderHere" ; myTable::myContainer )

To use this, you must first load a document using ScribeDocLoad.

Note: ScribeDocSubstitute does not support container data stored as reference. Containers must be stored either internally or externally.

Saving the File

To use this, you must first load a document using ScribeDocLoad.

PDF Support

To write XMP metadata to a PDF, use the PDFMetadata key, and pass in the XMP xml you wish to write (read this using ScribeDocReadValue

To write attachments to a PDF, use the PDFAttachment key, and pass in a container to attach to the file. Existing attachments with matching names will be replaced, otherwise a new attachment will be added to the PDF.

Word Support

Alternatively, Scribe also supports using placeholders in your template to replace with text. See the ScribeDocSubstitute function for details on how to do this.

Table Support in Microsoft Word Files

Use excel-style syntax to refer to table cells in a word document. For example, to write a value to the 3rd row, 4th column of the first table in a Word document:

     ScribeDocWriteValue("Table1!D3", "This is a table cell")
 

Writing to non-existent table cells will create new rows/columns as needed, copying cell styles from preceding cells.

Image Support in Microsoft Word Files

Use ScribeDocSubstitute or ScribeDocAppend to add images to a Word document.

Excel Support

The second parameter can be text or an image in a container field. Images will be placed so the top-left corner of the image is in the cell indicated by the name parameter.

To specify a sheet other than the first sheet, include the sheet name followed by an exclamation point, e.g. "Sheet 2!BB42".

Writing a value to a non-existent sheet will generate an error. If you specify a non-existent cell or row, it will be created.

     ScribeDocWriteValue("C3" ; "=SUM(A1,B1)" )
 

 ScribeDocWriteValue("1"; MyTable::MyImage;"x=100";"y=200";"width=300";"height=400")
 

XML Support

ScribeDocWriteValue("newPage()" ; "2" )

ScribeDocWriteValue("addImage()" ; my::imageContainer ;"page=2" ;"x=100" ; "y=100" ; "width=300" ;"height=400" )

ScribeDocWriteValue("addText()" ; "Hello, PDF!" ;"page=2" ;  "x=200" ; "y=500" )

Saving the File

Note:

For binary file document formats such as Word, PDF, etc. this attempts to return a human-readable presentation of the document. XML documents are returned as-is. Any unrecognized file will have its raw text contents returned (see optional parameters to customize this).

You can pass in optional additional parameters to customize the behavior of this function. A list of customizations follows:

• onlyKnownTypes=0 or 1. If this is set to 1, then Scribe will return an empty value "" for unknown file types, instead of returning their raw contents. The default is 0.

Here is a list of supported file types for reading text from:

• pdf
• doc, docx
• xls, xlsx
• ppt, pptx
• xml, xsd
• rtf
• htm, html
• JPEG (will read EXIF metadata)
• csv, txt, tab
• msg (Outlook emails)
• pages, key (Apple's Pages and Keynote documents '08 & '09)

 Set Variable [ $newPDF ; ScribeGetPDFAttributes ( myTable::myContainer ) ]
 

Unlike the substitute function, this is case-insensitive by default. The highlightPattern function supports regular expression patterns.

Regular Expression Pattern Processing

Using the flags optional parameter, you may set the following options, each of which influences the way patterns are matched.

caseInsensitive

Enables case-insensitive matching for US-ASCII characters.

multiline

Does not match line-terminating characters. This means that when the input text is a return-separated list, each line is matched independently.

literal

Treats metacharacters like ^ and $ and escape sequences like \t as literals.

includeLineEndings

Matches line-terminating characters, which means that a return-separated list would be treated as a single text block.

ignoreWhitespace

Ignores whitespace characters.

Example

Example of a highlight operation to match the string "file://" at the beginning of each line of a return-separated list.

 Set Field [ Globals::highlighted_text =
     ScribeHighlight(
     "file://temp/doc.txt" & ¶ &
     "file://documents/doc.txt" & ¶ &
     "http://my.site.com/home" & ¶ &
     "ftp://my.ftpsite.com/upload" ;
         "^file://" ;
         "flags=multiline"
     )
 ]
     

Style, color and size

Example

Example of a highlight operation to make any occurrences of "atlanta" blue and bold (the default highlight style is bold, blue text):

 Set Field [ Globals::highlighted_text =
     ScribeHighlight(Documents::body ; "atlanta")
 ]
 

 Set Field [ Globals::highlighted_text =
     ScribeHighlight(
         Documents::body ;
         "[0-9]+" ;
         "colorRGB=" & RGB(0;255;0) ;
         "styles=" + Italic"
     )
 ]
 

Begins an OCR operation on a PDF or image, starting a new job on AWS and returning a jobId which can be used to poll for completion using ScribeOCRFetch.

AWS Setup

Scribe OCR uses Amazon Web Services for OCR analysis. In order to use this, you must create an AWS account and set up a user access key / secret key / permissions. See supporting documentation for more details.

Pricing

Check pricing details for your region for the Detect Document Text API (OCR) service. This is typically around $0.0015 USD per page. At this rate, performing OCR on 1,000 pages will cost $1.50.

After creating a jobId with ScribeOCRBegin, call this function with your jobId to return the OCR results, if they are available.

Blocking vs Non-Blocking

You can specify a timeout in seconds to wait for a job to completion. The default timeout is zero. After timeout seconds have passed and the jobId job is still not finished, the plugin will return "ERROR" and the ScribeLastError will return RESULTS_NOT_READY. You can then try fetching the results again later, or increaising the timeout value. Typically OCR operations finish in under one minute.

Optional Parameters

timeout

Number of seconds to wait for a job to complete. Defaults to 0.

Example of a function to extract a return-separated list of numbers from a string.

 ScribePatternMatchAll("123 and 5321 are open, but 0121 is closed" ; "[0-9]+")
 /* returns the following:
 123
 5321
 0121
 */
 

Regular Expression Pattern Processing

caseInsensitive

Enables case-insensitive matching for US-ASCII characters.

multiline

Does not match line-terminating characters. This means that when the input text is a return-separated list, each line is matched independently.

literal

Treats metacharacters like ^ and $ and escape sequences like \t as literals.

includeLineEndings

Matches line-terminating characters, which means that a return-separated list would be treated as a single text block.

ignoreWhitespace

Ignores whitespace characters.

The default behavior of this function uses the caseInsensitive and includeLineEndings flags, so the following function calls are equivalent:

     ScribePatternMatchAll(
         "Wilhelm¶wilson¶Williams¶Zander" ;
         "wil.*" ;
         "flags=includeLineEndings+caseInsensitive"
     )
     ScribePatternMatchAll(
         "Wilhelm¶wilson¶Williams¶Zander" ;
         "wil.*"
     )
 

Highlighting style is determined by the three optional parameters: colorRGB, styles, and size. Consult the FileMaker TextStyleAdd and TextColor documentation for more details about named Filemaker text styles and colors.

Backreferences can also be used with the regular expression. Replacement text can use dollar sign syntax ($1, $2, etc.) to refer to these groups.

Regular Expression Pattern Processing

Using the flags optional parameter, you may set the following options, each of which influences the way patterns are matched.

caseInsensitive

Enables case-insensitive matching for US-ASCII characters.

multiline

Does not match line-terminating characters. This means that when the input text is a return-separated list, each line is matched independently.

literal

Treats metacharacters like ^ and $ and escape sequences like \t as literals.

includeLineEndings

Matches line-terminating characters, which means that a return-separated list would be treated as a single text block.

ignoreWhitespace

Ignores whitespace characters.

Example of simple replace, converting two or more consecutive line breaks to a single line break:

 ScribePatternReplaceAll(
     "Line one¶Line Two¶¶¶Line Three¶Line Four" ;
     "\n+" ;
     "¶"
 )
 // returns "Line one¶Line Two¶Line Three¶Line Four"
 

Example of a highlighting replace operation, highlighting the literal string "quick" by using styles:

 ScribePatternReplaceAll("The quick brown fox" ;
     "quick" ;
     "quick" ;
     "colorRGB=" & RGB(128 ; 128 ; 255) ;
     "styles=" + Bold
 )
 // returns The quick brown fox
 

ScribeSetErrorCapture(True)

The pageNumbers parameter should be a comma-separated list of page numbers or page number ranges.

Optional Parameters

filename

The name given to the resulting PDF file

filepath

destination folder/path for the resulting file

ownerPassword

The password used to encrypt the PDF file

 Set Variable [ $newPDF ; ScribeSplicePDF (
     myTable::myContainer ; // sourcePDF
     "1, 10, 20-30" ;  // pageNumbers
     "filename=SplicedResult.pdf" // optional filename parameter
 ) ]
 

This will affect all calls to ScribeDifferencesBetween until you quit FileMaker.

The available styles are:

• Plain
• Bold
• Italic
• Underline
• Condense
• Extend
• Strikethrough
• SmallCaps
• Superscript
• Subscript
• Uppercase
• Lowercase
• Titlecase
• WordUnderline
• DoubleUnderline

This will affect all calls to ScribeDifferencesBetween until you quit FileMaker.

This will affect all calls to ScribeDifferencesBetween until you quit FileMaker.