Configuration
Previous Topic  Next Topic 

Different configurations settings pertaining to different modules and utilities in SmartProject can be defined here. 

Figure: Configuration Settings window

Different settings that can be set here are mentioned in the following sections.

Refer the navigation template to access information on important configurations that can be set here.

Navigation Table

To

See

Assign viewer to file types

Assigning Viewer to file types

Define document related settings

Document Settings

Create Link authentication user

Creating a link authentication user

Enroll an organzation in WrenchXchange

Enrolling an organzation in WrenchXchange

Notify user account expiry

Notifying user account expiry

Define email address modification permission

Defining email address modification permission

Configure template display formats

Configuring display formats for templates

Configure report generation from documents

Configuring report generation from documents

Configure Stamp

Configuring Stamp

Configure Meta data security

Configuring meta data security

Assign Project files to file manager

Assigning Project files to file manager

Configure display format while creating smart folders from genealogy

Configuring display format for smart folders

Configure Authentication

Configuring Authentication

Configure file naming structure for consolidated comment file created from Rasterex

Configure file naming structure for consolidated comment file created from Rasterex


General Settings

Application Configuration

Different configurations that were set from web configuration is now available here. This option will available only for Admin login.

To define different configurations

  1. In the Configuration window click the configure button next to Application Configuration.

Application Configuration window is displayed.

Figure: Application Configuration window

Here configuration related to different applications can be made. They are mentioned in the following table.

#

Setting

Description

1

Enable attach reference document

Select this option to enable reference document addition in document addition.

2

Show SSRS report viewer

Select this option to open SSRS report in report viewer

3

Enable Workflow resource distribution

Select this option to assign workflow resources for multiple documents.

4

Send Customized mail after routing

Select this option to include custom property in Send mail.

5

Enable Error logging

Select this option to enable logging of errors.

6

Custom date format with time

Specify the date format along with time. Date and time will be displayed based on the format defined.

7

Custom date format without time

Specify the date format without time. Date will be displayed based on the format defined.

8

Custom date format with time for excel template

Specify the date and time format that has to be displayed in excel template.

9

PDF Viewer URL

Specify the PDF viewer URL.

10

Interval notification count

Here you can set a value for calculating the interval at which the count for push notification is to be reset.

11

User Group Name

Specify the user groups for which My Settings is to be hidden.

12

Page size option

Values for Page size option will be set as 25, 50, 100, 500. These values are non-editable. When a new smart folder is created page size value will be 100. While upgrading if any smart folder have page size value that is not set here, page size option for folders will be assigned as 100.

13

Maximum allowed file size

Specify the maximum size of file that can be uploaded.

14

Work As One URL

Specify the URL to open Work As One Portal.

15

Client Code

Client Code for Work As One.

16

Team Name

Team Name for Work As One.

17

Resource Utility Path

Specify the folder of resource files. 

18

WRENCH Web API URL

Display the WRENCH API URL.

19

SSRS server domain name

Domain Name of SSRS server.

20

SSRS server user name

User Name of SSRS server.

21

SSRS server password

Password of SSRS server.

22

SSRS server URL

Specify SSRS service URL.


Can change the default workflow: This setting helps to restrict changing of default workflow By default, this setting will be enabled. When the setting is disabled, users cannot change the default workflow assigned. 

Format for mapping LOV custom properties: The format for mapping LOV custom properties defined in server configuration is displayed here.

Limit transmittal search visibility to sender and recipient organization/origin: If the check box next to this option is selected, transmittals sent and received by the user’s organization/origin will be only accessible to the user. Users in one origin will not be able to view or access transmittals sent between two different origins. If a user tries to view a transmittal from the smart folder or Usage Information tab in Document Details window, a warning message is displayed, and the operation is cancelled.

System ID: If an organization is not enrolled in WrenchXchange service, no values are displayed against the field System ID. A button generate will be available.

Enroll in WrenchXchange: This button is displayed only after System Id is generated. Once this button is displayed, an organization can be enrolled in WrenchXchange.

Enrolling an organzation in WrenchXchange

  1. Click Enrol in WrenchXchange.

Wrench Connect service will send an OTP to the mail ID which is set as the organization mail ID.

A pop-up window is displayed for the system user

Figure: Validation window

  1. Enter the OTP received and click Validate.

