Web Central AXVW View Customization
Cheat Sheet
Understand the folder structure
Most environments have at least two instances of Archibus – development and production. Our standards usually have production on port 8080 and development on 8082. Therefore, the base part of the structure where the Archibus folder is located will look something like the following. Look in the 1.3 Installation – Physical Environment document for your installation in the knowledge base for more specific details.
Production: D:\CAFM\APPS\Tomcat 9 8080\webapps\archibus
Development: D:\CAFM\APPS\Tomcat 9 8082\webapps\archibus
After that point, all structure is the same within the Archibus folders. All views are contained within the “schema” folder:
- Ab-core – core files to make ARCHIBUS run, do not edit
- Ab-products – views/reports specific to ARCHIBUS applications you will find all your regular views there
- rsc – where all custom RSC files go
- [client] – your folder named for your organization to put your custom files. You can organize your files into sub-folders however you want and add .txt documents with notes if required
- Ab-system – system files, for things like graphics, icons, skins (like the WD logo displaying in Web Central)
- Per-site – where all user-specific files go. Views created in the view definition wizard will show up here under a folder with the users name and then “preview” files for previews and “view” for the final saved views. Anything created here that you like should be moved to the ab-products/[client] folder
Understand the customization standards
https://knowledgebase.rsc2lc.com/rsc-customization-standards-for-web-central/
Code Cheat Sheet
View
- View version refers to the code standard – do not edit
- JS supporting files (like the logo we add) are defined here. If you do not edit the supporting js file you do not need to copy/rename it.
- <js file=”client-title-logo.js”/>
- View Type and pattern – the organization of the panels
- “isAlterable” if you want the little edit icon in the top right panel or not. You may want to set this to false in your custom views as altering will get rid of some of the custom code that is not alterable through the simple alter view wizard.
- View Title
- Translatable = “true” – if you want the title to look for a translation if you are using multilingual ARCHIBUS
Data Source
- All tables/fields that you are referencing need to be added here
- Datasource ID – needs to match the panel/action button that is referring to it
- Standard Tables:
- If you want to bring in fields from a related table (ex: want to display a building site code on room data, you can have the main table be “rm” and the standard table be “bl”, as it contains the site code) you need to define the table as a standard table before you add the fields to the datasource.
- Note: you cannot transfer data in if you are using a standard table, you would need to transfer into each table separately
- Code example: <table name=”bl” role=”standard”/>
- Restrictions:
- If you only wish to bring in certain data, you can add restrictions to your data source. You can add as many restrictions as you want by adding new lines and then changing the relop
- Op Options:
- =
- !=
- IS NULL
- IS NOT NULL
- Relop Options:
- AND
- OR
- )AND(
- )OR(
- Code example:
<restriction type=”parsed”>
<clause relop=”AND” op=”=” table=”rm” name=”rm_cat” value=”PERS” />
<clause relop=”AND” op=”IS NULL” table=”rm” name=”rm_type” value=”” />
<clause relop=”)OR(” op=”IS NOT NULL” table=”rm” name=”rm_cat” value=”” />
<clause relop=”AND” op=”!=” table=”rm” name=”rm_type” value=”Lab” />
<clause relop=”AND” op=”!=” table=”rm” name=”name” value=”Panda Room” />
</restriction>
- Sorting data by a field: add sort field to panel
- <sortField name=”date_assigned” table=”wr” ascending=”true” />
Panels, Actions, and Fields
- The number of panels you can have depends on the view pattern – so it’s best to start with a pattern that can display the data how you like.
- Panel Type: display type
- Id: needed for some action buttons (like delete)
- Datasource: what data source it refers to
- Other questions are usually self-explanatory and can be played with like “showOnLoad” and “columns”.
- Region: the orientation of the panels
- Options: north, east, south, west center
- Not all regions work with all view patterns
- Export to XLS Button (with custom button title, and hover text) – make sure to change the panel id.
<action id=”exportXLS”>
<title translatable=”true”>XLS</title>
<tooltip translatable=”true”>Export to XLS</tooltip>
<command type=”exportPanel” outputType=”xls” panelId=”report_panel”/>
</action>
- Data Transfer Button
<action id=”exportTXFR”>
<title translatable=”true”>TXFR</title>
<tooltip translatable=”true”>Transfer Data</tooltip>
<command type=”exportPanel” outputType=”txfr” panelId=”report_panel”/>
</action>
- Change a Field Name: If you want to change the name of a field, add a <title> within the <field>
<field name=”contact_name” table=”rsc_contacts”>
<title>Contact Name</title>
</field>
- Make a Field Read Only: Add readOnly=”true”
- <field name=”form_name” table=”mv_survey” value=”Conference Room Inspection” readOnly=”true”>
- Hide a Field: Add hidden=”true”
- This is nice if the table has an auto-numerated key, as you need to have the key for the view to function, but you may not want to see it
- <field name=”form_name” table=”mv_survey” value=”Conference Room Inspection” readOnly=”true” hidden=”true”>
- Adding a space in a data panel: add an empty field
- <field />
- Adding text in a data panel:
- <field><title translatable=”true”>TEXT</title></field>
Was this helpful?
1 / 0