CMIS Export (Export Definition) - Revision history

Dgreenwood: /* Write Mappings for file naming */

2025-05-22T20:27:57Z

Write Mappings for file naming

← Older revision		Revision as of 15:27, 22 May 2025
Line 380:		Line 380:

	To name a file, you will edit the CMIS Repository's "Name" property in the "Write Mappings" editor.		To name a file, you will edit the CMIS Repository's "Name" property in the "Write Mappings" editor.
	# ~~Open~~ the "Write Mappings" editor.		# In a CMIS Export definition, open the "Write Mappings" editor.
			#:*<li class="fyi-bullet"> Write Mappings will not be configurable until a CMIS Repository is selected and an "Object Type" is selected.
	# The Write Mappings editor is a property grid used to map file properties and metadata fields to Grooper '''Data Fields''' or values calculated by code expressions.		# The Write Mappings editor is a property grid used to map file properties and metadata fields to Grooper '''Data Fields''' or values calculated by code expressions.
	#* The CMIS Repository's properties and metadata fields are on the left.		#* The CMIS Repository's properties and metadata fields are on the left.

Dgreenwood: /* How to add "Write Mappings" (general steps) */

2025-05-22T16:21:22Z

How to add "Write Mappings" (general steps)

← Older revision		Revision as of 11:21, 22 May 2025
Line 415:		Line 415:
	=== How to add "Write Mappings" (general steps) ===		=== How to add "Write Mappings" (general steps) ===

	To edit the CMIS Repository's property and metadata field mappings in the "Write Mappings" editor:		To edit the CMIS Repository's property and metadata field mappings, locate the "Write Mappings" in the "Write Mappings" editor:
	# Open the "Write Mappings" editor.		# Open the "Write Mappings" editor.
			#:*<li class="fyi-bullet"> Write Mappings will not be configurable until a CMIS Repository is selected and an "Object Type" is selected.
	# The Write Mappings editor is a property grid used to map file properties and metadata fields to Grooper '''Data Fields''' or values calculated by code expressions.		# The Write Mappings editor is a property grid used to map file properties and metadata fields to Grooper '''Data Fields''' or values calculated by code expressions.
	#* The CMIS Repository's properties and metadata fields are on the left.		#* The CMIS Repository's properties and metadata fields are on the left.

Dgreenwood: /* Mapping Configuration Examples */

2025-05-22T16:18:42Z

Mapping Configuration Examples

← Older revision		Revision as of 11:18, 22 May 2025
Line 573:		Line 573:
	#* The extracted values for the mapped '''Data Fields''' populate the corresponding metadata fields, using the "Purchas Order" metadata template.		#* The extracted values for the mapped '''Data Fields''' populate the corresponding metadata fields, using the "Purchas Order" metadata template.

	<big>Example 3: ~~ApplicationXtender~~</big>		<big>Example 3: AppEnhancer\AppXtender</big>
	# For the CMIS Repository, we've selected our AppXtender '''CMIS Repository'''.		# For the CMIS Repository, we've selected our AppXtender '''CMIS Repository'''.
	# Using the Target Folder property, ensure a folder location is selected.		# Using the Target Folder property, ensure a folder location is selected.

Dgreenwood: /* CMIS Connection considerations */

2025-05-22T16:18:13Z

CMIS Connection considerations

← Older revision		Revision as of 11:18, 22 May 2025
Line 509:		Line 509:
	# Import the Box CMIS Repository. The root of the Box account is imported when the CMIS Repository is created.		# Import the Box CMIS Repository. The root of the Box account is imported when the CMIS Repository is created.

	<big>Example 3: AppXtender (AppEnhancer)</big>		<big>Example 3: AppXtender (Used to connect to AppEnhancer)</big>

	When mapping data over an AppXtender connection, the only thing you really need to worry about is which repository you're connecting to.		When mapping data over an AppXtender connection, the only thing you really need to worry about is which repository you're connecting to.

Dgreenwood: /* Choosing the right Content Type for the Export Behavior */

2025-05-22T16:17:13Z

Choosing the right Content Type for the Export Behavior

← Older revision		Revision as of 11:17, 22 May 2025
Line 603:		Line 603:
	[[File:2021-cmis-export-how-to-data-mapping-field-mapping-23.png]]		[[File:2021-cmis-export-how-to-data-mapping-field-mapping-23.png]]

	=== Choosing the right Content Type for the Export Behavior ===		== Choosing the right Content Type for the Export Behavior ==
	Arguably, the most important part of data mapping a CMIS Export is choosing the right scope for your Export Behavior. A Content Category or Document Type's place in the Content Model hierarchy determines what Data Elements its Data Model inherits. This will determine which Data Fields are available for mapping.		Arguably, the most important part of data mapping a CMIS Export is choosing the right scope for your Export Behavior. A Content Category or Document Type's place in the Content Model hierarchy determines what Data Elements its Data Model inherits. This will determine which Data Fields are available for mapping.

