Custom Object

A custom object is fully configurable. Its purpose and functionality are determined by your administrator.

See how to configure this object under Project Workflows under this admin guide: Configuring Custom Object.

There are three main tabs that can be configured in the custom object as follows:

1. Custom Object

This tab consists of single-line text fields, multi-line text fields, single-select dropdown lists, multi-select dropdown lists, numeric fields, staff lists, and date fields configured by the administrator. It may also contain links to related documents in the document management system. You can click on a document link to view the related document. A sample custom object is illustrated below:

Figure 1.1

2. Custom Table Tab

This tab allows users to enter data into a table configured by the administrator. Rows of the table can either be added by the end user or can be pre-defined by the administrator via the object configuration area.

A sample custom table is illustrated below:

Figure 2.1

Users can also upload data to custom tables via the data upload wizard functionality. Please refer the 'Data Upload Wizard' section for more information.

3. Custom Attachment Tab

This tab allows users to attach documents to the Custom Object similar to the Attach Document object.

3.1 Sending a Document/URL for Sign Off

When document sign off functionality is activated through the object editor area, an icon titled as Sign Off will be available against each document/URL uploaded in the Custom Attachment tab.

Clicking Sign Off button adjacent to a document/URL will display a pop-up as shown below.

  • The pop-up window will also show details of the attachment such as its title and reference.  You can select the relevant sign off authorities and click on Submit for Sign Off button to submit the document/URL for approval. An email will be generated to the respective sign off authority.  

  • Once applied for approval, the document/URL will be read only. Hence, you will not be able to edit or delete the document/URL until the sign off is completed.  

  • Upon receiving the sign-off request email, the ‘Sign Off’ Authority can then review the document/URL and choose to Approve or Reject it. Depending on the sign off settings determined by the admin, the Sign Off Authority may be allowed to provide a justification for the decision.  

  • This can be done by either clicking the relevant link in the sign-off email, or by navigating to the respective object and clicking on the relevant button. 

  • After the approval, a ‘Sign Off’ Complete email will be generated. 

  • When a document/URL is approved, it will be ‘read-only’ and will not be editable for any users, except for users who have the ‘Can Edit After Sign Off’ permission to the object and super permissions (IPM admin, Project Manager, etc.).

  • When a document/URL is rejected, it will be made editable so that users can make the amendments and re-submit for sign off, if required.  

  • Sign Off status will be displayed in the ‘Status’ column.

    Document approval functionality is also available within the ‘Documents’ tab in Project Hub.

4. Data Upload Wizard functionality

  • The Data Upload Wizard is available within Custom Object > Custom Table tab, allowing you to upload data into the custom table from an Excel file.

    Click on the data upload icon on the toolbar in the Custom Table to navigate to the data upload wizard.

Note: Data Upload functionality will be available only when the rows are added to the Custom Table by the end user (i.e., when ‘Allow users to add rows’ tick box is selected in the object configuration area of the Custom Table). Hence, this functionality will not be available when the rows in Custom Tables are pre-defined by the administrator. 

4.1 Uploading Data into a Custom Table via the Data Upload Wizard

  • Step 1: File Upload

    1. You can either upload an Excel file to the wizard by using a pre-defined template or by using an Excel file you have already entered data in.

b. To download the predefined template, click on the Download Template button. The template will be automatically downloaded to your device. 

c. Once you fill the data in the Excel sheet and the file is ready to upload, click on the Select File button on the wizard.

d. Select the file which you want to upload the data from the file browser.

e. To upload the file to the system, click on the Upload button which is located next to the Select File button. Once the file is successfully uploaded to the wizard, you will be able to navigate to the next step.

Notes:

  • The format of the file which you upload to the wizard should be either xls or xlsx.  

  • Make sure that the column headers are added to the file which you upload since the first row of the data source will be considered as column headers.

  •  Step 2: Select Worksheet

    1. Select the worksheet from which the data should be imported.

b. Select the worksheet (in the file which you uploaded in step 1) which contains the data that you wish to upload from the dropdown list. Once you select the worksheet, you will be able to navigate to the next step.

Step 3: Select Custom Table

a. You can select the Custom Table in the project to which you wish the data to be uploaded via this step.

b. Expand the dropdown list and select the Custom Table which you will be uploading the data to.  

c. This dropdown list will display all the Custom Tables in the current project which you have edit permissions to, allowing you to upload data to a Custom Table in any phase of the project without navigating to the respective Custom Table. 

  • Step 4: Data Mapping

a. Map data between the Custom Table and the selected worksheet.

b. The Data Mapping table will display the following columns:

i. Column Name: Will display all the column names in the selected Custom Table.

ii. Column Type:  Will display the data type of each column.

iii. Map to Excel Column: Will display all the columns in the selected worksheet in a dropdown. You can select a column header from the ‘Map to Excel Column’ dropdown for each column in the Custom Table. 

iv. Once you map the columns and finish the data upload process (Step 5), the system will automatically populate the data within the respective columns in the Excel to the mapped columns in the Custom Table.

  • Step 5: Finish

a. The final step will allow you to see a preview of the final output of the Custom Table after the data is uploaded.

b. If there are any data upload errors, you will be able to view them in the error log which is displayed below the preview grid.

c. If you are satisfied with the preview output, you can proceed with the data upload by clicking on the Finish button.

5. Exporting Details

You can export information in the object tabs to formats such as PDF, Word, Excel etc. by following the steps below:

  • To generate an export of the object, click on export icon on the toolbar.

  • Upon clicking the export icon, you will see a preview of information within the object on a new browser tab.

  • Click on export dropdown menu icon and select the preferred export format from the menu to download the file in the selected format.

View other articles under this section:


<< Back to main section
Project Objects