Home / FactoryTalk Optix / Optix Studio Pro
Description
See the steps needed to link your github account in FactoryTalk Optix Studio and push from or pull to a remote github repository.
Transcript
(00:01) in this video I’d like to show how we can connect our GitHub account into our Factory talk Optics Studio we can use GitHub to be a remote repository to store and collaborate and share our Optics projects with our other team members that can all work on a project kind of simultaneously so to do this we’re going to have to first uh make sure we have a GitHub account so um if you don’t have a GitHub account you can go to github.
(00:30) com and create an account it’s free to do that once you create an account then you’ll have to create a repository uh inside of GitHub and we’ll do that in just a minute but first let’s create an Optics project I want to first show that um before you know before we start create an Optics project you do have to link your GitHub account into Optics studio so to do that we’re going to go to the settings we’ll go to factory talk Optics Studio options we’ll go to Version Control we’ll have to enter our username and our email address
(01:02) for our GitHub account and then we have two options right now available to us for Version Control providers one is GitHub and one is gitlab GitHub is basically the cloud-based version and gitlab would be an on Prim version of GitHub I’m going to use GitHub which is going to be our cloud-based so I would have basically I would choose GitHub and then I would I would enter my uh username and password credentials and then it would validate the connection and then we’re connected in the GitHub so once I’ve done that I can now
(01:36) come in here and create a project I’m going to go ahead and say default project and we’ll say um just the default resolution is good for right now I want to say that to use GitHub and to directly connect your GitHub account into Optics Studio we do have to have the pro subscription license for Optics so there are two versions of the studio there’s the standard version which is completely free unlicensed you can download it and use it without any licensing and there’s a pro subscription version which gives us the ability to
(02:18) directly Connect into a GitHub remote repository as well as to be able to use the cloud-based version of Optics studio now if you don’t have a pro subscription license you can always go to the GitHub repository you can always download the repository manually and you can always open that downloaded uh project into studio and then if you want to push it back into GitHub then it’ll be a manual process back right you would save your project and then you can push that change up in the GitHub log into GitHub and and uh upload uh the changes so that
(03:00) that that’s still possible but with a pro license you’ll be able to directly push and pull from a remote repository without having to do those manual steps so I’ve created a project and I I went I didn’t change the default name so it’s new HMI project so it’s very important that when we go into GitHub we have to make a repository in GitHub that exactly matches the name of our project here in an optic Studio they got to be exact matches so I’m going to go back to GitHub I’m going to choose my uh the green new button here and I’m going to
(03:42) call it basically exactly what the name of the project here and again that is new HMI project new HMI project so it shows that that is is available after that if I want to give it a brief description I can definitely do that um there are two options here as far as making it visible either public or private if it’s public well then it’s it’s visible to anybody on the internet if it’s private then only those that I choose to share it with can see to it can see it and the other option here is a checkbox for add a readme file it’s
(04:23) very important that you do not check this box um basically if you were to create a readme file uh it’ll it’ll be with the same name as the factor talk Optics project and uh this will cause an issue for Factor talk Optics uh it will prevent the project from synchronizing properly so just leave this box unchecked very important then we’re going to choose to create the repository so now that the repository has been made in GitHub uh I now have a link a URL to this repository I’m going to go ahead and copy this link
(05:01) because I’m going to need it here in just a few moments we’ll come back to optic studio and say I’ve made some edits here I’m ready to push this to the remote repository I can now choose I I have these two kind of cloud buttons up here one is a cloud with the arrow going up that’s pushed to remote and then one with a cloud the arrow going down that’s pull from remote so basically I’m going to upload to GitHub and I can download from GitHub to kind of put it in our PLC terminology that we like but basically pushing to the to GitHub and then
(05:35) pulling it off the off the cloud and and down into Optics as another option to me but I’m going to go ahead and push it because I I need to push my initial changes here um up into the GitHub so I’m going to choose push the remote it asks me to give a commit message which is basically a little bit of a comment as to maybe what this revision is um I might just put it as rev one and then it’s going to ask me to provide the URL to the remote uh location which is the the URL that I copied from the repositor I just created I’m going to
(06:13) say okay once I do that it starts to save that project remotely up into GitHub so it only took a few moments it’s done if I come back now to GitHub if I were to click on my new HMI project here kind of get back to the repository we’ll see that now we have we have the uh the items um the files from the object Optics project stored in my repository and I have myoptics file which is the new HMI project.
(06:48) Optics so that’s kind of the project there but there’s a few other files that come along too and then I have my commit message which I basically have what said was rev one it shows it as you know just being done here a minute ago so that’s it so if I want to make changes make any more additional changes then I can come back and say push the remote and uh it would ask me what what a commit is of course I didn’t uh make any changes so uh it didn’t detect any changes so it didn’t ask me to make the commit uh you know comments there if I
(07:25) want to download from the set from the uh remote Repository then I can just basically choose the download button as well and that will pull it down now for this project it kind of knew that the the path to the repository so I it didn’t prompt me for that but if this was a kind of a new project and somebody sent me a link to a GitHub repository to to to pull from then I it would ask me it would prompt me what is the path to the remote repository that you want to download from and I would enter that path and it would go and pull it from
(08:03) from that path so pretty straightforward pretty simple with the key is linking your GitHub account as well as creating a repository in GitHub that matches exactly the name of your Optics project and remembering to not choose to create a read me file when you do create that Repository
(14:21) flexibility with the pro license