Difference between revisions of "PA OXaaS APSv2 User Guide"

 
Line 1: Line 1:
 
= User Guide for the OX as a Service APSv2 package into Odin Service Automation =
 
= User Guide for the OX as a Service APSv2 package into Odin Service Automation =
  
This APS 2.0 package is only for the Open-Xchange own OXaaS platform or similar respective compatible deployments or copies of this platform. The package is designed for syndication and on-premise customers with Odin Service Automation 5.5 and higher.
+
This APS 2.0 package is only for the Open-Xchange own OXaaS platform or similar respective compatible deployments or copies of this platform. The package is designed for syndication and on-premise customers with Odin Service Automation 6.0.4 and higher.
  
 
This guide describes the integration for the OX as a Service APSv2 package into Odin Service Automation. This guide describes all the tasks administrators can carry out from the Customer Control Panel.
 
This guide describes the integration for the OX as a Service APSv2 package into Odin Service Automation. This guide describes all the tasks administrators can carry out from the Customer Control Panel.

Latest revision as of 11:20, 9 June 2016

User Guide for the OX as a Service APSv2 package into Odin Service Automation

This APS 2.0 package is only for the Open-Xchange own OXaaS platform or similar respective compatible deployments or copies of this platform. The package is designed for syndication and on-premise customers with Odin Service Automation 6.0.4 and higher.

This guide describes the integration for the OX as a Service APSv2 package into Odin Service Automation. This guide describes all the tasks administrators can carry out from the Customer Control Panel.

This guide is intended for administrators who intend to manage the services provided by Open-Xchange.

Terms and Abbreviations

Below is the list of concepts and abbreviations you will find in this page.

Abbreviation Definition
API Application Programming Interface
APS Application Packaging Standard, an open standard that was designed to simplify the delivery of SaaS applications in the cloud-computing industry.
CCP Customer Control Panel
OSA Odin Service Automation, which includes both POA and PBA.
OBA Odin Business Automation.
POA Parallels Operations Automation.
SaaS Software as a Service.

Customer Control Panel

In the Customer Control Panel (CCP) you can manage all the Open-Xchange settings.

User’s Tab

From this tab you can add, manage and delete service users registered within the current subscription.

  1. To add a user click on Add New Service User.

    Aps2 u1.png
  2. Fill in all the fields and click on Next.
    • User photo: you can upload a photo to add to your profile.
    • Display name: enter the display name you wish to have.
    • Login: choose a login name and select your domain from the dropdown list.
    • Password: choose your password. (You may also click Generate Password to create one automatically and you will see it under the Password field).
    • Confirm password: reenter your password.
    • Tick the Open-Xchange service checkbox.

      Aps2 u2.png
  3. A summary of the user information will appear. Click Finish for confirmation.

    Aps2 u3.png
  4. You can then see that the status of the user will be Aps2 u4.png

    Aps2 u5.png

OX Service Tab

From the Open-Xchange tab you can purchase requests and manage users, groups, resources, domains and purchase requests.

Users

On this tab you can add new users, manage profiles and edit, enable and disable them.

By default you will see the Active view, where you can see each user’s status. There are three different possibilities: Aps2 u6.png Aps2 u7.png Aps2 u8.png

Aps2 u9.png

You may also wish to see the Classic view by clicking Aps2 u10.png and selecting “Classic list”:

Aps2 u11.png. From here you will be able to see the same information and perform the same actions that are allowed in the Active view mode.

Add New User

To add a new user:

  1. Click Add New User.
  2. Fill in the following fields:

    Aps2 u12.png
  3. Click Next.
  4. The status will appear as Aps2 u13.png. If an error occurs during creation, the status will be Aps2 u14.png.
Manage Profiles

To manage profiles, follow these steps:

  1. Select the user whose profile you want to manage and then click Manage Profiles.

    Aps2 u15.png
  2. Select the new profile you want to assign to a user from the drop-down list.

    Aps2 u16.png
  3. Click OK to save the changes.
Edit
  1. Select the user whose profile you want to edit and then click Edit.

    Aps2 u17.png
  2. Enter the alias and select the appropriate domain from the drop-down list.

    Aps2 u18.png
  3. Click Save.
Enable

To populate the service user information to Open-Xchange:

  1. Select the user whose profile you want to enable and then click Enable OX App Suite2.

    Aps2 u19.png
  2. Enter the email and choose the domain, then select the profile you want to assign to the user. You can also add one or more aliases to the user by clicking on Additional Settings.

    Aps2 u20.png
  3. Click Next to save the changes. The user’s status will now be Enabled.
Disable

To delete an Open-Xchange user:

  1. Select the user whose profile you want to disable by ticking the appropriate box, then click Disable.

    Aps2 u21.png
  2. A message will ask you to confirm that you want to disable the user. Click Accept for confirmation.

Groups

On this tab you can create, delete and edit groups of users.

Aps2 u22.png

Add new group

To add a new group:

  1. Click on the Add new group button.

    Aps2 u23.png
  2. Enter a name for the group.
  3. Select the users that you want to add to the group and click Aps2 u24.png to add them. Then click Save.
  4. You will then see the group you have created and the users that belong to it.

    Aps2 u25.png
Delete group

In order to delete a group, select it by ticking the appropriate box and then click Delete selected groups.

Aps2 u26.png

Edit group

You can also edit the name of the group or add/remove members. To do that, click on the group’s name. You will then see the group’s details and you can edit its name and add or remove users by selecting them and clicking Aps2 u27.png or Aps2 u28.png accordingly.

Aps2 u29.png

Resources

On this tab you can add, delete and edit any resources you may need.

Add resource

To add a resource:

  1. Click on Add new resource.
  2. Enter the resource’s details:
    • Resource name: name that you want to call the resource.
    • Resource manager: select the person that will manage the resource from the drop-down list.
    • Display name: resource name that will be displayed.
    • Description: description of the resource. This field is not mandatory.
    • Resource email: enter the email and choose the domain from the drop-down list.

      Aps2 u30.png
  3. Click Save resource.
Delete resource

In order to delete a resource, select it by ticking the appropriate box and then click Delete resources.

Aps2 u31.png

Edit resource

You can also edit resources to change their details. In order to do so, click on the resource’s display name. All the details will be shown so that you can change any information. Click Save resource to save the details.

Aps2 u32.png

Domains

On this tab you can add and delete domains and subdomains.

Add domain

To add a domain:

  1. Click on Add domain.
  2. Select the catch all address from the dropdown list to avoid losing email due to misspellings.

    Aps domain.jpg
  3. Click Save.
Add subdomain
  1. Click on Add subdomain.
  2. Enter the following details:
    • Subdomain: enter the subdomain’s name and select the domain from the dropdown list.
    • Catch all: select, if appropriate, the catch-all email address from the drop-down list.

      Aps2 u33.png
  3. Click Save.
Remove domains

To remove a domain, you just have to tick the appropriate one from the list of existing domains and click on Remove domains.

Aps2 u34.png

Edit domains

To edit a domain, click on the pencil button under the Actions column. The details will be displayed for you to change, if necessary. Then click Save to save the changes.

Aps2 u35.png

Purchase Requests

The purchase requests tab shows all purchases that users have requested. These are made from the OX App Suite application as an upgrade request. After that, they will be listed on this tab and from here the customer will be able to proceed with the profile upgrade or cancel it using the “Proceed” or “Reject” buttons, accordingly.

Aps2 purchase request.jpg