Skip to main content

Best Practices when using Sim4Sys Designer

Below is a list of a few rules that you can apply to avoid some recurrent problems:

  • Keep your installation files in a same folder in C:/ for example. Some times you need to reinstall your tool, so it is useful to know precisely where you put the install kit. Also, it will allow you to know wich version you used in case you need to report a bug or a problem,
  • Keep your workspaces in C:/ and especially the generated code. If you don't have the rights to write directly on this drive, chose a folder who is the nearest possible from C:/. Long adresses can provoke errors during compilation,
  • As well as long names or adresses, avoid special characters in the name of workspaces (including spaces),
  • Keep the libraries in the workspace. Ideally, have them phyisically in the workspace. It will help avoiding compilation errors. In case you have a big number of workspaces and you don't want to have several copies of these libraries, you can have import a shortcut. Just keep them in the folder where you stock your workspaces. Be sure you import them correctly (you should be able to see them in the project explorer in Designer). And be aware that when you modify them it will impact all your workspaces. For more information about libraries: Add the CIL4SysLibs.

Before and during your modelisation, keep these practies in mind:

  • Identify the document template that will be used (naming the flows and activities will result in a natural rendering),
  • Have an overview of the system (properly identify the user features),
  • Identify from the outset the inputs/outputs, as well as their parameters,
  • Do not go into the technical solution (ex: user wants to light on a lamp, not push a button to light on it),
  • Create atomic User Stories, i.e. one trigger and its behavior (easier to maintain),
  • Prepare blank User Stories in advance, incorporating Diagram References of previous and next stories, in order to follow a logical sequence,
  • Focus on creating all the User Stories in your Use Cases before you start coding the body of your internal activities,
  • Generate in State Machine your User Stories as soon as these have been updated,
  • Compile your code regularly (with each completed User Story or Use Case),
  • Individually test your stories with simple data (fix your variables before switching to a database or csv), and prefer the timeline for your first tests with Virtual Bench.