Skip to main content
Version: 2025.10

PTC Creo & Windchill

Note: Users must procure and maintain valid licenses to integrate this commercial CAD tool with the Istari Digital platform. Please contact your local IT administrator for assistance.

Summary​

The PTC Creo & Windchill integration provides comprehensive data extraction and parameter modification capabilities for PTC Creo Parametric models, with support for both direct file uploads and Windchill PLM connectivity for automated CAD workflows.

Supported File Types: .prt (parts), .asm (assemblies in ZIP with dependencies)

Connection Methods: Upload, Link (via Windchill)

How and Where to Use​

You can use the PTC Creo integration through either the Istari Digital Platform UI or the Istari Digital SDK. Both methods allow you to extract data from Creo CAD models and modify parameters, with additional support for direct Windchill PLM integration for enterprise workflows.

What You Can Do​

  • Extract orthographic and isometric model views as images (PNG)
  • Extract user-defined parameters for digital threading
  • Retrieve mass properties and bounding box dimensions
  • Extract bill of materials (BOM) from assemblies
  • Extract material properties assigned to parts
  • Update model parameters with new values programmatically
  • Connect directly to Windchill PLM to retrieve and update CAD files
  • Execute batch operations on multiple models
  • Automate checkout/checkin workflows for Windchill-managed files

Prerequisites​

Before using this integration, ensure:

  • PTC Creo Parametric 10.0.X.X is installed and configured by your administrator
  • (Optional) PTC Windchill 12.1 is available if using Windchill integration features
  • The Istari Digital Agent is installed on a Windows machine (Windows 10/11 or Windows Server 2019/2022)
  • You have access to the Istari Digital Platform UI or the Istari Digital SDK
  • Required environment variables are configured (PRO_DIRECTORY, PRO_COMM_MSG_EXE, PATH)
  • For Windchill: You have valid credentials and workspace access

API​

Functions​

FunctionDescriptionInputsOutputs
@istari:extractExtracts comprehensive model data including views, parameters, and propertiesCreo part (.prt), Creo assembly (.asm in ZIP)Orthographic views (PNG), Isometric view (PNG), Parameters (JSON), Mass properties (JSON), BOM (JSON), Material (JSON)
@istari:update_parametersUpdates model parameters with user-specified valuesCreo model, Parameter updatesUpdated model with confirmation
@istari:windchill_extractExtracts CAD file directly from Windchill PLM instanceWindchill metadata file, Windchill credentialsSame outputs as @istari:extract
@istari:windchill_update_parametersUpdates parameters in Windchill-managed CAD files via checkout/checkinWindchill metadata, Credentials, Parameter updatesUpdated model checked back into Windchill
@istari:batch_executeExecutes multiple functions in sequence on modelsBatch job configurationResults from all executed functions

Output Examples​

Output NameTypeDescription
front.pngPNG imageFront orthographic view of the model
back.pngPNG imageBack orthographic view of the model
left.pngPNG imageLeft orthographic view of the model
right.pngPNG imageRight orthographic view of the model
top.pngPNG imageTop orthographic view of the model
bottom.pngPNG imageBottom orthographic view of the model
iso.pngPNG imageIsometric view of the model
parameters.jsonJSON fileUser-defined parameters extracted from the model
mass_properties_and_bounding_box.jsonJSON fileMass properties (volume, mass, center of gravity) and bounding box dimensions
bill_of_materials.jsonJSON fileBill of materials for assemblies listing all component parts
material.jsonJSON fileMaterial properties assigned to the model

Usage​

Method 1: Upload​

Upload your Creo files directly to the Istari Digital Platform and run extraction jobs using either the Platform UI or the SDK. For assemblies, package all dependent files in a ZIP archive before uploading.

Link to Windchill-managed CAD files by providing Windchill credentials and model object IDs (OIDs). The integration handles automatic retrieval from the Windchill server.

Using the Istari Digital Platform UI​