After successful validation an approval request is send to the WrenchXchange administrator. Once an enrolment is successful, the administrator of the WrenchXchange will receive a notification. The notification will contain a link for approval or rejection.

To approve an enrollment

  1. Click the link.

WrenchXChange login window is displayed.

Figure: WrenchXchange login window

  1. Enter the login name and password and click Sign In.

WrenchXchange main window is displayed.

Figure: WrenchXchange main window

  1. Select the pending enrollment and click Approve. The request is approved, and the enrolled user is notified on the approval and the status changes to ‘Active’.

Terminating an active enrollment

Active enrollments can be terminated due to reasons such as expiry, termination of contract, abuse, failure to remit payments etc. Termination of enrolment is carried out by the administrator.

To terminate an account

Notifying user account expiry

In smaller organisations, user administration is taken care by a single administrator. In such cases, only a single user is to be alerted. But in larger organisations, there may be group administrators who manage user accounts in specific groups. In such cases, the respective group administrator is to be notified.

To handle this scenario,  a setting to notify group administrators or a specific user about login expiry is provided. 

To notify user account expiry

  1. In the General Settings, click the Configure button next to Notify user account expiry to.

On clicking the configure button, the following window is displayed.

In the window the following options will be available.

Specific User: Select the radio button next to this option if expiry notification is to be send to a specific user. Click the browse button to select users from the User Search window. Selected users will be displayed in the window.

Group Admin: Select the radio button next to this option, if notification is to be send to the group administrator of a specific group.

None: If this option is selected, system will not send any notification regarding the expiry of user account.

  1. After selecting the required option click OK.

Once the configuration is done, seven days prior to the expiry of user accounts, the configured user (specified user account / the respective group administrator) will receive a notification about the expiry. If external emails are configured, the recipients will receive the notification via external emails as well.

Uniform Correspondence mail for internal and external users: If this option is enabled mails sent to internal and external users will be the same. Or else when correspondence mails are sent with attachments to internal and external users, internal users receive document links and external users receive document attachments with the correspondence mail. 

Limit transmittal Accessibility to sender and recipient origins: If this option is enabled, transmittals sent and received by the user’s organization/origin will be only accessible to the user. Users in one origin will not be able to view or access transmittals sent between two different origins. If a user tries to view a transmittal from the smart folder or Usage Information tab in Document Details window, a warning message is displayed, and the operation is cancelled.

Document Settings

Enable Origin wise user account administration: When the setting ‘Enable Origin wise user account administration’ is enabled, a user with adequate permissions in user master will be able to see only users of their origin. If this setting is enabled and the current user has Edit permission in user master, user is permitted to add or remove users from user master to the projects where the current user is a member, even when current user does not have ‘edit’ permission in the project.

When the setting is disabled or if the user does not have Edit permission in User Master, when a user with manage permission try to assign a project to a user, a warning message is displayed. 

When the setting is enabled, and if the current user has no ‘Edit’ permissions in the Project, modification of project information is restricted.

In certain scenarios, it may be required for an administrator in one origin to administer user accounts in certain other origins as well. For Example: A main contractor may need to administer their subcontractor’s user accounts. To achieve this, the sub contractor’s origin (sub origin) is to be assigned to the main contractor’s origin (master origin).

To extend user administration

  1. Enable the setting  Enable Origin wise user account administration.
  2. Click the hyperlink Extend user account administration.

 Configure Origins window is displayed.

Figure: Configure Origins window

Different elements in the window are mentioned in the following table.

#

Property

Description

1

Origin Type

List of all the available origin types in Wrench is displayed in the drop-down list. Select the required Origin type.

2

Master Origin

Based on the Origin selected, all the available origins corresponding to the selected origin type is listed.

3

Sub Origin

Sub-origins available against the selected origin, in the master origin list is displayed here.

To add a sub origin to the selected Master Origin

  1. Click the browse button.

Add Sub Origins window is displayed. 

  1. Select an Origin Type from the drop-down list. Based on the selection Sub Origins are displayed.
  2. Select the checkbox next to the sub origins that are to be selected.
  3. Click OK to assign the selected sub origins to the Master origin.

Default Comment Type: Here a  default comment type can be assigned at organizational level.

To assign default comment type

Maximum number of specters allowed for a document version: The number of specter files added manually can be limited by providing a value here.

