Administration

Create App Instance

By using Apps you can add functionality and you can connect PayPlans to various other Joomla extensions. Concept of PayPlans apps is like plug and play. You can plug(integrate) apps with PayPlans and can use them easily.

PayPlans apps are separate plugins and are outside of its core code, so they help in achieving different business needs easily without having any impact on performance.
Apps in PayPlans are the one of the power tool, by using them you can add different types of functionality. By creating App Instance of an app you can add exciting features in PayPlans, like - payment gateway(s), 3rd party integration, etc.

Onwards PayPlans v3.2.X version, we have introduced a new back-end App screen. On App screen there are three tabs MyApps, App Instances and Visit App-Store.

  • My Apps : List all the apps and plugins installed in your PayPlans and their plugins are published.

  • App Instances : List all the App Instances created for multiple apps.

  • Visit App-Store : It redirects to your PayPlans App Store. Here, you can install apps OR update existing apps if there is any update available.

Toolbar of 'App Instances' tab screen to create, delete and modify App Instances

NOTE : Every app that you want to use, you have to install it from AppStore (except pre-installed apps). Any app can have any number of app instances.

To demonstrate creating app instance in PayPlans we will give you an example of creating app instance for 2Checkout App as follow the underwritten steps-

  • Let’s say you have installed ‘2Checkout’ App from AppStore.

  • To use this app create app instance. Go to PayPlans -> Apps -> My Apps tab

  • Here, search the 2Checkout app and hover your mouse on 2Checkout app and click on button Create App Instance.

Installed apps are listed under 'My Apps' tab. Create App Instance easily for any app.

  • Now, you are on 2Checkout App edit screen. Contents on this screen is divided in three parts, which are App Details, Parameters and Setup Instructions.

App Instance edit screen. Admin can create and edit app instance detail here.

  • App Details: Name: Enter the name for the application. Published: Decide whether to publish it or not. Set Yes, to publish it and No, to unpublish. Apply On All Plans: Set it to Yes, if you want this app to be made applicable for all the plans. Set it to No, if you want to this application be made applicable only for some specific plans and then you can select those plans here. Description: Enter description for the application.

  • Parameters: Here you need to fill the required parameters for the application. Each app have it’s own different parameters depends on its working.

  • Setup Instructions: Setup instructions and other important notes related to the app configuration are quickly available in this section(You must go through it).

After filling all required details on app instance screen you need to Save it.
Now, you can use the app for which you have created app instance. For example, if you have created payment gateway app instance then it will be available on Invoice checkout page as Payment Method.