Follow these steps to extract data from Creo models using the web interface:

  1. Navigate to the Files page.
    Click the Files option in the left-hand sidebar.

  2. Upload your Creo file.

    • For parts: Drag and drop your .prt file into the Upload Files area or click to browse.
    • For assemblies: Create a ZIP file containing the .asm file and all dependent parts, then upload the ZIP.
    • For Windchill models: Create a .istari_windchill_metadata file (see Windchill section below) and upload it.

  3. Open the model file.
    Click on the uploaded file in your files list to open its detail page.

  4. Navigate to the Artifacts tab.
    Click the Artifacts tab to view and manage artifacts associated with this model.

  5. Fill out the function execution form.
    In the Execute Function section, provide the following information:

    • Tool Name: ptc_creo_parametric
    • Version: 10.0.0.0 (or your installed version)
    • Operating System: Windows 10, Windows 11, Windows Server 2019, or Windows Server 2022
    • Function: Select the desired function (e.g., @istari:extract, @istari:update_parameters, @istari:windchill_extract)
    • Agent: Select the appropriate agent with PTC Creo installed
    • Parameters: (Only for parameter update functions) Provide parameter updates in JSON format

  6. Run the function.
    Click the Run or Execute button to start the job.

  7. Monitor job progress.
    The page will display the job status. Creo operations typically complete in a few minutes depending on model complexity.

  8. View results.
    Once the job completes successfully, the extracted artifacts will appear in the Artifacts tab.

  9. Download or view artifacts.
    Click on any artifact to view images in the browser, or download JSON files for further analysis.

Using the Istari Digital SDK​

Prerequisite: Install Istari Digital SDK and initialize Istari Digital Client per instructions here​

Step 1: Upload and Extract the File(s)​

Upload the file as a model​

from pathlib import Path

# Upload Creo part or assembly (assemblies must be in ZIP format)
model = client.add_model(
    path="example.prt",  # Or: "assembly.zip" for assemblies with dependencies
    description="Creo model for extraction",
    display_name="Creo Part Model",
)
print(f"Uploaded model with ID {model.id}")

Extract once you have the model ID​

# Extract comprehensive model data (views, parameters, mass properties, BOM)
extraction_job = client.add_job(
    model_id=model.id,
    function="@istari:extract",
    tool_name="ptc_creo_parametric",
    tool_version="10.0.0.0",
    operating_system="Windows 10",  # Or: Windows 11, Windows Server 2019, Windows Server 2022
)
print(f"Extraction started for model ID {model.id}, job ID: {extraction_job.id}")

Step 2: Check the Job Status​

extraction_job.poll_job()

Step 3: Retrieve Results​

Example​

# Retrieve the model with updated artifacts
model = client.get_model(model.id)

for artifact in model.artifacts:
    output_file_path = f"c:\\creo_extracts\\{artifact.name}"

    # Create directory if needed
    Path(output_file_path).parent.mkdir(parents=True, exist_ok=True)

    if artifact.extension in ["txt", "csv", "md", "json", "html"]:
        with open(output_file_path, "w", encoding="utf-8") as f:
            f.write(artifact.read_text())
        print(f"Saved text artifact: {output_file_path}")
    else:
        # Binary files (PNG images, etc.)
        with open(output_file_path, "wb") as f:
            f.write(artifact.read_bytes())
        print(f"Saved binary artifact: {output_file_path}")

Notes on File Types​

  • Parts (.prt): Single part files can be uploaded directly and will extract all available data including parameters, mass properties, material, and views.
  • Assemblies (.asm): Must be packaged in a ZIP archive with all dependent parts included. The BOM extraction will list all components in the assembly hierarchy.
  • Windchill Files: Use the @istari:windchill_extract function to retrieve files directly from Windchill without manual download (see Windchill Integration section below).

Updating Parameters​

You can update parameters in Creo models programmatically using the @istari:update_parameters function:

# Upload the Creo model (part or assembly ZIP)
creo_model = client.add_model("path/to/model.prt")
print(f"Creo file uploaded as model {creo_model.id}")

# Create update job with parameter changes
update_job = client.add_job(
    model_id=creo_model.id,
    function="@istari:update_parameters",
    tool_name="ptc_creo_parametric",
    tool_version="10.0.0.0",
    operating_system="Windows 10",
    parameters={
        "parameters": {
            "DESCRIPTION": "Updated Description",
            "THICKNESS": "2.5",
            "MATERIAL": "STEEL"
        }
    }
)

print(f"Created update job {update_job.id}")

# Monitor job status
update_job.poll_job()

# Retrieve updated model
updated_model = client.get_model(creo_model.id)
for artifact in updated_model.artifacts:
    print(f" * {artifact.name}")

Windchill Integration​

The PTC Creo integration provides direct connectivity to Windchill PLM, allowing you to extract and update CAD files without manual download/upload workflows.

Extracting Files from Windchill​

The @istari:windchill_extract function retrieves CAD files directly from your Windchill instance.

Step 1: Create Required Files​

Windchill Credentials File (windchill_secret.json)

{
  "username": "your-windchill-username",
  "password": "your-windchill-password"
}

Windchill Metadata File (input.istari_windchill_metadata)

{
  "oid": "VR:wt.epm.EPMDocument:132353"
}

How to Extract the OID from a Windchill URL​

Windchill URLs typically look like:

https://company_domain/Windchill/app/...&oid=VR%3Awt.epm.EPMDocument%3A120615
  1. Copy the oid parameter value
  2. URL-decode it:
    • Encoded: VR%3Awt.epm.EPMDocument%3A120615
    • Decoded: VR:wt.epm.EPMDocument:120615
  3. Use the decoded string in your metadata file

Tip: You can also use the Istari Digital Platform UI to link Windchill files, which handles URL decoding automatically.

Step 2: SDK Example for Windchill Extract​

from istari.openapi_client import FunctionAuthType, NewSource

# Step 1: Securely add Windchill credentials
function_auth_secret = client.add_function_auth_secret(
    path="path/to/windchill_secret.json",
    function_auth_type=FunctionAuthType.BASIC,
)

windchill_auth_source = NewSource(
    revision_id=function_auth_secret.revision.id,
    relationship_identifier="windchill_auth",
)

# Step 2: Upload the Windchill metadata file
model = client.add_model(
    path="path/to/input.istari_windchill_metadata",
    display_name="Windchill CAD Download",
)

# Step 3: Submit the windchill_extract job
windchill_job = client.add_job(
    model_id=model.id,
    function="@istari:windchill_extract",
    tool_name="ptc_creo_parametric",
    tool_version="10.0.0.0",
    operating_system="Windows 10",
    sources=[windchill_auth_source],
)

print(f"Windchill extraction started, job ID: {windchill_job.id}")

# Monitor job and retrieve results
windchill_job.poll_job()

Updating Parameters in Windchill Files​

The @istari:windchill_update_parameters function implements a complete checkout/checkin workflow:

  1. Authentication: Connects to Windchill using provided credentials
  2. File Retrieval: Downloads the specified model from Windchill
  3. Checkout: Checks out the file (and all component parts for assemblies)
  4. Parameter Updates: Applies the specified parameter changes
  5. Checkin: Checks the modified file back into Windchill
  6. Export: Provides the updated model as output

Note: Only modified files are checked in; unchanged files are automatically skipped.

Example Usage​

# Using the same auth source and model from windchill_extract above
windchill_update_job = client.add_job(
    model_id=model.id,
    function="@istari:windchill_update_parameters",
    tool_name="ptc_creo_parametric",
    tool_version="10.0.0.0",
    operating_system="Windows 10",
    sources=[windchill_auth_source],
    parameters={
        "parameters": {
            "DESCRIPTION": "Updated via Istari Digital",
            "MATERIAL": "Aluminum 6061",
            "THICKNESS": "2.5"
        }
    }
)