Update submission details to documents on transmittal release by vendor: When a transmittal is released for a document of vendor origin, if this setting is enabled, external agency transmittal number and date needs to be captured to the documents details of the documents.

Alert when Work In Progress RFI's are existing against documents (View/Download/Upload/Check In/Release Trasmittal.): If this option is enabled, when a user tries to view, download, upload or check in a document, or drawing with an RFI attached to it is open, an alert message is displayed. If any of the documents have an open RFI, then while creating a Release transmittal user is alerted. 

Download attachments in single folder: If this option is enabled, a zip file which will contain all specter files in a single folder is created.

Add Meetings to MS Outlook calendar: If this options is enabled,  meetings created in WRENCH is added to MS Outlook Calendar, based on an Outlook plug-in configuration created in Administrative Settings>>Plug-In.

Meeting type is mandatory: If the checkbox next to this option is enabled, meeting type and meeting sub type will be mandatory for creating a meeting

Automatic numbering for comments in CRS:  In Comment Resolution Sheet (CRS) of document, comment number is a mandatory field, and user needs to manually enter the comment number for adding new comment to CRS. Some organisations follow a specific comment numbering pattern and others do not follow any numbering pattern for adding comments to a document. CRS number is generated automatically and format of the CRS number will be PROJECT_ID/CRS/SERIAL_NUMBER.

Auto numbering will be enabled only if the setting Automatic numbering for comments in CRS is enabled.

Accept past dates for 'Responded On' in CRS: If this setting is enabled, user can provide a past date in the Responded On field in CRS. If the setting is not selected, user is restricted from providing a past date in the Responded On field in CRS. If the setting is not selected, the value for the field Responded On in the Response Details window is auto-generated with current date and time.

Allow revision number duplication for documents: Once this option is enabled, revision number duplication for documents will be permitted. This will be applicable for project and non-project documents.

Only Creator can remove/modify attachment: By default, this setting will be enabled. If this setting is enabled, the attachments can be removed or modified only by the creator of the attachment. Even if the users (other than the creator) having replace/remove permission for the attachments in that genealogy will not be permitted to remove/modify the attachments added by other users.

Automatically insert QR code on download: If this option is enabled, QR code is inserted while documents are copied out automatically.

Block Duplication of Document Number: If this setting is enabled and duplicate document number exists, on clicking the Save button, list of duplicated document numbers is displayed. You can change the duplicate document number and try again.

Follow parent document’s file naming conventions for client comments: Once this option is enabled, when user attempts to download a document, if the document is attached as a client comment to another (single) document, the file will be downloaded using the file naming conventions as specified against the main document. 

If the selected document is not assigned to any document as a client comment OR if there are multiple documents to which the selected document is attached as client comment, the file will be downloaded using the file naming conventions (if any) specified against the selected document’s genealogy.

When there are no file naming conventions defined on the main document’s genealogy, default conventions of the main document are used to download the file.

Project ID mandatory in change proposal: If this option is enabled, a change proposal can be raised only for documents or tasks related to a Project.

Creating Link Authentication User

In the document smart folder, there is an option to create an external link to access a document. Once a link authentication user is selected here, recipient of the document link can open the link without any authentication. Login credentials of this user will be used for login.

To create link authentication user

  1. Click the browse button.

Search User window is displayed.

  1. Select the link authentication user from the list of users.

Format for mapping LOV type custom properties: When LOV type custom properties are mapped, usually values of the LOV are mapped. In some cases it is required that description of the LOV type has to be mapped. Format for mapping LOV that is defined in the server using a utility is displayed here.

Defining email address modification permission

Since users, especially Vendors enter their personal email address or incorrect email address instead of their official email address, it is recommended to allow only users with proper permission to modify their email setting.  So, it is required that restrictions are made on the level of origin group, by Admin group users.

To define email address modification permission

Configuring display format for templates

Here you can configure the display format for properties like Area, System in  Import/Export templates. Display format can be configure for selected properties of tasks, documents, risk management, meetings and time sheet.

To configure display formats

  1. In the Configuration window click the configuration button next to Configure display format for templates.

Configure window is displayed.

  1. In the window select an Object Type from a drop-down list. Types available are Task, Document,  Timesheet, Risk Management, Meetings, Snag, Issues, Non Conformances-Quality and Non-Conformance - Safety.

 

