|
SunSystems Connect Administration |
|
|
|
|
Sun Documentation -
System Administration
|
|
Page 1 of 3 SunSystems Connect (SSC) provides an XML (eXtensible Markup Language) and SOAP (Simple Object Access Protocol) interface through which developers can access SunSystems 5 data and core functionality.
SunSystems Connect functionality comprises:
Property Editor (PED)
User Manager (UM)
Component Manager (CM)
User Manager and Component Manager can only be run on a server with the client installed on it. Therefore, they cannot be run on the client on a client only installation. Property Editor can be run on a client installation, however, a number of properties are not applicable.
Read more about SunSystems Connect.
Component Manager
Component Manager (CM) is used by System Administrators and Systems Union consultants, external developers and channel partner consultants to administer and maintain components and methods used by Transfer Desk and SunSystems Connect. The Component Manager features the following: Transaction monitoringComponent/Method detailsComponent deploymentPayload content and deployment.
Components Tab
The components tab displays all the available run-time business components in a hierarchical view. It allows you to install new components, see details of available components/methods, display/administer payload definitions and generate schemas.
Runtime Components
This displays the list of SSC Components supported in the current version of SunSystems. These components relate to a SunSystems functions, for example, Accounts for Chart of Accounts. Click on the + icon to display the methods available for each component.
Methods
These relate to an action within a specified function, for example, Create. When you select a component or a method a brief description of it is displayed in the frame beneath the hierarchy structure. You can also generate input and output schemas.
To view the detail of a component: select the required component from the hierarchy and click the Component details button. The Component Details dialog is displayed, which shows the name and the description of the selected component. The information is read only and cannot be amended.
To view the details of a method: select the method and click on the Method details button. The Method Details dialog is displayed. The dialog contains the name and description of the method in the Description frame, the driver type, and its parameters and values. The information is read only and cannot be amended.
To install a new component: From time to time new SunSystems Connect components or methods may be delivered to you. These will have a file extension of .jar. To install components click Install Component(s) on the Components tab. The Specifying a package file dialog is displayed. Navigate to your required .jar file supplied by Systems Union for the required updates and click OK. A JAR (Java ARchive) file is a file that contains template definition and image files in a single file in a compressed format for faster downloading to your web browser. Note: Additional installed components are appended to the end of the list, not inserted. You must close and re-open Component Manager to view them in the correct order. If the new component has the same name as an existing component it overwrites it and updates the version number. You can see how new components are made up or have been changed by clicking the Component Details button.
Payload Definitions Tab
A payload is the essential data carried within a transmission unit that is delivered to the end user at the destination. The payload does not include the 'overhead' data required to get the data to its destination. It is made up of fields which may be grouped under Nodes. Every component method has an Input and an Output Payload defined. These are the definitions of all fields required to support that method. They differ according to the actions carried out. For example, a query input payload includes field definitions to allow filtering of data. Whereas the ouput payload returned does not include filtering fields. A create input payload includes definitions of data to be imported; the output payload includes definitions of any errors returned by the import process. The Payload Definitions provided include all possible data fields and child records for each component. Note: Payloads are defined in XML and referred to as SSML format (SunSystems XML). Date and numeric fields use international XML standards. The standard for date format is ddmmyyyy, the standard for numeric format uses a fullstop (.) as a decimal separator and no thousands separator.
You can view input and output Payload Definitions on the Components tab. Navigate to a method, select it and click either the Display Input Payload Definition button or the Display Output Payload Definition button, depending on your requirements.
Payload Definitions can be tailored to fit the needs of the user. For example, there may be fields the user is not interested in and if these are removed, performance is improved. You can view the properties for each field in a payload and you can choose to exclude fields available to the user. Properties include XML tag, database table and description, and payload definition version number, if applicable. Select a payload from the hierarchy. Click the Display Payload Definitions button. The relevant Payload Definition window is displayed. This details the Payload Definition and the XML tags it contains. Select the required XML tag, or use the Ctrl or Shift button to select a range of XML tags and click the Mark as used/Mark as unused buttons as required. Note: The command buttons are enabled/disabled as applicable, dependent on what is selected. To mark all XML tags within a payload node as unused/used, highlight the payload node icon itself and use the command buttons as required. Note: If budget checking at analysis code level is used, any amendment to analysis codes via Account Allocation is not reflected in the budget check values and therefore any future postings may not be compared against the correct value.
What is a Schema?
A schema details the characteristics of payload items with built in validation. It works in a similar way to the data dictionary. The schema is made up of 'metadata' which is data that describes other data. You can generate schemas which hold characteristics and inbuilt validation. Select a method and click the Generate Input Schema or Generate Output Schema button. The type of schema you choose depends on the method selected.
|
System Administration 
