emxComponents.properties

The properties in this table can be edited to configure the ENOVIA Business Process Services applications for your business processes.

Related Function Property Name
Allowed Values Description
Check in 
emxComponents.PoliciesList = 
policy_Document,policy_DataDocument,policy_DocumentSheet
Symbolic name of any policy that supports files. Default is shown. Defines the policies users can choose from when checking in a file. 
emxComponents.MultiFileUpload.NoOfFiles = 5
Positive integer.

Default is 5.

 Defines the number of files users can specify when checking in files. 
emxComponents.DocumentNameDelimiter=-
  Default is the hyphen. Defines the delimiter used in the document name.
Document 
emxComponents.CreateDocument.ExcludeAttributeList=attribute_DesignatedUser,attribute_Originator,attribute_Language,attribute_FileVersion,attribute_Version,attribute_VersionDate,attribute_Approver,attribute_ICURL
Property name shows the default list. Defines the list of attributes for the document that do not display in the Create Document form. 
emxComponents.CommonDocument.DocumentFileRequired=false

  • true (default). Users must check in a file when a Document object is created.
  • false. Users can create a Document object without checking in a file at the same. time.
 Defines whether a Document object can be created without checking in a file at the same time. 
emxComponents.AllowChangePolicy=true

  • true (default). Users can select alternative policies for documents.
  • false. Only the defined policy can be used.
 Defines whether the policy can be changed for Documents. 
emxComponents.DefaultPolicy.type_Document= policy_Document
The symbolic name of the policy. Defines the default policy used for creating Document objects. 
emxComponents.CommonDocument.EnforceAutoNameDuringDocumentClone

  • true. During a document cloning process, the name will be auto-generated as defined by the number generator for the type.
  • false or "" (empty) (default). The name of the object consists of Title + TimeStamp.
 Enforces autonaming of objects during the document cloning process across all applications. To configure a type to use auto-generate for cloned objects, see Setting Auto Generated Name Feature for Cloned Objects.
Route 
emxFramework.Routes.RouteVisibility = true

  • true (default). Routes are listed for the route owner and all members
  • false. Routes are listed only for the route owner
 Defines whether routes are listed on the Routes summary pages for route members. 
emxComponents.RouteDefaultAction=Approve

  • Approve (default)
  • Comment
  • Notify
 Defines the default action for route tasks. The value you enter is automatically entered for a task when a route is created; the route creator can change the value. 
emxComponents.Routes.ShowCommentsForTaskApproval=true

  • true (default). Comment field is available.
  • false. Comment field is not available.
 Defines whether the Comments field is shown for tasks with Approve actions.

Allowing assignees to enter a comment and choose an approval option opens the possibility of a user entering conflicting information. For example, the assignee could choose Approve but enter a negative comment.

 
emxComponents.Routes.ShowAbstainForTaskApproval=true

  • true (default). Abstain is added as a choice in the task approval drop-down list.
  • false. The user cannot select Abstain when approving tasks.
 Defines whether Abstain is displayed as an option for route tasks with Approve actions. 
emxComponents.Routes.DefaultContentType=type_Document
If needed, replace the default, type_Document, with the symbolic name of the needed type. Defines the default business object type to search for when adding content to a route. This value does not prevent other types from being searched for, it just determines the type pre-loaded into the search page. 
emxComponents.Route.AddPeoplePreference = false
 
  • true. the user must enter at least 1 character (in addition to the wildcard) to perform the search.
  • false (default). users can enter the * wildcard by itself in the User Name field of the Add People dialog box.
 Defines whether a user must enter at least 1 character (in addition to the * wildcard) for the User Name when adding people to a route or route template.

If your company has many people defined (thousands), the search could affect performance if using the * wildcard by itself.
Person Profile 
eServiceSuiteComponents.VaultAwareness=false

  • true (default). Uses person's company vault.
  • false. Allows the user to select a vault.
 Defines whether the user can manually select a vault. 
