Installing & Configuring CoDesigner

 

Supported MCAD Software

The following MCAD platforms and versions are currently supported:

For details of supported MCAD versions and the required version of Altium MCAD CoDesigner, check the Version Compatibility Matrix on the New in CoDesigner page.

Installing and Configuring CoDesigner

Altium CoDesigner is an interface for transferring printed circuit board designs between the ECAD and MCAD design domains. Once the CoDesigner extension/plugin has been added to the ECAD and MCAD software, CoDesigner can pass design changes back and forth. Design changes are passed through an Altium Workspace, which acts as a bridge between the ECAD and MCAD domains, as shown below.

The features and functionality available for MCAD CoDesign, such as transferring the copper geometry or working with rigid-flex boards, depend on your Altium product access level. For further information and links, refer to the Note in the right-hand pane of this web page.

Note that in addition to downloading and installing the relevant plugin (described later on this page) MCAD users require the Advanced MCAD CoDesigner application.

Installing the CoDesigner in your ECAD Software

  • The MCAD CoDesigner extension is included in the standard Altium Designer installation, so the MCAD CoDesigner panel is always available in the PCB editor. If you're interested, learn more about Extending and Updating your Installation.

Installing CoDesigner in your MCAD Software

To access the Altium CoDesigner panel in your MCAD software, you must install a Plugin (also referred to as an Add-In in some MCAD tools). You can download all of the MCAD CoDesigner plugins from the Altium website download page.

Once you have downloaded the Plugin, use these links to access detailed information about installing and configuring CoDesigner in your MCAD software.

Updating the MCAD Plugin

The MCAD Plugin includes an Auto-Update feature. During start-up, the following dialog will appear automatically whenever a newer version of the Plugin is available for your MCAD software.

The MCAD Plugin can also be updated by downloading a new version from the Altium website download page and installing it over the top of the current Plugin.

It’s strongly recommended that you update the MCAD Plugin every time you update your Altium design software, to ensure that the Plugin version matches the Altium Designer extension version. Details of the Plugin and extension version numbers are included at the end of each new feature summary section on the New in CoDesigner page.

CoDesigner License Usage

CoDesigner is included as part of your Altium design software, so there are no additional licensing requirements on the ECAD side.

On the MCAD side, license usage depends on the type of Workspace that CoDesigner is connecting to:

  • Altium 365 Workspace - the CoDesigner MCAD Plugin does not consume a license. 
  • Altium Enterprise Server Workspace - the CoDesigner MCAD Plugin consumes an Altium license CAL (Client Access License) when you sign in to the Enterprise Server Workspace via the Altium CoDesigner panel in your MCAD software. All CoDesigner features are available when you use an Enterprise Server Workspace.

Configuring your Workspace Settings

Accessing your Workspace in your Browser

CoDesigner transfers PCB design changes through a Workspace. To check and change your project and team settings, you can log in to your Workspace via a web browser. The approach you use to log in depends on how your Workspace is hosted. An Altium 365 Workspace is hosted on Altium 365, in the cloud. You can also use an Altium on-site Workspace, such as an Enterprise Server Workspace.

Your Workspace can be configured and managed through a web browser.Your Workspace can be configured and managed through a web browser.

Configuring the Workspace Members

Each person who needs access to your shared Workspace (directly, or from a design open in their ECAD or MCAD software) must be added to the Workspace Members and assigned a Group that gives them the appropriate permissions to access the files stored in the Workspace. Although their interfaces are slightly different, the process for adding a team member and assigning a group is essentially the same for an Altium 365 Workspace or an on-prem Altium Workspace, such as an Enterprise Server Workspace. These tasks are performed in the Workspace web interface, accessed through your preferred browser.

You must have administrator privileges to configure the Team/Users, Passwords, and Groups.

Adding New Members and Assigning Groups

The approach is to Invite Workspace Members (Users in an on-prem Server Workspace). As part of adding the team member, they can be assigned a Group; such as Mechanical Engineer, Librarian, Engineer, and so on. New Groups can also be defined. The image below shows where you add a new team member to an Altium 365 Workspace. The process is similar in on-prem Workspaces.

Configure your team members and assign their groups.Configure your team members and assign their groups.

Learn more about Managing Your Team in an Altium 365 Workspace

Learn more about Managing Users and Groups in an Enterprise Server Workspace

In an Altium 365 Workspace, you can also invite members who are not part of your organization.

Learn more about Inviting Other Users to Your Workspace

