Maya template builder - preserve all references when importing a template

[mre7a]

Changelog Description

When building a template with Maya template builder, we import the template and also the references inside the template file. This causes some problems:

• We cannot use the references to version assets imported by the template.
• When we import the file, the internal reference files are also imported. As a side effect, Maya complains about a reference that no longer exists.

// Error: file: /xxx/maya/2023.3/linux/scripts/AETemplates/AEtransformRelated.mel line 58: Reference node 'turntable_mayaSceneMain_01_RN' is not associated with a reference file.

Testing notes:

1. Create a template containing some references.
2. Build the workfile with template builder from openpype menu

[LiborBatek]

I think there shouldnt be any referenced files in Template File but only placeholders created via Template Creator.

So I guess its not valid request. @antirotor @iLLiCiTiT can you confirm its like I said?

[ClementHector]

@LiborBatek The purpose of the template file is to contain any type of data including placeholders. During the build phase the placeholders will be replaced by the data corresponding to the context.
We can say that it is a legitimate request.

[LiborBatek]

@LiborBatek The purpose of the template file is to contain any type of data including placeholders. During the build phase the placeholders will be replaced by the data corresponding to the context. We can say that it is a legitimate request.

My point is that template file should only/exclusively contain just placeholders....not any live reffed data. Thats my point :)

Also thats why I was asking devs whats their pov.

As I see it if there should be present something in the template file again and again ...why not create an asset for it and use placeholder for it instead and not normal maya referencing like "hardlink". Then all is build correctly and managable via Scene Inventory as any other assets loaded in.

[ClementHector]

I understand your point of view but when we started developing this feature, the goal was not to have only placeholders. I invite you to consult the description of the first tickets and thoughts that led to the development of this feature.
https://github.com/ynput/OpenPype/discussions/2013
#2202
#3544
In your case it does nothing more than the Build Workfile

[ClementHector]

If the template cannot integrate other things then for nuke we no longer have nodes that are connected to what is replaced by the placeholder.
And for maya, we can no longer put a placeholder that is replaced in a hierarchy.
And another point, maybe the reference didn't publish because it doesn't correspond to any asset, for example a lighting studio for asset reviews.

[OlivierOsotimehin]

I agree that the best way is to have proper loaded asset through Opype and not a "simple" reference.
And that's a pull request that will be coming (able to load an asset from other project (library project), with the template builder).

Being able to reference an arbitrary scene enable us to quickly prototype template elements, test them through the pipeline without having to publish again, again and again a turntable remplate or a camera, etc we are building / finetuning

[LiborBatek]

@mre7a I did try to test this but I have failed to replicate the conditions. Could you elaborate more on it, describe your workflow/ testing steps exactly step by step?

for ie I dont really understand these steps you wrote:

"When building a template with Maya template builder, we import the template and also the references inside the template file."

If I am correct theres no any "import" step normally invovled when using template file. Neither when creating the template itself nor when using that template file to create new workfile via OP>Template Builder>Build Workfile from Template

The only thing clear to me is whenever something got imported it obviously loose versioning via Scene Inventory.

Thanks.

[mre7a]

@LiborBatek Sorry if I wasn't clear.
Our template file contains not only placeholders (as expected), but also live references, and our problem is that the live references are imported into the scene and are no longer referenced.
When building a template, the Maya template builder builds the template and also imports the references inside the template file. I use the word "import" because the link to the referenced file is broken and the references inside the model are completely integrated into the current scene.
The template:

The build scene:

[LiborBatek]

When building a template, the Maya template builder builds the template and also imports the references inside the template file.

If I can reformat yout sentence it basically means this:

After using Create workfile from template file action, current maya work file no longer contains maya references formerly present within the Template file.

Btw thanks for the scrngrabs (these are very helpful! for debugging your issue).

Also looking on your template setup (pic 1) you do use some sort of asset so it could be created via placeholders not standard maya reference. All should be working then.

Does it have any special reason to create Template file like you do? Some benefits or any shortcommings when other method with placeholders?

[mre7a]

@LiborBatek Thanks a lot for reformatting my sentences. 😄
As @OlivierOsotimehin explained, I think the main reason here is that we can not use assets from other projects to build a template.
Also

Being able to reference an arbitrary scene enable us to quickly prototype template elements, test them through the pipeline without having to publish again, again and again a turntable remplate or a camera, etc we are building / finetuning.

[LiborBatek]

After creating the workfile by template file it keeps the contained maya reference files in the scene as references.

[LiborBatek]

There is one weird issue tho...I got each placeholder loaded 2x times with assets!

besides layout which is loaded just one time...

This issue is not present in the latest develop tho.
@mre7a Could you try to merge develop into this PR?

[LiborBatek]

Now all works as expected, references being preserved from Template file and
all assets correctly loaded...

[tokejepsen]

Tested in Maya 2023.

Just 1 small code cosmetic request.

can't use long names for that