System Parameters

System Parameters control certain user actions within the application. It allows items to be configurable by system administrators. You can find a list of seeded values here. System parameters should only be updated if advised in the online help or by support.

Validations
  • System Parameters Code must be unique.
  • The start date must begin before the end date. Both must be valid dates. Microsoft SQL Server defaults empty dates to 01/01/1753 for the beginning of time, and 12/31/9999 for the end of time. These dates will be defaulted in the database record if left blank.
System Parameter Object Definition
System Parameter Attributes Definition
SystemParametersID Unique ID for the System Parameter
SystemParametersCode Unique code that identifies the system parameter.
SystemParametersDesc System parameter description.
Attribute1 Attribute for the system parameter.
Attribute2 Attribute for the system parameter.
Attribute3 Attribute for the system parameter.
Attribute4 Attribute for the system parameter.
Attribute5 Attribute for the system parameter.
Attribute6 Attribute for the system parameter.
Attribute7 Attribute for the system parameter.
Attribute8 Attribute for the system parameter.
Attribute9 Attribute for the system parameter.
Attribute10 Attribute for the system parameter.
ActiveFlag Activates or Inactivates the record.
StartDate The date the record becomes active.
EndDate The date the record becomes inactive.
CreationDate The date the record was created.
CreatedBy The user that created the record.
LastUpdateDate The date the record was last updated.
LastUpdatedBy The user that last updated the record.
Adding a System Parameter
  • Navigation: Admin - System Parameters
  • A unique system parameters code is required.
  • Optionally, a description can be added.
  • Enter an attribute value.
  • Save the record.
Adding System Parameters - Mass Additions
  • A mass addition is a bulk import from a comma delimited file. Please review the Mass Addition notes before working with these files.
  • Download a template from the Templates section of our website. Likewise, the Systems Parameters Import Report can be used to extract an existing value. This template can also be used to create new system parameters.
  • Fill out appropriate data. Ensure Insert or Update column is set to INSERT.
  • Navigation: Admin Menu Item - Other Items - Mass Additions
  • Choose an Import Type of System Parameters
  • Click the Choose File Button. Navigate to your CSV file.
  • Click Upload File.
  • A message is displayed that the file uploaded successfully.
  • It is recommended that you select Validate file first! This will run through the file without loading it and provide any errors, which should be resolved before the file is actually loaded.
  • Click the Process File Button
  • Each record will either be successfully processed or will display an error.
  • Resolve any errors, upload the file again, and validate again. Repeat until all errors are resolved.
  • Once all errors are resolved, navigate to the CSV and upload it again.
  • Select Load in the drop down list to load the file.
Edit a System Parameter
  • Navigation: Admin - System Parameters
  • Search by System Parameter Code.
  • Click the Select Button.
  • System Parameter information is displayed.
  • Modify the record.
  • Save the Record.
Editing System Parameters - Mass Additions
  • A mass addition is a bulk import from a comma delimited file. Please review the Mass Addition notes before working with these files.
  • Download a template from the Templates section on our website. Likewise, the System Parameters Import Report can be used to extract an existing value. This template can also be used to create new system parameters.
  • Fill out appropriate data. Ensure Insert or Update column is set to UPDATE.
  • In this example, the system parameter description is being changed.
  • Navigation: Admin Menu - Other Items - Mass Additions
  • Choose an Import Type of System Parameters
  • Click the Choose File Button. Navigate to your CSV file.
  • Click Upload File.
  • You should see a message that the file uploaded successfully.
  • It is recommended that you select Validate file first! This will run through the file without loading it and provide any errors, which should be resolved before the file is actually loaded.
  • Click the Process File Button
  • Each record will either be successfully processed or will display an error.
  • Resolve any errors, upload the file again, and validate again. Repeat until all errors are resolved.
  • Once all errors have been resolved, upload the file again, choose Load File, and click the Process File Button.
  • You should receive a success message for each record as it is updated.
Related Topics
System Parameter Definitions and Seeded Values
System Parameters Mass Addition Information