© 2018 Capita Business Services Ltd. All rights reserved.

Capita Education Software Solutions is a trading name of Capita Business Services Ltd. Our Registered office is 30 Berners Street, London, W1T 3LR and our registered number is 02299747. Further information about Capita plc can be found in our legal statement.

SIMS 7 - Command Reporter (Execution)

Execution of Reports Programmatically

Pre-Requisites

If we assume that the integrator’s software is installed on a machine then that machine also must have SIMS installed and running on it. If this criteria is not met, then please refer the customer to their SIMS Support Unit who should be able to get SIMS and SIMS Reporting running on the machine independently of the integrator’s software.

Command Reporter

This is installed with every SIMS 7 installation and is typically found in the c:\Program Files (X86)\SIMS\SIMS .Net folder.

The file <WinDir>\SIMS.INI file should contain an entry SIMSDotNetDirectory which is the source of truth as to the location of SIMS on that machine.

Prior to executing the report, the report must be either imported manually or via command report importer. Obviously if the report does not exist then an error will occur.

Report Execution

ESS makes sample wrapper code available for contracted integrators which makes the execution of the import a single line of code (plus error handling) e.g:

SIMSReportingEngine.Reports.Run(<report name>,<Server>,<Database>,<User>,<Password>)

SIMSReportingEngine.Reports.Run(<report name>,<Server>,<Database>,<User> ,<Password>,<paramdef file name>)

Alternatively the executable can be called directly in a similar way.

It is far simpler for integrators to use the code provided because it handles various scenarios for them, however code samples include all of the exemplar code which can, if needed be modified to meet their specific requirements.

Report Names

We recommend that unique names such as ‘Partner Product <Student> v1.00’ for example so as not to get confused with a report created by the school themselves. There have been a number of reported conflicts which are typically resolved by deleting the reports manually in SIMS; but the ‘versioned’ and ‘unlikely to copy’ model does save on support costs.