Advanced Search
Search Results
476 total results found
Chapter 5: Make your product implementation a success
List of the Release Notes v9
Signify continually develops new functionality and resolves issues, so our system is continually improving. We also develop exciting new modules in line with how the use of Human Resource Information Systems is changing. A list of the Release Notes for the dif...
Can I Use
To make sure the supported browsers can render the CSS properties that you want to use, refer to the Can I Use Site. Can I Use provides browser support tables for modern web technologies. For example, when searching CSS Grid, you will see all the browsers (a...
Design Principles and Standards
For design principles using React, use the guide below by clicking the image For styling using React and JSX, use the guide below by clicking the image
Table of contents
1. General 2. Naming Conventions 3. Methods 4. Versioning 5. Object Usage
General
This is an extension on C# standards. XML Documentation Commenting Code Documenting Ensure all publicly exposed actions, objects and properties are described using XML Documentation Comments as this is used to instruct third party users more about what an a...
Naming conventions
URI's API URI's are based around resources. Actions are indicated with the use of HTTP Methods. Use nouns, not verbs Resources that are collections should be indicated using plural nounse.g. /pathways Specific resource in collection is defined after coll...
Methods
Related Documentation Define operations in terms of HTTP methods Conform to HTTP semantics GET methods Action: Retrieve resource(s).HTTP Status Code(s): 200 (OK), 404 (Not Found) POST methods Action: Create resource(s) (can also be used for updates...
Versioning
URI versioning is utilised. Refer to below links for more information: Versioning a RESTful web API API Version Control Service Versioning
Object Usage
Data Transfer Object - DTO Data Transfer Object is the object returned by an API call.A DTO is used to prevent exposing your database entity structure. This also prevent the exposing of data not being or to be used by the API client, such as linked entities. ...
Table of contents
General Naming conventions Cursors Common table expressions (CTE's) Temporary tables Table variables Tables and indexes User defined functions Stored procedures Triggers Existence checks
General
No more than 200 lines (formatted) allowed in any stored procedure, user-defined function or view. If more than 200 lines is unavoidable, please discuss this with a Senior Developer or Database Administrator first. Aliases should be used for tables in SELEC...
Naming conventions
General Decide per module if abbreviation (e.g. prs for Personnel module) or full name (e.g. leave) will be used for database Objects. Do not use spaces in the names of database objects. Avoid using ntext, text, and image data types in new development wor...
Cursors
Use cursors only when absolutely necessary. If the function performed by the cursor could have been achieved by another SQL function e.g. PIVOT or Common Table Expression then rather do that as CURSORS are expensive. When using a cursor to only cycle once ...
Common table expressions (CTE's)
CTE table names are declared with the prefix cte Used to simplify complex joins and subqueries. Use a Common Table Expression for paging instead of Dynamic SQL. Always start with a semi-colon before the WITH. Chaining CTE's must be limited to 3 instances...
Temporary tables
Temp tables are used for the large temporary storage of data. Only use local temp tables. Use temporary tables cautiously / only when necessary e.g. early filtering in reports / complex queries. When a temporary table is used in a stored procedure, evalu...
Table variables
Use table variables over temp tables for a small quantity of data (thousands of bytes) https://stackoverflow.com/questions/11857789/when-should-i-use-a-table-variable-vs-temporary-table-in-sql-server Example: DECLARE @product_table TABLE ( pro...
Tables and indexes
Always use a column list in INSERT statements of SQL queries. This will avoid a problem when table structure changes. Correct : INSERT INTO tmp (Value) SELECT @variable INSERT INTO tmp (Value) VALUES(@variable) Not correct : INSERT INTO tmp SELECT @vari...
User defined functions
Do not call functions repeatedly in stored procedures, triggers, functions and batches, instead call the function once and store the result in a variable, for later use. Unless absolutely necessary, DO NOT USE in-line user-defined functions in SELECTs. If u...
Stored procedures
EXCEPT or NOT EXIST clause can be used in place of LEFT JOIN or NOT IN for better performance (see example for EXCEPT below) SELECT EmpNo, EmpName FROM EmployeeRecord WHERE Salery > 1000 EXCEPT SELECT EmpNo, EmpName FROM EmployeeRecord WHERE Sale...
Triggers
Limit the use of triggers only for auditing, custom tasks, and validations that cannot be performed using constraints. If possible only exec trigger conditionally e.g. modifying data
Existence checks
Make use of the existence checking defined here Always check for existence when adding new objects to the database (see example below) IF NOT EXISTS ( SELECT TOP 1 1 FROM ...