Share

Custom report variables

The following tables outline each possible variable that may be added to a custom report.

Variables for all reports

Parameter Name Description
com_applicationUrl URL of the environment from which the report was generated eg. https://live.upchain.net
com_generatedOn Date and time the report was generated in timezone GMT+00. Format is YYYY-MM-DD HH:MM.
com_generatedBy First and last name of the person who generated the report.
com_reportName Name of the report under which the report template was uploaded and what is shown in the Reports sub-menu for an item, CR, CN, or project.

Project report variables

Parameter Name Description
proj_creator Creator of the project.
proj_parent Parent project of the current project.
proj_sheetSizingStandard Sheet sizing standard used in the project (European Standard or American National Standard).
proj_division Division to which the project belongs.
proj_mechanicalCad Mechanical CAD system including version used in this project.
proj_electricalCad Electrical CAD system including version used in this project.
proj_units Units for the project (Metric or Imperial).
proj_drawingView Drawing view for the project (1st Angle or 3rd Angle).
proj_status Status of the project.
proj_creationDate Date the project was created.
proj_customer Customer of the project.
proj_isPublic Privacy setting for the project (Public or Private).
proj_name Name of the project.
proj_type Type of project.
proj_childProjects Child projects of the project.
proj_number Project number.
proj_members_datasource List of project members.
proj_id Internal ID of the project. You can find this in the URL of the project. For example: https://live.upchain.net/?project=**3857**&page=2.

Item and BOM report variables

Parameter Name Description
ebom_items_datasource List of eBOM items.
item_actualCost Actual cost of the item.
item_bomEditLockUser Name of the user who applied the BOM edit lock on the item.
item_bomEditAddLockUser Name of the user who raised eBOM edit lock on the item.
item_bomRevision Revision value of the item.
item_boxHeight Box Height file attribute.
item_boxLength Box Length file attribute.
item_boxWidth Box Width file attribute.
item_centerofGravityX Center of Gravity X file attribute.
item_centerofGravityY Center of Gravity Y file attribute.
item_centerofGravityZ Center of Gravity Z file attribute.
item_creationDate Creation date of the item.
item_creator User who created the item.
item_crNumber Number for the change request the item belongs to.
item_crStatus Status of the change request the item belongs to.
item_crWorkflow Name of the workflow used in the change request the item belongs to.
item_currencyCode Currency code (eg. CAD, USD).
item_customAttributesMap A list of all custom item attributes and their values (custom attribute name - value).
item_customAttributesDatasource List of item custom attributes.
item_description Item description.
item_division_costs_datasource List of item cost per division.
item_drawings List of item drawings (filenames).
item_ebomStructuralLockUser Name of the user who applied the eBOM structural lock on the item.
item_editLockUser Name of the user who applied the Edit lock on the item.
item_erpItemNumber ERP number for the item.
item_estimatedCost Estimated cost of the item.
item_fileSize Primary CAD model file size.
item_fileVersion Latest CAD file version for the primary CAD file.
item_fileVersionDate The date the latest CAD file version was created.
item_finish Finish value.
item_hasDrawing Indicates that the item has a drawing.
item_heatTreat Heat treatment value.
item_isSpare eBOM spare value.
item_itemMasterId Internal unique item identifier.
item_itemName Item name.
item_itemNumber Item number.
item_itemVersionId Internal ID of the item. You can find this in the URL of the item. For example: https://live.upchain.net/?project=3857&page=4&previewItem=**670759**.
item_lastBomRevision Date of the last revision.
item_legacyDescription Legacy item description.
item_legacyItemRevision Legacy item revision.
item_majorRevision Item major revision.
item_manufacturer Manufacturer for the item.
item_manufacturerItemNumber Manufacturer item number for the item.
item_mass Mass value.
item_material Material value.
item_materialUom Unit of measurement value (eg. Each).
item_materialQty Quantity in the units specified in item_materialUom.
item_minorRevision Item minor revision.
item_modelFileName Primary CAD model filename.
item_modificationDate Date the last time the item was edited.
item_primaryCadFileVersionId Internal ID of the primary CAD file in the item.
item_releaseType Release type of the item (major / minor),
item_responsibleDesigner User entered as the responsible designer.
item_revisionNote Revision note on the item.
item_shape Shape value.
item_spare Recommended spare value.
item_status Status of the item.
item_suppliers Suppliers associated with the item.
item_thickness Thickness value.
item_thumbnail Thumbnail of the item.
item_toolClass Tool class value.
item_type Item type.
item_version Item version.
item_viewName BOM view name currently used when report was generated.
item_viewType BOM view type.
item_volume Volume file attribute.
item_weight Weight file attribute.
kitting The kitting number for the item in the following format: R<major revision>_<project number> ; item number of lowest level product structure above current item ; item number of immediate parent item. See The kitting number for more information.
supplier_supplierId Internal ID of the supplier associated with the item.

Change request report variables

Parameter Name Description
cr_assignees Names of people assigned tasks during the change request.
cr_assignees_datasource List of CR assignees.
cr_changeInvestigation The investigation request associated with the change request.
cr_creationDate Creation date of the change request.
cr_creator Creator of the change request.
cr_customer The customer associated with the project in which the change request was created.
cr_description Description entered into the change request.
cr_divisions The division in which the change request was created.
cr_items_datasource List of CR items.
cr_num Number of the change request.
cr_program The program associated with the project in which the change request was created.
cr_requestor Requestor of the change request.
cr_status Status of the change request.
cr_type Type of change request.

Change notice report variables

Parameter Name Description
cn_items_datasource List of CN items.
cn_number Number for the change notice.
cn_requisitionedBy Name of the user who requsitioned the items in CN.
cn_status Status of the change notice.
dateRequired Date the item is required by.
extendedCost Extended cost for the item.
initialHistoryQuantity Historical quantity for the item.
kitting In the following format: R<major revision>_<project number> ; item number of lowest level product structure above current item ; item number of immediate parent item. See The kitting number for more information.
moveQuantity Move quantity for the item.
partQuantity Project quantity for the item.
requisitionNote Note added to the item on a change notice.
requisitionQuantity Required quantity entered for the item on this change notice.
Parent page: Custom Reports

Was this information helpful?