emxComponents.DefaultRoles=role_OrganizationManager;role_Employee;role
_CompanyRepresentative;role_ExchangeUser;
Enter a semicolon-separated list of symbolic names of roles depending on your business requirements. Defines the roles that should be available when a person is added to the applications (when common profile is used). 
emxComponents.EnableLeadRolesForOrganizations=true

  • true (default). People can be marked as having lead roles.
  • false. Lead roles are not used.
 Defines if lead roles are available.

When you enable lead roles for an organization, the Lead Role column displays in the Edit Organizational Roles page and lead Roles column (in the People list for a company).
Pages Pages built using the common frameset, exmCommonFS.jsp, can be configured using properties in emxComponents.properties. For each of these pages, the properties file contains a property that defines the page's heading, buttons, action bars, content URL, page toolbar and pagination options, and help marker. 
eServiceSuiteComponents.PAGE.heading=STRING_RESOURCE_ID

For example, this property defines the heading text for the Discussions Subscription page: 

eServiceSuiteComponents.DiscussionsSubscribe.heading = 
emxComponents.DiscussionsSubscribe.heading
 Defines the heading text for a page.

Set the value for this property depending on your business requirements. The value for the property can be the actual text string or a string resource ID defined in the emxComponentsStringResource.properties files. For internationalization, the value must be a string resource ID.

 
eServiceSuiteComponents.PAGE.buttons =Done,Cancel,Previous,Next

For example, this property defines the buttons for the Discussions Subscription page:

eServiceSuiteComponents.DiscussionsSubscribe.buttons =Done,Cancel
 Defines the buttons that are to be shown in the lower right action bar. Only the standard buttons of Done, Cancel, Previous, and Next are supported. 
eServiceSuiteComponents.PAGE.topLinks= 
eServiceSuiteComponents.PAGE.bottomLinks=

For example, these properties define the links for the top and bottom of the Create Distribution List Step 2 page:

eServiceSuiteComponents.CreateDistributionListStep2.topLinks=AddMember
s

eServiceSuiteComponents.CreateDistributionListStep2.bottomLinks=Remove
Selected
Defines the action links that are to be shown at the top and bottom. 
eServiceSuiteComponents.PAGE.options=false/true|false/true|false/true

For example, this property defines the page tools for the Discussions Subscription page. 

eServiceSuiteComponents.DiscussionsSubscribe.options=false|false|false

true will show the respective icon/control.

Defines whether to display the Printer Friendly tool, Pagination controls (in that order), and Show Conversion tool. By default, only the Help tool displays.

The Printer Friendly and Show Conversion tools are in the page toolbar. The pagination controls are in the lower right side of table pages.

 
eServiceSuiteComponents.PAGE.contentURL=JSP_NAME

For example, this property defines the content URL for the Discussions Subscription page: 

eServiceSuiteComponents.DiscussionsSubscribe.contentURL=emxComponentsCreateSubscriptionsDialog.jsp
 Defines the JSP to call for the page. 
eServiceSuiteComponents.PAGE.help=MARKER
 

For example, this property defines the help marker for the Discussions Subscription page: 

eServiceSuiteComponents.DiscussionsSubscribe.help=emxhelpdiscussionsubscription
 Defines the help marker for the page.

This marker is passed to the help system so the help opens to the topic that explains the page.
Image 
emxComponents.ImageManager.AllowedFormats

For example: 

emxComponents.ImageManager.AllowedFormats=gif,jpg,png,giff,jpeg,3dxml,
cgr,bmp,psd,ai,svg
 Defines the allowable image formats system-wide for both 2D and 3D files.

The default Java image utility supports these formats: gif, giff, jpg, jpeg, and png. ENOVIA also supports svg vector graphic format on Windows-based servers. This property may be changed according to the utility tool used to generate thumbnails and different sized images.

The image utility does not support the PDF format. 

emxComponents.ImageManager.ImageUtility.Directory

