Skip to content

Commit

Permalink
Added basic preamble descriptions where missing
Browse files Browse the repository at this point in the history
  • Loading branch information
JuicyDragon committed Jul 30, 2019
1 parent d53972c commit 60aa9bb
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 0 deletions.
4 changes: 4 additions & 0 deletions WSS_FilterOnCommunicationDateYear.rb
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@
Visit GitHub for more examples: https://github.com/Nuix/Worker-Side-Script-Examples
This WSS demonstrates filtering items based on whether the year portion of a given item's
communication date falls within a specified range. Items without a Communication object
pass through as normal.
=end

$min_year = 2001
Expand Down
10 changes: 10 additions & 0 deletions WSS_ModifyCommunication.rb
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,16 @@
Visit GitHub for more examples: https://github.com/Nuix/Worker-Side-Script-Examples
This WSS demonstrates customizing the Communication object of an item being processed. This
script defines 2 classes:
- SimpleAddress: A Ruby class implementing the Nuix interface Address (https://download.nuix.com/releases/desktop/stable/docs/en/scripting/api/nuix/Address.html)
- SimpleCommunication: A Ruby class implementing the Nuix interface Communication (https://download.nuix.com/releases/desktop/stable/docs/en/scripting/api/nuix/Communication.html)
We use these 2 classes to then build a customized communication object and ultimately provide that back to Nuix
using the method WorkerItem.setItemCommunication which will replace any communication originally present
on the item with the one we created.
=end

java_import 'nuix.Address'
Expand Down
4 changes: 4 additions & 0 deletions WSS_PdfPagesAsChildPdfItems.rb
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@
Visit GitHub for more examples: https://github.com/Nuix/Worker-Side-Script-Examples
This WSS demonstrates detecting a PDF item being processed, breaking that PDF into a series of
single page PDF files and then adding those single page PDF files as children to the originating
PDF.
=end

java_import java.io.FileOutputStream
Expand Down
3 changes: 3 additions & 0 deletions WSS_StoreBinaryWhenAncestorMimeTypeMatchesList.rb
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@
Visit GitHub for more examples: https://github.com/Nuix/Worker-Side-Script-Examples
This WSS demonstrates selectively storing item binaries based on whether they have an
ancestor items which has a mime type specified in a list of mime types.
=end

# Provide a list of ancestor mime types for which
Expand Down
3 changes: 3 additions & 0 deletions WSS_TagByMimeType.rb
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@
Visit GitHub for more examples: https://github.com/Nuix/Worker-Side-Script-Examples
This WSS demonstrates tagging items based on their mime type. The mime types and associated tags assigned
to them is determined by listing each mime type and associated tag in the Hash $mime_type_tags.
=end

# Hash of mime types and the tag to apply to each
Expand Down

0 comments on commit 60aa9bb

Please sign in to comment.