Skip to content

Microdata Output

esseff edited this page Nov 5, 2022 · 123 revisions

Home > Model Development Topics > Microdata Output

This topic is a WIP describing OpenM++ functionality which has not yet been released.

Related topics

Topic contents

Introduction and outline

To follow.

[back to topic contents]

Quick start

Add the following statement to the model source code file RiskPaths/code/ompp_framework.ompp:

options microdata_output = on;

Build the Release version of RiskPaths.
In Windows, the model executable will be RiskPaths/ompp/bin/RiskPaths.exe.
In Linux, the model executable will be RiskPaths/ompp-linux/bin/RiskPaths.

The OpenM++ compiler will output the following warning, which is expected.


In the same folder as the RiskPaths executable there may already be a copy of the default model ini file RiskPaths.ini. If not create it using your IDE or a text editor such as Notepad.

Edit RiskPaths.ini to have the following content:

[OpenM]
TraceToFile = true

[Parameter]
SimulationCases = 5

[Microdata]
ReportStyle = readable

[back to topic contents]

General information

A model built with microdata output enabled will output the following warning to the log whenever it is run:

 Warning : model can expose microdata at run-time with microdata_output = on

If this is not a concern, for example the model generates a synthetic population, this warning can be disabled by the following statement:

options microdata_output_warning = off;

Some entity attributes are created by the OpenM++ compiler to implement model functionality. For example, if an entity table has a filter, an identity attribute is created to implement it. These internal generated attributes are normally hidden but they can be made visible by the following statement:

options all_attributes_visible = on;

[back to topic contents]

Home

Getting Started

Model development in OpenM++

Using OpenM++

OpenM++ user interface

Model Development Topics

OpenM++ web-service: API and cloud setup

Using OpenM++ from Python and R

Docker

OpenM++ Development

OpenM++ Design, Roadmap and Status

OpenM++ web-service API

GET Model Metadata

GET Model Extras

GET Model Run results metadata

GET Model Workset metadata: set of input parameters

Read Parameters, Output Tables or Microdata values

GET Parameters, Output Tables or Microdata values

GET Parameters, Output Tables or Microdata as CSV

GET Modeling Task metadata and task run history

Update Model Profile: set of key-value options

Update Model Workset: set of input parameters

Update Model Runs

Update Modeling Tasks

Run Models: run models and monitor progress

Download model, model run results or input parameters

Upload model runs or worksets (input scenarios)

Download and upload user files

User: manage user settings

Model run jobs and service state

Administrative: manage web-service state

Global Administrator: manage all web-services

Clone this wiki locally