Dgreenwood: /* Advanced CMIS Export: Exporting data using a "mapped export" */

2025-05-22T16:16:57Z

Advanced CMIS Export: Exporting data using a "mapped export"

Show changes

Dgreenwood: /* Write Mappings for file naming */

2025-05-22T16:10:13Z

Write Mappings for file naming

Dgreenwood: /* Write Mappings for file naming */

2025-05-22T16:06:35Z

Write Mappings for file naming

← Older revision		Revision as of 11:06, 22 May 2025
Line 379:		Line 379:
	[https://app.supademo.com/demo/cm90dj3fp19edeyp0izesjwrn Click here for an interactive walkthrough]		[https://app.supademo.com/demo/cm90dj3fp19edeyp0izesjwrn Click here for an interactive walkthrough]

	# ~~Select~~ the Write Mappings ~~property~~.		# Ppen the "Write Mappings" editor.
	# ~~Press the ellipsis button at the end to configure your data mappings.~~		# The Write Mappings editor is a property grid used to map file properties and metadata fields to Grooper '''Data Fields''' or values calculated by code expressions.
	~~# This will bring up the CMIS Export Map window.~~		#* The CMIS Repository's properties and metadata fields are on the left.
	~~# Any property you see here~~ is ~~an editable file metadata~~ property~~. Using these property definitions, we can dictate the exported~~ file's metadata ~~by mapping these properties~~ to Grooper ~~extracted~~ values.		#** Each CMIS Repository has its own set of properties and metadata fields that are able to be mapped in Grooper. These are called "CMIS properties". Which properties and metadata are available is dependent on the CMIS Binding used (Exchange, Box, NTFS, SharePoint etc) and possibly which CMIS Repository was imported (in the case of AppXtender applications).
	#* ~~Depending on the '''~~CMIS ~~Connection~~'s~~''' type (or~~ CMIS ~~Binding), different~~ metadata ~~properties will~~ be ~~editable~~. These are ~~the editable file~~ metadata ~~for~~ the NTFS ~~'''Connection Type'''. You may see more for some connection types. You may see less. You may see a widely different set~~ of ~~available properties~~. However, ~~for ''nearly'' all '''~~CMIS ~~Connection''' types, you~~ will ~~always see~~ a ~~Cmis~~ Name ~~property~~.		#** However, most CMIS Repositories will have a mappable CMIS property that will name the exported file. This is the cmis:name property. Its display name is typically just "Name".
	#* ~~We say "nearly" because the AppXtender connection type is~~ the ~~odd exception~~. ~~It actually does not have~~ a ~~Cmis Name~~ property ~~available for mapping. However, we discuss this further in the [[~~#~~Advanced~~ Data ~~Mapping~~: ~~Exporting Field Data\|next tutorial]].~~		#* Values are mapped using each CMIS property's editor on the right.
	# ~~We can edit~~ the ~~exported files' names, using~~ the ~~Cmis Name~~ property.		# There are two ways to map data from Grooper to a CMIS property:
	~~# Using~~ the ~~dropdown list,~~ you ~~can~~ map ~~a single Grooper extracted value~~ to the ~~file's name~~.		#* ''Selecting Data Fields from a dropdown list:''
	#* ~~Here, you will see any '''~~Data Field'~~'' available to~~ the ~~Export Behavior~~'s ~~'''Content Type''' scope~~. ~~We configured this Export Behavior on our '''Content Model'''. There~~ is ~~only~~ a ~~single '''Data Field''' in its '''Data Model'''~~, the ~~"Document Date" '''~~Data Field~~'''. That's why we see "''Document_Date''" as an option~~. If ~~we chose ''Document_Date'' from this list~~, ~~each file would be named as whatever date was extracted for that '''~~Data Field~~'''~~.		#** Press the hamburger button at the end of the CMIS property to expose the list of available Grooper Data Fields. Select the one you want to map to the CMIS property.
	#* ~~You may be thinking~~ "~~But what about all those other~~ '~~''Data Fields'''? Isn't there~~ a ~~'''~~Data Field~~''' for~~ the ~~invoice number or purchase order? Yes there is, but those are ''out of scope''~~. This ~~is why understanding your '''Data Model''' hierarchy is critical for~~ CMIS ~~Export. If you need~~ to ~~utilize those '''~~Data ~~Elements''' from those child '''Data Models''',~~ you will need to configure ~~Export Behaviors at the appropriate scope. For example, on the "Invoice" and "Purchase Order" '''Document Types''' instead of on their parent '''Content Model'''~~.		#**<li class="attn-bullet"> Make sure the Grooper Data Field's value type matches the CMIS property's value type. If the CMIS property is a string, the Data Field needs to be a string. If the CMIS property is a date, the Data Field needs to be a DateTime field. And so on.
	#* ~~You will also see some mappable expression snippets, like "~~''~~CurrentDocument.ContentTypeName''". Choosing ''CurrentDocument.ContentTypeName'' will name the file after the~~ ''~~'Batch Folder's''' classified '''Document Type'''.~~		#**<li class="fyi-bullet"> There's a shortcut if Grooper Data Field names match the CMIS property names. Right click anywhere in the grid to use the "Auto Map" command. This will automatically map CMIS properties to Grooper Data Fields if their names match (Otherwise you will need to configure each mapping individually).
			#* ''Entering a code expression:''
			#** To enter an expression, expand the CMIS property in the Write Mappings property grid. Then, either enter the expression in the "Expression" property or open the "Expression" editor to enter the expression. Whatever the expression evaluates to will be what Grooper exports.
			#**<li class="attn-bullet"> Make sure the value type the expression evaluates to matches the CMIS property's value type. If the CMIS property is a string, the expression will need to evaluate to a string value. If the CMIS property is a DateTime type, the expression will need to evaluate to a DateTime value. And so on.
			# After you've completed your Write Mappings, press "OK".
	~~You can also map data by crafting~~ an expression~~. This is~~ the ~~route we will take. What if we want to name our documents after ''two or more'' pieces of information Grooper collects? For example, if an invoice is dated 01/30/2021, we want to name~~ the ~~PDF file generated "Invoice - 2021-30-01~~.~~pdf"~~, ~~using both~~ the ~~'''Document Type''' ''and''~~ the ~~collected~~ "~~Document Date~~" ~~value. We can't do that with a simple dropdown. But we can with an expression!~~		# Press "OK" in the Export Definitions to finalize changes to CMIS Export.
			# Press "OK" in the Behaviors editor to finalize changes to the Export Definitions.
	~~# Expand the Cmis Name~~ property.		# Press the "Save" button.
	~~# Select~~ the Expression ~~property~~.
	~~# Press~~ the ~~ellipsis button at the end.~~
	~~# This~~ will ~~bring up an expression editor window~~.
	#* ~~Using this expression editor, you can stitch together a custom file name, using a .NET code snippet.~~
	~~# We've entered the following expression:~~
	#* <~~code>CurrentDocument.ContentTypeName + " - " + Document_Date.ToString(~~"~~yyyy-MM~~-dd"~~)</code~~>
	~~#* This will create file names as described earlier, using~~ the ~~'''Batch Folder~~'s~~''' classified '''Document Type''' and collected "Document Date"~~ value, ~~separated by~~ a ~~hyphen (FYI: That's why~~ the ~~<code>" - "</code> part of~~ the expression ~~is present. You're literally adding the characters in quotes~~ to ~~the file name~~.
	~~#* In other words, an invoice dated 01/30/2021, if exported as a PDF will be named "Invoice - 2021-31-01~~.~~pdf"~~
	# ~~When finished editing the expression~~, press "OK" ~~to save~~.
	# ~~Upon '''~~Export~~''', our files are now named dynamically, according~~ to ~~the expression we configured for the Cmis Name mapping.~~
	~~# Furthermore, note ''all'' files generated by each~~ Export ~~Format will be named the same~~.
	#* We had two Export Formats configured: one PDF Format and one XML Metadata
	~~#* Obviously, the extension will be different, because they are different file types. Just keep~~ in ~~mind,~~ the ~~mapping will apply~~ to ~~multiple files if multiple~~ Export ~~Formats are configured for~~ the ~~same CMIS Export~~.

	{\|class="fyi-box"		{\|class="fyi-box"
Line 415:		Line 402:
	'''FYI'''		'''FYI'''
	\|		\|
			Files are named in CMIS Export by configuring a mapping expression for the "cmis:name" property (The display name for this is usually "Name").

	If you do not edit the "Write Mappings", Grooper will name the file for you.		If you do not edit the "Write Mappings", Grooper will name the file for you.
	* If the Batch Folder has an attachment file, all exported files will be named after the attachment file.		* If the Batch Folder has an attachment file, all exported files will be named after the attachment file.

Dgreenwood: /* The Subfolder Path property */

2025-05-22T14:53:41Z

The Subfolder Path property

← Older revision		Revision as of 09:53, 22 May 2025
Line 350:		Line 350:

	==== The Subfolder Path property ====		==== The Subfolder Path property ====
	Use the "Subfolder Path" property to dynamically place files in subfolders in a CMIS Repository. This can use any combination of a document's data content (Data Field values or other data accessible by expressions), system data, plain text, or anything else a code expression can come up with to traverse a platform's folder structure. If the folder path does not exist, Grooper will create it.		Use the "Subfolder Path" property to dynamically place files into subfolders in a CMIS Repository. This can use any combination of a document's data content (Data Field values or other data accessible by expressions), system data, plain text, or anything else a code expression can come up with to traverse a platform's folder structure. If the folder path does not exist, Grooper will create it.

	[https://app.supademo.com/demo/cm90061zj0w8keyp0ihokqvsd Click here for an interactive walkthrough]		[https://app.supademo.com/demo/cm90061zj0w8keyp0ihokqvsd Click here for an interactive walkthrough]

Dgreenwood: /* The Subfolder Path property */

2025-05-22T14:52:49Z

The Subfolder Path property

← Older revision		Revision as of 09:52, 22 May 2025
Line 350:		Line 350:

	==== The Subfolder Path property ====		==== The Subfolder Path property ====
	Use the "Subfolder Path" property to dynamically place files in subfolders ~~of the "Target Folder" assignment~~. This can use any combination of a document's data content (Data Field values or other data accessible by expressions), system data, plain text, or anything else a code expression can come up with to traverse a platform's folder structure. If the folder path does not exist, Grooper will create it.		Use the "Subfolder Path" property to dynamically place files in subfolders in a CMIS Repository. This can use any combination of a document's data content (Data Field values or other data accessible by expressions), system data, plain text, or anything else a code expression can come up with to traverse a platform's folder structure. If the folder path does not exist, Grooper will create it.

	[https://app.supademo.com/demo/cm90061zj0w8keyp0ihokqvsd Click here for an interactive walkthrough]		[https://app.supademo.com/demo/cm90061zj0w8keyp0ihokqvsd Click here for an interactive walkthrough]

← Older revision		Revision as of 11:10, 22 May 2025
Line 379:		Line 379:
	[https://app.supademo.com/demo/cm90dj3fp19edeyp0izesjwrn Click here for an interactive walkthrough]		[https://app.supademo.com/demo/cm90dj3fp19edeyp0izesjwrn Click here for an interactive walkthrough]

	# ~~Ppen~~ the "Write Mappings" editor.		To name a file, you will edit the CMIS Repository's "Name" property in the "Write Mappings" editor.
			# Open the "Write Mappings" editor.
	# The Write Mappings editor is a property grid used to map file properties and metadata fields to Grooper '''Data Fields''' or values calculated by code expressions.		# The Write Mappings editor is a property grid used to map file properties and metadata fields to Grooper '''Data Fields''' or values calculated by code expressions.
	#* The CMIS Repository's properties and metadata fields are on the left.		#* The CMIS Repository's properties and metadata fields are on the left.
Line 388:		Line 389:
	#* ''Selecting Data Fields from a dropdown list:''		#* ''Selecting Data Fields from a dropdown list:''
	#** Press the hamburger button at the end of the CMIS property to expose the list of available Grooper Data Fields. Select the one you want to map to the CMIS property.		#** Press the hamburger button at the end of the CMIS property to expose the list of available Grooper Data Fields. Select the one you want to map to the CMIS property.
	#**<li class="attn-bullet"> Make sure the Grooper Data Field's value type matches the CMIS property's value type. ~~If the CMIS~~ property is a string~~, the Data Field needs to be a string. If the CMIS property is a date, the Data Field needs to be a DateTime field. And so on.~~		#**<li class="attn-bullet"> Make sure the Grooper Data Field's value type matches the CMIS property's value type. The "Name" property is always a string.
	#**<li class="fyi-bullet"> There's a shortcut if Grooper Data Field names match the CMIS property names. Right click anywhere in the grid to use the "Auto Map" command. This will automatically map CMIS properties to Grooper Data Fields if their names match (Otherwise you will need to configure each mapping individually).
	#* ''Entering a code expression:''		#* ''Entering a code expression:''
	#** To enter an expression, expand the CMIS property in the Write Mappings property grid. Then, either enter the expression in the "Expression" property or open the "Expression" editor to enter the expression. Whatever the expression evaluates to will be what Grooper exports.		#** To enter an expression, expand the CMIS property in the Write Mappings property grid. Then, either enter the expression in the "Expression" property or open the "Expression" editor to enter the expression. Whatever the expression evaluates to will be what Grooper exports.
	#**<li class="attn-bullet"> Make sure the value type the expression evaluates to matches the CMIS property's value type. ~~If the CMIS~~ property is a string~~, the expression will need to evaluate to a string value. If the CMIS property is a DateTime type, the expression will need to evaluate to a DateTime value. And so on~~.		#**<li class="attn-bullet"> Make sure the value type the expression evaluates to matches the CMIS property's value type. The "Name" property is always a string.
	# After you've completed your Write Mappings, press "OK".		# After you've completed your Write Mappings, press "OK".
	# Press "OK" in the Export Definitions to finalize changes to CMIS Export.		# Press "OK" in the Export Definitions to finalize changes to CMIS Export.