print(f"Windchill update started, job ID: {windchill_update_job.id}")
windchill_update_job.poll_job()

Installation​

Prerequisites​

  • PTC Creo Parametric 10.0.X.X
  • Windows 10, Windows 11, Windows Server 2019, or Windows Server 2022
  • (Optional) PTC Windchill 12.1 for Windchill integration features
  • Istari Digital Agent version 9.0.0 or higher
  • GPU with OpenGL support (for view rendering)
  • Administrative access to configure environment variables

Configuration​

Module Version 3.1.0+: Simplified Configuration

Starting with creo-module 3.1.0, the cad-geometry-toolkit is bundled directly in the module release, replacing the separate renderer and converter tools. The toolkit is automatically available at runtime with zero configuration required.

The module uses standardized configuration variables and supports centralized configuration via istari_digital_config.yaml.

The Istari Agent is configured via the file istari_digital_config.yaml. The Agent expects the file to be located at:

  • %LOCALAPPDATA%\istari_digital\ on Windows
  • ~/.config/istari_digital/ on RHEL/Ubuntu

Configure the Creo module using the istari_digital_agent_module_configurations section:

agent:
  istari_digital_agent_module_configurations:
    "@istari:ptc_creo_parametric":
      "ptc_creo_parametric_executable_path": "C:/Program Files/PTC/Creo 10.0.0.0/Common Files/x86e_win64/bin/parametric.exe" # required
      "ptc_creo_parametric_windchill_pdm_link": "https://your-windchill-server.com" # optional
      "ptc_creo_parametric_windchill_workspace": "C:/windchill/workspace" # optional
      # Renderer/converter paths no longer needed - toolkit is bundled
Click to expand legacy configuration instructions

Legacy Configuration (module_config.json)​

For backward compatibility with older module versions, you can use the legacy module_config.json file located at {istari_agent_dir}\istari_modules\ptc_creo_parametric\app\resources\module_config.json:

{
  "ptc_creo_parametric_executable_path": "C:/Program Files/PTC/Creo 10.0.0.0/Common Files/x86e_win64/bin/parametric.exe",
  "ptc_creo_parametric_windchill_pdm_link": "https://your-windchill-server",
  "ptc_creo_parametric_windchill_workspace": "/path/to/workspace"
}

Configuration for Older Versions (3.0.0 - 3.0.x)​

If you're using an older module version (3.0.0 - 3.0.x), you'll need to include renderer and converter paths:

Centralized Configuration (3.0.0 - 3.0.x):

agent:
  istari_digital_agent_module_configurations:
    "@istari:ptc_creo_parametric":
      "ptc_creo_parametric_executable_path": "C:/Program Files/PTC/Creo 10.0.0.0/Common Files/x86e_win64/bin/parametric.exe"
      "ptc_creo_parametric_renderer_executable_path": "C:/path/to/blender/render/tool"
      "ptc_creo_parametric_converter_executable_path": "C:/path/to/universal/cad/converter"
      "ptc_creo_parametric_windchill_pdm_link": "https://your-windchill-server.com"
      "ptc_creo_parametric_windchill_workspace": "C:/windchill/workspace"

module_config.json (3.0.0 - 3.0.x):

{
  "ptc_creo_parametric_executable_path": "C:/Program Files/PTC/Creo 10.0.0.0/Common Files/x86e_win64/bin/parametric.exe",
  "ptc_creo_parametric_renderer_executable_path": "/path/to/render/tool",
  "ptc_creo_parametric_converter_executable_path": "/path/to/convert/tool",
  "ptc_creo_parametric_windchill_pdm_link": "https://your-windchill-server",
  "ptc_creo_parametric_windchill_workspace": "/path/to/workspace"
}

Configuration Parameters​