Figure: Configure window

On selecting an object type corresponding object properties are displayed. A display format can be selected for an object.

To select a display format

  1. Select a Property and click the Display Format column.
  2. Click the drop-down arrow.

Figure: Selecting display formats

Different available display formats are displayed.

  1. Select a display format.

In the Import/Export template the selected property will be displayed in the format selected from the drop-down list. In this way you can define display formats for properties of a selected object type.

Configuring Report Generation From Documents

SSRS reports link can be configured from the Administrative Settings in SmartProject (ATOM).

To configure reports link

  1. Click the configure button next to Configure Report Generation from Documents.

Report Generation From Documents window is displayed.

  1. Click Insert Row. A new row is inserted.
  2. Enter a Report Name and Report URL.
  3. Click the browse button to select a document genealogy.
  4. Click Save to store the changes.

Configured reports will be displayed in the navigation menu of the document details window.

Configuring stamp

Here there is a facility to upload the stamps that you will be using.

To upload stamps

  1. In the Configuration window click the configure  button next to Configure Stamp.

Configure Stamp window is displayed.

Figure: Configure Stamp window

In the section Stamps, configured stamps are displayed.

To create a stamp

  1. In the Stamps section Click Add

New Stamps window is displayed.

  1. In the window enter a name for the stamp.
  2. Click the browse button to select the stamp file.
  3. Click Save to create the stamp.

Created stamp is displayed in the Stamps section.

To remove a stamp

  1. Select the stamp that is to be removed.
  2. Click Remove. An alert message Do you want to remove the selected stamp is displayed.
  3. Click Yes to delete the stamp. Click No to discard the operation.

Stamps can be related to specific types or group of documents using specific documents or user properties.

To apply selected stamps to documents

  1. In Apply Selected Stamps to section click Add.

Filter Criteria window is displayed.

  1. Criteria names are displayed here. Select the checkbox next to the criteria name that is to be selected and click OK.
  2. Selected criteria names will be displayed in the window.

In the window select a value for each criteria. While stamping, the system will filter the stamps based on the filter criteria specified against the stamps.

Configuring Metadata Security

When WRENCH is deployed across multiple organizations, people from different organizations will need to work together on projects. In such scenarios, it is required to control the permission to modify specific document properties and task properties to specific groups or users. For Example: Users other than the originator’s group needs to be restricted from editing some of the basic document properties such as “Description”, “Sheet Number” etc. Whereas they should be allowed to modify certain other properties such as “Approval Status Code” etc. Security for different document properties can be configured here so that a user / user group can only edit the property which they are authorised to do.

To configure metadata security

  1. Click the configure button next to  Configure Metadata Security button. Configure Metadata Security window is displayed. In the window option User Group is selected by default. Click the radio button next to User, if metadata security is to be configured for users.
  2. Select an Object Type for which Metadata Security is to be selected. This can be selected from a drop-down list. Objects types available are Document and Task.
  3. In the window select a User Group/User that has to be prevented from editing some properties.

Figure: Configure Metadata Security

  1. In the Properties section click Add.

A list of basic document properties and custom properties will be displayed. 

Figure: Selecting document properties

  1. Select the properties that has to be prevented from editing and click OK button.

NOTE: If Object Type is selected as Tasks, then task properties and custom properties will be displayed in the window.

Next step is to assign the selected properties to a project or genealogy.

  1. After selecting the properties that has to be prevented from editing click Insert Row.

Figure: Creating an exception list

  1. Select a Project Number or Genealogy. You can also select both together.

In this manner you can insert rows and assign multiple projects  for document properties.

  1. Click Save to store changes. You have successfully configured the metadata security.

NOTE: The metadata security defined will be exempted from the primary operations like check out-in, replace, transmittal creation. For Example:  A user group  "UG"  in the  Project P1  is exempted from editing the property revision number for the genealogy G1. If members of the group UG tries to replace a document for the same project and genealogy, there will be no restriction in updating the revision number in replace window as primary operation is ‘replace’ here but the revision number will not be editable from document details for the same document.  

If the checkbox next to the option APPLY WHEN NOT IN ACTIVE STAGE is selected, system restricts updating a property when the user not in active stage.’ This can be set exclusively for a property or in combination with ‘Project’ or ‘Genealogy’.

