Hi,
I have a Visio file and a custom protocol. What is the procedure to deploy it into a protocol file, and how can I assign this Visio to the elements created when a new element is added?
Thanks
If you already uploaded the protocol but have not yet created any elements with it, you can go to the Protocols & Templates app, find your protocol there in the left hand column and then right click in the Visio Files section next to it. From there you can do "Upload custom Visio file...".
In case you are starting from an element card, you can go to the Visual Overview page of the element, right click anywhere in it and follow the menu items to the same end result over there.


Could you describe your exact use case for this in your original question by editing? (i.e. what do you plan to do with the eventual package/file?) I think it might help for future reference and it will also help me identify what you are trying to achieve so we can help you further.
EDIT: Nevermind I think I understand based on your last sentence. You want this to be part of the dmprotocol package or similar?

Hi Toon,
Yes, I need Visio part of dmprotocol package.
Thanks
You can manually modify a .dmprotocol file generated from Visual Studio using DIS. However, uploading the modified .dmprotocol via the steps below will not automatically set the Visio file as the active one. To include a Visio file manually, follow these steps:
Embedding a Visio File into a .dmprotocol
- In your Visual Studio Connector solution, open the protocol.xml.
- Go to File > Save Compiled Protocol As... and save the resulting .dmprotocol file to a desired location.
- Extract the contents of the .dmprotocol file (it’s a ZIP archive, so tools like 7-Zip can open it).
- Inside the extracted contents, create a new folder named Visuals.
- Add your Visio file to the Visuals folder and name it according to how you want it used:
- skyline_<connector name>.vsdx — if you want the Visio to be the Protocol default one shown with the protocol.
- <connector name>.vsdx — if you want it to be a custom Visio file that users can replace or select manually.
- Repack the contents into an archive and give it the .dmprotocol extension.
You now have a .dmprotocol file that includes a Visio file.
Making the Visio File the Active Visio
If you need the Visio file to be set as the active one automatically upon deployment, you should create an application package that includes the protocol and Visio:
-
Refer to the section Application package builder API in Creating application packages | DataMiner Docs.
-
Use the
Skyline.AppInstaller.AppPackage
API, which provides methods to include a Visio file within a protocol. -
You may also need an install script to activate the Visio file upon installation.
Personally, I don’t have experience with this packaging method or the scripting required, someone else in the community may need to explore this further if more in-depth guidance is required.
Hi Toon
Thank you for your quick reply. However, what I’m looking for is to embed both the Visio file and the protocol in the same file, so that everything is bundled together. When install this custom protocol comes with Visio file