ParameterTypeRequiredDescription
ptc_creo_parametric_executable_pathStringRequiredPath to the Creo Parametric executable (parametric.exe)
ptc_creo_parametric_windchill_pdm_linkStringOptionalURL to your Windchill PDM server (required only if using Windchill integration)
ptc_creo_parametric_windchill_workspaceStringOptionalPath to the Windchill workspace directory (required only if using Windchill integration)

Required Environment Variables​

The following environment variables must be configured on the agent machine:

  1. PRO_DIRECTORY

    • Path to PTC Creo common files directory
    • Example: C:\Program Files\PTC\Creo 10.0.0.0\Common Files\

  2. PRO_COMM_MSG_EXE

    • Path to the pro_comm_msg.exe executable
    • Example: C:\Program Files\PTC\Creo 10.0.0.0\Common Files\x86e_win64\obj\pro_comm_msg.exe

  3. PATH

    • Add the platform library folder to Windows PATH
    • Example: Add C:\Program Files\PTC\Creo 10.0.0.0\Common Files\x86e_win64\lib\

Setting Environment Variables on Windows​

  1. Open Control Panel → System and Security → System
  2. Click Advanced system settings
  3. In System Properties, click Environment Variables
  4. Under System variables, click New to add PRO_DIRECTORY and PRO_COMM_MSG_EXE
  5. Select the Path variable and click Edit to add the library path
  6. Click OK to save all changes
  7. Restart the Istari Digital Agent service

External Dependencies​

The cad-geometry-toolkit is bundled directly in the module release (version 3.1.0+), providing unified rendering and conversion capabilities. The toolkit is automatically available at runtime with no additional configuration required.

License Configuration​

No additional license configuration is required for the Creo module itself. However, you must have:

  • Valid PTC Creo Parametric licenses on the agent machine
  • (Optional) Valid PTC Windchill licenses if using Windchill integration features

Versions​

Current Module Version: 3.1.0​

The latest version includes the bundled cad-geometry-toolkit, eliminating the need for separate renderer and converter tool configurations. This simplifies setup and improves reliability.

Compatibility Notes​

  • Agent Version: Requires Istari Digital Agent version 9.8.0 or higher (for centralized configuration support)
  • Creo Versions: Tested with PTC Creo Parametric 10.0.X.X; designed to be generally version-compatible
  • Windchill Versions: Tested with PTC Windchill 12.1
  • Operating Systems: Windows 10, Windows 11, Windows Server 2019, Windows Server 2022
  • Python Version: Not applicable (compiled module)

Changelog​

Module Version 3.0.0​

Release Date: September 2024

Changes:

  • Introduced standardized configuration variables with ptc_creo_parametric_ prefix
  • Added support for centralized configuration via istari_digital_agent_module_configurations
  • Deprecated legacy configuration variable names for future removal
  • Maintained backward compatibility with legacy module_config.json
  • Improved error messaging for configuration issues
  • Enhanced Windchill integration stability

Module Version 2.1.0​

Release Date: May 2024

Changes:

  • Added @istari:windchill_update_parameters function for direct Windchill parameter updates
  • Implemented automatic checkout/checkin workflow for Windchill operations
  • Enhanced BOM extraction for complex assemblies
  • Improved material property extraction accuracy
  • Fixed rendering issues with large assemblies

Module Version 2.0.0​

Release Date: February 2024

Changes:

  • Added @istari:windchill_extract function for direct Windchill connectivity
  • Added @istari:update_parameters function for local parameter updates
  • Added @istari:batch_execute multi-function support
  • Enhanced view rendering with improved quality
  • Added support for Windows Server 2022

Module Version 1.0.0​

Release Date: November 2023

Initial Release Features:

  • @istari:extract function for comprehensive model data extraction
  • Orthographic and isometric view generation
  • User-defined parameter extraction
  • Mass properties and bounding box extraction
  • Bill of materials extraction for assemblies
  • Material property extraction
  • Support for parts and assemblies

Release Notes​

