X3 Developer Notes

Accessing the Authoring Tools

The system administrator may be asked to define the main characteristics of a page, navigation pages, dashboard definitions, home pages (landing pages), menu modules and categories, and menu items.

These authoring tools can be accessed in the Administration > Authoring block.

Sage X3 and Sage Software are trademarks of Sage Software, Inc. Microsoft SQL Server, Microsoft SQL Enterprise Manager and SQL Server Management Studio are registered trademarks of Microsoft Corporation. Oracle is is a registered trademark or Oracle Corporation. All other product names used here are trademarks or registered trademarks of their respective owners.

Uploading Documents

You also need to store documents in the database (mongoDB). Use Documents under Documents in the Administration > Collaboration block to accomplish this task. A document can be any file (such as a Word document, Excel spreadsheet, or image). A document can be accessed by its owner and by members of a team.

If the Read-only check box is selected, the document cannot be modified or uploaded again, except by the owner.

Only a volume stored on mongoDB and defined in the Volumes function can be selected at the Storage volume field.

At the Storage volume field, select the volume where you want to store the document.

You can click and drag a file from Windows Explorer directly into the Content area or manually select the file.

After a document is added, you can view the document by clicking it in this function as well as remove the file by clicking Remove.

Use the Tags & Teams section to assign specific tags and teams to the document.

The Information section displays information about the file including the upload date and file name.

Uploading Documents

Click New document in the Right panel of the List of documents window to define and upload a document.

Setting Up Teams for Document Control

You have been asked to create teams for document control in your system. Use Teams in the Administration > Collaboration block to accomplish this task. Teams are a set of users that are able to access and manage documents. To add a team, click New team in the Right panel.

When uploading documents, you can assign a team(s) to a document.

When creating a login user, you can assign the user to various teams for viewing, managing, and authoring documents.

If the Public access check box is selected, any user has access to the documents linked to the team.

The administrator selected has the rights to modify the team (add or remove members) and control membership. Only one administrator can be selected.

Under Authors, select all users that can create new documents in the team.

Under Members, select all users that have access to the documents posted for the team.

Any documents or template documents already attached to the selected team display. You can remove them from a team in this function as well as add documents and template documents already uploaded to the team.

The Tags section displays the tag associated with the documents available for the team.

Setting Up Document Tags

Tags are labels attached to documents to aid in the management of documents throughout the system. Tags are also useful when searching for documents with the same tag attached to them.

There are two functions used for setting up tags:

Tag categories

Document tags

Note: Creating document tags is optional.

Document tag categories

Use Tag categories under Documents in the Administration > Collaboration block to group document tags together. A tag can have a unique category, but the category is not mandatory. Click the New document Tag Category button in the Right panel.

You can add tags to a tag category if already defined. This function will also list tags assigned to the category in the Document tags function.

Document tags

Use Document tags under Documents in the Administration > Collaboration block to define an actual label that is attached to a document. Click the New document Tag Category button in the Right panel.

A list of documents linked to the tag display under Documents. You can also assign a tag to a document or delete an association with a document.

A list of template documents linked to the tag display under Template Documents. You can also assign a tag to a document or delete an association with a document.

Use the Category field to assign the tag to a tag category.

Setting Up Storage Volumes

The system administrator needs to create and view the default storage volumes in your system. Use Volumes in the Administration > Collaboration block to accomplish this task. To add a volume, click New storage volume in the Right panel. To edit a volume, click the pencil icon for the volume in the List of storage volumes.

A volume is considered a logical volume where documents are safely stored and shared based on teams.

The program comes with pre-set volumes and you can also create your own volumes.

When uploading a document, you must assign it to a storage volume.

Storage

In the Storage section, you have the choice of mongoDB or File.

MongoDB corresponds to a global storage area on the mongoDB platform. Any kind of document can be stored there including images, documents, spreadsheets, etc.

The File option allows you to store the file on the server using the path you provide.

If File is selected, you must enter a path.

Select the Dynamic check box to automatically update content. With this check box selected, you will not be prompted to update a document because it will be updated automatically.

Accessing the Collaboration Tools

As system administrator, you may be asked to set up storage volumes, document tags, document tag categories, and teams for document control. The collaboration tools to accomplish these tasks can be accessed from the Administration menu. You can also use these tools to upload documents and word templates to the database (mongoDB). These tools provide a way to handle documents in the Sage X3 Web (Syracuse) architecture of the software.

Setting Up Global Users

The system administrator will be tasked with defining global user that are used to access the software and linked to one or more endpoint users to determine the functionality in the selected endpoint (folder). Use Users under Users in the Administration > Administration block to define global users. The login created is used to access the software. To add a global user, click Create user in the Right panel. To edit a user, click the pencil icon for the user in the List of users.

At the Login field, enter the login ID for the user. You can also indicate if this user is active or inactive.

Additional information for the user such as their full name and e-mail address is entered.

You can select a file to display a photo of the user. Any image file type supported by the browser can be used.

Authentication

The options available for Authentication define the authentication policy specific to this user.

Select Standard if using the standard authentication method selected in Global Settings.

DB is used as an alternate method when no other standard authentication exists.

In this case, a user password is entered and is stored encrypted in the mongoDB database.

To use LDAP, select the LDAP option and enter the appropriate authentication name and defined LDAP server.

To use OAuth2, select the OAuth2 option and select the defined OAuth2 server.

Administration

In the Administration section, you can assign the user to one or more groups, endpoint
logins, and teams.

Under Groups, select the group(s) the user is assigned.

By default, the connection to the endpoints associated with the group is performed with an endpoint user code equal to the selected user in this function.

If an equal endpoint user code is not available, they are unable to access any endpoints.

Under Endpoints login, you can optionally choose to grant access to the various endpoints using a different endpoint login than the user logon. This allows you to define different access rights based on the folder the user is accessing.

You can add endpoints that are not assigned to the group(s) selected.

Teams are a set of users that are able to access and manage documents. Setting up teams is discussed in a later topic.

X3 Developer Notes

Pages

Monday, November 27, 2017

Accessing the Authoring Tools

Uploading Documents

Uploading Documents

Setting Up Teams for Document Control

Setting Up Document Tags

Document tag categories

Document tags

Setting Up Storage Volumes

Storage

Accessing the Collaboration Tools

Setting Up Global Users

Authentication

Administration