Tenant properties

Tenant properties give you further control over the behavior of your Upchain environment. Many properties impact the behavior of the CAD, Office, and Outlook plugins, while others enable or disable functionality that you may or may not find to be useful to your company and the CAD system you use. Take some time to read through the table of properties below to determine how each one affects your Upchain environment and what it means to change it.

Enable or disable a tenant property

To enable or disable a tenant property:

1. Navigate to Administration > Engineering > Tenant properties.
2. Click Edit.
3. Locate the property you want to enable or disable.
4. Select or deselect the checkbox in the Value column of any properties you want to change.
5. Click Save.

List of tenant properties

Property	Description	Affected Area of Upchain
allow.create.item.for.suppressed.files​	When enabled, an item is created for a suppressed CAD file.	SOLIDWORKS plugin
allow.import.with.missing.files	When enabled, assemblies with missing and/or suppressed files may be registered in Upchain. However, no item is created for the missing or suppressed files in Upchain. When the assembly is downloaded and opened in the CAD Plugin > cBOM view, the files are marked as 'Not loaded'.	All supported CAD plugins (except for Inventor)
autoresolve.cad.anomalies	When enabled, Upchain automatically resolves any unresolved anomalies so that the eBOM matches the cBOM whenever you create items, check in, save, or copy items. Note: The BOM Wizard may not open to show you the resolved anomalies depending on the action you have taken.	All supported CAD plugins
cr.optional.revision.note	When enabled, the revision note is optional on a change request. This means the CR may be started with empty revision notes.	Web
create.cr.skip.verification.is.item.on.project	When enabled, the Upchain CAD plugin bypasses the check to confirm the items belong to the project selected in the context selector when sending them to a change request from the cart. In other words, when this property is enabled, you can release items under a project they do not belong to.	All supported CAD plugins
create.new.item.version.from.release.check​	When enabled, only users that hold a specific role can check out or create new item versions of released items of specified item types. The roles and item types are defined in the tenant property create.new.item.version.from.release.allowed. Note: The tenant property is cached and it may take up to an hour for the value change to apply.	All supported CAD plugins
create.new.item.version.from.release.allowed​	This tenant property becomes editable when its parent property create.new.item.version.from.release.check is enabled. In this text field, you define the roles that can create new versions of released items for the item types you specify. This is specified as follows: Enter the role first, followed by =, then a list of item types separated by a ,. Use a ; to add an additional role and item type combination. For example, Project Manager=Assembly;Lead Mechanical Designer=Purchased Mechanical Part,Purchased Electromechanical Part;Lead Electrical Designer=Purchased Electrical Part,Purchased ElectroMechanical Part. If an item type is not listed, then there are no restrictions for versioning that item type and anyone can version it. Note: The tenant property is cached and it may take up to an hour for the value change to apply.	All supported CAD plugins
custom.create.items	Launches the Project Selection Window during item creation to allow you to choose the exact location within a project where the newly created items will exist. If this setting is disabled, items are created but not associated to any project, and only the item creator can retrieve the items through a search.	All supported CAD plugins
custom.report.BOM.fetch.thumbnails	Adds the thumbnail for each item into the custom BOM reports created for customers. This increases the length of time it takes to generate the report.	Reports
custom.report.BOM.item.limit	Indicates the maximum number of items allowed in the custom BOM reports created for the customer. Enter a number up to 100000. If you have enabled thumbnails to be added into the report, the limit is 40000.	Reports
disable.edit.of.manufacturer.details	When enabled, an item ERP number cannot be edited. If an ERP number exists, the Manufacturer name and Manufacturer item number also cannot be edited.	Web
drawing.create.dwg	When enabled, Upchain automatically generates a DWG translation of the 2D drawing each time a new version of the drawing is created. This property is disabled by default. Note: - Enable this property to enable mapping attributes to your drawing's title block. - Enabling this property might affect check-in performance of larger assemblies with drawings.	All supported CAD plugins, Web
drawing.create.pdf	When enabled, Upchain generates a PDF translation of the 2D drawing every time the drawing is saved or checked in ie. when a new version of the drawing is created. This property is disabled by default. Note: - Enable this property to enable mapping attributes to your drawing's title block. - Enabling this property might affect check-in performance of larger assemblies with drawings.	All supported CAD plugins, Web
drawing.edit	Automatically checks out the drawing when its corresponding model is checked out from the cBOM view. When an item is checked out from the Project BOM or Search, the checkbox to check out the drawing is automatically selected.	All supported CAD plugins
drawing.import	Automatically registers the drawing at the same time as its corresponding model when the drawing has the same file name as the model file name. If the drawing does not have the same file name, it will not be registered at the same time as its model. If this option is disabled, the drawing will not be registered at the same time as its model regardless of its name.	All supported CAD plugins
drawing.populate.title.block.codes	When enabled, this property converts drawing codes found on the DWG and PDF translations of the drawing to their corresponding value upon release of the item. Note: drawing.create.dwg and drawing.create.pdf must also be enabled.	All supported CAD plugins, Web
dwg.write.properties	When enabled, custom properties are written to the DWG file. Note: Enabling this property requires special configurations and is not available by default. Contact Support for more information.	All supported CAD plugins, Web
ebom.part.report	When enabled, the eBOM Part report option is shown in the Reports menu of each item.	Web
enable.bulk.export	Enables the bulk export feature in the BOM section of projects. This tenant property is disabled by default. Note: This functionality includes options that are only possible to use if Upchain is connected to a local GPS (Grid Processing Server).	Web
enable.eDrawings.translations	Generates an eDrawing translation of the model and/or drawing when you single-click the model () or drawing () icon in the BOM table, or select View > Model/Drawing from an item’s menu. This setting can only be enabled or disabled by a Super Administrator and cannot be enabled at the same time as enable.hoops.visualization. In other words, these two settings provide two different options for viewing models and drawings outside of their native application. This setting requires a local GPS (Grid Processing Server) to be connected to create the translations.	Web > All supported CAD types
enable.hoops.visualization	Enables the creation of 3D visualization of the models. Visualization is created during item creation, check ins, and on demand from an item’s menu > Visualization in the BOM table. Open the 3D visualization by double-clicking the model icon. Open the PDF viewer by double-clicking the drawing icon.This setting can only be enabled or disabled by a super administrator and cannot be enabled at the same time as enable.eDrawings.translations. In other words, these two settings provide two different options for viewing models and drawings outside of their native application. This setting uses the cloud GPS (Grid Process Server) to create the visualizations.	Web > All supported CAD types
enable.inforplm.import	When enabled, Upchain reads the BOM structure from the imported InforPLM package. Existing items are pulled in or new items are created to replicate the BOM structure in Upchain.	Web
enable.prioritize.custom.property.over.file.property	When enabled, if a custom property and file property have the same name, Upchain will prioritize the custom property over the file property.	Inventor plugin
create.visualization.on.rootonly.save	Only generates visualization of the item checked in during a root check in. This setting prevents unnecessary load on the system by not sending visualization requests for the child items. This setting requires the parent setting enable.hoops.visualization to be enabled.	All supported CAD plugins
hoops.conversions.import.hidden.objects	When enabled, hidden objects are included when generating the 3D visualization of the model. This setting requires the parent setting enable.hoops.visualization to be enabled.	All supported CAD plugins
enable.manufacturer.on.all.item.types	When enabled, the Manufacturer, Manufacturer Item Number, and Manufacturer Description item attributes are shown and editable for all item types in the BOM table, the item detail view, and the CAD plugin.	Web, All supported CAD plugins
enable.module.ecn	Enables the ability to send items from the Cart in the CAD plugins to a Change Notice (CN) workflow. When disabled, there are no available CN Workflows to send an item to from the Cart. Note: You will still see the option to create a CN from the Web application.	All supported CAD plugins
enable.module.ecr	Enables the ability to send items from the Cart in the CAD plugins to a Change Request (CR) workflow. When disabled, there are no available CR Workflows to send an item to from the Cart. You will still see the option to create a CR from the Web application.	All supported CAD plugins
extract.cad.properties	Extracts all CAD attributes (those not associated to any item attributes) from the CAD files during item creation and subsequent check ins and writes them to the CAD Attributes section in the Item Details tab. You can add additional attributes to the CAD files and these will be written to Upchain during the next check in. These attributes are searchable within the item details CAD attributes tab.	All supported CAD plugins
file.checkout.multiple	Enables the check out boxes beside each item in the cBOM view to be able to check out multiple items at once. When this property is disabled (and edit.first.parent is also disabled), checking out an item from the cBOM view checks out the parent items above the selected item to the top of the tree shown in the cBOM view.	All supported CAD plugins
file.checkout.phantom	When enabled, this property allows the check out of phantom CAD files through the Check Out window when initiated from the Project BOM or Search results. You can always check out a phantom file from the cBOM view.	All supported CAD plugins
file.delete.onsave	Deletes the CAD and drawing files from your home folder after a successful check in. This can help keep your hard drive from filling up.	Catia plugin, Inventor plugin, NX plugin, PTCCreo plugin, Generic plugin
file.permissions.inventor	Updates the read-only/read-write permissions on CAD files when checked in and out. If enabled, files that are checked out become read-write and all others remain read-only to prevent accidental changes. If this property is disabled, all files are read-write regardless of their check out status.	Inventor plugin
file.permissions.nx	Updates the read-only/read-write permissions on CAD files when checked in and out. If enabled, files that are checked out become read-write and all others remain read-only to prevent accidental changes. If this property is disabled, all files are read-write regardless of their check out status.	NX plugin
file.permissions.ptccreo	Updates the read-only/read-write permissions on CAD files when checked in and out. If enabled, files that are checked out become read-write and all others remain read-only to prevent accidental changes. If this property is disabled, all files are read-write regardless of their check out status.	PTCCreo plugin
file.permissions.solidworks	Updates the read-only/read-write permissions on CAD files when checked in and out. If enabled, files that are checked out become read-write and all others remain read-only to prevent accidental changes. If this property is disabled, all files are read-write regardless of their check out status.	SOLIDWORKS plugin
file.save.onrefresh	Changes made to open CAD files and/or drawings are automatically saved to your local computer when the cBOM or eBOM view is refreshed. This setting only saves the files locally and does not prompt the user to rebuild/regenerate the model if one is required.	Catia plugin, SOLIDWORKS plugin, Inventor plugin, PTC Creo plugin, AutoCAD plugin, Generic plugin (for all supported CAD software)
file.version.change.description.mandatory	When enabled, this property forces the BOM Anomaly window to open during every check in to allow the user to enter a change description for every file that was changed. A change description must be entered for every file being checked in before check in can proceed.	All supported CAD plugins
filename.pattern	Use this tenant property to specify how CAD files and their associated drawings will be renamed during item creation. You can enter a combination of the following text: ${originalFilename} - represents the original filename ${sequenceNumber} - an 8-digit sequence that starts at 11000000 ${itemNumber} - the item number ${itemName} - item name (without forbidden characters) ${extension} - the original file extension (for example .prt or .sldprt) The following characters are not permitted: \ / : * ? " < > | All other text in the tenant property field that is not one of the above mentioned five choices or forbidden text is considered fixed text or a delimiter in the filename. For example, if you enter ${itemNumber}.${extension} the files will be renamed to match the item number during item creation and the original file extension is retained.	All supported CAD plugins
phantom.filename.pattern	Use this tenant property to specify how phantom CAD files will be renamed during registration. You can enter the following text: ${originalFilename} - represents the original filename ${sequenceNumber} - an 8-digit sequence that starts at 11000000 ${extension} - the original file extension (for example .prt or .sldprt) The following characters are not permitted: \ / : * ? " < > | All other text in the tenant property field that is not one of the above mentioned three choices or forbidden text is considered fixed text or a delimiter in the filename. Note: If you register a CAD file as a phantom file then the file name follows phantom.filename.pattern. If you subsequently register the phantom file to an item, the file name does not change to match filename.pattern.	All supported CAD plugins
import.from.directory	When enabled, the Import from directory option is available in the CAD Plugins. When disabled, the Import from directory option is not available in the CAD Plugins.	All supported CAD plugins
import.library.parts	Enables you to import toolbox parts into Upchain. Each toolbox part is already associated to a released Purchased Item in Upchain, so when they form part sof an assembly that gets registered into Upchain, Upchain automatically inserts the existing item into the eBOM.	SOLIDWORKS plugin
item.attribute.uppercase	When enabled, the item name, values entered for the Item Name, Item Description, Revision Note, and Manufacturer Item Number attributes are saved as uppercase letters.	All supported CAD plugins, Web
item.description.navigation	When enabled, the item description is shown beside the item in the navigation pane of the BOM section of a project.	Web
item.name.in.translation	- When enabled, translations are named: {ItemNumber}-{MajorRevision}-{MinorRevision}.{ItemVersion}-{ItemName}-{FileName}.{extension} - When disabled, translations are named: {ItemNumber}-{MajorRevision}-{MinorRevision}.{ItemVersion}-{FileName}.{extension}. This is to ensure unique translation file names when items contain more than one drawing. Note: Consider the following before enabling this propery: - Item names are taken from file names during initial registration. - The tenant property filename.pattern changes the file names during initial registration.	Web, All CAD plugins
keep.supplier.info	When enabled and a released item is revisioned then the supplier’s details about the item are automatically added to the revisioned item. Prior to this change, only the item’s list of associated suppliers carried over when a released item is revisioned. If keep.supplier.info is disabled then supplier’s details are excluded for revisioned items.	Web, All CAD plugins
libraries.paths	Allows you to specify the location (local computer or shared drive) from which Upchain reads during item creation. If the file exists in this library, the item is automatically created as a Purchased Mechanical Part with a status of Released. This property can only be edited by Upchain. If you would like to learn more, contact support.	All supported CAD plugins
material.library.name	Specifies the name of the SOLIDWORKS materials library in which Upchain looks when attempting to apply material to a part. When you specify a material in the CAD plugin, Upchain looks for that same material in this specified library and applies it to the part automatically. If the specified material is not part of this library, Upchain does not apply any material to the part.If no library is specified here, Upchain uses the default SOLIDWORKS Materials library.	SOLIDWORKS plugin
material.picklist.visible	When enabled, the item attributes Shape, Material, Heat Treat, and Finish are converted into picklist fields with a fixed set of drop-down options. These fields are cross-dependent and drop-down options are based on what was selected in the previous field. For example, the drop-down options for Material are dependent on what was selected for Shape. Contact support to configure the drop-down options for these fields.	All supported CAD plugins, Web
open.get.latest.versions	When enabled, it ensures Upchain checks if there are newer CAD file versions on the server when opening files from the Project BOM. When disabled, if the CAD files already exist in your home folder (from a previous download), Upchain will not check if there are newer versions and simply open the files from there. This means you could potentially be working with outdated files. A refresh of the cBOM view will show you the files that are outdated.	SOLIDWORKS plugin All CAD plugins
private.floating.items	When enabled, this property hides any item that has no project association ("floating item") from all users except the item creator.	Web, All CAD plugins
redownload.files.to.home.folder	When enabled, an Overwrite option is added to the right-click context menus in the CAD Plugin. Select the Overwrite option to open the Download files window and overwrite the modified file in the home folder, as long as the file is not checked out. In effect, this enables you to revert any changes you may have made to the file.	All CAD plugins
restrict.project.creation	Restricts the creation of a project to Tenant Administrators only.	Web and API
show.attributes.mapping	Enables the property mapping window in the CAD plugin settings. This allows you to preview which CAD attributes are mapped to specific item attributes.	All supported CAD plugins
show.items.from.private.projects.in.search	Enables all relevant items to be included in search results, including those from projects of which the user (who performed the search) is not a team member. The items are listed in the search results, however, the user will not be able to view the details of these items, or edit or copy these items.	All supported CAD plugins, Web
show.new.item.window	Enables the Create New Item window in which you can specify an Item Name, Item Type, and Item Description before the item is created. This behavior is only available for empty assemblies (no child parts or sub-assemblies) and individual parts from the Item View and cBOM View. If this setting is disabled, then the default Item Name, Type, and Description are applied when the item is created.	All supported CAD plugins
supplier.part.bp.enabled	When enabled, suppliers are able to view and manage business processes and tasks assigned to them from the supplier portal.	Web
supplier.unrestricted.gwt.access	When enabled, suppliers have unrestricted access to the Upchain Web app (except the Business processes pages) and not just the Supplier Portal.	Web
task.create	Enables the option to create a project task (that appears in the Gantt chart) for an item from the Assignments tab. Note: You will still be able to create a task from the Project BOM.	All supported CAD plugins