API - Application Programming Interface, a means in computer programming that enables the transfer of information from one application to another in a standardized format.
Asset - A component property of a process.
Asset Framework - A single repository for asset-centric models, hierarchies, objects, and equipment.
Asset Structure - The organisation of your assets within the confines of a repository.
Attribute - Descriptive characteristic of an asset.
Color - Colors are used to differentiate context item types.
Component - Tags, assets or attributes.
Context Item - An element of context that provides details of a component.
Context Item Workflow - A standard series of process states that can be predefined.
Context Type - A standard form of contextual information.
ContextHub - A detail factory, repository and search engine for context items that can be neatly aligned to both assets and processes.
Data Ingestion - The import of contextual information.
Description - A written and detailed account of a context item.
Event - A timestamp indicating a change in process.
Icon - A graphic symbol that represents a context item type.
Import - The way in which contextual information is inputted within ContextHub.
Keywords - Definers of a context item.
Name - Definer of a workflow.
Platform configuration - The organization of context types, workflows and asset structure.
Spot - The spot, also known as a bubble, is a small circular icon found on a trendline (context item spot) that flags a context type.
State - Components or process conditions used as the building blocks of a workflow.
Tags - A define dataset.
Technical Identifier - A standard identifier of a context type used for purposes of import and export of contextual information between applications.
Views - The presentation of context items that are logged within a time period defined in your ContextHub view’s filter.
1.1 An Introduction to ContextHub
Goto TrendHub's menu and click on the search icon find the Context Items search tool . Select this tool to open TrendMiner's ContextHub, the location where all elements of context used to annotate data can be found.
TrendMiner's ContextHub is a detail factory, repository and search engine for Context Items that can be neatly aligned to both assets and processes. ContextHub is a platform in its own right, and can be configured to requirements, so that context itself becomes a powerful new dataset which can be both visualized and analyzed. Events can be automatically captured, manually entered or easily imported from external business solutions, such as; Laboratory Information Management Systems, Maintenance Management Systems and OEE systems, thus maximizing the flexibility of contextual information crucial to today's self-service visual analytics.
The story of your assets and processes is key to the understanding of their inner workings. The more detail provided by the story, the better the provision for understanding. ContextHub will help you to build a highly structured story around your process and assets that can be easily shared with, and searched by others.
It is up to you to ensure the creation of context, it's ContextHub's role to help you create, import, manage, access and retrieve context.
What is a context Item?
A context Item is a block of information linked to a data point or a period of data associated with an event identified in your datasets. Instead of writing a note in a book, add your thoughts and observations to a context item.
Why use a context Item?
Having created your context item, you can use it to compare with other context items, share insights with colleagues and add further contextual information that will strengthen understanding of your process.
Context items can be added to the graphical representation of your data, or within contextHub.
1.2 Migrating from TrendMiner Capture
TrendMiner customer success team will help support the migration from your current TrendMiner Capture setup to ContextHub. Your asset data will be migrated; and previously created annotations will be converted to Context Items.
1.3 Using ContextHub
1.3.1 An overview of ContextHub
ContextHub supports the contextualization (annotation) of tags, assets and attributes (components) all contained within a package called a Context Item. Context items can be used to highlight a point of information within a trendline, or used to indicate time periods of interest that have a start point and end point. Context items can be presented in a number of display modes, including the;
- table display - a folder like list of context items;
- Gantt display - a series of items that can represent a process; and,
- detail display - specific information relating to your context item.
A context item can be one of many context types (batch, anomaly, temperature measurement etc.), and contains information relating to:
- Start date
- Intermediate dates
- End date
- Short key
ContextHub stores your items and has a search facility that enables you to find specific items of interest.
Searching items typically results with a list of items that fall within the frame of your search. A list of items in ContextHub is referred to as a ContextHub View. Views can be saved.
You can make the view more specific by adjusting the search parameters (filters) to include a range of different properties, like Context Type or Component. For example, if you are interested in information concerning a particular asset over a given timeframe, your views platform will enable you to conduct a search based on these parameters. You can then further filter your views to identify when your asset exhibited a certain anomaly over a period of 3 years, for example. You can then save your search (ContextHub view). All views that have been saved in the application are also listed in the Work Organizer.
Context is the flesh. To complete this analogy the bones are your assets, attributes and tags:
- Asset: An asset is a process component, for example; a pump, a valve, a column, a heat exchanger. A number of different tags can be related to a single asset.
- Attribute: A characteristic of an asset that has a time series signal attached to it (most of the time), for example: Flow rates, component specifications and temperatures. These are descriptive characteristics.
- Tag: Are time series datasets that reflect asset and process operation.
To construct a new context item you will need to provide the following information:
- Component - Tag, asset or attribute.
- Context type - Measurement, Batch, Anomaly etc.
- Description - Further context to your item.
- Keywords - Related to your context item.
- Events - Timestamp that relates to a given state of your item.
To enter a context type, you must first configure your type (you will need administrator rights). To configure a type you must provide the following information:
- Technical identifier - Used for your imports, api calls..
- Name - A classifier that highlights the nature of your type, eg. Measurement, Batch, Anomaly etc.
- Workflow (optional) - Is a process path composed of states - the more common being a functional state intersected by two events; start and stop.
- Visualization - An icon and color (context item spot). This is an image that will appear on your Trendline highlighting to you the type of context that relates to your context item.
To complete the configuration of a context type, you must first configure a workflow. To configure your workflow you must provide the following information:
- Technical identifier - API calls, import id..
- Workflow name - What is used when constructing a context type
- States - The steps contained within your workflow. There must be a start and end state entered.
Once your types and workflows are configured, it will be very easy to construct new context items.
As a user you can add context to your process by choosing a component (tag, asset or attribute), selecting a context item type, and then adding further context in the form of a description and keywords.
- Component - Asset: Reactor R302
- Context Type - Anomaly
- Description - Reactor overheated shortly after commencement of process, followed protocol to resolve issue. No problems since.
- Keywords - TodoSearchRootCause
You are free to annotate your tags when using other search tools, for example, the similarity and value based search tools. Simply select your search option of choice, open the tags of interest and then click on the 3dot icon menu. You will see an annotation option in this menu, enabling you to provide context to your data signals.
You can also add an instant context item in the focus chart of TrendHub. This is a direct annotation that will result with a trendline point highlighted with an icon. This is done by double clicking in the focus chart to reveal a scooter. In the scooter dropdown you can select the speech bubble icon, which when opted for will open up a side panel for the construction of a new context item.
The following is an overview of the key elements in ContextHub:
Contain context items that are logged within a time period defined in your ContextHub view’s filter. You can make the view more specific by adjusting those filters to include a range of different properties, like Type or Component.
Context items can be grouped by different types. The types are what gives context a classification of what that data represents, and it defines the workflow that is attached to a type which the events will need to follow. The states that come with your context item workflow provide context relating to the status of an event (Process started, In Progress, Paused, Completed).
These are a series of states you can choose when you are entering events into context items.
When creating new context types, you can configure a workflow. A workflow is a process path composed of states. Once configured, you can then create a context item and select your newly created context type. Having selected the context type, you can choose from configured states of which your event will be composed.
The timestamps that intersect states; start / stop.
Note: dates in TrendMiner are represented in UTC with the option to include timezone information in alignment with ISO 8601.
Process conditions used as the building blocks of a workflow. Otherwise described as the periods between event timestamps; the actions, conditions and occurrences.
As administrator you will configure the context framework with types and workflows, giving users a selection of states and types to choose from when creating context. This will become the narrative (the story) around your assets and process.
The spot, also known as a bubble, is a small circular icon found on a trendline (context item spot) that flags a context type.
1.3.2 Context item search in TrendHub
When in TrendHub, you can search for context items using the Context Item Search tool , located under the search icon in the software menu . This search tool has replaced the event frame search.
Context item search lets you select views from ContextHub and presents them as time periods that can be overlaid in the trend view.
Note: You need to click on "saved contextHub views" in the search menu to use the search in TrendHub. If you click on context items, you are redirected to ContextHub.
Note: Searching context items can only be done under the search icon in the TrendHub menu. The search requires the creation of a context view. A context view can only be created in ContextHub.
Once you have filtered views and saved them in ContextHub, the context items contained can be searched for in TrendHub.
- Select the search icon in the TrendHub menu.
- Under the heading of Context Items, click on "Saved ContextHub views".
- The work organizer will open providing you a list of views, choose one. A trendview similar to the one in the image directly below will open:
- Click on "Search Context Items" button. Search results will appear below the search button. See image below. In this case, 169 items were found.
1.4 Platform Configuration (Administrator)
1.4.1 Access to ContextHub configuration pages
To access the ContextHub configuration pages, you must have administrative rights. It is here you configure the platform and tune it to your process:
- Click the gear icon present in the top bar of ContextHub.
- Look to the PLATFORM CONFIGURATION.
Three tabs are visible: Context Item Workflows, Context Item Types, Context item fields, Asset structure and Context Item Import.
1.4.2 Context Item Workflows
This option enables you to provide the "workflows/states" that are used when creating new Context Types.
- Click on "Config" located in the top bar of ContextHub.
- Go to the PLATFORM CONFIGURATION menu.
- Select "context item workflow".
You will be led to the State Configuration page where you will see a table that lists your states.
188.8.131.52 Add a Context Item Workflow
- Click on the "+Add item" option highlighted in blue above the configuration table.
- A new workflow config side panel opens. Fill in the fields of this panel. In this panel you can enter the states and substates of your workflow. However, the states list must include a start and end state.
- Enter the start and end state where requested in the panel.
- Once the panel requirements are completed, click on the "Save" button.
Note: Your new workflow will be added to the workflow configuration table.
184.108.40.206 Delete a Context Item Workflow
- Select "Context Item Workflows" in the PLATFORM CONFIGURATION menu.
- Identify the workflow you wish to delete, and click on the three vertical dots at the end of the selected row.
- Click on delete.
220.127.116.11 Changing workflow order
You can reorder the workflows by clicking on the title of each column. To refine your workflow order further you need to reconfigure your workflows.
- Select "Context Item Workflows" in the PLATFORM CONFIGURATION menu.
- Identify the workflow you wish to reorder, and click on the three vertical dots at the end of the selected row.
- Click on Configure workflow.
- Rename the workflow or add a state as required.
- Click on save
- Click on the column head that you wish to reorder.
Note: New workflows can be reordered as needed. But once the workflow is created its start and end items will be fixed in place and only the inner items can be reordered.
1.4.3 Context Item Types
Context Item Types are elements that can be used to add salient detail to your context data. Types also act as classifiers that can be used as a target for search. For example, you are interested in a particular process, specifically the maintenance history of your plant. With the creation and use of the Context Item Type "Maintenance" you will be able to find maintenance details of your process.
18.104.22.168 Open Context Item Type
- Click on the gear icon present in the top bar of ContextHub
- Click on "context item type" in left panel. A table view of all context item types available is shown.
- Select the context item of interest. A panel will open from the right of the screen, providing detail of the context item type selected.
- Edit context type fields within the panel. These fields include: the identifier, name, states, icon and color.
22.214.171.124 Create a context item type
- Click on the gear icon present in the top bar of ContextHub.
- Opens the context item types config page.
- Click on the "Add new Context Item Type" option to create new context item type. A panel will appear from the right of the screen.
- Populate the panel with a name, workflow (A-Z), icon and color (hex code).
- Click save.
126.96.36.199 Delete a context item type
- Open the context item types config page.
- Identify the context item type of interest, and click on the trash can icon located in the far right column of the configuration table, in the row your context item type sits.
- A confirmation popup appears, click "Yes delete".
- If you change your mind, select "Don't delete".
Note: If a Context Item Type is in use, the delete function will not carry out the request.
Note: You cannot recreate a TYPE with the same name even after deletion. Deletions are soft deleted only.
Note: Context Items can only be deleted by their owner or an administrator.
1.4.4 Custom Item Fields
This option enables you to create custom fields, using text, a number or predefined states. This option will allow you to add structured metadata to all context items in the form of parameters. For example, for batch records, you can add context fields like; product type, input feed and final concentration:
188.8.131.52 How to add a context field
- Select the gear icon located in the top bar of ContextHub.
- Go to the PLATFORM CONFIGURATION menu.
- Select "Context fields".
- Click "Add field".
A side panel appears from the right called, "New field".
- Fill in the fields provided in the side panel.
- Click "Save".
In the example above (left), a new field called "Reason" has been created. Now when you edit or create a new context item type (above right) you can add your new field. In this example, the context type "Equipment failure" is being edited so that a new field is required for completion. The new field added, is "Reason".
- Click on "CONTEXT ITEM FIELDS" to search for and select your new field.
When you now add a new context item and you select the type "Equipment Failure" the new field "Reason" automatically appears as a necessary field.
The newly made custom items can be added to the item view tables in the form of columns. If a number type custom field is added to a table, it will be possible to filter your new context type down to numerical ranges, data allowing.
1.4.5 Asset Structure
This is a tool that will enable you to import an asset structure with nodes and templates linked to tags.
As an administrator you will be able to create and update an asset structure. You can:
- Upload a CSV file with a defined asset structure;
- Track progress of the process in the history table; and,
- See the file is added to the history table after the file is uploaded.
1.4.6 Asset permissions
Access to asset information can be controlled at administrator level so that only those people that need access will be given rights. This is relevant when considering access to asset structure and contextual data attached to it at the process level, the division level and ultimately the plant level. Access to the structure means that you will be able to read the context items associated to the assets that access has been provided for.
Users with the administrator role have full asset permissions and can control access rights to the asset structure.
Note: The default position is full asset structure access to all root levels. Consequently, everyone with access to the asset framework will be able to read all context items by default. This means that permissions must be finalised before providing end users access to the asset structure.
To manage asset access rights:
- Click on "Configuration" in the top right of Contexthub.
- In the platform configuration menu select "Asset permissions"
The asset structure tree will open.
3. Identify the asset or parent you wish to set access levels.
An asset access panel appears on the right side of the screen. Here you will see any inherited permissions on the selected item. To add access rights:
4. Type the name of the end user under the "ITEM PERMISSIONS" heading, for which you want to provide permission for.
5. Select individual.
6. Look to the permission level field, and select permission level.
7. Click on the plus sign.
There is an overview dropdown which provides a description of the permission levels available. Three permissions levels are listed:
- Read context items: allows users to view context items in the asset structure (included permissions - browse).
- Browse: Allows browsing through asset structure.
- No access: Denies permission for users to browse beyond this component in the asset structure and hides the context data attached to these items.
Note: Access permissions can be provided at the root level, or lower levels. If access is denied at the root level, everything beyond root level is also denied. When permissions are granted on a lower level, users automatically get browse permission on the higher levels.
Access levels are played out through the asset structure provided to the end user. Assets that the end user has not been granted permission for, will not appear in the asset structure, or any associated views that have been shared.
1.4.7 Add permissions on types
This option lets administrators define permission levels for each context type.
Different types of information are fit for different users to input depending on department or role. Users can now be giving write or delete rights on a specific type. Shielding context item creation and updates from certain users.
When creating new types in ContextHub everyone gets write permissions to the type by default. Write gives someone the ability to create or update context items of the selected type. The other permission, “delete”, provides the user the option to delete a type, whilst maintaining the right to create and update the context item type.
The principle is that end users will have the right to read and maintain types, but only managers or team leads can delete a type.
Note: Without any permission on the type you can not create or update context items based on it.
Note: With permission to write on the type you can edit previous items (i.e. all content on the item). You will not be able to delete the item.
To provide permission on types:
1. Create a new context type in the normal way.
2. Identify your type row on the ContextHub grid, and click the three vertical dots situated far right of the row.
3. Click on "Edit permissions".
4. Type in the name of user under "ITEM PERMISSIONS".
5. Select between "Write" or "Delete" options.
6. Click on the plus button.
Note: Deleting a type means a soft delete. ie a new type with the same name will not be possible.
In addition to permission rights, approval rights on content can also be managed.
1.5 Data Ingestion
1.5.1 Context Item Import
For quick ingestion of context data without plugging in an integration through APIs, there is a context item import available, where CSV files containing your data can be uploaded. For example, to do a quick import of a file with lab sample measurements.
This feature enables you to import historical and ad-hoc context data from an external platform.
- In ContextHub and click on "Platform Configuration".
- Select "Context item import" in the platform configuration menu..
- Click on "Add component" and populate the fields.
- Select your file to import.
Select the "View import history" button to list previous importations.
Existing log book applications, OEE tools, spreadsheets with batch data, LIMS data or other 3rd party tools can have their data ingested and imported as context. Providing aligned workflows and types are available in ContextHub, Context Item import functionality allows you to use a standardised CSV format to easily import data from external systems.
1.5.2 Context REST API
We employ REST API to enable more elaborate integration with data in ContextHub, e.g. data ingress to retrieve data from external systems and data egress to expose context data to business intelligence tools. REST API development teams can develop integrations of choice.
1.5.3 CSV Files
CSV stands for comma separated values, and the .csv file format is commonly used to exchange data between applications. This format can be easily imported and opened by excel, and visa versa. Further information on the rules and uses of CSV files is provided in the TrendMiner help panel. Just type "csv-file requirements" into the help panel search tool, and open the file.
The CSV-file consists of the following columns in which the listed info is required:
|Column #||Column-name||Required info|
|1||Description||Text that will show up as the context-description.|
|2||Type||Technical identifier (used in imports, API calls, etc.) of the Context Item Type|
|3||Keywords||Keywords separated by commaE.g. "keyword1, keyword2, ..."|
|4||Events_0_state||Start state as defined in the corresponding Context Item Workflow|
|5||Events_0_ts||Timestamp of the starting state in "UTC" format YYYY-MM-DDThh:mm:ss:SSSZ|
|6||Events_1_state||End state as defined in the corresponding Context Item Workflow|
|7||Events_1_ts||Timestamp of the end state.|
|8||Properties_0_key||Technical identifier of the Context Field (or other property)|
|9||Properties_0_value||The value of the Context Field (or property)|
|10||Properties_1_key||Technical identifier of a second Context Field (or other property)|
|11||Properties_1_value||The value of the second Context Field|
Note: Dates in TrendMiner are represented in UTC with the option to include timezone information in alignment with ISO 8601.
Note: The administrator is able to configure a number of states and substates that can be employed within a workflow. There is no limit to the number of states you can use.
Note: We employ REST API to enable more elaborate integration with data in ContextHub, e.g. data ingress to retrieve data from external systems and data egress to expose context data to business intelligence tools. REST API development teams can develop integrations of choice if required.
Note: Make sure to check the format of the .csv file after editing it in tooling like spreadsheet software. Depending on the settings and tools used, a csv file can be saved as comma separated or semicolon separated.
1.5.4 Cross asset search templates
The cross asset value based search is a TrendMiner search option that enables you to explore through similar assets and attributes that are predefined as part of a template.
Assets belonging to the same group are defined within a template column of your asset structure. Having defined your templates and grouped your assets and attributes within the template column, you will be able to search through your assets and attributes in the form of groups, as opposed to individual datasets.
Your asset framework may contain a template column for templates to which assets and attributes are associated. The created template is used to find all assets that are grouped within its confines. The image directly below is an example of an asset file structure that contains the template name "BA Reactor". This particular template groups reactors 1, 2 and 3. Traditionally through the value based search you would need to save each individual reactor search for a particular value of interest, to then compare and contrast. With the cross asset value based search you can easily search through all reactor data by ensuring at the description level you group each reactor under the template, in this case, BA reactor.
Note: The created template name must be consistent in its use. This means consistent spelling and case use.
1.6 My Views (End User)
Goto TrendHub's menu and click on the search icon to find the Context Items search tool . Select this tool to open TrendMiner's ContextHub, the location where all views for context used to annotate data can be found.
Note: You need to click on "saved contextHub views" in the search menu to use the search in TrendHub. If you click on context items, you are directed to ContextHub.
This path leads directly to the Work Organizer. Alternatively you can click on the work organizer situated top right of the UI.
A view in ContextHub is a window to the list of context items you have stored. If required, a view can contain every context item stored in your library, or a series of context items filtered based on a set of conditions selected by the user. Adding a context item does not necessarily add it to a view you have opened. It is critical to understand that a view is controlled by the filter conditions placed upon it. If your newly formed Context Item does not fall within your view's filter conditions, it will not appear in your view.
See the filters section below for more details.
1.6.1 Loading a view
Look to the MY VIEWS menu within the panel on the left hand side of the screen.
- Click on "MY VIEWS" to open the "MY VIEWS" drop down list.
The list is a series of previously saved views in ContextHub.
- Select a view from the list.
The view will open and present your context data in the table display mode by default.
A View table presents a series of Context Items, normally indicative of a process. The table is composed of the following columns which can be selected by clicking the gear icon:
- Created by
- Current state
- End date
- Key words
- Short key
- Start date
- Context fields
Opening the column selector (gear) will give you a variety of column types you wish to see displayed in your views table. Tick the column options that are interesting to you. Each new column selection will be placed to the front of the list of columns.
If you wish to see the story of your Context Item, click on a row to open the Context Item details panel, which appears from the right side of the screen.
1.6.2 Add Context Item
To add a Context Item, simply click on the + icon where it says "Add Context Item" at the top right of the screen in ContextHub.
An "Add Context" Item panel will appear from the right of the screen, providing a series of detail elements to be completed and saved.
- Select a Tag, Asset or Attribute in the cell named "Component".
- Select a context item type.
- Add a description for your Context Item.
- Add a few keywords that relate specifically to your Context Item.
- Add events to your context item. The minimum number of events required is two; the start and end events.
Note: The "Type" cell is a drop down list of Context Item Types created in the Configuration Page described above.
1.6.3 Context item approval
In some circumstances the context item updates will need to be approved or verified by an accountable actor. An approval requirement can be set within a context item so that any accountable staff can put their name to the item, effectively acknowledging that they have checked and/or agreed with the new updates placed into the context item.
Why use context item approval?
Dependant on the urgency of the situation an approval requirement on an item can be created so that an accredited operator, engineer or similar can read the situation as laid out in the context item and respond with an approval of the item, or take necessary actions to ensure the state for approval is met. For example, approvals can be used to acknowledge receipt of an update, acknowledge that a task has been carried out, or acknowledge that a shift report has been read.
Anyone creating a context item type can add an approval requirement. If you have a context item that uses a type with approval settings established, you can switch the approval setting on.
How to set context item approvals:
- Create a context item type as normal.
- Tick the "Approvals available" button.
If you have edit rights on the context item for a type, you can set yourself the approval.
- Create a new context item using your new context type.
- Click home on the ContextHub bar.
- Click the + sign at the top of the views menu.
- Filter your view to locate your new context item.
- Click the small greyed arrow that points right at the far right of your new context item. A side panel will appear from the right.
6. Click on the "Add approval" button.
When you add your approval, you are essentially authenticating the context item you have created. You approval will be publicly available. When others given authority to approval approve, you will see this highlighted under the "APPROVALS" section in the context item.
If necessary you can remove the approval by clicking the "Remove approval" button.
Note: The users that click the approve button are the ones that appear in the item.
Note: When you edit the item, approvals are automatically removed.
Note: By default no one will have approval.
Create more process insights by adding documents to context items as attachments.
Add attachments to the context items in ContextHub using a drag and drop mode or by using browse mode.
1. Go to ContextHub
2. Select the context view.
3. Click on the context item of choice.
A side panel will appear from the right
4. At the top of the panel select "Attachments".
5. Drag and drop or browse and select a file of choice.
6. Click on "Upload".
The uploaded file will appear above the drag and drop site.
Each time you wish to access this document you simply return to the context item and open the attachments option. The file will be available providing you have the appropriate access rights.
Note: Unique names are needed when uploading your documents.
Note: Most document types are loadable (PDF, Doc, Dox..), with a maximum file size of 20 Mb.
1.6.5 Comments in context item
Each context item provides the option to add comments, for any information that can be deemed pertinent to the asset or attribute.
Why use the comment box?
The comment box is there as a communications device that can prove invaluable to those needing to be briefed on the events and any key updates of the day. The comments list provides provenance to the context item, enabling anyone to understand the history of the asset or attribute with relation to any issue that may arise and any individual that maybe associated.
How to add comments
- Open a new or current context item and scroll to the bottom of the context item panel.
- At the bottom of the panel add a new comment.
- Click on the "Add comment" button.
Note: Each additional comment is added to the comments list in chronological order.
1.6.6 Component selector
The component selector is an option available that enables you to select your tags and assets in a number of locations in TrendMiner, for example; the component filter in ContextHub, the context item visualization panel and the context import screen.
The procedure is the same wherever you employ it, in this instance we add a component while we create a new context item:
- Goto ContextHub.
- Select "Add context item" located in the top right hand side of the screen.
- Populate the newly opened side panel as normal.
- Click on the "Add a component" button.
Note: When you select the "Add a component" option, a mini asset browser appears.
- Search for or identify a component from the list.
- Click on the icon directly to the left of the component name so that a green tick appears.
- Click on the "Select" button.
The component is now added to your components list as a bubble. You are free to add more components as you wish.
Note: When selecting a component, parent information is included.
Note: If an asset framework is not available, contact your system administrator to set one up.
1.6.7 Context item history
Context item history is an administrator option that when activated stores all changes on a context item in an audit trail.
Why use audit trails?
Audit trails provide a context item content archive that may be referred to if descriptive elements of an item have been unintendedly lost through deletion, technical fault or personal fault; or you simply wish to refer to historical content.
How to activate the context item history tool
1. Goto a context type of interest and open its details panel.
2. Scroll down the panel and find the "Turn on history" check box.
3. Click the "Turn on history" check box to activate the option.
4. Click on "Save Context Item".
Note: When a context item is deleted, all audit trails are deleted too.
Accessing the audit trail
At the moment audit trails are available through the TrendMiner APIs. To access the APIs of TrendMiner contact TrendMiner support to get developer access.
1.6.8 Adding a context item in TrendHub's focus chart
With the appropriate access rights, instant annotations can be created in the focus chart, and later retrieved in ContextHub. In order to create instant annotations:
1. Double click in the focus chart which you wish to create context. A data scooter and additional menu will pop up.
2. Clicking the context (annotation) icon opens the context menu on the right of the screen.
3. Select the component (tag, attribute or asset) on which you want to create the context.
4. Select the type and description of the context.
Optional: Assign keywords and/or a description to the context.
5. Tick off "Create item on visible layers" if you want to create context for all layers present in the focus chart.
This could be useful when you have retrieved multiple occurrences of a similar event and want to label all the overlays with one action.
- Click the 'Save' button.
Note: When creating context over a period in the focus chart, the scooter will present range information that highlights the start and end of your selected period.
Note: Currently, the limit on the number of context items that can be visualized within the focus chart is set to 150.
1.6.9 New view / Filter function
Filter your ContextHub views to get a more concise picture of your process issues.
A new view can be a specifically filtered set of context items. First you must understand what you want to look for within your views content, then create a filter query. You can filter on all the available fields in context items.
1. When in ContextHub, select a current view and click on the "+Add filter" function.
2. Choose from a selection of filter types to focus in on your context of interest. Filters include:
- Component (+ Hierarchy filter)
- Created by
- Current state
- Other properties
- Context fields
If you wish to select a component, click on component. Using the newly opened drop down menu, select a Tag, Asset or Attribute you wish to filter for. Check the box "Include ancestors". The "Include ancestors" check box adds a hierarchical filter which returns all contextual data included on the components that are the ancestors of the selected components.
You can filter context items by their "Current state". So for example, if you wish to see all context items that are currently "In Progress", select the "Current states" filter and then select the "In progress" option. This active filter enables you to filter your active context items specifically.
You can also filter a view using time periods and dates, relate to:
- Event start date
- Creation date of the context items
Simply select the time cell (last eight hours is the default setting) and enter the time periods and dates desired, in which your events occur.
You can either:
- select a preordained period (in which your event occured) by clicking on the "8 hours"field;
- select specific event dates; or,
- choose an item creation date beneath the "Creation date" button. This subfilter includes before and after date.
Then click "Done".
Note: Creation date filter is not available on the Gantt chart.
You can also enable "Enable Live mode". Live mode enables auto-refreshing of the grid chart so that new items set, feature on the grid chart automatically.
1.6.10 Keywords filter
When you have a new view, are editing an existing view, or when you view or make context items, you can attach keywords to it.
In ContextHub you can search for a context item within a view of interest by filtering for a component, a context type and / or a keyword.
- Go to ContextHub.
- Select your view of interest, or create a new view.
- Select the keyword option from the available filters.
- Add a keyword to the dropdown panel (as many keywords as you like).
- Select done.
This filters the content in your current view to find elements that contain your selected keywords, as well as any other filter you may have selected.
1.6.11 Save a view
Once you have created a view through your filter selection, be sure to save your view.
- Click on the Action option to open a dropdown menu.
- Click "save as" to enter a name and description of your view.
- Click on "save view".
Note: Your newly created view will now appear in the list under "MY VIEWS", and will be added to your work organizer.
1.6.12 Search ContextHub’ s views
Over time your list of views will become extensive. To help find the view you are looking for goto the TrendHub menu and click the search button . Find the Context items icon and select it. The "My Views" page supports a search function for views. Simply type in the view you are looking for.
Note: You need to click on "saved contextHub views" in the search menu to use the search in TrendHub. If you click on context items, you are redirected to ContextHub.
Items can be sorted by 'Start date', 'Short key', 'Type', 'State' and 'Description'.... by clicking the corresponding column header in the table display.
1.6.14 Visualize context items found in ContextHub, in TrendHub directly
When you start in ContextHub, you can get a table view of your events of interest. You can view the details of a context item of interest by clicking on an item. If you want to visualize the context you have found in ContextHub on a graphical display in TrendHub:
1. When in ContextHub, select a view, then context item of choice.
2. Click the option button, in the newly opened side panel.
3. Click on the visualize button (you are directed to a side panel in TrendHub).
4. Select the tags or attributes you want to visualize.
5. Make a selection from the asset list made available.
6. Select visualize.
A period of 8 hours will be visualized with the context item in the middle of that period. If the context item is less than 4 hours before the 'now' moment less than 8 hours will be visualized.
1.6.15 Grid live mode
Live mode enables auto-refreshing of the grid chart so that new items set, feature on the grid chart automatically.
Why use live mode?
The purpose of the live mode option is to ensure that the information you have in your ContextHub grid is up to date and inline with any edits or updates made on items at any given time. As time progresses the new items appear at the top of the grid in chronological order.
How to engage live mode
1. Click on the time filter situated above the grid chart.
2. Click on the check "Enable live mode".
3. Click on "Done".
4. Click on the "Actions" button (top right of the ContextHub UI) and click "Save" in the drop down menu.
Once live mode is engaged, you can see a small icon on the time filter above the grid that signifies the fact you are working in live mode. The bubble also turns green.
Every time a new item is added or edited, live mode will ensure your grid is updated to fall in line with any revisions or new inclusions associated to your view. When live mode is switched on and the grid is saved, the live status of your view will remain until you switch it off and re-save the view.
Note: Live mode changes sorting to chronological order, where newest items come in first.
Note: If you turn off the live mode, you must re-save the view if you wish the off action to persist.
1.7 Gantt Chart
As a user you can view a Gantt chart to display your context items.
The Gantt chart can be configured to display context items typically seen in the ContextHub grid view. Components in the Gantt chart are displayed by section and context types fall under each relevant section by row.
You are able to view multiple components on the Gantt chart which by default display in alphabetical order. You can sort the items in your chart by type or by component. New items are added to the bottom of the chart. This is particularly important when you are collecting new items for your chart in live mode.
Refine your Gantt using multiple options located under the filter button and by citing the period of interest. Group your items by context type or by context field.
To select Gantt view mode:
- Open ContextHub.
- Filter your views using components and any other filter field of choice.
- Click on the Gantt chart icon located towards the top right of the ContextHub UI.
Note: Context items of an instant type are plotted in the row of the component itself.
1.7.1 Gantt Settings
Located at the top right of the Gantt chart is the settings button . Under this button two settings can be found:
- Expand all types by default (see overlapping context items below)
- Gantt configuration
- Display density
- Group by
1.7.2 Gantt configuration
184.108.40.206 Gantt display density
The display density of the Gantt chart refers to the level of bar compaction seen on the chart. There are three settings: compact, regular and spacious.
First display your Gantt chart on screen, then:
1. Click on the gear icon at the far right of the Gantt timeline heading (Gantt settings).
2. Select display density.
3. Click "Save".
220.127.116.11 Gantt grouping
By default the group setting is by context type. Rows can also be grouped in the Gantt chart based on context field.
In the following image two context types describing events concerning a process flow component are displayed. The context types are:
- Loss: Availability
By clicking the three dots and Gantt configuration, you can select a context field, a drop down table opens and lists the fields available.
- Click "Context field".
- Select one of the context fields listed in the drop down menu.
- Click "Save". Now the Gantt chart is sorted by the values of the selected context field and the "no value" represents the empty context fields.
18.104.22.168 Overlapping context items
When you hover over an item on the Gantt chart, underlying context items are contrasted from the top layer.
By clicking on the item a dropdown list of items appears.
You can also expand the type by clicking the small arrow situated in the first column of the item. All layered items are now located on their own row.
Note: Expanded rows are organised by start time.
Expand all types by default under the three vertical dots button.
- Click on the three vertical dots situated at the top right of the chart bar.
- Click the checkbox for "Expand all types by default".
22.214.171.124 Instant context items
Instant context items are items with a single time point signified on the Gantt chart by an icon; for example, an information icon highlighted as an (i) in a small green circle.
The same principles as with the overlapping context items above apply to the overlapping instant items as well as context item fields.
- Click on individual instant items to open the associated context panel
- Click on the arrows located in the row headers to expand overlapping instant items / context fields.
- Scroll over a cluster of icons and click, a dropdown list will appear providing a list of all instant items in the cluster.
To expand types or fields by default,
- Click on the three vertical dots; a drop down menu will appear.
- Click on the expand check box located in the drop down menu.
Also under the dots you can select a gantt configuration. A side panel will reveal from the right for you to select display density and group type.
Note: This will expand all rows but you can still overrule certain rows by the arrow in front of the row.
Note: Info items have no overlapping solution currently.
Note: When using this option, all newly added data (e.g. types that have no data in the current timeframe but have data in a larger timeframe) will follow this default setting.
126.96.36.199 Gantt live mode (ContextHub)
Live mode enables auto-refreshing on the Gantt chart so that new items that have been set, feature on the Gantt chart automatically. As time progresses the new items appear on the right of the Gantt and grow in size as they remain active.
To engage live mode:
1. Click on the time filter situated above the Gantt chart.
2. Click on the check "Enable live mode".
3. Click "Done".
4. Click "Action" and click on "Save".
Note: Live mode updates every 5 secs.
Note: Live mode is only available for relative time periods. Eg. Last 8 hours
Note: Historical data of items added to the Gantt chart will not be seen in live mode. Only the newest information is added.
Once live mode is engaged, you can see a small icon on the time filter above the Gantt that signifies the fact you are working in live mode. The bubble also turns green. When live mode is switched on and the Gantt is saved, the live status of your view will remain until you switch it off.
New items added to the Gantt with the live mode on can be visualized in real time. When items are closed manually, the Gantt elements affiliated will automatically stop further additions to the bars.
188.8.131.52 Sorting the Gantt chart (ContextHub)
Gantt sort refers to the order of the Gantt components and types displayed on the table. Gantt sort enables you to move the context components and types into an order of preference. By default new context items are added to the bottom of the Gantt.
To sort the context items:
1. Look to the item you wish to move.
2. Click the small arrow to the right of the context item name, up or down to move as desired.
3. Save the sort conducted by clicking on the action button.
4. Click "Save" in the action drop down.
Gantt sort occurs on two levels; the type level and component level. You can use the up down arrow beside the type name to move the type up or down the table as required. Sorting on the component level sorts the component as well as associated types. For example, if you have a pump component with various types associated, such as an anomaly, equipment failure and cleaning types, the entire package moves with the component.
Note: With any alteration to the order of the components and types, the view definition changes to "Unsaved changes", so you must save after the selected component/type moves.
Note: Gantt rows are sorted alphabetically by default.
1.7.3 Label on the Gantt
For ease of identification the bars on the Gantt can be specifically labelled with identifiers that enable simple differentiation between context types.
Labelling of this type is controlled in the edit type detail page.
1. Goto ContextHub and click on the Configuration button on the top right of the UI.
2. Click on "Context item types" in the "PLATFORM CONFIGURATION" menu.
3. Select a context item type you wish to have a field label, and click on the three vertical dots located on the right side of the type row.
4. Click on "Edit type" in the drop down menu. A side panel will appear from the right.
5. Under "Context fields" select the items you wish to add a label on the Gantt, and turn the associated toggle on.
Now the identification is displayed on the associated item Gantt bars.
1.7.4 Create context items on Gantt
If you are viewing the Gantt chart, you have the option to add context items directly to the chart. This is particularly useful if an item is missing from the chart and you need to quickly add it.
- Drag and drop over the period of the chart you wish to add an item.
- Click on the + icon that appears right of the drag and drop. A context item panel will appear from the right of the screen.
- Select the item type, provide a description and add further details if necessary.
- Optionally, add more events making sure to select the right states.
- Click on the "Save Context Item" button.
You can see the new context item on the chart providing suitable filter options are selected.