Key Changes Between Versions​

Version 3.0.0 (September 2024):

  • Configuration system modernized with centralized YAML support
  • Standardized configuration variable names for consistency
  • Enhanced Windchill integration reliability

Version 2.1.0 (May 2024):

  • Added Windchill parameter update capabilities
  • Improved assembly handling and BOM extraction

Version 2.0.0 (February 2024):

  • Major feature expansion with Windchill integration
  • Added parameter update and batch execution functions
  • Expanded OS support to Windows Server 2022

Version 1.0.0 (November 2023):

  • Initial production release with core extraction functionality
  • Established foundation for Creo integration workflows

Troubleshooting​

Common Issues​

Issue: Missing PNG View Images

  • Symptom: Extraction completes but orthographic/isometric view PNG files are missing
  • Cause: GPU driver issues or missing OpenGL support required by the Blender rendering tool
  • Solution:
    1. Verify GPU driver is properly installed on the agent machine
    2. Ensure the GPU driver supports OpenGL (check manufacturer specifications)
    3. Update GPU driver to the latest version from the manufacturer
    4. Test OpenGL support by running a simple OpenGL application
    5. Review module logs for specific rendering errors
    6. Contact your IT administrator to verify GPU hardware compatibility

Issue: Missing parameters.json Artifact

  • Symptom: Extraction completes but parameters.json file is missing or empty
  • Cause: Source model doesn't contain user-defined parameters
  • Solution:
    1. Open the model in PTC Creo Parametric
    2. Verify that user-defined parameters exist in the model
    3. Create parameters if needed (refer to PTC Creo documentation)
    4. Ensure parameters are not system-generated (user-defined parameters only)
    5. Re-upload and extract the model after adding parameters

Issue: Missing material.json Artifact

  • Symptom: Extraction completes but material.json file is missing or shows null values
  • Cause: Material properties not properly assigned in the source model
  • Solution:
    1. Open the model in PTC Creo Parametric
    2. Verify material is assigned (Edit → Material)
    3. Assign appropriate material from the material library
    4. Save the model and re-upload for extraction
    5. Check module logs for material extraction errors

Issue: Assembly Extraction Fails

  • Symptom: Error messages when trying to extract assembly files
  • Cause: Missing dependent part files or assembly not packaged correctly
  • Solution:
    1. Ensure assembly and ALL dependent part files are included in the ZIP
    2. Verify ZIP file structure: all files should be at the root level (not in subdirectories)
    3. Check that file references in the assembly match the actual filenames in the ZIP
    4. Test opening the assembly in Creo to verify all dependencies are resolved
    5. Re-package the ZIP with all required files and re-upload

Issue: Windchill Connection Failed

  • Symptom: @istari:windchill_extract or @istari:windchill_update_parameters fails with connection errors
  • Cause: Incorrect Windchill server URL, invalid credentials, or network connectivity issues
  • Solution:
    1. Verify ptc_creo_parametric_windchill_pdm_link is correct in configuration
    2. Test Windchill URL accessibility from the agent machine (ping/browser test)
    3. Verify username and password in the credentials file are correct
    4. Ensure the Windchill user account has necessary permissions
    5. Check firewall rules allow HTTPS connections to Windchill server
    6. Review Windchill server logs for authentication errors

Issue: Windchill OID Not Found

  • Symptom: Error message indicating "Object not found" or "Invalid OID"
  • Cause: Incorrect OID format, URL-encoding not removed, or object doesn't exist in Windchill
  • Solution:
    1. Verify the OID is correctly URL-decoded (replace %3A with :, etc.)
    2. Copy the OID directly from the Windchill URL parameter
    3. Check that the object exists in Windchill and you have access to it
    4. Ensure you're using the correct OID type (e.g., VR:wt.epm.EPMDocument:12345)
    5. Try accessing the object in Windchill UI to verify it exists

