SmartPlant Foundation Customization - SmartPlant Foundation

PPMProduct: SmartPlant Foundation
PPMCategory_custom: Customization & Programming
SPFVersion_custom: 10

SmartPlant® Foundation Customization
SmartPlant Foundation Client Customization
Creating a New Project
Creating your project
Getting Started with the Training Assembly
Loading the training project
Setting the references
Setting the compilation directory
Configuring the Desktop Client to load our custom assemblies
Debugging our custom assembly
Alternative debug mechanism
Writing a Custom Client API
Introduction to the model
Writing the Client API class
Configuring methods to invoke our Client API
Using Containers
Retrieving objects into a container
Creating objects in a container
Committing changes to the server
Adding Custom Windows Forms to Your Client API
Designing the form
Changing the form's inheritance
Placing the form in the SmartPlant Foundation namespace
Modifying the constructor
Invoking the form from the Client API
Calling Server APIs
Client Primitives
Getting objects from the server
The GetObjectByOBID method
GetObjectByName and GetObjectsByName methods
Getting objects by UID
Getting objects using advanced query
Expanding relationships
Expanding edges
Transactions
Creating objects
Creating relationships
Creating relationships with link interfaces
Updating objects and relationships
Terminating objects and relationships
Creating file objects
Immediate (non-transactional) operations
Structured objects
Creating complex objects (documents)
Document specific helper methods
Customizing the Tree View
Customizing the List View
Customizing the List Edit Control
Customizing Forms
Wizard overrides
Base wizard overrides
Page overrides
Create wizard overrides
Copy wizard overrides
Info wizard overrides
Update wizard overrides
Query wizard overrides
Form section classes
Adding items into the section
Overridable methods
Display item classes
Overriding display items
List of overrides available
Modifying combo box choices
Adding a custom control
Customizing a Module
Custom module properties
Required class attributes
Custom module class properties
Controllers
View model views
Views
Regions
Event aggregators
Desktop Client module
Using the Desktop Client in your module
Scope control
Configure the custom module
Persist your module
Change the size of the header and footer
Switching modules
Other Code Examples
Default create values
Client Training Assembly Examples
Show the user the ENS-generated name before creating the object
How to see it
Location of source code
Replace display item with new control
How to see it
Location of source code
Modify the contents of a display item picklist
How to see it
Location of source code
Changing value on a display item
How to see it
Location of source code
Place a button next to a display item
How to see it
Location of source code
Place a button at the bottom of the wizard
How to see it
Location of source code
Extract list view to Excel
How to see it
Location of source code
Output object to immediate window
How to see it
Location of source code
Issue change (shortcut menu server call)
How to see it
Location of source code
Update all User Settings
Update all users process
Update process processing messages
SmartPlant Foundation Server Customization
Getting Started with the Training Assembly
Loading the training project
Setting the compilation directory
Checking compilation
Setting references
Configuring SmartPlant Foundation to load the custom assembly
Debugging the custom override
Attaching the debugger
Security warning
Hitting the breakpoint
Debugging hints
Creating a New Project
Creating your project
Creating the interface class
Interface Overrides
Sideways override
Overrides using modeling
Customizing icons for light list view paging query
Server Module
What is a module?
Creating the class library for a custom module
Implementing a module
Implementing the module class
Server APIs
Abstract server API class
BaseItem and BaseDictionary
Implementing OnDeserialize
Implementing OnHandlerBody
Helper functions for extracting single object
Helper Functions for extracting multiple objects
Managing transactions
Implementing OnSerialize
Serialization usage
Example server API
Modeling a New Interface
Modeling
Example load file
Adding a new MethodDef
Editing the SpecializationValues.xml file
Using the code generator to create the interface implementations
What it does
How it works
Configuring the code generator
Using the code generator
Writing code overrides
Create any PrimaryMethodDefs
Load new interface into the database
Server Primitives
Query
GetObject
Retrieving objects by UID or OBID
RunBy methods
Retrieving objects by interface and name
Retrieving objects by complex queries
Retrieving objects by querying on related properties
Using the cache
Accessing properties
Accessing other interfaces using ToInterface
Expanding relationships
Single object
Multiple objects
Expanding edges
Customizing edge expansions
Callback functionality
Post handler functionality
Expanding GraphDefs
Navigating the schema
Transactions
Streaming transaction
Creating objects
FinishCreate
Updating objects
Terminating and deleting objects
Creating relationships
Link interfaces
Terminating and deleting relationships
Committing the transaction
Deferred methods
Create deferred methods
Update deferred methods
RequestContext class
Throwing exceptions
Calling with custom SQL statements
Configuring the SmartConverter for Graphical Navigation
SmartConverter prerequisites
SmartConverter setup
Set SmartSketch as the default symbol editor
Add SmartSketch symbol to the registry
Set DCOM configuration for the SmartConverter
Grant the SmartSketch symbol identity user account full control access to registry keys
Grant security permissions to local service account
SmartConverter configuration
SmartConverter Controls
Find a SmartConverter Control
Create a SmartConverter Control
Update a SmartConverter Control
Terminate a SmartConverter Control
Modify SmartConverter options in SPFSmartConverter.ini
Define Hotspotter rules in SPFHotspotter.ini
Free text and group text rules
Convert blocks into groups for scattered text processing
Adding a special tag handler
Mapping topics to interfaces
Adding a user macro
Hotspotter utilities component reference
Overriding the SmartConverter
Test the rules
Discovering tags with the batch SmartConverter
Set conversion required for navigation
Navigating the drawing
Polling Intervals for the Scheduler
Override the default number of threads
Using Scheduler Tasks
Server Training Assembly Examples
Custom reporting
How to see it
Location of source code
Adding server side validation
How to see it
Location of source code
Overriding a server API
How to see it
Location of source code
Workflow process step customization
How to see it
Location of source code
Asynchronous process step
SmartPlant Foundation Version 2016 Impact on Existing Custom Server Projects
Custom settings files for custom server projects
Query mechanism for custom server projects
Calling with custom SQL statements
Using the Dynamic Query in the Data Access Layer (DAL)
What to import into the class definition
Building criteria
Containers
Executing queries
Functions
Ordering the results
Related items and related item properties
Paging queries
Custom result factories
Partial queries
Edge and relationship expansion queries
Using the Graph Expansion API in a Query
Class definition syntax
Building object criteria
Executing a graph expansion
Create a graph expansion instance
Specify starting objects for expansion
Adding graph node criteria
Adding properties to return for a partial query expansion
Graph expansion properties and methods
Migrating existing graph expansions
Configuring upload to a SmartPlant Foundation Web Client Site
Configuring virus scanning for uploaded files
Integrating an existing virus scanner
Settings
Uploading Files
Upload a single file
Upload a large file in separate parts
Make a file available to a safe location
Determine if an in-line virus scanner is present
Expose Methods for Extensibility
ExposedService attribute parameters
Singleton
Entities and entity objects
Actions and functions
Contained EntitySet
Updating objects
Bound action
SmartPlant Foundation Web Services
Security
Login and SessionID
Configuration
ChangeSessionConfiguration
GetCurrentConfiguration
Transfer Object
DataTransfer Datagram
Simple DataTransfer View
The "header" Data
The "item" Data
Full DataTransfer View
UploadResult Object
Tracing
Upload Web Service
UploadTransfer Method
UploadFile Method
UploadFileValidateOpt Method
GetUploadResultLog Method
GetInfoForFTPFileUpload Method
ViewFileUsingVirtualFilePath Method
UploadFileInstruction Method
Simple List
Download Web Service
Mapping
Examples of Mapping
GetObjectsNewlyAllocated Method
Inputs
Outputs
GetObjectsNewlyAllocatedByIDef Method
GetObjectsDetailsForNewlyAllocatedAndUpdated Method
GetObjectsDetailsForNewlyAllocatedAndUpdatedByIDef Method
GetObjectFileAttachments Method
GetObjectFileAttachmentsByOBID Method
GetObjectDetails Method
GetObjectDetailsByIDef Method
GetObjectDetailsByIDefAndCriteria Method
GetObjectDetailsByOBIDs Method
GetObjectDetailsForSingleObject Method
GetObjectDetailsForSingleObjectByOBID Method
QueryObjectsAndGetObjectsWithDetails Method
QueryComplexObjectsAndGetRelatedObjects Method
GetRelationshipsForSingleObject Method
GetRelationshipsForSingleObjectByOBID Method
Examples of XFRDataTransfer to NLF format mapping
Set configuration to a plant
Set configuration to a project
Simple Object
Object with UoM
Relationship as XFRAttribute of its end object
Relationship as XFRItem
Relationship with OrderValue
Document
Terminate Action
SmartPlant Foundation Interoperability
Extensibility
Web Client Extensibility
Technologies
Getting started
Prerequisites
Install SmartPlant Foundation or HxGN SDx
Install Node.js
Install npm
Install IDE
Architecture
Basic Web Client setup
Extensibility communication events
Recommended setup
Single application with multiple routes
Hybrid setup
Connecting to third-party data sources
OAuth setup
Proxy service setup
Configuring methods for Extensibility applications
Using the Extensibility example application
Building for production
Limitations and restrictions
iframe
CORS
Deep linking
Actions menu
Other frameworks
External application versions
Embedded mode
Technologies
Getting started
Prerequisites
Architecture
Communication events
Security
Using the embedded mode example parent application
Setup your environment
Server Extensibility
Server configuration
Server events
Server object event payload
Server update object event payload
Relationship object event payload
Relationship update object event payload
Configuring a custom workflow process step
Custom process step event payload
Subscribing to server events
AMQP message annotations
Server extensibility example scenarios
User Impersonation
User Impersonation security
Troubleshooting
No AMPQ settings in Server Manager
Server events are not coming through
An invalid request URI was provided
Cannot embed a website in the Web Client
Additional support
Data Validator Customization
Sample customization code
Customizing the Validation Report Writer
Location of sample customization code
Configure the validation report definition
Create a sample validation report writer
Sample custom writer implementations
CustomValidationReportWriter
CustomExcelReportWriter
Using the customized writers
Custom Target System Adapter
Target system adapter
Custom target system
IVTLTargetSystemValidationService
IVTLTargetSystemDataExportService
IVTLTargetSystemQueryService
IVTLTargetSystemSchemaQueryService
Custom Import Mapping Functions
Computed columns
Prompted API
Configure the custom function assembly
Custom Validation Rules
General rule schema
Exact string rule code example
Customizing Workflows
Find sample data on Smart Support
Support, Copyright, and Legal Information
Hexagon PPM Policy Against Software Piracy
Copyright Notice
Customer Support and Technical User Forum

Back to home page