Assigning projects to file manager

Projects in WRENCH can be assigned to folders in the file manager so that it can be accessed by the project resources in each project. If there are folders which do not belong to any Projects, folders can be assigned without mentioning the project so that all users in the WRENCH can access the given ‘Project independent’ folder.

To assign projects to file manager

  1. In the Configuration window click the configure button next to Assign Projects To File Manager.

Configure Project Folders window is displayed.

Figure: Configure Project Folders window

  1. In the window click Add.

A new row is inserted in the window.

  1. Click the new column. A browse button is displayed.

Figure: Selecting a Project

  1. Click the browse button. Projects window is displayed.

Select the Project from the list. Selected project will be displayed in the window.

To select folders to file manager

  1. In the Configure Project window click the new column inserted, below the heading Folder.

A browse button is displayed.

Figure: Assigning a folder to file manager

  1. On clicking the browse button Shared Folders window is displayed. Folders configured in server settings is displayed here.

Figure: Shared Folders window

  1. Select the folder that is to be added to the file manager and click Save.

Selected folder is displayed in the Configure Project Folders window.

Assigning viewer to file types

In some project sites third party viewers like Autodesk Forge viewer or Raesterex viewer are used to view the documents or the related files attached to it. Viewers can be assigned to different file types from the Viewer Settings window.

To open viewer settings window

  1. In the Configuration window click the configure button next to  Viewer Settings.

Viewer Settings window is displayed. Here the file types and their associated viewers will be listed in ascending order of file extensions. User may add additional file type and associate it with a viewer.

Figure: Viewer Settings window

Setting a default viewer

Default viewer is used to simplify the viewer configuration. For Example:  There are multi-format file viewers commercially available in the market, which can be integrated with Wrench such as ‘Autodesk Forge’ and ‘Rasterex’. Customers may purchase such viewers and set it as ‘Default’. Once set as default, the individual file types can be assigned with ‘Default Viewer’ as the viewer. In case the user later decides to change the default viewer, the individual association of viewer with file type need not be updated, instead the default viewer is changed. A set of viewers will be available in the drop-down list.

When users attempt to view files, if there is an associated viewer, it is opened accordingly. If there are no associated viewer and if the user has ‘Copy’ permission, the file is downloaded. If there are no associated viewer and if the user does not have ‘Copy’ permission, an alert message “You do not have Copy out permissions” is displayed and the operation is aborted.

To set a default viewer

  1. In the Viewer Settings window, click the down arrow. List of viewers is displayed.

  1. Select the viewer from the list and click Set.

Default viewer set successfully message is displayed.

To associate file type with viewer

  1. In the Viewer Settings window click the browse button in the cell titled viewer.

Viewers window is displayed.

Figure: Viewers window

  1. Select a viewer from the list displayed in the window.
  2. In case you want to disassociate the file type from all the viewer select the option No Viewer.

To add new file types

  1. In the Viewer Settings window click Add.

Figure: Adding new file types

  1. Custom File Type window is displayed. In the window enter values for the following fields.

CUSTOM FILE TYPE: Enter the extension for the file type here.

DESCRIPTION: Enter a description for the file type.

VIEWER: Select the viewer from a drop-down list.

  1. Click OK to save changes.

Configuring display format while creating  smart folders from genealogy

Usually genealogy structure comprising of Code and Description is created as per the standards followed by an organization. When this genealogy structure is replicated to smart folders in SmartProject, only genealogy description is displayed. This results in a mismatch between the genealogy structure and smart folder created, which leads to confusion for users. Option to define display pattern for the folders created from genealogy will help in solving this issue.

To configure display format for smart folders

  1. Click the option Display format for smart folder from genealogy

Configure Display Format window is displayed.

  1. Here a Display Format can be selected against a Module Name. Display formats available are DescriptionCode (Description) and Description (Code).

Newly created smart folders will have the display pattern based on the options selected.

Configuring Authentication

SmartProject supports both Native Authentication and External Authentication.  In the case of Native Authentication, option to authenticate using single factor and multi factor is available. In the case of External Authentication, option to authenticate using MS Office and OKTA is available.

Single Sign On in SmartProject provides centralized session and user authentication service in which one set of login credentials can be used to access multiple applications. 