Issue: Parameter Update Not Applied

  • Symptom: @istari:update_parameters completes but parameters remain unchanged
  • Cause: Parameter names don't match exactly, parameters are read-only, or computed parameters
  • Solution:
    1. Verify parameter names match exactly (case-sensitive)
    2. Check that parameters are user-defined and not system parameters
    3. Ensure parameters are not computed/derived from other parameters
    4. Open the model in Creo to verify parameter names and types
    5. Review module logs for parameter update error messages
    6. Use the correct parameter path format for nested parameters

Issue: Module Not Found or Won't Execute

  • Symptom: Error messages indicating the module cannot be found or executed
  • Cause: Module not installed correctly, wrong agent version, or configuration issues
  • Solution:
    1. Verify Istari Digital Agent version is 9.8.0 or higher
    2. Check that the Creo module is installed in the correct agent modules directory
    3. Verify PTC Creo is installed on the same machine as the agent
    4. Restart the Istari Digital Agent service
    5. Review agent logs for specific error messages
    6. Verify all required environment variables are set correctly
    7. Contact your administrator to verify the module installation

Issue: Environment Variables Not Recognized

  • Symptom: Module fails to start with errors about missing Creo resources
  • Cause: Required environment variables not set or set incorrectly
  • Solution:
    1. Verify PRO_DIRECTORY, PRO_COMM_MSG_EXE, and PATH are set correctly
    2. Check environment variables are system-level, not user-level
    3. Restart the Istari Digital Agent service after setting environment variables
    4. Use absolute paths (not relative) for all environment variable values
    5. Verify paths point to actual files/directories that exist
    6. Open a new command prompt and verify variables with echo %PRO_DIRECTORY%

Getting Help​

If you continue to experience issues:

  1. Check the module log files for detailed error messages
  2. Review the Istari Digital Agent logs for additional context
  3. Verify PTC Creo can be launched and operated manually on the agent machine
  4. Consult the main troubleshooting guide for general agent issues
  5. Contact Istari Digital support with:
    • Module version (3.0.0)
    • Agent version
    • PTC Creo version (e.g., 10.0.0.0)
    • (If applicable) Windchill version
    • Operating system and Windows version
    • Error messages from module logs and agent logs
    • Configuration file contents (redact sensitive information)
    • Steps to reproduce the issue
    • Sample model file if possible

Tips and Best Practices​

Optimal Model Preparation​

User-Defined Parameters: Create user-defined parameters in your Creo models for effective digital threading:

  • Use descriptive parameter names (avoid generic names like "PARAM1")
  • Define parameters at the part level, not feature level
  • Set appropriate units for dimensional parameters
  • Document parameter purposes in model descriptions
  • Use parameters to connect design values across your digital thread

Material Assignments: Properly define materials in Creo models:

  • Assign materials from the standard material library
  • Define custom materials with complete property sets
  • Ensure material assignments propagate to all assembly components
  • Verify material density is set for accurate mass properties

Assembly Best Practices:

  • Keep assembly structures organized with meaningful names
  • Ensure all part dependencies are included when packaging
  • Use relative references for part files when possible
  • Verify assembly opens correctly in Creo before uploading
  • Document assembly hierarchy in model metadata

Windchill Integration Best Practices​

Credential Management:

  • Use service accounts for automated Windchill integration
  • Store credentials securely using the function auth secret mechanism
  • Rotate credentials regularly per your security policy
  • Grant minimum necessary permissions for Windchill access
  • Monitor Windchill audit logs for integration activity

Workflow Efficiency:

  • Use @istari:windchill_extract to avoid manual download/upload cycles
  • Leverage @istari:windchill_update_parameters for automated parameter synchronization
  • Batch multiple parameter updates in a single operation
  • Schedule regular extractions to maintain up-to-date data
  • Use the Platform UI to simplify OID extraction from Windchill URLs

