SherlockAnalysisService
Last update: 09.03.2026@Copyright 2023-2024 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.
GetHarmonicVibeInputFieldsRequest
Request to list the valid Harmonic Vibe input fields for the provided model source and user configuration.
| Field | Type | Label | Description |
|---|---|---|---|
| modelSource | ModelSource | optional | Optional model source. Default: GENERATED. |
GetHarmonicVibeInputFieldsResponse
| Field | Type | Label | Description |
|---|---|---|---|
| fieldName | string | repeated | List of Harmonic Vibe input fields. |
GetICTAnalysisInputFieldsRequest
Request to list the valid ICT analysis input fields given the user configuration.
GetICTAnalysisInputFieldsResponse
| Field | Type | Label | Description |
|---|---|---|---|
| fieldName | string | repeated | List of ICT Analysis input fields. |
GetMechanicalShockInputFieldsRequest
Request to list the valid mechanical shock input fields for the provided model source and user configuration.
| Field | Type | Label | Description |
|---|---|---|---|
| modelSource | ModelSource | optional | Optional model source. Default: GENERATED. |
GetMechanicalShockInputFieldsResponse
| Field | Type | Label | Description |
|---|---|---|---|
| fieldName | string | repeated | List of Mechanical Shock input fields for a model source. |
GetNaturalFrequencyInputFieldsRequest
Request to list the valid natural frequency input fields given the user configuration.
GetNaturalFrequencyInputFieldsResponse
| Field | Type | Label | Description |
|---|---|---|---|
| fieldName | string | repeated | List of Natural Frequency input fields. |
GetPartsListValidationPropsRequest
Request to retrieve the Parts List Validation properties.
| Field | Type | Label | Description |
|---|---|---|---|
| project | string | Sherlock Project name. | |
| ccaName | string | The CCA name. |
GetPcbModelingInputFieldsRequest
Request to list the valid PCB Modeling input fields given the user configuration.
GetPcbModelingInputFieldsResponse
| Field | Type | Label | Description |
|---|---|---|---|
| fieldName | string | repeated | List of Pcb Modeling input fields. |
GetRandomVibeInputFieldsRequest
Request to list the valid random vibe input fields for the provided model source and user configuration.
| Field | Type | Label | Description |
|---|---|---|---|
| modelSource | ModelSource | optional | Optional model source. Default: GENERATED. |
GetRandomVibeInputFieldsResponse
| Field | Type | Label | Description |
|---|---|---|---|
| fieldName | string | repeated | List of Random Vibe input fields. |
GetSolderFatigueInputFieldsRequest
Request to list the valid solder fatigue input fields given the user configuration.
GetSolderFatigueInputFieldsResponse
| Field | Type | Label | Description |
|---|---|---|---|
| fieldName | string | repeated | List of Solder Fatigue input fields. |
PartsListValidationPropsResponse
Response that includes Parts List Validation properties.
| Field | Type | Label | Description |
|---|---|---|---|
| returnCode | ReturnCode | Status code of response. | |
| partLibrary | string | Part library name. | |
| processUseAVL | bool | Process option to use AVL. | |
| processUseWizard | bool | Process option to use wizard. | |
| processCheckConfirmedProperties | bool | Process option to check confirmed properties. | |
| processCheckPartNumbers | bool | Process option to check part numbers. | |
| matching | MatchingMode | Matching type. | |
| avlRequireInternalPartNumber | bool | AVL option to require internal part number. | |
| avlRequireApprovedDescription | bool | AVL option to require approved description. | |
| avlRequireApprovedManufacturer | bool | AVL option to require approved manufacturer. |
RunAnalysisRequest
Request to run one or more Sherlock analysis given the project path, CCA name, analyses, lifecycle phases and events.
| Field | Type | Label | Description |
|---|---|---|---|
| project | string | Sherlock project name. | |
| ccaName | string | The CCA name. | |
| analyses | RunAnalysisRequest.Analysis | repeated | List of Analyses to run. |
RunAnalysisRequest.Analysis
| Field | Type | Label | Description |
|---|---|---|---|
| type | RunAnalysisRequest.Analysis.AnalysisType | Type of Analysis to run. | |
| phases | RunAnalysisRequest.Analysis.Phase | repeated | List of Phases for each Analysis to run. |
RunAnalysisRequest.Analysis.Phase
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | Life cycle phase name. | |
| events | RunAnalysisRequest.Analysis.Phase.Event | repeated | List of life cycle Events. |
RunAnalysisRequest.Analysis.Phase.Event
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | Life cycle event name. |
RunStrainMapAnalysisRequest
Request to run Sherlock strain map analysis given the project name, CCA name, and strain maps.
| Field | Type | Label | Description |
|---|---|---|---|
| project | string | Sherlock project name. | |
| ccaName | string | The CCA name of the main CCA for the analysis. | |
| strainMapAnalyses | RunStrainMapAnalysisRequest.StrainMapAnalysis | repeated | List of Strain Map Analyses to run. |
RunStrainMapAnalysisRequest.StrainMapAnalysis
| Field | Type | Label | Description |
|---|---|---|---|
| type | RunStrainMapAnalysisRequest.StrainMapAnalysis.AnalysisType | Type of Strain Map analysis to run. | |
| eventStrainMaps | RunStrainMapAnalysisRequest.StrainMapAnalysis.EventStrainMap | repeated | List of Strain Map events to run. |
RunStrainMapAnalysisRequest.StrainMapAnalysis.EventStrainMap
| Field | Type | Label | Description |
|---|---|---|---|
| phaseName | string | Life cycle phase name. | |
| eventName | string | Life cycle event name. | |
| pcbSide | string | PCB side for the strain map. Supported values are: TOP, BOTTOM. | |
| strainMap | string | Strain map assigned to the event. | |
| subAssemblyName | string | optional | The name of the sub-assembly CCA to be assigned the strain map. |
UpdateHarmonicVibePropsRequest
Request to update the harmonic vibe analysis properties for one or more CCA's in the project indicated.
| Field | Type | Label | Description |
|---|---|---|---|
| project | string | Project name. | |
| harmonicVibeProperties | UpdateHarmonicVibePropsRequest.HarmonicVibe | repeated | List of HarmonicVibe analysis properties to update. |
UpdateHarmonicVibePropsRequest.HarmonicVibe
| Field | Type | Label | Description |
|---|---|---|---|
| ccaName | string | CCA name for which the harmonic vibe properties are set. | |
| modelSource | ModelSource | optional | Optional model source. Default: GENERATED. |
| harmonicVibeCount | int32 | optional | Number of harmonic result layers to generate. |
| harmonicVibeDamping | string | optional | Modal Damping Ratio(s). |
| partValidationEnabled | bool | optional | Flag indicating if part validation should be performed. |
| requireMaterialAssignmentEnabled | bool | optional | Flag indicating if material assignment is required. |
| analysisTemp | double | optional | Temperature. |
| analysisTempUnits | string | optional | Temperature units. |
| forceModelRebuild | string | optional | Model Creation. Valid values are "FORCE" or "AUTO". |
| filterByEventFrequency | bool | optional | Flag indicating if harmonic results outside selected event range are imported. |
| naturalFreqMin | uint32 | optional | Min Frequency. For NX Nastran analysis only. |
| naturalFreqMinUnits | string | optional | Min Frequency units. For NX Nastran analysis only. |
| naturalFreqMax | uint32 | optional | Max Frequency. For NX Nastran analysis only. |
| naturalFreqMaxUnits | string | optional | Max Frequency units. For NX Nastran analysis only. |
| reuseModalAnalysis | bool | optional | Reuse Natural Frequency. For NX Nastran analysis only. |
| strainMapNaturalFreq | double | optional | Maximum Natural Frequency used for strain map analysis. |
UpdateICTAnalysisPropsRequest
Request to update ICT Analysis properties.
| Field | Type | Label | Description |
|---|---|---|---|
| project | string | Sherlock Project name. | |
| ictAnalysisProperties | UpdateICTAnalysisPropsRequest.ICTAnalysis | repeated | List of ICTAnalysis properties to update for each CCA in a project. |
UpdateICTAnalysisPropsRequest.ICTAnalysis
| Field | Type | Label | Description |
|---|---|---|---|
| ccaName | string | The CCA name. | |
| applicationTime | double | optional | Application Time. |
| applicationTimeUnits | string | optional | Application Time Units. |
| numberOfEvents | uint32 | optional | Number of Events. |
| partValidationEnabled | bool | optional | Part Validation. |
| requireMaterialAssignmentEnabled | bool | optional | Flag indicating if material assignment is required. |
| forceModelRebuild | string | optional | Model Creation. Valid values are "FORCE" or "AUTO". |
| ictResultCount | int32 | optional | Number of ICT layers to generate when using thermal analysis. |
UpdateMechanicalShockPropsRequest
Request to update the mechanical shock analysis properties.
| Field | Type | Label | Description |
|---|---|---|---|
| project | string | Sherlock Project name. | |
| mechanicalShockProperties | UpdateMechanicalShockPropsRequest.MechanicalShock | repeated | List of MechanicalShock properties to update. |
UpdateMechanicalShockPropsRequest.MechanicalShock
| Field | Type | Label | Description |
|---|---|---|---|
| ccaName | string | The CCA name. | |
| modelSource | ModelSource | optional | Default is GENERATED. |
| shockResultCount | int32 | optional | Mechanical Shock Result Count. |
| criticalShockStrain | double | optional | Critical Shock Strain. |
| criticalShockStrainUnits | string | optional | Critical Shock Strain units. |
| partValidationEnabled | bool | optional | Flag indicating if part validation should be performed. |
| requireMaterialAssignmentEnabled | bool | optional | Flag indicating if material assignment is required. |
| forceModelRebuild | string | optional | Model Creation. Valid values are "FORCE" or "AUTO". |
| naturalFreqMin | uint32 | optional | Min Frequency. |
| naturalFreqMinUnits | string | optional | Min Frequency units. |
| naturalFreqMax | uint32 | optional | Max Frequency. |
| naturalFreqMaxUnits | string | optional | Max Frequency units. |
| analysisTemp | double | optional | Temperature. |
| analysisTempUnits | string | optional | Temperature units. |
UpdateNaturalFrequencyPropsRequest
Request to update natural frequency analysis properties.
| Field | Type | Label | Description |
|---|---|---|---|
| project | string | Project name. | |
| ccaName | string | CCA name. | |
| naturalFreqCount | int32 | NF Result Count. | |
| naturalFreqMin | double | Min Frequency. IMPORTANT: Only Integer values will be accepted for this field. Decimal values will be rejected in the API. | |
| naturalFreqMinUnits | string | Min Frequency units (HZ, KHZ, MHZ, or GHZ). | |
| naturalFreqMax | double | Max Frequency. IMPORTANT: Only Integer values will be accepted for this field. Decimal values will be rejected in the API. | |
| naturalFreqMaxUnits | string | Max Frequency units (HZ, KHZ, MHZ, or GHZ). | |
| partValidationEnabled | bool | Part Validation. | |
| requireMaterialAssignmentEnabled | bool | Require Material Assignment. | |
| analysisTemp | double | optional | Temperature. |
| analysisTempUnits | string | optional | Temperature units (C, F, or K). |
UpdatePartModelingRequest
Request to update FEA part modeling properties.
| Field | Type | Label | Description |
|---|---|---|---|
| project | string | Sherlock project name. | |
| ccaName | string | The CCA name. | |
| partEnabled | bool | Whether to enable part modeling. Ignores all other fields if part modeling is disabled. | |
| partMinSize | double | optional | The minimum part size. |
| partMinSizeUnits | string | optional | Units for minimum part size. |
| partElemOrder | string | optional | Element order. |
| partMaxEdgeLength | double | optional | Maximum mesh size. |
| partMaxEdgeLengthUnits | string | optional | Units for maximum mesh size. |
| partMaxVertical | double | optional | Vertical mesh size. |
| partMaxVerticalUnits | string | optional | Units for vertical mesh size. |
| partResultsFiltered | bool | optional | Whether to enable filtered part results. |
UpdatePartsListValidationPropsRequest
Request to update the Parts List Validation properties.
| Field | Type | Label | Description |
|---|---|---|---|
| project | string | Sherlock Project name. | |
| partsListValidationProperties | UpdatePartsListValidationPropsRequest.PartsListValidation | repeated | Properties for each CCA in the project. |
UpdatePartsListValidationPropsRequest.PartsListValidation
| Field | Type | Label | Description |
|---|---|---|---|
| ccaName | string | The CCA name. | |
| partLibrary | string | optional | Part library name. |
| processUseAVL | bool | optional | Process option to use AVL. |
| processUseWizard | bool | optional | Process option to use wizard. |
| processCheckConfirmedProperties | bool | optional | Process option to check confirmed properties. |
| processCheckPartNumbers | bool | optional | Process option to check part numbers. |
| matching | MatchingMode | optional | Matching type. |
| avlRequireInternalPartNumber | bool | optional | AVL require internal part number. |
| avlRequireApprovedDescription | bool | optional | AVL require approved description. |
| avlRequireApprovedManufacturer | bool | optional | AVL require approved manufacturer. |
UpdatePcbModelingPropsRequest
Request to update FEA analysis PCB Modeling properties.
| Field | Type | Label | Description |
|---|---|---|---|
| project | string | Sherlock project name. | |
| ccaNames | string | repeated | The CCA names for which to assign the PCB modeling parameters. |
| analyses | UpdatePcbModelingPropsRequest.Analysis | repeated | List of Analysis message types. |
UpdatePcbModelingPropsRequest.Analysis
| Field | Type | Label | Description |
|---|---|---|---|
| type | UpdatePcbModelingPropsRequest.Analysis.AnalysisType | The type of analysis for which PCB modeling properties apply. | |
| modelType | UpdatePcbModelingPropsRequest.Analysis.PcbModelType | The PCB modeling mesh type. | |
| modelingRegionEnabled | bool | Indicates if modeling regions are enabled. | |
| pcbMaterialModel | UpdatePcbModelingPropsRequest.Analysis.PcbMaterialModel | The PCB modeling PCB model type. | |
| pcbMaxMaterials | int32 | optional | The number of PCB materials for Uniform Elements and Layered Elements PCB model types. |
| pcbElemOrder | ElementOrder | The element order for PCB elements. | |
| pcbMaxEdgeLength | double | The maximum mesh size for PCB elements. | |
| pcbMaxEdgeLengthUnits | string | The length units for the maximum mesh size. | |
| pcbMaxVertical | double | The maximum vertical mesh size for PCB elements. | |
| pcbMaxVerticalUnits | string | The length units for the maximum vertical mesh size. | |
| quadsPreferred | bool | Indicates that the meshing engine should attempt to generate quad-shaped elements when creating the mesh. |
UpdateRandomVibePropsRequest
Request to update random vibe analysis properties.
| Field | Type | Label | Description |
|---|---|---|---|
| project | string | Project name. | |
| ccaName | string | CCA name. | |
| randomVibeDamping | string | optional | Modal Damping Ratio(s). |
| naturalFreqMin | double | optional | Min Frequency. For NX Nastran analysis only. |
| naturalFreqMinUnits | string | optional | Min Frequency units. For NX Nastran analysis only. |
| naturalFreqMax | double | optional | Max Frequency. For NX Nastran analysis only. |
| naturalFreqMaxUnits | string | optional | Max Frequency units. For NX Nastran analysis only. |
| analysisTemp | double | optional | Temperature. |
| analysisTempUnits | string | optional | Temperature units. |
| partValidationEnabled | bool | optional | Part Validation. |
| forceModelRebuild | string | optional | Model Creation. Valid values are "FORCE" or "AUTO". |
| reuseModalAnalysis | bool | optional | Reuse Natural Frequency. For NX Nastran analysis only. |
| performNFFreqRangeCheck | bool | optional | Frequency Range Check. For NX Nastran analysis only. |
| requireMaterialAssignmentEnabled | bool | optional | Require Material Assignment. |
| modelSource | ModelSource | optional | Optional model source. Default: GENERATED. |
| strainMapNaturalFreqs | string | optional | Comma-separated list of natural frequencies for strain map analysis. |
UpdateSolderFatiguePropsRequest
Request to update solder fatigue properties.
| Field | Type | Label | Description |
|---|---|---|---|
| project | string | Sherlock Project name. | |
| solderFatigueProperties | UpdateSolderFatiguePropsRequest.SolderFatigue | repeated | List of SolderFatigue properties to update for a CCA. |
UpdateSolderFatiguePropsRequest.SolderFatigue
| Field | Type | Label | Description |
|---|---|---|---|
| ccaName | string | The CCA name. | |
| solderMaterial | string | optional | Name of the solder material. |
| partTemp | double | optional | Part temperature rise. |
| partTempUnits | string | optional | Part temperature rise units. |
| partTempRiseMinEnabled | bool | optional | Flag indicating if part temperature minimum rise should be enabled. |
| partValidationEnabled | bool | optional | Flag indicating if part validation should be performed. |
UpdateThermalMechPropsRequest
Request to update thermal mech analysis properties.
| Field | Type | Label | Description |
|---|---|---|---|
| project | string | Project name. | |
| ccaName | string | repeated | CCA names. |
| thermalResultCount | int32 | Thermal Mech Result Count. | |
| partValidationEnabled | bool | Part Validation. | |
| requireMaterialAssignmentEnabled | bool | Require Material Assignment. |
ElementOrder
Enumeration defining the types of supported element orders.
| Name | Number | Description |
|---|---|---|
| UnknownOrder | 0 | Default enum to catch invalid element order. |
| Linear | 1 | Enum for first order linear elements. |
| Quadratic | 2 | Enum for second order quadratic elements. |
| SolidShell | 3 | Enum for solid shell elements. |
ModelSource
| Name | Number | Description |
|---|---|---|
| UNKNOWN | 0 | Default enum to catch invalid source. |
| GENERATED | 1 | Generated analysis model source. |
| STRAIN_MAP | 2 | Strain map analysis model source. |
AnalysisType
| Name | Number | Description |
|---|---|---|
| UNKNOWN | 0 | Default enum to catch invalid analysis. |
| NaturalFreq | 1 | Enum for the Natural Frequency analysis. |
| HarmonicVibe | 2 | Enum for the Harmonic Vibe analysis. |
| ICTAnalysis | 3 | Enum for the ICT analysis. |
| MechanicalShock | 4 | Enum for the Mechanical Shock analysis. |
| RandomVibe | 5 | Enum for the Random Vibe analysis. |
| ComponentFailureMode | 7 | Enum for the Component Failure Mechanism analysis. |
| DFMEAModule | 8 | Enum for the DFMEA analysis. |
| PTHFatigue | 9 | Enum for the PTH Fatigue analysis. |
| PartValidation | 10 | Enum for the Part Validation analysis. |
| SemiconductorWearout | 11 | Enum for the Semiconductor Wearout analysis. |
| SolderJointFatigue | 12 | Enum for the Solder Fatigue analysis. |
| ThermalDerating | 13 | Enum for the Thermal Derating analysis. |
| ThermalMech | 14 | Enum for the Thermal Mech analysis. |
AnalysisType
| Name | Number | Description |
|---|---|---|
| UNKNOWN | 0 | Default enum to catch invalid analysis. |
| RandomVibe | 1 | Enum for the Random Vibe analysis. |
| MechanicalShock | 2 | Enum for Mechanical Shock analysis. |
| HarmonicVibe | 3 | Enum for the Harmonic Vibe analysis. |
AnalysisType
| Name | Number | Description |
|---|---|---|
| UnknownAnalysisType | 0 | Default enum to catch invalid analysis. |
| HarmonicVibe | 1 | Enum for the Harmonic Vibe analysis. |
| ICTAnalysis | 2 | Enum for the ICT analysis. |
| MechanicalShock | 3 | Enum for the Mechanical Shock analysis. |
| NaturalFreq | 4 | Enum for the Natural Frequency analysis. |
| RandomVibe | 5 | Enum for the Random Vibe analysis. |
| ThermalMech | 6 | Enum for the Thermal Mech analysis. |
PcbMaterialModel
| Name | Number | Description |
|---|---|---|
| UnknownPcbModel | 0 | Default enum to catch invalid PCB model. |
| Uniform | 1 | Enum for uniform PCB model. |
| Layered | 2 | Enum for layered PCB model. |
| UniformElements | 3 | Enum for uniform elements PCB model. |
| LayeredElements | 4 | Enum for layered elements PCB model. |
PcbModelType
| Name | Number | Description |
|---|---|---|
| UnknownMeshType | 0 | Default enum to catch invalid mesh type. |
| Bonded | 1 | Bonded FEA model. |
SherlockAnalysisService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| runAnalysis | .RunAnalysisRequest | .ReturnCode | Runs one or more Sherlock analysis. |
| runStrainMapAnalysis | .RunStrainMapAnalysisRequest | .ReturnCode | Run Sherlock strain map analysis. |
| getHarmonicVibeInputFields | .GetHarmonicVibeInputFieldsRequest | .GetHarmonicVibeInputFieldsResponse | Returns the list of valid harmonic vibe input fields for the provided model source and user configuration. |
| updateHarmonicVibeProps | .UpdateHarmonicVibePropsRequest | .ReturnCode | Updates the analysis properties for harmonic vibe analysis. |
| getRandomVibeInputFields | .GetRandomVibeInputFieldsRequest | .GetRandomVibeInputFieldsResponse | Returns the list of valid Random Vibe input fields for the provided model source and user configuration. |
| updateRandomVibeProps | .UpdateRandomVibePropsRequest | .ReturnCode | Updates the analysis properties for random vibe analysis. |
| getMechanicalShockInputFields | .GetMechanicalShockInputFieldsRequest | .GetMechanicalShockInputFieldsResponse | Returns the list of valid mechanical shock input fields for the provided model source and user configuration. |
| updateMechanicalShockProps | .UpdateMechanicalShockPropsRequest | .ReturnCode | Updates the analysis properties for mechanical shock analysis. |
| updateSolderFatigueProps | .UpdateSolderFatiguePropsRequest | .ReturnCode | Updates the analysis properties for solder fatigue analysis. |
| getNaturalFrequencyInputFields | .GetNaturalFrequencyInputFieldsRequest | .GetNaturalFrequencyInputFieldsResponse | Returns the list of valid natural frequency property fields given the user configuration. |
| updateNaturalFrequencyProps | .UpdateNaturalFrequencyPropsRequest | .ReturnCode | Updates the analysis properties for natural frequency analysis. |
| updateThermalMechProps | .UpdateThermalMechPropsRequest | .ReturnCode | Updates the analysis properties for thermal mech analysis. |
| getPcbModelingInputFields | .GetPcbModelingInputFieldsRequest | .GetPcbModelingInputFieldsResponse | Returns the list of valid PCB modeling property field. |
| updatePcbModelingProps | .UpdatePcbModelingPropsRequest | .ReturnCode | Updates the PCB modeling properties for the provided analysis types. |
| getSolderFatigueInputFields | .GetSolderFatigueInputFieldsRequest | .GetSolderFatigueInputFieldsResponse | Returns the list of valid solder fatigue property fields given the user configuration. |
| updatePartModelingProperties | .UpdatePartModelingRequest | .ReturnCode | Updates the part modeling properties for a given project's CCA. |
| getICTAnalysisInputFields | .GetICTAnalysisInputFieldsRequest | .GetICTAnalysisInputFieldsResponse | Returns the list of valid ICT analysis property fields given the user configuration. |
| updateICTAnalysisProps | .UpdateICTAnalysisPropsRequest | .ReturnCode | Updates the analysis properties for ICT analysis. |
| updatePartsListValidationProps | .UpdatePartsListValidationPropsRequest | .ReturnCode | Updates the analysis properties for parts list validation analysis. |
| getPartsListValidationProps | .GetPartsListValidationPropsRequest | .PartsListValidationPropsResponse | Returns the parts list validation properties. |
Back to Top