How to setup apps
Limited access
Only administrators can see the Apps screen.
Can't find the method you are looking for?
We have already catered for most major CMS suppliers. However, if you require any new methods in your instance, a small amount of initial setup and development is required to construct the translation mechanism. Should you require the new method, please email us.
You can setup apps through the Apps screen. To view the Apps screen, click Apps from the left panel.
Click on the App's icon to view the properties for each app. See below on how to setup each app.
The CAE Crew Manager system users will already have the API installed and connected with the SAFE application. They will only need the SAFE Application API key.
Crew Manager places all the data required into an agreed upon end point and simultaneously sends a message to SAFE and CARE to declare there is new data in the end point.
SAFE and CARE will collect that data. The data in the end point will be pre-mapped to the SAFE and CARE data structure requirements. The collected data will be uploaded into SAFE and CARE, validated and then analysed. The analysis will be returned to the another agreed upon end point for use in Crew Manager. To setup Crew Manager, you will need to provide value to the following properties:
| Property | Description |
|---|---|
| Enable Crew Manager Interaction | The property that controls if CREW manager can send and receive messages from SAFE and Care. Check this property to enable messaging. |
| Base Url | The base url of the Crew Manager |
| Customer Id | The customer Id of Crew Manager system to integrate with |
| Customer App Id | The customer app Id of Crew Manager system to integrate with |
| Company | The company which the intergation is associated with |
| Username | The username that SAFE must use when messaging Crew Manager |
| Processing Lead Days | The number of days prior the schedule start day from which the data must be collected from the Crew Manager to analyse the roster |
If you are using Amazon S3, SAFE and CARE can automatically check address for new files and retrieve them for analysis. To setup Amazon S3, you will need to provide value to the following properties:
| Property | Description |
|---|---|
| Bucket name | The name of Amazon S3 bucket |
| Access key | The Amazon S3 access key |
| Secret Key | The Amazon S3 secret key |
| Region name | The region in Amazon S3 where your bucket is hosted |
| Conversion Format | The format in which the roster data is in |
If you are using Azure Storage, SAFE and CARE can automatically check address for new files and retrieve them for analysis. To setup Azure Storage, you will need to provide value to the following properties:
| Property | Description |
|---|---|
| Blob container | The URL to the Azure blob container |
| Storage connection string | The connection string to use to validate access to the blob container |
| Conversion Format | The format in which the roster data is in |
IDEAGEN’s Coruson FDM application is also integrated with SAFE and CARE. After you have set it up, SAFE can receive data from your crew management system, analyse it and afterwards place it into Coruson to assist in FDM analysis. To setup Ideagen/Coruson, you will need to provide value to the following properties:
| Property | Description |
|---|---|
| Source | The bucket name for the source of the roster data |
| Destination | The bucket name for the destination where the analysed roster should be shared |
| Source access key | The access key to the source |
| Source secret key | The secret key to the source |
| Source region name | The region name of the source |
| Destination access key | The access key to the destination |
| Destination secret key | The secret key to the destination |
| Destination region name | The region name of the destination |
Like Azure Storage and Amazon S3, SAFE and CARE can automatically check SFTP address for new files and retrieve them for analysis. To setup SFTP, you will need to provide value to the following properties:
| Property | Description |
|---|---|
| Server Name | The url to the server |
| Port | The port SAFE application must use when connecting to this server |
| User Name | The username SAFE application must use when connecting to this server |
| Password | The password SAFE application must use when connecting to this server |
| Files Path | The path to the roster data that SAFE application must check after connecting to this server |
| Conversion Format | The format in which the roster data is in |
Like Azure Storage and Amazon S3, SAFE and CARE can automatically check FTP address for new files and retrieve them for analysis. To setup SFTP, you will need to provide value to the following properties:
| Property | Description |
|---|---|
| Server Name | The url to the server |
| User Name | The username SAFE application must use when connecting to this server |
| Password | The password SAFE application must use when connecting to this server |
| Files Path | The path to the roster data that SAFE application must check after connecting to this server |
| Conversion Format | The format in which the roster data is in |