Platform Legal Agreement

Manage the platform legal agreement.

API Platform Version: 8.3

Table of Contents

  1. What is the platform legal agreement?
  2. What file formats are supported for the platform signup legal agreement?
  3. How do I add a platform signup legal agreement?
  4. How do I change the platform signup legal agreement?
  5. How do I deactivate the platform signup legal agreement?
  6. Related Topics

What is the platform legal agreement?

You might want to have a platform legal agreement in place, that all platform users are required to accept. If a legal agreement is in place, the platform requires users to accept the agreement in these scenarios:

  • As part of completing the initial login process.
  • On next login if the legal agreement changes.

You can upload more than one agreement document, but only one can be active. You can change the legal agreement at any time, or deactivate it. Remember that every time you change the legal agreement, every user must accept the new agreement at next login.

Note: The platform supports use of only one legal agreement. Make sure all the legal requirements are combined into one document.

Back to top

What file formats are supported for the platform signup legal agreement?

The following file formats are supported for the legal agreement:

  • Text (.txt, .text)
  • HTML (.htm, .html)

Back to top

How do I add a platform signup legal agreement?

To add a legal agreement there are two steps:

  1. First, upload the legal agreement file to the content/system/agreements folder. See Step 1: To upload a new legal agreement to the Akana API platform below.
  2. Then, make the new agreement the default for the platform. See Step 2: To set a specific legal agreement as the default for the platform below.
Step 1: To upload a new legal agreement to the Akana API platform

Note: Follow the procedure below to upload a legal agreement directly to the correct folder. This is the fastest way to do it. However, you can also upload via Administration > Config > Resources > Content. You'd then need to create the rest of the folder structure before uploading the file. It doesn't matter how the legal agreement is uploaded but it must be in the content/system/agreements folder.

  1. Log in as the Site Admin.
  2. Go to Administration > Agreements.
  3. Click Upload Agreement.

    Note: this functionality is only available to the Site Admin. If you don't see the Upload Agreement button on the right, you don't have the appropriate permissions.

  4. In File Manager, click Upload a File, then navigate to the location of the new developer agreement and upload it (for example, it could be a .txt, .htm, or .html file). The content is uploaded automatically to the content/system/agreements folder.

Once you've uploaded the legal agreement, the next step is to make it the default for the platform. See below.

Step 2: To set a specific legal agreement as the default for the platform

Before setting the legal agreement as the default for the platform, you must upload it. See Step 1 above.

  1. Log in as the Site Admin.
  2. Go to Administration > Agreements.
  3. Click Add Agreement.

    Note: this functionality is only available to the Site Admin. If you don't see the Add Agreement button on the right, you don't have the appropriate permissions.

  4. Specify values:
    • Name: Used internally.
    • Description: Displayed to users above the legal agreement when the user is logging in for the first time, or at the next login if the legal agreement changes.
    • Content Path: Browse for the agreement users must accept. You can only choose a file previously uploaded to the content/system/agreements folder as per Step 1 above.
    • Printable Content Path (optional): Browse for the agreement users can print. It can be the same file or a more print-friendly file format such as PDF. You can include a link to this file from the main developer agreement so that users can print.
  5. Click Finish. The legal agreement immediately becomes the default for the platform, and new or existing users will need to accept it to log in.

Note: You can upload more than one legal agreement. If you have more than one, they display in a list view in the Legal Agreements page. However, only one can be active.

Back to top

How do I change the platform signup legal agreement?

If you have a legal agreement in place, and want to deactivate it or change to a different one, you can do that in the Agreements page.

If you are changing to a new legal agreement, upload the file to the platform first; follow the steps in To upload a new legal agreement to the Akana API platform above.

To change an existing platform signup legal agreement
  1. Log in as the Site Admin.
  2. Go to Administration > Agreements.
  3. On the Legal Agreements page, find the agreement. Click the Actions drop-down menu at the right and choose Edit Agreement.
  4. On the Edit Agreement page, modify one or more values as needed. For information about the fields, see To set a specific legal agreement as the default for the platform above.
  5. Click Finish. The revised legal agreement immediately becomes the default for the platform, and new or existing users will need to accept it to log in.

Back to top

How do I deactivate the platform signup legal agreement?

If you have a legal agreement in place, and want to deactivate it so that platform users no longer need to accept the legal agreement, you can do that in the Administration > Agreements page.

To deactivate an existing legal agreement
  1. Log in as the Site Admin.
  2. Go to Administration > Agreements.
  3. On the Legal Agreements page, find the agreement. Click the Actions drop-down menu at the right and choose Deactivate Agreement.
  4. At the confirmation message, click OK. The agreement is immediately deactivated.

Back to top