You must also specify the name of the image converter using this property: 

emxComponents.ImageManager.ImageUtility.Name

where the value can be either ImageMagick.exe or nConvert.exe. If you do not use one of these utilities, leave the value for this property blank. Use the forward slash as a directory separator.

Defines the directory path where image utility is installed.

If this property is empty, the application will use the Java image utility. To support additional formats, ImageMagick or nConvert can be used (currently the only image utilities supported).

NConvert can be used to covert PDF files, however, Ghost Script must be installed on the system.

To generate thumbnails, you also need to install these third-party plug-ins (for Windows only) in the NConvert plugins folder (default is C:\nConvert\Plugins):


  • cs_svg.dll: converts svg to jpeg. Download from http://www.cadsofttools.com/en/documents/ downloads.html
  • xswf.usr: converts swg to jpeg. Download from http://www.cherubicsoft.com/xnview/.

Internet Explorer users need to install browser plug-ins for viewing SVG files. 

emxComponents.ImageUtility.Transparency.nConvert=false

  • true. Preserves transparency of PNG images.
  • false (default). Transparency, which is not supported by the JPEG format (default for image conversion) is not preserved.
 Enables the transparency of PNG images when using nConvert.

If your system does not use nConvert, this property is ignored.

 
emxComponents.ImageManager.ViewerThumbnailFormat

  • format_mxSmallImage (default)
  • format_mxMediumImage
  • format_mxLargeImage
  • format_mxThumbnailImage

These default values can be changed by editing the mxImageSize administrative property on the Format.

Denifes the symbolic names of the Formats that the generated images are checked into

The default size of these images are:


  • format_mxSmallImage - 64 pixels
  • format_mxMediumImage - 102 pixels
  • format_mxLargeImage - 480 pixels
  • format_mxThumbnailImage - 45 pixels
 
emxComponents.3DXML.AltPath.<symbolic name of object type>

This property value can be empty, and can be a comma-separated list of expressions. For example, the alternate path can be used to get 2D or 3D images from Designer Central added to the part as a specification, not as an image. If a subtype is not defined, the parent type will be used.

 Defines the full path expression to find an object that contains images external to the Image Holder object (an alternate path to the image). 
emxComponents.3DXML.AltPath3DXMLFormat.<symbolic name of the Admin type>
emxComponents.3DXML.AltPathCGRFormat.<symbolic name of the Admin type>
emxComponents.3DXML.AltPathImageFormat.<symbolic name of the Admin type>

For example: 

emxComponents.3DXML.AltPath.type_Part=from 
[$relationship_PartSpecification].to.from[$relationship_ActiveVersion]
.to.from[$relationship_Viewable].to.id
If the AltPath property is used, define an MQL for the relationship between the image and the object for these properties for each object you added 
emxComponents.3DXML.AltPath.type_Company = $<id>
  Associates images with a company by defining an alternate path to the image. 
emxComponents.3DXML.AltPathImageFormat.type_Company=format_generic
emxComponents.3DXML.AltPath3DXMLFormat.type_Company=format_generic
emxComponents.3DXML.AltPathCGRFormat.type_Company=format_generic
  Defines the format where the images above are checked in. 
emxComponents.3DXML.AltPath3DXMLFormat.<symbolic name of the Admin type>
emxComponents.3DXML.AltPathCGRFormat.<symbolic name of the Admin type>
emxComponents.3DXML.AltPathImageFormat.<symbolic name of the Admin type>

The values can be blank (indicating you do not intend to use that format), and the values can be comma-separated lists of format symbolic names.

For example: 

emxComponents.3DXML.AltPath3DXMLFormat.type_Part=format_3DXML
emxComponents.3DXML.AltPathCGRFormat.type_Part=format_CGR
emxComponents.3DXML.AltPathImageFormat.type_Part=format_Image
 Defines the formats in which the CAD files are checked into the alternate path object

