SharePoint component RRTs

Component RRT ID

The RRT ID for this component is SPF.

Reserved Replacement Tag Names (RRTN)

The following table describes the reserved RTN values for this component.

Name Description
FileName The original name of the file.
Counter An incremental counter based on the duplicate file names found within a directory. The counter value concatenated with a name provides a unique file name.
FileExt The original file extension.
DocumentURL The path of the document within the server. If the component processes a batch of multiple documents, this RRT is replaced by the path of the first stored document.

This RRT is applicable only for the SharePoint eConnector component and can be used only in the subsequent components.

ListURL URL of the target list. Can be used alone to refer to the list or jointly with the List Item ID to refer to the created item.

This RRT is applicable only for the SharePoint eConnector component and can be used only in the subsequent components.

ListItemId Numeric identifier assigned to the list item stored (or updated) on SharePoint Server. Can be used as a part of a URL to refer to the item.

This RRT is applicable only for the SharePoint eConnector component and can be used only in the subsequent components.

ListItemURL URL of the list item stored in SharePoint. The ~SPF::ListItemURL~ RRT is equivalent to ~SPF::ListURL~~SPF::ListItemId~. The value of this tag is not supposed to be used in a browser address bar. Its purpose is to represent the full path to the item within the server.

This RRT is applicable only for the SharePoint eConnector component and can be used only in the subsequent components.

ListItemDisplayURL URL of the list item stored in SharePoint.

The value of this tag, as opposed to ~SPF::ListItemURL~, is supposed to be used in a browser access bar and represents the full path to the routed list item on the server as it is accessible through the browser.

This RRT is applicable only for the SharePoint eConnector component and can be used only in the subsequent components.

Examples of usage of the above RRTN include:

~SPF::FileName~~SPF::Counter~ is replaced with MyDocument1.

~SPF::DocumentURL~ is replaced with /New_site/Shared Documents/MyDocument.doc.

~SPF::ListURL~ is replaced with http://sp2010/New_site/Lists/Tasks.

~SPF::ListItemId~ is replaced with 26.

~SPF::ListItemURL~ is replaced with http://sp2010/New_site/Lists/Tasks/26_.000.

~SPF::ListItemDisplayURL~ is replaced with http://sp2010/New_site/Lists/Tasks/DispForm.aspx?id=26

~SPF::Counter~

can be used only on the Documents tab in the Rename schema box.

~SPF::DocumentURL~, ~SPF::ListURL~, ~SPF::ListItemId~, and ~SPF::ListItemURL~ cannot be used in the component configuration settings. This is because the numeric identifier is assigned to the list item only after the list item is added or updated on the SP server.

When using SharePoint Process component, do not use ~SPF::DocumentURL~, ~SPF::ListItemURL~, and ~SPF::ListURL~ RRTs in subsequent component rename schemas. This is because the values of those RRTs contain backslashes, and if you choose to use any of those RRTs as part of a Rename Schema, it would create an error because no file name can contain a backslash.

If you use the Overwrite option on the List Item tab for list items and the component updates several list items, then the ~SPF::ListItemURL~ and ~SPF::ListItemId~ will be replaced for the list item with the greatest ID.

Field Replacement Tag Names (FRTN)

This component does not have any FRTNs.

Special Set Replacement Tag Names (SSRTN)

This component supports the Date/Time tag names listed below:

Name Description
%a Abbreviated English weekday name (Sun – Sat)
%A Full English weekday name (Sunday – Saturday)
%b Abbreviated English month name (Jan – Dec)
%B Full English month name (January – December)
%d Day of month as 2-digit decimal number (01 – 31)
%H Hour in 24-hour format (00 – 23)
%I Hour in 12-hour format (01 – 12)
%j Day of year as decimal number (001 – 366)
%m Month as decimal number (01 – 12)
%M Minute as decimal number (00 – 59)
%p Current locale’s A.M./P.M. indicator for 12-hour clock
%S Second as decimal number (00 – 59)
%U Week of year as decimal number, with Sunday as first day of week (00 – 53)
%w Weekday as decimal number (0 – 6; Sunday is 0)
%W Week of year as decimal number, with Monday as first day of week (00 – 53)
%y Year without century, as decimal number (00 – 99)
%Y Year with century, as decimal number
Date and time related RRTs are evaluated in Coordinated Universal Time (UTC) by default. It can be set to use local time, for more details, see Using RRTs.

Examples of usage of the above SSRTN include:

~SPF::%Y~-~SPF::%m~ will be replaced by 2010-05.