After you have set up the integration, you can start adding integration rules and define how the integration should behave.
Each rule is a template - it will define the flow of integration. Each rule runs separately, so for different actions you need to define different rules.
To set up rules, go to Provisioning page and click Edit on the Integration you wish to modify.
On Manage Integration page go to Rules.
Click Add to create an integration rule.
A dialog window will open where you can enter your settings.
Write in the name of the rule. It is recommended to write the title based on the action the rule is related to. Such as - Add all existing users to AppsCo or Add new user.
The first part of the rule represents an event or query in the Gsuite which will trigger a reaction.
Rule example No. 1:
Add all existing users to AppsCo
Under Choose event or query the system, choose Lookup from the drop-down.
Under Incoming object choose which object from Gsuite do you wish to sync - user or a group. In this case, choose Gsuite User.
This query will look trough Gsuite for all existing users.
Now, in order to define the action which will be performed, under Action to be performed choose Add from the drop-down.
Under Affected object choose how will this user be added on AppsCo. Choose for example AppsCo User.
This means that Lookup will look for all the users in the Guite and them upon sync add them as AppsCo users inside your company.
Check toggle to activate the rule and then click Add to create it.
The rule will be added to the list. Since this rule uses Lookup as a method - which means there is no event which can trigger the web-hooks, it needs to be synced manually. Click Run on the card
to run the sync for this rule.
You can use this type of rule to add all your users on Gsuite to AppsCo. By defining the parameters you can define how the entire system should behave.
Rule example No. 2:
Add new user to AppsCo
Under Choose event or query the system, choose Added from the drop-down - this means that when the defined object is added on Gsuite it will trigger the reaction and the rule will be performed.
Under Incoming object choose which object from Gsuite do you wish to sync - user or a group. In this case, choose Gsuite User.
This means when user is added on Gsuite it will trigger a specific action defined in the second part of the rule.
You can use the Advanced settings to define details and filter the object (in this case user).
Click Advanced to expand this section. You can define different conditions which will be applied. For example, under Group write in the name of the group on Gsuite - Marketing (as an example).
This condition means - if a user is added on Gsuite and is in the group Marketing, a reaction will be triggered and result in an action which will be defined in the second part of the rule you are setting up.
In the second section, under Action to be performed choose Add from the drop-down.
Under Affected object choose for example AppsCo User. This means the action will be performed on AppsCo User.
You can also define conditions under Advanced. Click Advanced to expand the section, and under Group enter for example Marketing, Sales (comma-separated names of the groups in AppsCo).
This means that when user is Added on Gsuite and is in the Marketing group it will trigger the reaction and an AppsCo user will be created in groups Marketing and Sales.
Check toggle to activate the rule and then click Add to create it.
Since you used the method Added - this rule will run automatically trough web-hooks, so in this case you do not have to sync it manually. This applies for methods - Added, Modified and Removed while Lookup must be run manually.
As you can see, each rule can be customized and set up according to your needs. Rules are usually set initially and then run in the background.
If you have any questions, please send us an email at support@appsco.com
0 Comments