Checkout/Checkin Management:

  • The module automatically handles checkout/checkin for Windchill operations
  • Only modified files are checked back in (unchanged files skipped)
  • Monitor Windchill workspaces for any orphaned checkouts
  • Use Windchill audit trails to track automated updates
  • Coordinate with PLM administrators for workspace cleanup policies

Performance Optimization​

File Size Considerations:

  • Large assemblies (>1000 parts) may take several minutes to process
  • Complex models with detailed geometry increase rendering time
  • Simplify models for extraction if full detail isn't needed
  • Consider extracting subassemblies separately for very large products

Batch Operations:

  • Use @istari:batch_execute for processing multiple models
  • Group related models for efficient batch processing
  • Schedule batch jobs during off-peak hours
  • Monitor system resources during large batch operations

GPU Optimization:

  • Ensure GPU driver is up to date for optimal rendering performance
  • Allocate sufficient GPU memory for rendering complex views
  • Monitor GPU utilization during extract operations
  • Consider dedicated GPU for agent machines with high workload

Security Considerations​

Credentials:

  • Never hardcode Windchill credentials in scripts
  • Use the function auth secret mechanism for credential storage
  • Implement credential rotation policies
  • Audit credential usage through Windchill logs

Configuration:

  • Protect configuration files with appropriate permissions
  • Restrict access to module directories to authorized users only
  • Review configuration for exposed sensitive information
  • Document configuration changes for audit purposes

Model Access:

  • Verify user permissions before granting platform access
  • Use Windchill permission schemes to control model access
  • Monitor extraction activity for unauthorized access attempts
  • Implement data classification policies for sensitive models

FAQ​

  • Do I need to package assemblies in a specific way?

    • Yes, assemblies must be in a ZIP file with all dependent part files included at the root level (no subdirectories). All file references in the assembly must match the actual filenames in the ZIP.

  • Can I extract from Creo versions other than 10.0?

    • The module is tested with Creo 10.0.X.X but may work with other recent versions. However, compatibility is not guaranteed. Contact support if you need support for a specific Creo version.

  • Why are my view images missing or corrupted?

    • View generation requires a GPU with OpenGL support. Verify your GPU driver is installed and up to date. The Blender rendering tool requires proper OpenGL support to generate views.

  • How do I find the OID for a Windchill object?

    • Look for the oid parameter in the Windchill URL when viewing the object. Copy the value and URL-decode it (replace %3A with :, %2F with /). Alternatively, use the Platform UI which handles this automatically.

  • Can I update parameters in Windchill without checking out manually?

    • Yes! The @istari:windchill_update_parameters function automatically handles the entire checkout/update/checkin workflow. Just provide the credentials, model OID, and parameter updates.

  • What's the difference between @istari:update_parameters and @istari:windchill_update_parameters?

    • @istari:update_parameters works on uploaded Creo files and returns the updated model. @istari:windchill_update_parameters works on Windchill-managed files, performs checkout/checkin, and updates the model directly in Windchill.

  • Why does my BOM extraction show missing components?

    • Ensure all assembly dependencies are included in the ZIP file. Open the assembly in Creo to verify all components load correctly. Missing dependencies will appear as failures in the BOM extraction.

  • Can I extract from models stored in other PLM systems besides Windchill?

    • Currently, only Windchill PLM integration is supported. For other PLM systems, you'll need to download the model manually and upload it to the Platform.

  • How do I troubleshoot "PRO_DIRECTORY not found" errors?

    • Verify the PRO_DIRECTORY environment variable is set at the system level (not user level). Restart the Istari Digital Agent service after setting environment variables. Ensure the path points to your actual Creo installation directory.

  • Can the module handle models with encrypted or proprietary data?

    • Yes, the module processes models locally on your agent machine and respects all Creo security features. However, ensure your licensing and security policies permit automated processing.

  • What happens if a Windchill checkout fails during parameter update?

    • The module will report the error and not check in any changes. Review Windchill logs to determine the cause (permissions, locks, etc.). The workspace remains in a safe state with no partial updates.