Creating New Apps
From Subscribe-HR Wiki Help
| (3 intermediate revisions by the same user not shown) | |||
| Line 8: | Line 8: | ||
Subscribe-HR allows third-party Developers to create custom solution extensions that can then be published in the Subscribe-HR App store and offered to Users as add-ons. To get started with App building the first step is to create your App record. Objects, Elements, Relationships, Integration Processes can then be created for your App and be bundled as part of the installation package. | Subscribe-HR allows third-party Developers to create custom solution extensions that can then be published in the Subscribe-HR App store and offered to Users as add-ons. To get started with App building the first step is to create your App record. Objects, Elements, Relationships, Integration Processes can then be created for your App and be bundled as part of the installation package. | ||
| − | <b>NOTE:</b> before your App can be published in the store it will be subjected to a testing, validation and approval process which will be performed by Subscribe-HR team. | + | <b>NOTE:</b> before your App can be published in the store it will be subjected to a testing, validation and approval process which will be performed by the Subscribe-HR team. |
Once approved, the App will become available in the following two locations: | Once approved, the App will become available in the following two locations: | ||
| − | #Under the General menu (left-hand side of the System) > | + | #Under the General menu (left-hand side of the System/screen) > Development > Apps. |
#Via the App Dashboard [coming soon]. | #Via the App Dashboard [coming soon]. | ||
Developers can access the App documentation here: https://subscribehr.readthedocs.io/en/latest/getting_started.html | Developers can access the App documentation here: https://subscribehr.readthedocs.io/en/latest/getting_started.html | ||
| − | Apps can be configured by Users via the Activation Hub [Coming soon]. | + | Apps can be installed and configured by Users via the Activation Hub [Coming soon]. |
==Creating A New App== | ==Creating A New App== | ||
| − | # After logging into the Subscribe-HR portal, | + | #The first step in the process is to start a Free Trial: https://www.subscribe-hr.com.au/free-trial |
| + | # After logging into the Subscribe-HR portal, go to the General menu (left-hand side of the System/screen) > Development > Apps. | ||
# Select the <b>Apps</b> folder. | # Select the <b>Apps</b> folder. | ||
# Select the "+Add new record" button. | # Select the "+Add new record" button. | ||
| − | # Enter the <b>Name | + | # Enter the <b>Name</b> - name the App as you want it to appear in the store. |
| − | # Enter | + | # Enter a <b>Short Description</b> - add a short App description snippet. This description will appear in the store on the App tile. |
| − | # Enter the <b>Categories</b> | + | # Enter the <b>Categories</b> - include the categories that App will be listed under. |
| − | # Enter the <b>Developer Name</b>. | + | # Enter the <b>Developer Name</b> - list the Developer's name. |
| − | # Enter the <b>Developer Website</b>. | + | # Enter the <b>Developer Website</b> - share the Developer's website. |
| − | # Enter the <b>Developer Logo</b> | + | # Enter the <b>Developer Logo</b> - add the Developer/Company logo. This can be a product logo if this is an integration project. |
| − | # Enter the <b>Full Description</b> of the | + | # Enter the <b>Full Description</b> - include a detailed description of the App. Include any post installation instructions in this section as well. |
# Click "Save." | # Click "Save." | ||
| − | |||
| − | |||
| − | |||
| − | |||
<b>Mandatory fields</b> are marked with Red Asterisk, the record will not be saved unless mandatory fields are filled in first. | <b>Mandatory fields</b> are marked with Red Asterisk, the record will not be saved unless mandatory fields are filled in first. | ||
<br> | <br> | ||
<br> | <br> | ||
| − | After the App has been saved, you will | + | After the App has been saved, you will see a "Publish" button in the actions section. Click "Publish" when you are ready to publish your App. Subscribe-HR team will receive your request and start the App approval process. |
| + | |||
| + | |||
| + | ==Installing An App== | ||
| + | |||
| + | [Coming Soon] | ||
| + | |||
| + | Users will be able to install integrated Apps in two locations: | ||
| + | #Via the Apps Dashboard (for System Administrators only). {Coming soon]. | ||
| + | #Via "Settings" (you can access the Settings menu via the dropdown menu at the top-right of the screen (click on the downward pointing arrow next to your name). When the Settings page open, go to Developers > Apps. | ||
| + | |||
| + | To install an App: | ||
| + | #Click on the App widget in the App Dashboard or App Settings page. | ||
| + | #Configure the App settings (which includes endpoints listed as part of the integration). | ||
| + | #Click "Install." | ||
| + | |||
| + | When installation is complete, you will be asked to authenticate the App with your application account via the API, including: | ||
| + | *User name. | ||
| + | *Password. | ||
| + | *Relevant URLs etc. | ||
<br><br>[[File:subscribehr_logo.gif]] | <br><br>[[File:subscribehr_logo.gif]] | ||
Latest revision as of 21:51, 8 August 2021
Apps Explained
Subscribe-HR allows third-party Developers to create custom solution extensions that can then be published in the Subscribe-HR App store and offered to Users as add-ons. To get started with App building the first step is to create your App record. Objects, Elements, Relationships, Integration Processes can then be created for your App and be bundled as part of the installation package.
NOTE: before your App can be published in the store it will be subjected to a testing, validation and approval process which will be performed by the Subscribe-HR team.
Once approved, the App will become available in the following two locations:
- Under the General menu (left-hand side of the System/screen) > Development > Apps.
- Via the App Dashboard [coming soon].
Developers can access the App documentation here: https://subscribehr.readthedocs.io/en/latest/getting_started.html
Apps can be installed and configured by Users via the Activation Hub [Coming soon].
Creating A New App
- The first step in the process is to start a Free Trial: https://www.subscribe-hr.com.au/free-trial
- After logging into the Subscribe-HR portal, go to the General menu (left-hand side of the System/screen) > Development > Apps.
- Select the Apps folder.
- Select the "+Add new record" button.
- Enter the Name - name the App as you want it to appear in the store.
- Enter a Short Description - add a short App description snippet. This description will appear in the store on the App tile.
- Enter the Categories - include the categories that App will be listed under.
- Enter the Developer Name - list the Developer's name.
- Enter the Developer Website - share the Developer's website.
- Enter the Developer Logo - add the Developer/Company logo. This can be a product logo if this is an integration project.
- Enter the Full Description - include a detailed description of the App. Include any post installation instructions in this section as well.
- Click "Save."
Mandatory fields are marked with Red Asterisk, the record will not be saved unless mandatory fields are filled in first.
After the App has been saved, you will see a "Publish" button in the actions section. Click "Publish" when you are ready to publish your App. Subscribe-HR team will receive your request and start the App approval process.
Installing An App
[Coming Soon]
Users will be able to install integrated Apps in two locations:
- Via the Apps Dashboard (for System Administrators only). {Coming soon].
- Via "Settings" (you can access the Settings menu via the dropdown menu at the top-right of the screen (click on the downward pointing arrow next to your name). When the Settings page open, go to Developers > Apps.
To install an App:
- Click on the App widget in the App Dashboard or App Settings page.
- Configure the App settings (which includes endpoints listed as part of the integration).
- Click "Install."
When installation is complete, you will be asked to authenticate the App with your application account via the API, including:
- User name.
- Password.
- Relevant URLs etc.
