AFAS ATS

Adding the GetConnectors

As AFAS doesn’t provide the necessary prebuilt connectors, they need to be added

Upload the files to your AFAS server

  1. ⚠️ First, download the two necessary GetConnectors for applicants and vacancies

  2. Click the three white lines at the top middle of your screen:

    Screenshot 2023-02-26 at 17.44.56.png
  3. In the menu that appears now, click the upload button:

    Screenshot 2023-02-26 at 17.45.20.png



  4. Select the two connectors that you just downloaded and finish the selection dialog:

    Screenshot 2023-02-26 at 17.55.49.png



  5. Select any location to store the two files and click "OK":

    Screenshot 2023-02-26 at 17.46.42.png



Import the connectors

  1. Go to General > Output > Management > GetConnectors:

    Screenshot 2023-02-26 at 17.29.55.png



  2. Click "Import":

    Screenshot 2023-02-26 at 17.36.19.png



  3. Open the dialog for uploading Files:

    Screenshot 2023-02-26 at 17.56.25.png



  4. Select the two connectors that you just uploaded under the "Upload the files to your AFAS server" section of this guide and click "Open":

    Screenshot 2023-02-26 at 17.57.04.png


  5. You should now see the two connectors in listed in the import window:

    Screenshot 2023-02-26 at 17.57.26.png



  6. Click "Finish"


Creating a user and user group

Create user

  1. Go to General > Management > Authorization tool:

    Screenshot 2023-02-02 at 14.19.14.png



  2. Click on User > New system user...

    Screenshot 2023-02-02 at 14.23.56.png



  3. You have to prefix the username with your environment ID (which consists of five numbers) and it cannot exceed 20 characters.
    For example:

    - User: "12345.integrationUsr"

    - Description: "User for granting API access"

    Screenshot 2023-02-02 at 15.06.18.png



  4. Click next on the following dialog:

    Screenshot 2023-02-02 at 15.08.25.png



  5. Make sure to add a valid email address to the user:

    Screenshot 2023-02-02 at 15.09.03.png



  6. Click on the user you just created, then:

    1. "User maintenance"

    2. "Authorisation"

    3. "General"

    4. "Management"

    5. "Definition"

    6. "Filters"

    7. Click on "Filter active"

      Screenshot 2023-02-02 at 15.11.49.png
  7. There is no “save” button, just close the window to persist your changes

Create group

  1. Open the Authorization window, just as you did when creating the user, and click on Group > New...:

    Screenshot 2023-02-02 at 15.22.43.png
  2. Click the "Create a completely new user group":

    Screenshot 2023-02-02 at 15.24.37.png



  3. Enter any name and description, i.e.:

    - Name: "integrationUserGroup"

    - Description: "Only contains one user for moderating API access"

    Screenshot 2023-02-02 at 15.26.57.png



  4. Click on the "..." where it says "Enter based on":

    image.png



  5. In the window that pops up, select the option "Manually" and click "OK":

    Screenshot 2023-02-02 at 15.37.56.png



  6. Click on "Next" and optionally add any comments

  7. Click on "Finish"

Add user to group

  1. Open the Authorization window, just as you did when creating the user and group

  2. Go to
    1. "User maintenance"
    2. Select the user you just created
    3. Click "New"

    Screenshot 2023-02-02 at 15.39.02.png



  3. Enter the first letters of your group name into the blue field below "Grp.", then hit Enter. Click the checkbox on on the left of your group and click "OK":


  4. You should now be able to see the the group appear in the list:

    Screenshot 2023-02-02 at 15.45.37.png



Creating an app connector

  1. Go to Go to General > Management > App connector:

    Screenshot 2023-02-02 at 15.48.34.png



  2. Click "New" on the top left of the window that just opened:

    Screenshot 2023-02-02 at 16.07.31.png



  3. Give the connector any description you like, i.e.: "App connector for integration". Then, click the "..." at the bottom of the dialog:


  4. Enter the first letters of your group name into the blue field below "Grp.", then hit "Enter". Select your User Group and hit "OK":


  5. After that, click "Finish".

Configure its read and write permissions

  1. Open the properties of the app connector. To do this, go to the app connectors page and double click the name of your connector

  2. Click on "GetConnectors", then click "New":

    Screenshot 2023-02-02 at 16.19.23.png



  3. In the new window, click on the blue field below “Definition”, enter "custom_applicants" and hit enter. Then check the box on the left:

    Screenshot 2023-02-26 at 18.37.56.png



  4. Now repeat the same process for "custom_vacancies":

    Screenshot 2023-02-26 at 18.38.06.png



  5. Click “Finish
    - ⚠️ If you renamed the files before importing the GetConnectors you have to enter a different value in the search

  6. Now, go to "UpdateConnectors", then click "New":

    Screenshot 2023-02-26 at 18.42.55.png



  7. In the new window, click on the blue field below Connector ID and enter "HrCreateApplicant", and click the check box on the left of the field:

    Screenshot 2023-02-26 at 18.44.41.png



     

  8. Click “Finish

Unblock the app connector

  1. Open the properties of the app connector. To do this, go to the app connectors page and double click the name of your connector

  2. Go to "General" and make sure there is no check mark left to the field that says “Blocked”:

    Screenshot 2023-02-02 at 16.31.47.png



  3. Click "Finish".

Generate the token

  1. Open the properties of the app connector. To do this, go to the app connectors page and double click the name of your connector

  2. Click on "User tokens", then "New":

    Screenshot 2023-02-02 at 16.25.41.png



  3. Give the token any description, i.e.: "Token for granting API access", then the "..." right next to "User":

    Screenshot 2023-02-02 at 16.35.19.png



  4. Select the user you created, then click "OK":

  5. Click "next".

  6. On the new page you will see your token. You won’t be able to access it again, so save it somewhere secure:

Tip: how to copy your token out of the Citrix workspace

If you’re accessing AFAS via remote Desktop, you can’t use your Clipboard outside the remote Desktop. If you don’t want to copy the token by writing it down, you can copy it like this:

  1. Select the token, then right click on the selection and click "copy":

    Screenshot 2023-02-02 at 16.44.28.png



  2. Now click the three white lines at the top middle of your screen:

    Screenshot 2023-02-02 at 16.46.15.png



  3. A few icons should appear, click the one that looks like a clipboard:

    Screenshot 2023-02-02 at 16.47.20.png



  4. A new window should open, you can now copy the contents by pressing "Ctrl + C" and use it anywhere outside of Citrix:

    Screenshot 2023-02-02 at 16.48.17.png



Composing the AFAS service domain

The service domain of your AFAS instance takes the form of "<environmentID>.rest.afas.online"

You have to replace the "environmentID" with the five digit number of your environment name. Your environment name can be found at the top of your Profit workspace and will look something like this: "O12345AA" (the first letter is a capital “O”, not a 0)

So in this case your service domain will be: "12345.rest.afas.online"

  • ⚠️ You have to use an AFAS production environment. Production environment names are always prefixed with the capital letter “O”, so make sure it looks like this "O12345AA" and not like this "A12345AA" (which would be an “accept” environment)

 

Adding the integration

  1. Paste the service domain and user token into the connection flow and click “Set up integration”:

    Screenshot 2023-02-02 at 16.51.53.png