Skip to main content
Technical ManualLooking for step-by-step instructions? In the User Manual: Set Up a New Site

Recipes and Recipe Steps

The Estimator modules ship Orchard Core recipes, and recipe steps that other recipes can use. Setup recipes show on the setup screen; the others show in Tools > Recipes. All recipe JSON is wrapped in { "steps": [...] }.

Recipes​

Recipe (name)Display nameSetupModuleWhat it does
EstimatorEstimatorYesCrestApps.OrchardCore.EstimatorEnables the Orchard Core admin features, the themes, every Estimator feature but the API and AI, Liquid, CrestApps Reports with its Excel export and the Report Builder, Data Pipelines and Media. Adds the starting proposal clauses (EstimatorProposalClauses)
EstimatorElectricalEstimator – ElectricalYesCrestApps.OrchardCore.EstimatorThe same features as Estimator, plus the Estimator API, OrchardCore.OpenApi and OrchardCore.OpenApi.SwaggerUI; the Estimator, Estimating manager and Catalog administrator roles; and, with the Recipes step, the EstimatorSampleCatalog, EstimatorElectricalPackage and EstimatorMigrationTemplates recipes. See Estimator API
EstimatorSampleCatalogEstimator sample catalogNoCrestApps.OrchardCore.Estimator.CatalogA small fictional catalog, five assemblies, and sample labor rate tables, crews and factors. See Estimator Catalog
EstimatorElectricalPackageEstimator electrical packageNoCrestApps.OrchardCore.Estimator.Electrical263 sample items, 304 assemblies, job condition factors, crews, electrical clauses and the default Electrical – Commercial estimate template. See Estimator Electrical
EstimatorMigrationTemplatesEstimator migration templatesNoCrestApps.OrchardCore.Estimator.CatalogTwo draft data pipelines that import the item and assembly exports of another estimating system, and sample exports in the media library. See Estimator Catalog
EstimatorAIAssistantEstimator AI assistantNoCrestApps.OrchardCore.Estimator.AIThe CrestApps AI features, AI usage tracking, and the Estimator Assistant and Catalog Specialist profiles. See Estimator AI

Each data recipe can run again: its steps change the records they added before and keep everything else. The EstimatorElectrical setup recipe runs the data recipes in the order of the table, so the electrical package finds the sample labor rates.

Recipe steps​

StepModuleImportsMatched byReference
EstimatorCatalogEstimator CatalogCatalog items with their prices and labor unitsItem numberCatalog recipe step
EstimatorAssembliesEstimator CatalogAssemblies with their components, parameters and variantsCode; the assembly is replacedAssembly recipe step
EstimatorLaborEstimator CatalogLabor rate tables, crews and labor factorsName; factors by group and nameLabor recipe step
EstimatorProposalClausesEstimator ProposalsInclusions, exclusions and clarifications of the clause libraryKind and textProposals recipe step
EstimatorEstimateTemplatesEstimator EstimatesEstimate templates with their recap settings, breakdown and linesNameEstimate templates

Data pipeline steps​

The Estimator Catalog adds two steps to Orchard Core Data Pipelines, for imports that a person maps and runs in the admin:

StepWritesReference
Save catalog items (SaveCatalogItems)Catalog items and their prices, such as from a price filePrice file import
Save assemblies (SaveAssemblies)Assemblies from rows of one component eachMigration from other estimating systems

Tests​

tests/CrestApps.OrchardCore.Estimator.Tests/Architecture/SetupRecipeTests.cs checks that the electrical setup recipe enables every feature of the Estimator recipe and the API, that its roles use only permissions the modules declare, and the order of its nested recipes. AIRecipeTests checks the AI recipe.