Configuring the MCAD Component Model Naming

As CoDesigner converts each component to a Parasolid model, they are named using the following scheme:

<Footprint Name>_<ComponentDesignItemID>_<ItemRevision>

The following special characters, along with other control symbols, are replaced with an underscore (_):

\, /, :, %, [whitespace], |, [, ], *, ", ', \t

The default naming scheme used for component models.The default naming scheme used for component models.

In PTC Creo, all symbols except the letters (a-z, A-Z) and numbers (0-9) are replaced with an underscore, and the result presented in upper case.

Controlling the Naming of Component Models

CoDesigner supports four options for controlling how component models are named, during their initial transfer from ECAD to MCAD:

  1. <FootprintName>, then <ComponentID> (the default mode)
  2. <ComponentID>, then <FootprintName>
  3. <FootprintName>, then <CustomComponentProperty>
  4. <CustomComponentProperty>, then <FootprintName>

Configure the Naming of Component Models option in the MCAD CoDesigner section of the Workspace Settings.

Select the Naming option and if it includes a Custom Component Property (parameter), define the parameter name.Select the Naming option and if it includes a Custom Component Property (parameter), define the parameter name.

These options simplify the interaction with the components in MCAD, allowing the MCAD engineer to add meaningful information such as part numbers into the Component ID, or the ECAD engineer can add a Custom Component Property in the ECAD component library.

The MCAD model is named based on the naming option configured in the Workspace.The MCAD model is named based on the naming option configured in the Workspace.

Notes:

  • The option can be changed by an Administrator in the Admin > Settings > MCAD CoDesigner section when you are logged into your Workspace in a browser.
  • Changing the naming option will not change the name of component models that have already been created by CoDesigner.

Configuring the ECAD-MCAD Component Linkage

Main page: Linking Native ECAD and MCAD Design Components i

One of the challenges of transferring design data between the MCAD and ECAD environments is managing how the components are transferred. In many companies, the ECAD and MCAD teams create and manage their own separate component libraries and need to be able to link between the MCAD and ECAD versions of that component.

The default behavior is when a design is Pushed from either the MCAD or ECAD domains, CoDesigner converts each component to a Parasolid format model and stores them all in the Workspace. When that design is Pulled, CoDesigner then builds a model of each component in the format required by the target tool. This approach gives an accurate representation of each component in both the ECAD and the MCAD design spaces. The disadvantage of this approach is that the model may not fully represent the component as it needs to be represented in that tool. For example, when a design is Pulled into Altium Designer the component will not include the pads, silkscreen, and other entities typically included in a PCB component. Nor will it be linked to a schematic symbol, or into the supply chain.

To manage the requirement for each design tool to be able to use native components, CoDesigner supports linking between the MCAD and ECAD components. The links are defined in the Workspace, which acts as a bridge between the ECAD and domains.

Configuring the Component Linkage in your Workspace

Javascript ID: A

MCAD to ECAD and ECAD to MCAD component linkage is enabled and configured in your Workspace, this image shows Altium 365.

MCAD to ECAD and ECAD to MCAD component linkage is enabled and configured in your Workspace, this image shows an Enterprise Server Workspace.

Learn more about Linking Native ECAD and MCAD Design Components

Linking Native ECAD and MCAD components requires:

  • A suitable Altium PCB editor, with MCAD CoDesigner installed. Refer to the Note in the right-hand pane for information on whether the ECAD-MCAD Component Linkage feature will be available in your installation of MCAD CoDesigner.
  • A supported MCAD platform.
    • MCAD-to-ECAD component linking is available for all supported MCAD platforms, except Autodesk Fusion 360.
    • ECAD-to-MCAD component linking is currently supported in PTC Creo Parametric (connected to Windchill), and SOLIDWORKS (connected to SOLIDWORKS PDM).
  • CoDesigner checks the component linkage settings on startup (from Altium Designer and from the MCAD tools). Restart your design software if the settings have been changed.

Where to Next?

Now that CoDesigner is installed and your Workspace is configured, you're ready to start exploring the process of transferring your design between your ECAD and MCAD software.

Learn more about Direct ECAD-MCAD Design with Altium CoDesigner

 

If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.
Note

The features available depend on your Altium product access level. Compare features included in the various levels of Altium Designer Software Subscription and functionality delivered through applications provided by the Altium 365 platform.

If you don’t see a discussed feature in your software, contact Altium Sales to find out more.

Content