App's configuration page

If needed, you have the possibility to provide each of your Apps with a configuration page. Your App is launched within an iframe with a width of 100%. The iframe then calls your end-point /configuration in order to render the view.

To access your App's configuration page:

  • Connect as Administrator
  • Go to Marketplace > Your App
  • Click on button Configuration

App_page.png

 

App's view rendering

An App can provide HTML content as we saw with the configuration page. For embedded Apps, this is necessary for the users to be able to use your App. Here are the use-cases for displaying a view:

    • The  App's default page accessible from a User Account > My Apps
    • Configuration page
    • Quick access from a button
    • Quick access from an iframe

The  App's default page 

 When a user has access to your App, he can access its default page from his list of Apps. The App is launched within an iframe with a width of 100%. The iframe then calls your App's base URL in order to render the view.

 

hireability.png

  

Access to the App from a button

As we mentioned in the Declare your App section, a button can be configured to appear on a specific page in BoondManager and act as a trigger to launch any specific function (i-e end-point in our App's API).

When clicked, an iFrame is opened with the following URL where function will depend on your button settings:

  • <App's URL>/<function>?signedRequest=...".  

 

Access to the App from an iframe

When an iframe is configured to appear on a specific page, your App is launched into an iframe and calls "<App's URL>/<function>?signedRequest=...". Here, function will depend on your App settings.

You can identify the origin of the App's iframe by analyzing the request's parameters :

Param Description Type Mandatory
  fromPage

  If the page is a record then it is concatenated with the        string "/@id"

  ex:

  • candidates
  • expenses-reports
  • resources/@id
  • opportunities/@id
string Yes
  fromId

  Record's id. Empty if the App's come from a search page.

integer  No
  fromTab

  ex: information or technical-data

  Empty if not used or the App's come from a search page.

string

No 

 

 

How signedRequest is built when rendering a view?

As we saw in the installation process, it is an object where specific attributes are encoded. Here is the list of attributes when rendering the view:  

Attribute Description Type Mandatory
  userToken

  The connected user's unique Token

string Yes
  clientToken

  Client unique token

string Yes
  language

  User's language :

  • fr
  • en

string

Yes 

  urlCallback   BoondManager's URL where the iFrame is shown string  Yes 
  issuedAt

  Date formatted:

  • [0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}[+-][0-9]{4}
string Yes 

  

Trigger your App on an event

Your App can receive a call from BoondManager when an event is triggered. However we do not handle your App's response.

BoondManager calls:

  • App's URL/function?signedRequest=...
  • function depends on your app's setting, with method GET.
  • signedRequest is a JSON object encoded with the following attributes :

 

Attribute Description Type Mandatory
  userToken

  The connected user's unique Token

string Yes
  clientToken

  The Client's unique token

string Yes
  language

  User's language :

  • fr
  • en

string

Yes 

  page

 The record's page that triggered the event followed by /{id}:

  • candidates/{id}
  • actions/{id}
  • companies/{id}
  • contacts/{id}
  • opportunities/{id}
  • resources/{id}
  • projects/{id}
  • positionings/{id}
  • contracts/{id}
  • advantages/{id}
  • groupments/{id}
  • inactivities/{id}
  • deliveries/{id}
  • actions/{id}
  • products/{id}
  • purchases/{id}
  • payments/{id}
  • orders/{id}
  • invoices/{id}
  • times-reports/{id}
  • expenses-reports/{id}
  • absences-reports/{id}
  • validations/{id}
  • quotations/{id}
string  Yes 
  id   A record'id integer  Yes 
  hookType

  Event type :

  • create
  • update
  • delete
string  Yes 
  issuedAt

  Date formatted:

  • [0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}[+-][0-9]{4}
 string Yes 
  tab

The record's tab. Not used if the record has no tab. Used only if hookType = update:

  • technical-data
  • information
string No 

 

 

Cet article vous a-t-il été utile ?
Utilisateurs qui ont trouvé cela utile : 1 sur 3

Commentaires

0 commentaire

Vous devez vous connecter pour laisser un commentaire.