KBA-01588: Overview of the CloudStorageConfig Rule Group

Overview:

The CloudStorageConfig rules configure options for cloud drive storage. See also the technical white paper Setup for Cloud Storage Integration.

The CloudStorageConfig rule group is found in the Rules Maintenance tool on the System Admin Dashboard. Each rule in the group consists of a rule name, a filter value (which can be blank) and a result value.


Filter Values:

Any Doc type

The CloudStorageConfig rules accept any Doc type (as defined in the Doc Types tool and appearing on the filter drop-down) as the filter value, except where noted.


Result Values:

Varies

Result values for the CloudStorageConfig rules depend on the rule and are indicated within the description of each rule. Some rules are enabled and disabled through a checkbox in the result value, for example:

KBA Rule Checkboxes


Rules:

CacheDocList 

[V2019+] Specifies (in the result value) whether the cloud engine can cache the list of published documents.  This rule cannot be filtered.

  • unchecked = No (legacy default for V2017 and prior)
  • checked = Yes (default).

CloudPath

Specifies (in the result value) the target folder for documents on the cloud storage provider. You can use either { } or $ placeholders. If the result value begins with a slash (/), it is used as the entire path; otherwise, the result value is added to the end of the project default (if one is specified) or the cloud provider default. The default is $DocTypeName/$Num – $Title/.

  • {0} or $DocTypeName = the site name for the Doc type.
  • {1} or $Num = the document number.  (See also the DocNoPathMask rule below.)
  • {2} or $Title = document title. For Item-driven publishing, $Title becomes the Item description.
  • {3} or $CustName = Project Customer name.
  • {4} or $ProjectID = Project ID (not masked).
  • {5} or $ProjectName = Project name.
  • {6} or $Location = Project location.
  • {7} or $SourceID = Vendor or Source Contact ID. For Item-driven publishing, $SourceID becomes the Item Responsible party.
  • {8} or $SourceCompany = Vendor or Source company. For Item-driven publishing, $SourceCompany becomes the company for the Item Responsible party.
  • {9} or $ItemNum = Item number or SourceItemNumber (See also the SourceItemNumber rule below)
  • {10} or $ItemTitle = Item Description (first 60 characters)
  • {11} or $ItemSpec = Item Spec.
  • {12} or $ItemPara = Item Para.
  • {13} or $ItemType = Item Type Description.
  • {14} or $SitePath = Site Path (for example, try.spitfirepm.com/sfpms)
  • {15} or $HostName = Site Host (for example, try.spitfirepm.com)
  • {16} or $SourceNum = Document Header Source Doc Number

CloudItemPath

Specifies (in the result value) the target folder for published items in the cloud storage provider. You can use the placeholders described under the CloudPath rule (above). The default is $DocTypeName/$Num – $Title/. Use CloudPath for document publishing and CloudItemPath for Item publishing—this distinction allows different defaults that are appropriate for each.

DocNoPathMask

Specifies (in the result value) the mask for formatting the document number to be included in the cloud path. The default is to use the mask (if any) specified by the DocTypeConfig | DocNoMaskName rule.

FNCheckedOut

Specifies (in the result value) how the filename of an sfPMS file is to be modified when it is checked out. Use $FN to include the basic filename in your result (and to support cascading with other FN rules). For example, for the file Tile Sample.pdf, the result value $FN (checked out) would name the file Tile Sample (checked out).pdf when the file is checked out. The default is 0, which means the filename is not changed at all.

FNGenerated

Specifies (in the result value) how the filename of an sfPMS file is to be modified when the file is created from a template. Use $FN to include the basic filename in your result (and to support cascading with other FN rules). For example, for the file From Template.pdf, the result value $FN (output) would name the file From Template (output).pdf. The default is 0, which means the filename is not changed at all.

FNLocked

Specifies (in the result value) how the filename of an sfPMS file is to be modified when the file is locked. Use $FN to include the basic filename in your result (and to support cascading with other FN rules). For example, for the file Tile Sample.pdf, the result value $FN (read-only) would name the file Tile Sample (read-only).pdf. The default is 0, which means the filename is not changed at all.

