Objects and Functions
File Profile
| Type of Object | Name | Description | Used with |
|---|---|---|---|
| File Object | File.Created | The creation time of the file. | Script & Assignments |
| File.Exists | Returns True if the file exists, otherwise false. | Script & Assignments | |
| File.Extension | The extension of the file. | Script & Assignments | |
| File.FullPath | Gets the full path to the processed file. | Script & Assignments | |
| File.GetPath | Gets the folder name from file ascending. For example, GetPath(0) would return Folder2 for "C:/Folder1/Folder2/File.txt". | Script & Assignments | |
| File.GetPathFromRoot | Gets the folder name from the root descending. For example, GetPathFromRoot(0) would return Folder1 for "C:/Folder1/Folder2/File.txt". | Script & Assignments | |
| File.Modified | The last time the file was modified. | Script & Assignments | |
| File.Name | The full name of the file. To extract part of a file name, e.g. the characters 2 to 6 use Mid(File.Name,2,5). | Script & Assignments | |
| File.Size | The size of the file in bytes. | ||
| File.Title | The title of the file. (e.g: test.docx -> test). | ||
| Index Data Object | ExecuteProfile | This function executes a File indexing profile given the indexing profile id and the filepath to the file. Usually used with an e-mail indexing profile, where we can get index data from an attachment too. (e.g PDF attachment). | Script |
| GetField | Gets the current index data value of the specified field. | Script | |
| SetCategory | Gets the category for the current document. You can use an integer (category ID) or a string (category name). | Script | |
| SetField | Sets the value of the index data field. | Script | |
| SetCaseNo | Sets the CaseNo for this Index Data object. | Script | |
| SetCaseDef | Initializes this index data object, with a case definition. Do not use this directly on the predefined IndexData object (the predefined object is used when you don’t write an object name in front of the function call). This should be used in conjunction with CreateThereforeObject. | Script | |
| CreateCase | Use this after you have initialized the index data object with a case definition and after all mandatory fields are filled in. Do not use this directly on the predefined IndexData object (the predefined object is used when you don’t write an object name in front of the function call). This should be used in conjunction with CreateThereforeObject. | Script | |
| Profile Object | AddNewKeyword | With this function you can add a new keyword to an already existing keyword dictionary. | Script |
| FilesToSave | Sets the files that should be saved with this document. | Script | |
| NotApplicable | Call this function if you want to abort the indexing profile execution. | Script | |
| ReadPart | Reads a part of the text, specified with a mask. For example to extract 1234 from PO:1234 use: ReadPart (Extract("ExtractedStringName"), "PO*:?"). The "*" represents 'any text' and the "?" represents the section to be extracted. | Script & Assignments | |
| ScriptError | Stops the execution of the script and throws an error with the specified text. | Script | |
| ToDate | Converts a string in the specified format to a date. This is needed, for example, when the date on imported documents is in a different format to the system. Use "D", "M", "Y" for day, month, year respectively. Delimiters are interpreted strictly, for example "D-M-Y" the delimiter must be "-" in this case. To represent any delimiter use "~". | Script & Assignments | |
| ToFloat | Converts a string in the specified format to a float number. This is needed, for example, when the money format on imported documents is in a different format to the system. | Script & Assignments | |
| CreateThereforeObject |
This function will create a new Therefore object. As parameter, an array is expected. The first element in the array should always be a string with the object name you want to create. Currently this can be used to create an Index data object. Note: If you use the scripting help dialog, it will insert a predefined CreateThereforeObject call. |
Script | |
| Data Extractor Object (PDF) | Extract | Gets the value of the defined item name. | Script & Assignments |
| ExtractList | Gets the vale of the defined item name on all pages of the PDF (only applicable if the item name was defined with Page set to "All pages") | Script & Assignments | |
| GetFormField | Gets the value of the PDF form field. | Script & Assignments | |
| SetErrorOnMissingTag | If set to True, the extract functions will throw an error if the item name is not found. Otherwise the Extract function will return empty. | Script | |
| PDF Document Properties | GetAuthor | Gets the Author. | Script & Assignments |
| GetCreationDate | Gets the creation date. | Script & Assignments | |
| GetCreator | Generally gets the application that created the PDF. | Script & Assignments | |
| GetCustomProperty | Gets a custom property from the PDF. e.g GetCustomProperty("MyProp"). | Script & Assignments | |
| GetKeywords | Gets the keywords associated with the PDF. | Script & Assignments | |
| GetModificationDate | Gets the last modification date. | Script & Assignments | |
| GetProducer | Gets the PDF Producer. | Script & Assignments | |
| GetSubject | Gets the PDF Subject. | Script & Assignments | |
| GetTitle | Gets the PDF Title. | Script & Assignments | |
| Data Extractor Object (XML) | Extract | Gets the value of the first tag found. (e.g. Extract("ExampleTag") will extract the value of the first tag with name "ExampleTag"). | Script & Assignments |
| ExtractAttribute | Gets the value of the specified attribute of the specified tag. (e.g. ExtractAttribute("ExampleTag", "att1") will extract the attribute: att1 from the first tag with name "ExampleTag". | Script & Assignments | |
| ExtractList | Gets the value of each tag. (e.g. ExtractList("ExampleTag") will extract the values from all tags with name "ExampleTag"). | Script & Assignments | |
| ExtractListAttribute | Gets the value of each attribute in the specified tag. (e.g. ExtractListAttribute("ExampleTag", "att1") will extract the attribute: att1 from all the tags with name "ExampleTag". | Script & Assignments | |
| ExtractListTable | Similar to ExtractList but ensures that any empty rows in a table are retained. Hence the table tag must be specified. (e.g. ExtractListAttribute("TagName", "TableTag") . | Script & Assignments | |
| ExtractListXPath | Can be used to execute an XPath query on the XML document. | Script & Assignments | |
| Count | Gets the count of nodes from the XPath query. | Script & Assignments | |
| SetErrorOnMissingTag | If set to true, every Extract function will throw an error if the specified tag was not found. Otherwise the Extract function will return "empty". Default is set to false. | Script | |
| Data Extractor Object (Text-Line/Text-Page) | Extract | Gets the value of the defined item name. | Script & Assignments |
| ExtractList | Gets the vale of the defined item name on all pages of the text file (only applicable if the item name was defined with Page set to "All pages"). | Script & Assignments |
Profiles for Microsoft Office
| Type of Object | Name | Description | Used with |
|---|---|---|---|
| Index Data Object | ExecuteProfile | This function executes a File indexing profile given the indexing profile id and the filepath to the file. Usually used with an e-mail indexing profile, where we can get index data from an attachment too. (e.g PDF attachment). | Script |
| GetField | Gets the current index data value of the specified field. | Script | |
| SetCategory | Gets the category for the current document. You can use an integer (category ID) or a string (category name). | Script | |
| SetField | Sets the value of the index data field. | Script | |
| SetCaseNo | Sets the CaseNo for this Index Data object. | Script | |
| SetCaseDef | Initializes this index data object, with a case definition. Do not use this on the predfined IndexData object (the predefined object is used when you don’t write an object name in front of the function call). This should be used in conjunction with CreateThereforeObject. | Script | |
| CreateCase | Use this after you have initialized the index data object with a case definition and after all mandatory fields are filled in. Do not use this directly on the predefined IndexData object (the predefined object is used when you don’t write an object name in front of the function call). This should be used in conjunction with CreateThereforeObject. | Script | |
| Profile Object | AddNewKeyword | With this function you can add a new keyword to an already existing keyword dictionary. | Script |
| FilesToSave | Sets the files that should be saved with this document. | Script | |
| NotApplicable | Call this function if you want to abort the indexing profile execution. | Script | |
| ReadPart | Reads a part of the text, specified with a mask. For example to extract 1234 from PO:1234 use: ReadPart (Extract("ExtractedStringName"), "PO*:?"). The "*" represents 'any text' and the "?" represents the section to be extracted. | Script & Assignments | |
| ScriptError | Stops the execution of the script and throws an error with the specified text. | Script | |
| ToDate | Converts a string in the specified format to a date. This is needed, for example, when the date on imported documents is in a different format to the system. Use "D", "M", "Y" for day, month, year respectively. Delimiters are interpreted strictly, for example "D-M-Y" the delimiter must be "-" in this case. To represent any delimiter use "~". | Script & Assignments | |
| ToFloat | Converts a string in the specified format to a float number. This is needed, for example, when the money format on imported documents is in a different format to the system. | Script & Assignments | |
| CreateThereforeObject | This function will create a new Therefore object. As parameter, an array is expected. The first element in the array should always be a string with the object name you want to create. Currently this can be used to create an Index data object. Note: If you use the scripting help dialog, it will insert a predefined CreateThereforeObject call. |
Script | |
| Microsoft Word Object | Filename | Gets the file name of the file. | Script & Assignments |
| GetControl | Gets the content of an content control. | Script & Assignments | |
| GetFormField | Gets the content of a form field. | Script & Assignments | |
| GetProperty | Gets the content of a document property. | Script & Assignments | |
| Template | Gets the name of the template used for the document. | Script & Assignments | |
| Microsoft Excel Object | Filename | Gets the file name of the file. | Script & Assignments |
| GetCell | Gets the value of the specified cell. | Script & Assignments | |
| GetCells | Gets the value of each cell in the specified range. | Script & Assignments | |
| GetProperty | Gets the content of a document property. | Script & Assignments | |
| Microsoft Office Object | Filename | Gets the file name of the file. | Script & Assignments |
| GetProperty | Gets the content of a document property. | Script & Assignments |
E-mail Profile
| Type of Object | Name | Description | Used with |
|---|---|---|---|
| Index Data Object | ExecuteProfile | This function executes a File indexing profile given the indexing profile id and the filepath to the file. Usually used with an e-mail indexing profile, where we can get index data from an attachment too. (e.g PDF attachment). | Script |
| GetField | Gets the current index data value of the specified field. | Script | |
| SetCategory | Gets the category for the current document. You can use an integer (category ID) or a string (category name). | Script | |
| SetField | Sets the value of the index data field. | Script | |
| SetCaseNo | Sets the CaseNo for this Index Data object. | Script | |
| SetCaseDef | Initializes this index data object, with a case definition. Do not use this directly on the predefined IndexData object (the predefined object is used when you don’t write an object name in front of the function call). This should be used in conjunction with CreateThereforeObject. | Script | |
| CreateCase | Use this after you have initialized the index data object with a case definition and after all mandatory fields are filled in. Do not use this directly on the predefined IndexData object (the predefined object is used when you don’t write an object name in front of the function call). This should be used in conjunction with CreateThereforeObject. | Script | |
| Profile Object | AddNewKeyword | With this function you can add a new keyword to an already existing keyword dictionary. | Script |
| FilesToSave | Sets the files that should be saved with this document. | Script | |
| NotApplicable | Call this function if you want to abort the indexing profile execution. | Script | |
| ReadPart | Reads a part of the text, specified with a mask. For example to extract 1234 from PO:1234 use: ReadPart (Extract("ExtractedStringName"), "PO*:?"). The "*" represents 'any text' and the "?" represents the section to be extracted. | Script & Assignments | |
| ScriptError | Stops the execution of the script and throws an error with the specified text. | Script | |
| ToDate | Converts a string in the specified format to a date. This is needed, for example, when the date on imported documents is in a different format to the system. Use "D", "M", "Y" for day, month, year respectively. Delimiters are interpreted strictly, for example "D-M-Y" the delimiter must be "-" in this case. To represent any delimiter use "~". | Script & Assignments | |
| ToFloat | Converts a string in the specified format to a float number. This is needed, for example, when the money format on imported documents is in a different format to the system. | Script & Assignments | |
| CreateThereforeObject | This function will create a new Therefore object. As parameter, an array is expected. The first element in the array should always be a string with the object name you want to create. Currently this can be used to create an Index data object. Note: If you use the scripting help dialog, it will insert a predefined CreateThereforeObject call. |
Script | |
| Mail Object | AttachmentCount | Gets the number of attachments. | Script & Assignments |
| Body | Gets the body of the e-mail. | Script & Assignments | |
| Categories | In Outlook you can assign categories to an item. The name of the categories assigned to the saved item, can now be retrieved via a script function. Note: this is not supported with the Therefore™ Mail monitoring feature. | Script & Assignments | |
| CC (Display Name) | Gets the display names of the cc recipients of the e-mail. | Script & Assignments | |
| CC (SMTP Address) | Gets the smtp addresses of the cc recipients of the e-mail. | Script & Assignments | |
| From (Display Name) | Gets the display name of sender of the e-mail. | Script & Assignments | |
| From (SMTP Address) | Gets the smtp address of sender of the e-mail. | Script & Assignments | |
| GetAttachments | Gets the attachments of the e-mail (full path file names). | Script & Assignments | |
| MessageId | Gets the unique Message-ID of the e-mail. | Script & Assignments | |
| References | Returns an array of Message-IDs of the referencing e-mails. | Script & Assignments | |
| Sent | Gets the date the e-mail was sent on. | Script & Assignments | |
| Size | Gets the size of the e-mail. | Script & Assignments | |
| To (Display Name) | Gets the display names of the recipients of the e-mail. | Script & Assignments | |
| To (SMTP Address) | Gets the SMTP Addresses of the recipients of the e-mail. | Script & Assignments | |
| Subject | Gets the Subject of the e-mail. | Script & Assignments |
Signed Document Profile
| Type of Object | Name | Description | Used with |
|---|---|---|---|
| File Object | File.Created | The creation time of the file. | Script & Assignments |
| File.Exists | Returns True if the file exists, otherwise false. | Script & Assignments | |
| File.Extension | The extension of the file. | Script & Assignments | |
| File.FullPath | Gets the full path to the processed file. | Script & Assignments | |
| File.GetPath | Gets the folder name from file ascending. For example, GetPath(0) would return Folder2 for "C:/Folder1/Folder2/File.txt". | Script & Assignments | |
| File.GetPathFromRoot | Gets the folder name from the root descending. For example, GetPathFromRoot(0) would return Folder1 for "C:/Folder1/Folder2/File.txt". | Script & Assignments | |
| File.Modified | The last time the file was modified. | Script & Assignments | |
| File.Name | The full name of the file. To extract part of a file name, e.g. the characters 2 to 6 use Mid(File.Name,2,5). | Script & Assignments | |
| File.Size | The size of the file in bytes. | Script & Assignments | |
| File.Title | The title of the file. (e.g: test.docx -> test). | Script & Assignments | |
| Index Data Object | ExecuteProfile | This function executes a File indexing profile given the indexing profile id and the filepath to the file. Usually used with an e-mail indexing profile, where we can get index data from an attachment too. (e.g PDF attachment). | Script |
| GetField | Gets the current index data value of the specified field. | Script | |
| SetCategory | Gets the category for the current document. You can use an integer (category ID) or a string (category name). | Script | |
| SetField | Sets the value of the index data field. | Script | |
| SetCaseNo | Sets the CaseNo for this Index Data object. | Script | |
| SetCaseDef | Initializes this index data object, with a case definition. Do not use this directly on the predefined IndexData object (the predefined object is used when you don’t write an object name in front of the function call). This should be used in conjunction with CreateThereforeObject. | Script | |
| CreateCase | Use this after you have initialized the index data object with a case definition and after all mandatory fields are filled in. Do not use this directly on the predefined IndexData object (the predefined object is used when you don’t write an object name in front of the function call). This should be used in conjunction with CreateThereforeObject. | Script | |
| Profile Object | AddNewKeyword | With this function you can add a new keyword to an already existing keyword dictionary. | Script |
| FilesToSave | Sets the files that should be saved with this document. | Script | |
| NotApplicable | Call this function if you want to abort the indexing profile execution. | Script | |
| ReadPart | Reads a part of the text, specified with a mask. For example to extract 1234 from PO:1234 use: ReadPart (Extract("ExtractedStringName"), "PO*:?"). The "*" represents 'any text' and the "?" represents the section to be extracted. | Script & Assignments | |
| ScriptError | Stops the execution of the script and throws an error with the specified text. | Script | |
| ToDate | Converts a string in the specified format to a date. This is needed, for example, when the date on imported documents is in a different format to the system. Use "D", "M", "Y" for day, month, year respectively. Delimiters are interpreted strictly, for example "D-M-Y" the delimiter must be "-" in this case. To represent any delimiter use "~". | Script & Assignments | |
| ToFloat | Converts a string in the specified format to a float number. This is needed, for example, when the money format on imported documents is in a different format to the system. | Script & Assignments | |
| CreateThereforeObject |
This function will create a new Therefore object. As parameter, an array is expected. The first element in the array should always be a string with the object name you want to create. Currently this can be used to create an Index data object. Note: If you use the scripting help dialog, it will insert a predefined CreateThereforeObject call. |
Script | |
| Data Extractor Object (PDF) | Extract | Gets the value of the defined item name. | Script & Assignments |
| ExtractList | Gets the vale of the defined item name on all pages of the PDF (only applicable if the item name was defined with Page set to "All pages"). | Script & Assignments | |
| GetFormField | Gets the value of the PDF form field . | Script & Assignments | |
| SetErrorOnMissingTag | If set to True, the extract functions will throw an error if the item name is not found. Otherwise the Extract function will return empty. | Script | |
| PDF Document Properties | GetAuthor | Gets the Author . | Script & Assignments |
| GetCreationDate | Gets the creation date | Script & Assignments | |
| GetCreator | Generally gets the application that created the PDF | Script & Assignments | |
| GetCustomProperty | Gets a custom property from the PDF. e.g GetCustomProperty("MyProp") | Script & Assignments | |
| GetKeywords | Gets the keywords associated with the PDF | Script & Assignments | |
| GetModificationDate | Gets the last modification date | Script & Assignments | |
| GetProducer | Gets the PDF Producer | Script & Assignments | |
| GetSubject | Gets the PDF Subject | Script & Assignments | |
| GetTitle | Gets the PDF Title | Script & Assignments | |
| Data Extractor Object (XML) | Extract | Gets the value of the first tag found. (e.g. Extract("ExampleTag") will extract the value of the first tag with name "ExampleTag"). | Script & Assignments |
| ExtractAttribute | Gets the value of the specified attribute of the specified tag. (e.g. ExtractAttribute("ExampleTag", "att1") will extract the attribute: att1 from the first tag with name "ExampleTag". | Script & Assignments | |
| ExtractList | Gets the value of each tag. (e.g. ExtractList("ExampleTag") will extract the values from all tags with name "ExampleTag"). | Script & Assignments | |
| ExtractListAttribute | Gets the value of each attribute in the specified tag. (e.g. ExtractListAttribute("ExampleTag", "att1") will extract the attribute: att1 from all the tags with name "ExampleTag". | Script & Assignments | |
| ExtractListTable | Similar to ExtractList but ensures that any empty rows in a table are retained. Hence the table tag must be specified. (e.g. ExtractListAttribute("TagName", "TableTag") | Script & Assignments | |
| ExtractListXPath | Can be used to execute an XPath query on the XML document. | Script & Assignments | |
| Count | Gets the count of nodes from the XPath query. | Script & Assignments | |
| SetErrorOnMissingTag | If set to true, every Extract function will throw an error if the specified tag was not found. Otherwise the Extract function will return "empty". Default is set to false. | Script | |
| Data Extractor Object (Text-Line/Text-Page) | Extract | Gets the value of the defined item name. | Script & Assignments |
| ExtractList | Gets the vale of the defined item name on all pages of the text file (only applicable if the item name was defined with Page set to "All pages"). | Script & Assignments |