SSO is implemented using Security Assertion Markup Language (SAML) which is an open standard that allows identity providers (IdP) to pass authorization credentials to service providers (SP). What that means is that user can use one set of credentials to log into different websites i.e. Single Sign-On (SSO).

By implementing SSO in SmartProject, in addition to Native Sign-on, option to login to SmartProject using Office 365 credentials and Active Directory Services credentials will be available.

An  option to configure  what types of authentications are allowed is provided. Based on this, individual users many be allowed to use different types of authentication.

To configure native authentication

Configuring External Authentication

Option to login to SmartProject using Office 365 or OKTA  credentials and Active Directory Services credentials will be available.

A integration between SmartProject and Office 365 or Okta can be defined here.

To configure external authentication

  1. In the Configure Authentication: Internal Users window select Authentication Method as External Authentication.

Figure: Configuring Single Sign On

Single Sign On Configuration Settings window is displayed. Configuration can be defined for Microsoft Active Directory and Microsoft Office/Okta.

  1. Enter values for the following fields.

Identify Provider: Select an Identity Provider from a drop-down list. Options available in the drop-down list are Microsoft Office 365 and Okta

By default option Microsoft Office 365 is selected. If there are any saved configuration it is displayed in the window.

NOTE: When the Identity Provider is changed from the drop-down list, a warning message Do you wish to clear the existing configuration is displayed. On clicking Yes, existing configuration of the currently selected identity provider is removed, and the fields are cleared. On clicking No, existing configuration values are not cleared.

Identifier (Entity ID): This URL is unique and identifies the application. Copy-paste the same URL from Active Directory. Login URL from AD only contains the base URL path. Append the encrypted request using the reply URL and Identifier (Entity ID) while login.

Reply URL: This url specifies where the application expects to receive the SAML token. The reply URL is also referred to as the Assertion Consumer Service (ACS) URL. 

Logout URL: This URL is used to send the Single Sign On Logout responses back to the application. This is mandatory if the selected identity provider is Microsoft Office 365. For Okta this URL is not mandatory.

App Federation MetaData URL: Specify this URL to allow user to access the metadata specific to the application.

Authentication Attribute: Specify the authentication attribute, which helps SmartProject to validate the user. Options Email ID and Login Name is available in the drop-down list. By default, Email Address is selected. 

User Attribute: Specify the field name corresponding to the Authentication Attribute in the Federation MetaData XML retrieved using ‘App Federation MetaData URL. Once user pastes the metadata URL, corresponding attributes in the XML file will be listed in User Attribute drop down. User should select the right attribute relative to the authentication attribute.

Login URL: Specify the login URL. When a user opens this URL, the service provider redirects to Azure AD to authenticate and sign on the user. Azure AD uses the URL to start the application from Microsoft 365 or Azure AD My Apps. 

Certificate: Enter the trust key to decrypt the response from Identity provider.

  1. After entering the values click Save to store changes.

Configuring Okta SAML Settings

To enable Okta single sign on configuration, user has to configure SAML setting in Okta administration page.

Figure: Configuring Okta SAML Settings

To Integrate SSO 

  1. Copy the Reply URL from Single Sign-on plug-in configuration in SmartProject and paste it to the SAML Setting fields in Create SAML Integration window.
  2. When the configuration is completed, SSO will generate the Login URL to link with Okta. 
  3. Copy the Identity Provider Single Sign-On URL (i.e Login URL in SmartProject) , X.509 Certificate , Identity Provider Metadata URL (i.e App Federation Metadata URL in SmartProject) from SSO and paste it in the SmartProject Plug in. 
  4. Save the SAML plug-in configuration to complete the configuration.

If the authentication mode is configured for Okta sign on, user will be redirected to Sign on URL which will be the login page of Okta. Once successfully logged in with Okta, user will be redirected to the ‘Reply URL’ defined, where the ‘email address’ or the ‘Login Name’ (as configured) will be available. SmartProject will use this Okta login credentials to identify the corresponding SmartProject user account.

Configuring file naming structure for consolidated comment file created from Rasterex

Some Project sites prefer a file naming structure based on their naming conventions.  Hence a provision to configure file name for consolidated comment files will be available in the Administrative Settings.  

To configure a file naming structure

Configuring Live Review

Bluebeam, Rasterex or WRENCH Viewer can be configured as the collaboration model.

To configure live review