ForItemsOnly

Specifies (in the result value checkbox) whether attachments on the document not associated with an Item should be ignored. This rule applies only if there are any entries for the cloud-enabled Doc type in the DocItemIsInCloudStorage rule group (see KBA-01443).

  • unchecked = No (default). Attachments on the document are published to the document folder (parent to any Item folders).
  • checked = Yes  Any attachments on the document that are not associated with any item are ignored.

LocationCodeSet

Specifies (in the result value) the code set (as defined in the Code Maintenance tool) that is used to determine the location text for the cloud folder path. In order to determine the specific code in the code set, the characters chosen by the LocationPathFrom, LocationPathLen and LocationPathStart rules (below) are used. The description of the specific code becomes the location. This rule does not accept a filter value. The default is to match the Division ID to the Division Name.

LocationPathFrom

Specifies (in the result value) the data source for deriving the location field for the cloud path. This rule does not accept a filter value. The default is DivisionID. Possible result values are:

  • CUSTOMERID = Customer ID
  • DIVISIONID = Company Division ID
  • PROJECT = Project ID
  • SUBTYPE = Document Header Subtype [V2019+]

LocationPathLen

Specifies (in the result value) the number of characters from the LocationPathFrom source to be used to find the code in the LocationCodeSet rule (above). This rule does not accept a filter value. The default is 99.

LocationPathStart

Specifies (in the result value) the starting point of characters in the LocationPathFrom source to be used to find the code in the LocationCodeSet rule (above). This rule does not accept a filter value. The default is 1.

LockGeneratedFiles

Specifies (in the result value checkbox) whether template-generated files should be locked in the cloud, which means that revisions will be sent, but never updated in sfPMS.

  • unchecked = No (default).
  • checked = Yes.

MaxInboundFileSizeInMB

Specifies (in the result value) the daytime file size limit in MB that cloud sync should download from the cloud.  The default is 360.  Files larger than the limit will be processed only if they are encountered before 8 AM or after 9 PM.

ProjectPathLen

Specifies (in the result value) the number of characters from the Project ID to be included in the cloud path. This rule does not accept a filter value. The default is 32.

ProjectPathMask

Specifies (in the result value) a mask for formatting the selected portion of the Project ID to be included in the cloud path. The mask is applied only to the characters selected by the Start and Len rules. This rule does not accept a filter value.  If your site has defined [custom].cf_MapProjectID(), then the output of that function is used and all the ProjectPath* rules are ignored. There is no default.

ProjectPathStart

Specifies (in the result value) the starting position of the Project ID to be included in the cloud path. This rule does not accept a filter value. The default is 1.

SingleThreadedFolderScans

Specifies (in the result value checkbox) whether the cloud engine should scan folders one at a time on a single thread. This reduces CPU, RAM and bandwidth resource utilization but takes significantly longer because of longer waits for responses from the cloud storage provider.

  • unchecked = No (default).
  • checked = Yes.

SourceItemNumber

Specifies (in the result value) whether the source Item number should replace the Document number when generating the cloud path for the corresponding  type. This rule applies only when the publishing by Item.

  • unchecked = No (default).
  • checked = Yes.

UseCloudCopy

Specifies (in the result value) whether the cloud engine should save bandwidth by making copies of files already in the cloud.

  • unchecked = No.
  • checked = Yes (default).

Additional Comments:

This feature requires additional third party service agreements; see deployment information. Normally, each document is associated with a Cloud Folder.  In some cases, such as the Submittal Item Register, a folder for each item is appropriate.  If there are any entries for the cloud-enabled Doc type in the DocItemIsInCloudStorage rule group (see KBA-01443), then that Doc type will have Item-driven publishing. Also note that for Item-driven publishing:

  • $SourceID = the Item responsible party.
  • $SourceCompany = the Item responsible party.

KBA-01588; Last updated: April 2, 2019 at 12:00 pm green text = new