Axpoint: Difference between revisions

From UmsWiki
Jump to navigation Jump to search
← Older edit
VisualWikitext
Kia (talk | contribs)
engineering, inHouse, Administrators
2,475 edits
 
(11 intermediate revisions by 3 users not shown)
Line 1: Line 1:
Integration with Axpoint's Office 365 SharePoint-based document management system.
Integration with Axpoint's Office 365 SharePoint-based document management system.


== Prerequisites ==
==Prerequisites==


=== Module requirements ===
===Module requirements===
[[UMS]]
[[UMS]]


== Template Setting ==
==Template settings==
This is where you connect an Axpoint Setting to a template. Users that are on this template will be synchronized with Axpoint.[[File:Axpoint Template.jpg|none|thumb|694x694px|This is where you connect an Axpoint Setting to a template.]]
This is where you connect an Axpoint Setting to a template. Users that are on this template will be synchronized with Axpoint.[[File:Axpoint Template.jpg|none|thumb|791x791px|This is where you connect an Axpoint Setting to a template.]]Start by selecting the setting you want to change or add a new one.[[File:Axpoint Settings.jpg|none|thumb|556x556px|Start by selecting the setting you want to change or add a new one.]]
== Settings ==
Start by selecting the setting you want to change or add a new one. [[File:Axpoint Settings.jpg|none|thumb|556x556px|Start by selecting the setting you want to change or add a new one.]]After choosing to either create a new or edit an existing setting, you will see the picture below.[[File:Axpoint Setting.jpg|none|thumb|707x707px|This is where you set up your Axpoint settings.]]


=== Security options ===
==Settings==
Site Collection URL: The URL for the work area
This is where you set up your Axpoint setting. The fields are described below.[[File:Axpoint Setting.jpg|none|thumb|859x859px|This is where you set up your Axpoint settings.]]


Security token: Value obtained from Axpoint
===Security options===


Site type: Value obtained from Axpoint
====Site Collection URL====
Insert the URL for the work area.


User account: The user who are allowed to access the site collection
This is the part or the URL that comes after the DNS name.


Waid: Value obtained from Axpoint
====Axpoint authorization token====
Value obtained from Axpoint


=== Disable/Enable ===
====Site type====
The key and values are different for each customer.
Value obtained from Axpoint


Key: It is the key Axpoint looks at to see if a user is disabled or not (do not include in metadata)
====User account====
Value obtained from Axpoint


User enabled value: A value that defines the user as active
The user who is allowed to access the site collection


User disabled value: A value that defines the user as disabled
===Disable/Enable===
Please note that the key and values are different for each customer.


=== Disable options ===
====Key====
Disable Users: Whether or not to disable users when they leave
This is the key/field Axpoint will look at when checking if a user is enabled or disabled (do not include this key in your metadata)


Disable after: Keep users active for a certain number of days after they have left and before disabling them
====User enabled value====
This is a GUID


=== Metadata configuration ===
The value which defines the user as active
Select the Metadata setting used


=== SQL Sentence ===
====User disabled value====
This is used to define more uniquely what records to include from the students table. This is only the Where part of a SQL sentence
This is a GUID


Could be something like
The value which defines the user as inactive


(Studienr = 'UMS)
===Disable options===


Or (Fullname like 'inLogic%')
====Disable users====
Check this if users should be disabled when they leave the school. If left unchecked, users will not be disabled.


== Metadata ==
====Disable after====
Creating users: Metadata used when creating or updating users[[File:Axpoint Metadata.jpg|none|thumb|668x668px]]
Choose how many days a user should be active before being disabled
Axpoint key name: The key that Axpoint uses


Static text beforedatabase field: Can be any text
===Metadata configuration===
Select the Metadata setting used. See how to create or update users below.


UMS database field: Choose a field from the students table.
===SQL Sentence===
In this field, you can define which records should be included from the students' table. It is only possible to use the SQL where sentence.


Static text after database field: Can be any text
I.e. (Studienr = 'UMS) or (Fullname like 'inLogic%').


Required in Axpoint: Check this to make sure the field will not be empty in Axpoint. If the field is blank in UMS it will not send the record to Axpoint
==Metadata==
This is the metadata used when you create or update user in Axpoint. The fields are described below.[[File:Axpoint Metadata.jpg|none|thumb|1052x1052px|This is the metadata used when you create or update user in Axpoint.]]
 
===Default fields===
{| class="wikitable"
|+Predefined fields that must be set
!UMS
!AxPoint
!Description
!Unique
|-
|
|Ax_Id
|This is a unique key for a user
|X
|-
|
|Ax_Name
|
|
|}
 
====Axpoint key name====
The key that Axpoint uses
 
====Static text before database field====
Can be any text
 
====UMS database field====
Choose a field from the students' table
 
====Static text after database field====
Can be any text
 
====Required in Axpoint====
Check this to ensure that the field will not be empty in Axpoint. Please note that if the field is blank in UMS, the record will not be sent to Axpoint
 
====Upload====
Upload the information to Axpoint or not

Latest revision as of 14:04, 16 June 2022

Integration with Axpoint's Office 365 SharePoint-based document management system.

Prerequisites

Module requirements

UMS

Template settings

This is where you connect an Axpoint Setting to a template. Users that are on this template will be synchronized with Axpoint.

This is where you connect an Axpoint Setting to a template.

Start by selecting the setting you want to change or add a new one.

Start by selecting the setting you want to change or add a new one.

Settings

This is where you set up your Axpoint setting. The fields are described below.

This is where you set up your Axpoint settings.

Security options

Site Collection URL

Insert the URL for the work area.

This is the part or the URL that comes after the DNS name.

Axpoint authorization token

Value obtained from Axpoint

Site type

Value obtained from Axpoint

User account

Value obtained from Axpoint

The user who is allowed to access the site collection

Disable/Enable

Please note that the key and values are different for each customer.

Key

This is the key/field Axpoint will look at when checking if a user is enabled or disabled (do not include this key in your metadata)

User enabled value

This is a GUID

The value which defines the user as active

User disabled value

This is a GUID

The value which defines the user as inactive

Disable options

Disable users

Check this if users should be disabled when they leave the school. If left unchecked, users will not be disabled.

Disable after

Choose how many days a user should be active before being disabled

Metadata configuration

Select the Metadata setting used. See how to create or update users below.

SQL Sentence

In this field, you can define which records should be included from the students' table. It is only possible to use the SQL where sentence.

I.e. (Studienr = 'UMS) or (Fullname like 'inLogic%').

Metadata

This is the metadata used when you create or update user in Axpoint. The fields are described below.

This is the metadata used when you create or update user in Axpoint.

Default fields

Predefined fields that must be set
UMS AxPoint Description Unique
Ax_Id This is a unique key for a user X
Ax_Name

Axpoint key name

The key that Axpoint uses

Static text before database field

Can be any text

UMS database field

Choose a field from the students' table

Static text after database field

Can be any text

Required in Axpoint

Check this to ensure that the field will not be empty in Axpoint. Please note that if the field is blank in UMS, the record will not be sent to Axpoint

Upload

Upload the information to Axpoint or not

Retrieved from "http://wiki.inlogic.dk/index.php?title=Axpoint&oldid=4379"