If you specified a value for the above property, emxComponents.3DXML.AltPath.<symbolic name of object type>, you need to specify the corresponding format for the image type.

Use emxComponents.3DXML.AltPath3DXMLFormat.<symbolic name of the Admin type> to specify the format of the Admin Object where 3D XML images will be checked in; use emxComponents.3DXML.AltPathCGRFormat.<symbolic name of the Admin type> to specify the format of the Admin Object where CGR images will be checked in; and use emxComponents.3DXML.AltPathImageFormat.<symbolic name of the Admin type> for other formats of images.		 
emxComponents.3DXML.CADFormats.Extensions

For example: 

emxComponents.3DXML.CADFormats.Extensions=3dxml, cgr,gif,jpg,bmp,png
Defines the CAD formats allowed to be checked in. 
emxComponents.3DXML.DefaultImage

For example: 

emxComponents.3DXML.DefaultImage=Sample.jpg
 Defines the default image name displayed as a thumbnail for 3DXML and CGR files when the file does not contain its own thumbnail. 
emxComponents.ImageManager.2DImageFormats

For example: 

emxComponents.ImageManager.2DImageFormats=gif,jpg,png,giff,jpeg
Defines the 2D formats allowed to be checked in. 
emxComponents.ImageManager.MaxTimeToWaitForImageConversion = 60000
The default is 60000 (1 minute). The value is defined in milliseconds. Defines the maximum time to wait for image conversionusing ImageMagick or nConvert tools. 
emxComponents.ImageManager.ImageConversionAtFCS=false

  • true. Image conversion is executed at the FCS.
  • false (default). Image conversion is executed at the MCS.
 Defines whether image conversion is executed at the FCS or MCS.
Notifications 
emxComponents.CaptureEmail.AutoCCSubscriptionEnabled=false

  • true. Users who receive email notifications (whether on the CC, To, or BCC lists), can reply to the message. The reply message uses "Subscription Agent" as the To person. When the user sends this email, the system automatically creates a discussion for the email thread and subscribes that user and all CC'd users to the New Reply event for the discussion. If the email includes an email address not defined in ENOVIA Live Collaboration, that person is ignored. All email replies to the thread are addressed to Subscription Agent and are connected to the discussion thread and sent to all other users who are subscribed to the thread.

    In this way, users can access the discussion either completely through their email system, or by logging into the ENOVIA products and using the Discussions feature, or both.

  • false. There is no automatic subscription to notifications. Users will receive the email notification and the discussion or reply is created, however, CCed users are not subscribed to the discussion or reply.
 You can configure the subscription notification feature to automatically subscribe users on the CC, To, and BCC list of the notification to a discussion.
DSFA 
emxComponents.VersionControl.FolderAllowedFormats= zip,gz,tgz
Add or remove formats as needed. Defines the formats allowed for a compressed file to be checked in as a folder. 
emxComponents.VCFileFolder.PathBadChars= @ , * ? [ ] # $ { } \\\" < > | 
; :

You should not remove any of the characters unless instructed to by ENOVIA.

 Defines the characters that cannot be used in the path name when creating or checking in a DesignSync folder.

The application verifies that those characters have not been used in the selector or path prior to submitting the form, and presents an error message if and of the listed characters are used. 

emxComponents.VCFileFolder.SelectorBadChars= @ , * ? [ ] # $ { } \\\\ 
\\\" < > | ; ' ~ ! % ^ & ( ) ` + =
  Defines the characters that cannot be used in the selector name when creating or checking in a DesignSync folder. 
emxComponents.VCFile.PathBadChars= ' # $ @ & % 
emxComponents.VCFolder.PathBadChars= ' # $ @ & ; %
  Defines the characters that cannot be used in the path name when creating or checking in a DesignSync folder or file. 
emxComponents.LocalDSServer = DSSTORENAME 
emxComponents.LocalDSPath = PATH

where:


If you want to set up an ENOVIA product to copy files or folders from one DesignSync server to another, add these properties to emxFramework.properties:

Note: These properties are set in the emxFramework.properties file, not emxComponents.properties. 

emxComponents.DSFAConnect.ShowDialog = TRUE

  • true (default). The Connect to DesignSync File/Folder page opens when the user clicks Connect. In the page, the user selects a Type from the type chooser and enters a description of the connection being created.
  • false. the connection happens automatically. The Connect to DesignSync File/Folder page does not open and the following assumptions are made:
    Connect Initiated From Type of Business Object Created

    Navigate DesignSync page

    The business object created as a result of the connection is always of Type DOCUMENTS.

    Folder Contents page

    The business object created in the ENOVIA collaboration platform has the same type as the parent business object. For example, if the parent business object is a folder of type Engineering Specification, the business object created as a result of the connection also has the type Engineering Specification.

    Create Issue option in Navigate DesignSync or the Folder Contents page

    The newly created business object is connected to the Issue.

Enables or disables the Connect to DesignSync File/Folder dialog box.

If the user initiated the connection but does not have the connect access to the parent object (for example a Workspace Folder), the connection does not succeed. There are no errors and a new business object is created but it is not connected to a file or a folder in DesignSync.

Cage Codes 
emxComponents.cageCode.Uniqueness=true

  • true. The cage code must be unique.
  • false (default). The cate code does not need to be unique.
 Defines the cage code, which is an ID issued by the federal government and associated with a company. The Create New Company dialog and the Edit Company Details dialog show the Cage Code field as a required field. 
emxEngineeringCentral.MEP.UniquenessIdentifier

  • Cage Code. Sets the manufacturer Cage Code as the unique revision identifier. When users create or edit an MEP, the Revision field shows the Cage Code. If a user changes the Manufacturer, Engineering Central changes the revision identifier to match.
  • Company ID (default). Sets the manufacturer Company ID as the unique revision identifier. When users create or edit an MEP, the Revision field shows the Company ID. If a user changes the Manufacturer, Engineering Central changes the revision identifier to match.
  • Policy. Sets the revision sequence specified by the policy governing the MEP as the unique revision identifier. When users create or edit an MEP, the dialog shows the first value of that revision sequence specified by the policy.
Specifies the kind of revision identifier that makes an MEP unique.
Vaults 
emxComponents.DefaultSearchPreference = ALL_VAULTS

  • ALL_VAULTS. All Vaults of the Company
  • LOCAL_VAULTS. All vaults of the company Local to the connected server.
  • DEFAULT_VAULT. Default vault (as set in user preferences) of the context user.
 Specifies the option to be selected by default in the Default Vault (Search) preference.

This preference is installed with ENOVIA Business Process Services and is used by some applications, such as Engineering Central, to let users choose the vaults they want to search in by default. When executing a specific search, users can choose a different vault.

Alternate Tree menu Lines that include emxTreeAlternateMenuName:
eServiceSuiteComponents.emxTreeAlternateMenuName.type_Company=type_Company 
eServiceSuiteComponents.emxTreeAlternateMenuName.type_BusinessUnit= type_BusinessUnit
eServiceSuiteComponents.emxTreeAlternateMenuName.type_Location=type_Location
eServiceSuiteComponents.emxTreeAlternateMenuName.type_Person=type_Person
eServiceSuiteComponents.emxTreeAlternateMenuName.type_Department=type_Department
eServiceSuiteComponents.emxTreeAlternateMenuName.type_Message=type_Message
Here are a few examples of ENOVIA Business Process Services's alternate Categories menus properties. See the properties file for a complete list. Defines alternate Categories (tree) menu objects for common types.

These properties define Categories menu objects for types that are used in more than one application.

Packages 
emxFramework.PackageAndTransfer.Enabled=true

  • Enabled. Users can download file packages.
  • Disabled. File packages are not available for download.
 Enables or disables the ability for users to download file packages.